Skip to content

docs: update ApiConfigSource docs with grpc_services only for GRPC configs #3834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattklein123 merged 1 commit into from
Jul 10, 2018
Merged

docs: update ApiConfigSource docs with grpc_services only for GRPC configs #3834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions api/envoy/api/v2/core/config_source.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
//
Expand All @@ -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.
Expand Down
40 changes: 30 additions & 10 deletions docs/root/configuration/overview/v2_overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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
<envoy_api_field_config.bootstrap.v2.Bootstrap.dynamic_resources>` of the :ref:`Bootstrap
Expand All @@ -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
<envoy_api_field_Cluster.eds_cluster_config>` field of the :ref:`Cluster
Expand All @@ -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
<envoy_api_field_config.bootstrap.v2.Bootstrap.dynamic_resources>` of the :ref:`Bootstrap
Expand All @@ -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
<envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.rds>` field of the :ref:`HttpConnectionManager
Expand Down Expand Up @@ -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
<envoy_api_field_config.bootstrap.v2.Bootstrap.dynamic_resources>` of the :ref:`Bootstrap
Expand Down