Aide-mémoire Envoy Proxy

📋 Copy All Envoy Proxy Commands 📄 Generate Envoy Proxy PDF Guide

Aide-mémoire Envoy Proxy

Installation

Plateforme	Commande
Ubuntu/Debian	`curl -sL ‘https://deb.dl.getenvoy.io/public/gpg.8115BA8E629CC074.key’ \
macOS	brew install envoy
Docker	docker pull envoyproxy/envoy:v1.28-latest
Binary (Linux)	curl -L https://github.com/envoyproxy/envoy/releases/download/v1.28.0/envoy-1.28.0-linux-x86_64 -o envoy && chmod +x envoy && sudo mv envoy /usr/local/bin/
RHEL/CentOS	`curl -sL ‘https://rpm.dl.getenvoy.io/public/gpg.CF716AF503183491.key’ \
Kubernetes (Helm)	helm repo add bitnami https://charts.bitnami.com/bitnami && helm install my-envoy bitnami/envoy
Verify Installation	envoy --version

Commandes de base

Commande	Description
envoy -c envoy.yaml	Démarrer Envoy avec un fichier de configuration spécifié
envoy --version	Afficher les informations de version d’Envoy
envoy --help	Afficher toutes les options de ligne de commande disponibles
envoy --mode validate -c envoy.yaml	Valider le fichier de configuration sans démarrer
envoy -c envoy.yaml --log-level info	Commencez avec un niveau de log spécifique (trace, debug, info, warn, error, critical)
envoy -c envoy.yaml --component-log-level upstream:debug	Définir le niveau de log pour un composant spécifique
envoy -c envoy.yaml --service-cluster my-cluster	Commencez par l’identificateur de cluster de service
envoy -c envoy.yaml --service-node node-1	Commencez par l’identificateur de nœud de service
envoy -c envoy.yaml --base-id 0	Définir l’ID de base pour la fonctionnalité de redémarrage à chaud
envoy -c envoy.yaml --restart-epoch 1	Effectuer un redémarrage à chaud avec le numéro d’époque
envoy -c envoy.yaml --drain-time-s 60	Définir le temps de vidange pour l’arrêt gracieux (secondes)
envoy -c envoy.yaml --parent-shutdown-time-s 90	Définir le temps d’arrêt parent pendant le redémarrage à chaud
envoy -c envoy.yaml --concurrency 4	Définir le nombre de threads de travail
envoy -c envoy.yaml --disable-hot-restart	Désactiver la fonctionnalité de redémarrage à chaud
envoy --help-hidden	Afficher les options de ligne de commande masquées/avancées

Commandes de l’interface d’administration

Commande	Description
curl http://localhost:9901/server_info	Obtenir les informations du serveur et son état actuel
curl http://localhost:9901/stats	Récupérer toutes les statistiques au format texte brut
curl http://localhost:9901/stats/prometheus	Exporter les statistiques au format Prometheus
curl http://localhost:9901/stats?format=json	Obtenir des statistiques au format JSON
curl http://localhost:9901/stats?filter=cluster.outbound	Filtrer les statistiques par préfixe
curl http://localhost:9901/stats?usedonly	Afficher uniquement les statistiques avec des valeurs non nulles
curl http://localhost:9901/config_dump	Vidage de la configuration actuelle complète
curl http://localhost:9901/config_dump?resource=bootstrap	Déposer uniquement la configuration bootstrap
curl http://localhost:9901/config_dump?resource=dynamic_listeners	Configuration de l’écouteur dynamique
curl http://localhost:9901/config_dump?resource=dynamic_clusters	Dump configuration dynamique du cluster
curl http://localhost:9901/clusters	Obtenez des informations détaillées sur le cluster et son état de santé
curl http://localhost:9901/listeners	Obtenir des informations détaillées sur l’auditeur
curl http://localhost:9901/ready	Vérifier si Envoy est prêt à servir le trafic
curl -X POST http://localhost:9901/healthcheck/fail	Marquer le serveur comme en échec pour les vérifications de santé
curl -X POST http://localhost:9901/healthcheck/ok	Marquer le serveur comme sain pour les vérifications de santé
curl -X POST http://localhost:9901/reset_counters	Réinitialiser tous les compteurs de statistiques à zéro
curl -X POST http://localhost:9901/drain_listeners	Écouter les drains pour un arrêt gracieux
curl -X POST http://localhost:9901/logging?level=debug	Modifier le niveau de log global à l’exécution
curl -X POST http://localhost:9901/logging?upstream=debug	Modifier le niveau de log spécifique au composant
curl -X POST http://localhost:9901/runtime_modify?key=value	Modifier les valeurs de configuration d’exécution

