diff --git a/api/base.proto b/api/base.proto index 3b3e2ce0..49b42892 100644 --- a/api/base.proto +++ b/api/base.proto @@ -175,6 +175,11 @@ message ApiConfigSource { ApiType api_type = 1 [(validate.rules).enum.defined_only = true]; // Multiple cluster names may be provided. If > 1 cluster is defined, clusters // will be cycled through if any kind of failure occurs. + // + // .. note:: + // + // The cluster with name ``cluster_name`` must be statically defined, or an + // EnvoyException will be thrown. repeated string cluster_name = 2 [(validate.rules).repeated .min_items = 1]; // For REST APIs, the delay between successive polls. google.protobuf.Duration refresh_delay = 3 [(gogoproto.stdduration) = true]; @@ -196,6 +201,11 @@ message ConfigSource { oneof config_source_specifier { option (validate.required) = true; // Path on the filesystem to source and watch for configuration updates. + // + // .. note:: + // + // The path to the source must exist at config load time, or an + // EnvoyException will be thrown. string path = 1; // API configuration source. ApiConfigSource api_config_source = 2; diff --git a/docs/root/api-v1/listeners/lds.rst b/docs/root/api-v1/listeners/lds.rst index 7cffe5ff..70432639 100644 --- a/docs/root/api-v1/listeners/lds.rst +++ b/docs/root/api-v1/listeners/lds.rst @@ -13,8 +13,8 @@ Listener discovery service (LDS) cluster *(required, string)* The name of an upstream :ref:`cluster ` that hosts the listener discovery service. The cluster must run a REST service that implements the - :ref:`LDS HTTP API `. NOTE: This is the *name* of a cluster defined - in the :ref:`cluster manager ` configuration, not the full definition of + :ref:`LDS HTTP API `. NOTE: This is the *name* of a statically defined + cluster in the :ref:`cluster manager ` configuration, not the full definition of a cluster as in the case of SDS and CDS. refresh_delay_ms diff --git a/docs/root/api-v1/route_config/rds.rst b/docs/root/api-v1/route_config/rds.rst index 939d4c03..650744dd 100644 --- a/docs/root/api-v1/route_config/rds.rst +++ b/docs/root/api-v1/route_config/rds.rst @@ -14,8 +14,8 @@ Route discovery service (RDS) cluster *(required, string)* The name of an upstream :ref:`cluster ` that hosts the route discovery service. The cluster must run a REST service that implements the - :ref:`RDS HTTP API `. NOTE: This is the *name* of a cluster defined - in the :ref:`cluster manager ` configuration, not the full definition of + :ref:`RDS HTTP API `. NOTE: This is the *name* of a statically defined + cluster in the :ref:`cluster manager ` configuration, not the full definition of a cluster as in the case of SDS and CDS. route_config_name