1 // Copyright 2020 The gRPC Authors
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
15 // Local copy of Envoy xDS proto file, used for testing only.
19 package envoy.config.core.v3;
21 import "src/proto/grpc/testing/xds/v3/percent.proto";
23 import "google/protobuf/any.proto";
24 import "google/protobuf/struct.proto";
26 // Identifies location of where either Envoy runs or where upstream hosts run.
28 // Region this :ref:`zone <envoy_api_field_config.core.v3.Locality.zone>` belongs to.
31 // Defines the local service zone where Envoy is running. Though optional, it
32 // should be set if discovery service routing is used and the discovery
33 // service exposes :ref:`zone data <envoy_api_field_config.endpoint.v3.LocalityLbEndpoints.locality>`,
34 // either in this message or via :option:`--service-zone`. The meaning of zone
35 // is context dependent, e.g. `Availability Zone (AZ)
36 // <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html>`_
37 // on AWS, `Zone <https://cloud.google.com/compute/docs/regions-zones/>`_ on
41 // When used for locality of upstream hosts, this field further splits zone
42 // into smaller chunks of sub-zones so they can be load balanced
47 // Identifies a specific Envoy instance. The node identifier is presented to the
48 // management server, which may use this identifier to distinguish per Envoy
49 // configuration for serving.
50 // [#next-free-field: 12]
52 // An opaque node identifier for the Envoy node. This also provides the local
53 // service node name. It should be set if any of the following features are
54 // used: :ref:`statsd <arch_overview_statistics>`, :ref:`CDS
55 // <config_cluster_manager_cds>`, and :ref:`HTTP tracing
56 // <arch_overview_tracing>`, either in this message or via
57 // :option:`--service-node`.
60 // Defines the local service cluster name where Envoy is running. Though
61 // optional, it should be set if any of the following features are used:
62 // :ref:`statsd <arch_overview_statistics>`, :ref:`health check cluster
64 // <envoy_api_field_config.core.v3.HealthCheck.HttpHealthCheck.service_name_matcher>`,
65 // :ref:`runtime override directory <envoy_api_msg_config.bootstrap.v3.Runtime>`,
66 // :ref:`user agent addition
67 // <envoy_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.add_user_agent>`,
68 // :ref:`HTTP global rate limiting <config_http_filters_rate_limit>`,
69 // :ref:`CDS <config_cluster_manager_cds>`, and :ref:`HTTP tracing
70 // <arch_overview_tracing>`, either in this message or via
71 // :option:`--service-cluster`.
74 // Opaque metadata extending the node identifier. Envoy will pass this
75 // directly to the management server.
76 google.protobuf.Struct metadata = 3;
78 // Locality specifying where the Envoy instance is running.
79 Locality locality = 4;
81 // Free-form string that identifies the entity requesting config.
82 // E.g. "envoy" or "grpc"
83 string user_agent_name = 6;
85 oneof user_agent_version_type {
86 // Free-form string that identifies the version of the entity requesting config.
87 // E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"
88 string user_agent_version = 7;
91 // Client feature support list. These are well known features described
92 // in the Envoy API repository for a given major version of an API. Client features
93 // use reverse DNS naming scheme, for example `com.acme.feature`.
94 // See :ref:`the list of features <client_features>` that xDS client may
96 repeated string client_features = 10;
99 // Runtime derived FractionalPercent with defaults for when the numerator or denominator is not
100 // specified via a runtime key.
104 // Parsing of the runtime key's data is implemented such that it may be represented as a
105 // :ref:`FractionalPercent <envoy_api_msg_type.v3.FractionalPercent>` proto represented as JSON/YAML
106 // and may also be represented as an integer with the assumption that the value is an integral
107 // percentage out of 100. For instance, a runtime key lookup returning the value "42" would parse
108 // as a `FractionalPercent` whose numerator is 42 and denominator is HUNDRED.
109 message RuntimeFractionalPercent {
110 // Default value if the runtime value's for the numerator/denominator keys are not available.
111 type.v3.FractionalPercent default_value = 1;
114 // Configuration for transport socket in :ref:`listeners <config_listeners>` and
115 // :ref:`clusters <envoy_api_msg_config.cluster.v3.Cluster>`. If the configuration is
116 // empty, a default transport socket implementation and configuration will be
117 // chosen based on the platform and existence of tls_context.
118 message TransportSocket {
119 // The name of the transport socket to instantiate. The name must match a supported transport
120 // socket implementation.
123 // Implementation specific configuration which depends on the implementation being instantiated.
124 // See the supported transport socket implementations for further documentation.
126 google.protobuf.Any typed_config = 3;