Utilisation avancée

Commande	Description
`curl http://localhost:9901/stats \	grep circuit_breakers`
`curl http://localhost:9901/stats \	grep outlier_detection`
`curl http://localhost:9901/stats \	grep ratelimit`
`curl http://localhost:9901/stats \	grep upstream_rq_retry`
`curl http://localhost:9901/stats \	grep ssl`
`curl http://localhost:9901/stats \	grep http.ingress.downstream_rq`
`curl http://localhost:9901/clusters \	grep health_flags`
`curl http://localhost:9901/config_dump \	jq ‘.configs[].bootstrap.tracing’`
`curl http://localhost:9901/config_dump \	jq ‘.configs[].dynamic_active_clusters’`
`curl http://localhost:9901/stats?format=json \	jq ‘.stats[] \
`curl http://localhost:9901/listeners \	grep -A 5 “address”`
`curl http://localhost:9901/stats/prometheus \	grep envoy_cluster_upstream_rq_total`
docker run -d -v $(pwd)/envoy.yaml:/etc/envoy/envoy.yaml -p 9901:9901 -p 10000:10000 envoyproxy/envoy:v1.28-latest	Exécuter Envoy dans Docker avec configuration montée
kubectl create configmap envoy-config --from-file=envoy.yaml	Créer un ConfigMap Kubernetes pour la configuration Envoy
kubectl logs -f deployment/envoy	Suivre les logs d’Envoy dans Kubernetes
envoy -c envoy.yaml --log-format '[%Y-%m-%d %T.%e][%t][%l] %v'	Commencer avec un format de log personnalisé
curl http://localhost:9901/certs	Afficher les informations des certificats TLS chargés
curl http://localhost:9901/memory	Afficher les statistiques d’allocation de mémoire
curl http://localhost:9901/contention	Afficher les statistiques de contention de mutex (si activé)
curl -X POST http://localhost:9901/cpuprofiler?enable=y	Activer le profilage CPU (si compilé avec profilage)

Configuration

Structure de configuration de base

# envoy.yaml - Minimal configuration
static_resources:
  listeners:
  - name: listener_0
    address:
      socket_address:
        address: 0.0.0.0
        port_value: 10000
    filter_chains:
    - filters:
      - name: envoy.filters.network.http_connection_manager
        typed_config:
          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
          stat_prefix: ingress_http
          route_config:
            name: local_route
            virtual_hosts:
            - name: backend
              domains: ["*"]
              routes:
              - match:
                  prefix: "/"
                route:
                  cluster: service_backend
          http_filters:
          - name: envoy.filters.http.router
            typed_config:
              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router

  clusters:
  - name: service_backend
    connect_timeout: 0.25s
    type: STRICT_DNS
    lb_policy: ROUND_ROBIN
    load_assignment:
      cluster_name: service_backend
      endpoints:
      - lb_endpoints:
        - endpoint:
            address:
              socket_address:
                address: backend-service
                port_value: 8080

admin:
  address:
    socket_address:
      address: 0.0.0.0
      port_value: 9901

Configuration dynamique (xDS)

# envoy-dynamic.yaml - Control plane configuration
node:
  cluster: my-cluster
  id: node-1

dynamic_resources:
  lds_config:
    resource_api_version: V3
    api_config_source:
      api_type: GRPC
      transport_api_version: V3
      grpc_services:
      - envoy_grpc:
          cluster_name: xds_cluster
  cds_config:
    resource_api_version: V3
    api_config_source:
      api_type: GRPC
      transport_api_version: V3
      grpc_services:
      - envoy_grpc:
          cluster_name: xds_cluster

static_resources:
  clusters:
  - name: xds_cluster
    connect_timeout: 1s
    type: STRICT_DNS
    lb_policy: ROUND_ROBIN
    http2_protocol_options: {}
    load_assignment:
      cluster_name: xds_cluster
      endpoints:
      - lb_endpoints:
        - endpoint:
            address:
              socket_address:
                address: control-plane
                port_value: 18000

admin:
  address:
    socket_address:
      address: 0.0.0.0
      port_value: 9901

Configuration des fonctionnalités avancées

