Examples

    A minimal fully static bootstrap config is provided below:

    A bootstrap config that continues from the above example with dynamic endpoint discovery via an gRPC management server listening on 127.0.0.1:5678 is provided below:

    2.   access_log_path: /tmp/admin_access.log
    3.   address:
    4.     socket_address: { address: 127.0.0.1, port_value: 9901 }
    6. static_resources:
    7.   listeners:
    8.   - name: listener_0
    9.     address:
    10.       socket_address: { address: 127.0.0.1, port_value: 10000 }
    11.     filter_chains:
    12.     - filters:
    13.       - name: envoy.filters.network.http_connection_manager
    14.         typed_config:
    15.           "@type": type.googleapis.com/envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager
    16.           stat_prefix: ingress_http
    17.           codec_type: AUTO
    18.           route_config:
    19.             name: local_route
    20.             virtual_hosts:
    21.             - name: local_service
    22.               domains: ["*"]
    23.               routes:
    24.               - match: { prefix: "/" }
    25.                 route: { cluster: some_service }
    26.           http_filters:
    27.           - name: envoy.filters.http.router
    28.   clusters:
    29.   - name: some_service
    30.     connect_timeout: 0.25s
    31.     lb_policy: ROUND_ROBIN
    32.     type: EDS
    33.     eds_cluster_config:
    34.       eds_config:
    35.         api_config_source:
    36.           api_type: GRPC
    37.             envoy_grpc:
    38.               cluster_name: xds_cluster
    40.     connect_timeout: 0.25s
    41.     type: STATIC
    42.     lb_policy: ROUND_ROBIN
    43.     http2_protocol_options: {}
    44.     upstream_connection_options:
    45.       # configure a TCP keep-alive to detect and reconnect to the admin
    46.       # server in the event of a TCP socket half open connection
    47.       tcp_keepalive: {}
    48.     load_assignment:
    49.       cluster_name: xds_cluster
    50.       endpoints:
    51.       - lb_endpoints:
    52.         - endpoint:
    53.             address:
    54.               socket_address:
    55.                 address: 127.0.0.1
    56.                 port_value: 5678

    Notice above that xds_cluster is defined to point Envoy at the management server. Even in an otherwise completely dynamic configurations, some static resources need to be defined to point Envoy at its xDS management server(s).

    In the above example, the EDS management server could then return a proto encoding of a DiscoveryResponse:

    The versioning and type URL scheme that appear above are explained in more detail in the documentation.

    A fully dynamic bootstrap configuration, in which all resources other than those belonging to the management server are discovered via xDS is provided below:

    1. admin:
    2.   access_log_path: /tmp/admin_access.log
    3.   address:
    4.     socket_address: { address: 127.0.0.1, port_value: 9901 }
    6. dynamic_resources:
    7.   lds_config:
    8.     api_config_source:
    9.       api_type: GRPC
    10.       grpc_services:
    11.         envoy_grpc:
    12.           cluster_name: xds_cluster
    13.   cds_config:
    14.     api_config_source:
    15.       api_type: GRPC
    16.       grpc_services:
    17.         envoy_grpc:
    18.           cluster_name: xds_cluster
    20.   clusters:
    22.     connect_timeout: 0.25s
    23.     type: STATIC
    24.     lb_policy: ROUND_ROBIN
    25.     http2_protocol_options: {}
    26.     upstream_connection_options:
    27.       # configure a TCP keep-alive to detect and reconnect to the admin
    28.       # server in the event of a TCP socket half open connection
    29.       tcp_keepalive: {}
    30.     load_assignment:
    31.       cluster_name: xds_cluster
    32.       endpoints:
    33.       - lb_endpoints:
    34.         - endpoint:
    35.             address:
    36.               socket_address:
    37.                 address: 127.0.0.1
    38.                 port_value: 5678

    The management server could respond to RDS requests with:

    1. version_info: "0"
    2. resources:
    3. - "@type": type.googleapis.com/envoy.api.v2.RouteConfiguration
    4.   name: local_route
    5.   virtual_hosts:
    6.   - name: local_service
    7.     domains: ["*"]
    8.     routes:
    9.     - match: { prefix: "/" }
    10.       route: { cluster: some_service }

    The management server could respond to CDS requests with:

    The management server could respond to EDS requests with:

    1. version_info: "0"
    2. resources:
    3. - "@type": type.googleapis.com/envoy.api.v2.ClusterLoadAssignment
    4.   cluster_name: some_service
    5.   endpoints:
    6.   - lb_endpoints:
    7.     - endpoint:
    8.         address:
    9.           socket_address:
    10.             address: 127.0.0.2