diff --git a/api/envoy/api/v2/core/config_source.proto b/api/envoy/api/v2/core/config_source.proto index 17bdbbeb28d9e..1ebb265da2ae4 100644 --- a/api/envoy/api/v2/core/config_source.proto +++ b/api/envoy/api/v2/core/config_source.proto @@ -28,7 +28,7 @@ message ApiConfigSource { GRPC = 2; } ApiType api_type = 1 [(validate.rules).enum.defined_only = true]; - // Multiple cluster names may be provided for REST_LEGACY/REST. If > 1 + // Cluster names should be used only with REST_LEGACY/REST. If > 1 // cluster is defined, clusters will be cycled through if any kind of failure // occurs. // @@ -40,11 +40,6 @@ message ApiConfigSource { // Multiple gRPC services be provided for GRPC. If > 1 cluster is defined, // services will be cycled through if any kind of failure occurs. - // - // .. note:: - // - // If a gRPC service points to a ``cluster_name``, it must be statically - // defined and its type must not be ``EDS``. repeated GrpcService grpc_services = 4; // For REST APIs, the delay between successive polls. diff --git a/docs/root/configuration/overview/v2_overview.rst b/docs/root/configuration/overview/v2_overview.rst index 1e5629e8c80ea..f67e2ceb46292 100644 --- a/docs/root/configuration/overview/v2_overview.rst +++ b/docs/root/configuration/overview/v2_overview.rst @@ -145,7 +145,9 @@ on 127.0.0.3:5678 is provided below: eds_config: api_config_source: api_type: GRPC - cluster_names: [xds_cluster] + grpc_services: + envoy_grpc: + cluster_name: xds_cluster - name: xds_cluster connect_timeout: 0.25s type: STATIC @@ -198,11 +200,15 @@ below: lds_config: api_config_source: api_type: GRPC - cluster_names: [xds_cluster] + grpc_services: + envoy_grpc: + cluster_name: xds_cluster cds_config: api_config_source: api_type: GRPC - cluster_names: [xds_cluster] + grpc_services: + envoy_grpc: + cluster_name: xds_cluster static_resources: clusters: @@ -236,7 +242,9 @@ The management server could respond to LDS requests with: config_source: api_config_source: api_type: GRPC - cluster_names: [xds_cluster] + grpc_services: + envoy_grpc: + cluster_name: xds_cluster http_filters: - name: envoy.router @@ -270,7 +278,9 @@ The management server could respond to CDS requests with: eds_config: api_config_source: api_type: GRPC - cluster_names: [xds_cluster] + grpc_services: + envoy_grpc: + cluster_name: xds_cluster The management server could respond to EDS requests with: @@ -324,7 +334,9 @@ for the service definition. This is used by Envoy as a client when cds_config: api_config_source: api_type: GRPC - cluster_names: [some_xds_cluster] + grpc_services: + envoy_grpc: + cluster_name: some_xds_cluster is set in the :ref:`dynamic_resources ` of the :ref:`Bootstrap @@ -341,7 +353,9 @@ for the service definition. This is used by Envoy as a client when eds_config: api_config_source: api_type: GRPC - cluster_names: [some_xds_cluster] + grpc_services: + envoy_grpc: + cluster_name: some_xds_cluster is set in the :ref:`eds_cluster_config ` field of the :ref:`Cluster @@ -358,7 +372,9 @@ for the service definition. This is used by Envoy as a client when lds_config: api_config_source: api_type: GRPC - cluster_names: [some_xds_cluster] + grpc_services: + envoy_grpc: + cluster_name: some_xds_cluster is set in the :ref:`dynamic_resources ` of the :ref:`Bootstrap @@ -376,7 +392,9 @@ for the service definition. This is used by Envoy as a client when config_source: api_config_source: api_type: GRPC - cluster_names: [some_xds_cluster] + grpc_services: + envoy_grpc: + cluster_name: some_xds_cluster is set in the :ref:`rds ` field of the :ref:`HttpConnectionManager @@ -496,7 +514,9 @@ for the service definition. This is used by Envoy as a client when ads_config: api_type: GRPC - cluster_names: [some_ads_cluster] + grpc_services: + envoy_grpc: + cluster_name: some_ads_cluster is set in the :ref:`dynamic_resources ` of the :ref:`Bootstrap