# Circuit breaker and outlier detection
clusters:
- name: backend_service
  connect_timeout: 0.25s
  type: STRICT_DNS
  lb_policy: ROUND_ROBIN
  circuit_breakers:
    thresholds:
    - priority: DEFAULT
      max_connections: 1024
      max_pending_requests: 1024
      max_requests: 1024
      max_retries: 3
  outlier_detection:
    consecutive_5xx: 5
    interval: 30s
    base_ejection_time: 30s
    max_ejection_percent: 50
    enforcing_consecutive_5xx: 100
  load_assignment:
    cluster_name: backend_service
    endpoints:
    - lb_endpoints:
      - endpoint:
          address:
            socket_address:
              address: backend
              port_value: 8080
          health_check_config:
            port_value: 8081

Configuration TLS

# TLS termination
listeners:
- name: https_listener
  address:
    socket_address:
      address: 0.0.0.0
      port_value: 443
  filter_chains:
  - filters:
    - name: envoy.filters.network.http_connection_manager
      typed_config:
        "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
        stat_prefix: ingress_https
        route_config:
          name: local_route
          virtual_hosts:
          - name: backend
            domains: ["*"]
            routes:
            - match:
                prefix: "/"
              route:
                cluster: backend_service
        http_filters:
        - name: envoy.filters.http.router
          typed_config:
            "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
    transport_socket:
      name: envoy.transport_sockets.tls
      typed_config:
        "@type": type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.DownstreamTlsContext
        common_tls_context:
          tls_certificates:
          - certificate_chain:
              filename: /etc/ssl/certs/server.crt
            private_key:
              filename: /etc/ssl/private/server.key

Cas d’utilisation courants

Cas d’utilisation : Proxy HTTP de base

Configurer Envoy comme un proxy HTTP simple transférant le trafic vers des services backend.

# Create configuration file
cat > envoy.yaml << EOF
static_resources:
  listeners:
  - name: listener_0
    address:
      socket_address:
        address: 0.0.0.0
        port_value: 8080
    filter_chains:
    - filters:
      - name: envoy.filters.network.http_connection_manager
        typed_config:
          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
          stat_prefix: ingress_http
          route_config:
            name: local_route
            virtual_hosts:
            - name: backend
              domains: ["*"]
              routes:
              - match:
                  prefix: "/"
                route:
                  cluster: backend_cluster
          http_filters:
          - name: envoy.filters.http.router
            typed_config:
              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
  clusters:
  - name: backend_cluster
    connect_timeout: 0.25s
    type: STRICT_DNS
    lb_policy: ROUND_ROBIN
    load_assignment:
      cluster_name: backend_cluster
      endpoints:
      - lb_endpoints:
        - endpoint:
            address:
              socket_address:
                address: localhost
                port_value: 3000
admin:
  address:
    socket_address:
      address: 0.0.0.0
      port_value: 9901
EOF

# Start Envoy
envoy -c envoy.yaml

# Test the proxy
curl http://localhost:8080

# Monitor statistics
curl http://localhost:9901/stats | grep http

Cas d’utilisation : Équilibrage de charge de plusieurs backends

Configurer Envoy pour répartir la charge entre plusieurs instances backend avec vérification de santé.

# Create load balancing configuration
cat > envoy-lb.yaml << EOF
static_resources:
  listeners:
  - name: listener_0
    address:
      socket_address:
        address: 0.0.0.0
        port_value: 8080
    filter_chains:
    - filters:
      - name: envoy.filters.network.http_connection_manager
        typed_config:
          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
          stat_prefix: ingress_http
          route_config:
            name: local_route
            virtual_hosts:
            - name: backend
              domains: ["*"]
              routes:
              - match:
                  prefix: "/"
                route:
                  cluster: backend_cluster
          http_filters:
          - name: envoy.filters.http.router
            typed_config:
              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
  clusters:
  - name: backend_cluster
    connect_timeout: 0.25s
    type: STRICT_DNS
    lb_policy: ROUND_ROBIN
    health_checks:
    - timeout: 1s
      interval: 10s
      unhealthy_threshold: 2
      healthy_threshold: 2
      http_health_check:
        path: /health
    load_assignment:
      cluster_name: backend_cluster
      endpoints:
      - lb_endpoints:
        - endpoint:
            address:
              socket_address:
                address: backend1.example.com
                port_value: 8080
        - endpoint:
            address:
              socket_address:
                address: backend2.example.com
                port_value: 8080
        - endpoint:
            address:
              socket_address:
                address: backend3.example.com
                port_value: 8080
admin:
  address:
    socket_address:
      address: 0.0.0.0
      port_value: 9901
EOF

# Start Envoy with load balancing
envoy -c envoy-lb.yaml

# Check cluster health status
curl http://localhost:9901/clusters

# Monitor load distribution
watch -n 1 'curl -s http://localhost:9901/stats | grep backend_cluster.upstream_rq_total'

Cas d’utilisation : Résiliation et re-chiffrement TLS

Configurer Envoy pour résilier le TLS des clients et re-chiffrer vers les backends.

# Generate self-signed certificates for testing
openssl req -x509 -newkey rsa:4096 -keyout server.key -out server.crt -days 365 -nodes -subj "/CN=localhost"

# Create TLS configuration
cat > envoy-tls.yaml << EOF
static_resources:
  listeners:
  - name: https_listener
    address:
      socket_address:
        address: 0.0.0.0
        port_value: 443
    filter_chains:
    - filters:
      - name: envoy.filters.network.http_connection_manager
        typed_config:
          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
          stat_prefix: ingress_https
          route_config:
            name: local_route
            virtual_hosts:
            - name: backend
              domains: ["*"]
              routes:
              - match:
                  prefix: "/"
                route:
                  cluster: secure_backend
          http_filters:
          - name: envoy.filters.http.router
            typed_config:
              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
      transport_socket:
        name: envoy.transport_sockets.tls
        typed_config:
          "@type": type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.DownstreamTlsContext
          common_tls_context:
            tls_certificates:
            - certificate_chain:
                filename: server.crt
              private_key:
                filename: server.key
  clusters:
  - name: secure_backend
    connect_timeout: 0.25s
    type: STRICT_DNS
    lb_policy: ROUND_ROBIN
    transport_socket:
      name: envoy.transport_sockets.tls
      typed_config:
        "@type": type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext
    load_assignment:
      cluster_name: secure_backend
      endpoints:
      - lb_endpoints:
        - endpoint:
            address:
              socket_address:
                address: backend.example.com
                port_value: 443
admin:
  address:
    socket_address:
      address: 0.0.0.0
      port_value: 9901
EOF

# Start Envoy with TLS
envoy -c envoy-tls.yaml

# Test TLS connection
curl -k https://localhost

# Check TLS statistics
curl http://localhost:9901/stats | grep ssl

Cas d’utilisation : Limitation de débit et disjoncteur

Implémenter la limitation de débit et le disjoncteur pour une communication de service résiliente.

# Create resilience configuration
cat > envoy-resilience.yaml << EOF
static_resources:
  listeners:
  - name: listener_0
    address:
      socket_address:
        address: 0.0.0.0
        port_value: 8080
    filter_chains:
    - filters:
      - name: envoy.filters.network.http_connection_manager
        typed_config:
          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
          stat_prefix: ingress_http
          route_config:
            name: local_route
            virtual_hosts:
            - name: backend
              domains: ["*"]
              routes:
              - match:
                  prefix: "/"
                route:
                  cluster: protected_backend
                  retry_policy:
                    retry_on: "5xx"
                    num_retries: 3
                    per_try_timeout: 1s
          http_filters:
          - name: envoy.filters.http.router
            typed_config:
              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
  clusters:
  - name: protected_backend
    connect_timeout: 0.25s
    type: STRICT_DNS
    lb_policy: ROUND_ROBIN
    circuit_breakers:
      thresholds:
      - priority: DEFAULT
        max_connections: 100
        max_pending_requests: 100
        max_requests: 100
        max_retries: 3
    outlier_detection:
      consecutive_5xx: 5
      interval: 10s
      base_ejection_time: 30s
      max_ejection_percent: 50
    load_assignment:
      cluster_name: protected_backend
      endpoints:
      - lb_endpoints:
        - endpoint:
            address:
              socket_address:
                address: backend.example.com
                port_value: 8080
admin:
  address:
    socket_address:
      address: 0.0.0.0
      port_value: 9901
EOF

# Start Envoy with resilience features
envoy -c envoy-resilience.yaml

# Monitor circuit breaker status
curl http://localhost:9901/stats | grep circuit_breakers

# Check outlier detection events
curl http://localhost:9901/stats | grep outlier_detection

# View retry statistics
curl http://localhost:9901/stats | grep retry

Cas d’utilisation : Observabilité avec traçage distribué

Configurer Envoy avec traçage distribué pour l’observabilité des microservices.

# Créer une configuration de traçage
cat > envoy-tracing.yaml << EOF
static_resources:
  listeners:
  - name: listener_0
    address:
      socket_address:
        address: 0.0.0.0
        port_value: 8080
    filter_chains:
    - filters:
      - name: envoy.filters.network.http_connection_manager
        typed_config:
          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
          stat_prefix