|
| 1 | +syntax = "proto3"; |
| 2 | + |
| 3 | +package envoy.config.endpoint.v3; |
| 4 | + |
| 5 | +import "envoy/config/core/v3/address.proto"; |
| 6 | +import "envoy/config/core/v3/base.proto"; |
| 7 | +import "envoy/config/core/v3/config_source.proto"; |
| 8 | +import "envoy/config/core/v3/health_check.proto"; |
| 9 | + |
| 10 | +import "google/protobuf/wrappers.proto"; |
| 11 | + |
| 12 | +import "udpa/annotations/status.proto"; |
| 13 | +import "udpa/annotations/versioning.proto"; |
| 14 | +import "validate/validate.proto"; |
| 15 | + |
| 16 | +option java_package = "io.envoyproxy.envoy.config.endpoint.v3"; |
| 17 | +option java_outer_classname = "EndpointComponentsProto"; |
| 18 | +option java_multiple_files = true; |
| 19 | +option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/endpoint/v3;endpointv3"; |
| 20 | +option (udpa.annotations.file_status).package_version_status = ACTIVE; |
| 21 | + |
| 22 | +// [#protodoc-title: Endpoints] |
| 23 | + |
| 24 | +// Upstream host identifier. |
| 25 | +message Endpoint { |
| 26 | + option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.endpoint.Endpoint"; |
| 27 | + |
| 28 | + // The optional health check configuration. |
| 29 | + message HealthCheckConfig { |
| 30 | + option (udpa.annotations.versioning).previous_message_type = |
| 31 | + "envoy.api.v2.endpoint.Endpoint.HealthCheckConfig"; |
| 32 | + |
| 33 | + // Optional alternative health check port value. |
| 34 | + // |
| 35 | + // By default the health check address port of an upstream host is the same |
| 36 | + // as the host's serving address port. This provides an alternative health |
| 37 | + // check port. Setting this with a non-zero value allows an upstream host |
| 38 | + // to have different health check address port. |
| 39 | + uint32 port_value = 1 [(validate.rules).uint32 = {lte: 65535}]; |
| 40 | + |
| 41 | + // By default, the host header for L7 health checks is controlled by cluster level configuration |
| 42 | + // (see: :ref:`host <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.host>` and |
| 43 | + // :ref:`authority <envoy_v3_api_field_config.core.v3.HealthCheck.GrpcHealthCheck.authority>`). Setting this |
| 44 | + // to a non-empty value allows overriding the cluster level configuration for a specific |
| 45 | + // endpoint. |
| 46 | + string hostname = 2; |
| 47 | + |
| 48 | + // Optional alternative health check host address. |
| 49 | + // |
| 50 | + // .. attention:: |
| 51 | + // |
| 52 | + // The form of the health check host address is expected to be a direct IP address. |
| 53 | + core.v3.Address address = 3; |
| 54 | + |
| 55 | + // Optional flag to control if perform active health check for this endpoint. |
| 56 | + // Active health check is enabled by default if there is a health checker. |
| 57 | + bool disable_active_health_check = 4; |
| 58 | + } |
| 59 | + |
| 60 | + message AdditionalAddress { |
| 61 | + // Additional address that is associated with the endpoint. |
| 62 | + core.v3.Address address = 1; |
| 63 | + } |
| 64 | + |
| 65 | + // The upstream host address. |
| 66 | + // |
| 67 | + // .. attention:: |
| 68 | + // |
| 69 | + // The form of host address depends on the given cluster type. For STATIC or EDS, |
| 70 | + // it is expected to be a direct IP address (or something resolvable by the |
| 71 | + // specified :ref:`resolver <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>` |
| 72 | + // in the Address). For LOGICAL or STRICT DNS, it is expected to be hostname, |
| 73 | + // and will be resolved via DNS. |
| 74 | + core.v3.Address address = 1; |
| 75 | + |
| 76 | + // The optional health check configuration is used as configuration for the |
| 77 | + // health checker to contact the health checked host. |
| 78 | + // |
| 79 | + // .. attention:: |
| 80 | + // |
| 81 | + // This takes into effect only for upstream clusters with |
| 82 | + // :ref:`active health checking <arch_overview_health_checking>` enabled. |
| 83 | + HealthCheckConfig health_check_config = 2; |
| 84 | + |
| 85 | + // The hostname associated with this endpoint. This hostname is not used for routing or address |
| 86 | + // resolution. If provided, it will be associated with the endpoint, and can be used for features |
| 87 | + // that require a hostname, like |
| 88 | + // :ref:`auto_host_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>`. |
| 89 | + string hostname = 3; |
| 90 | + |
| 91 | + // An ordered list of addresses that together with `address` comprise the |
| 92 | + // list of addresses for an endpoint. The address given in the `address` is |
| 93 | + // prepended to this list. It is assumed that the list must already be |
| 94 | + // sorted by preference order of the addresses. This will only be supported |
| 95 | + // for STATIC and EDS clusters. |
| 96 | + repeated AdditionalAddress additional_addresses = 4; |
| 97 | +} |
| 98 | + |
| 99 | +// An Endpoint that Envoy can route traffic to. |
| 100 | +// [#next-free-field: 6] |
| 101 | +message LbEndpoint { |
| 102 | + option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.endpoint.LbEndpoint"; |
| 103 | + |
| 104 | + // Upstream host identifier or a named reference. |
| 105 | + oneof host_identifier { |
| 106 | + Endpoint endpoint = 1; |
| 107 | + |
| 108 | + // [#not-implemented-hide:] |
| 109 | + string endpoint_name = 5; |
| 110 | + } |
| 111 | + |
| 112 | + // Optional health status when known and supplied by EDS server. |
| 113 | + core.v3.HealthStatus health_status = 2; |
| 114 | + |
| 115 | + // The endpoint metadata specifies values that may be used by the load |
| 116 | + // balancer to select endpoints in a cluster for a given request. The filter |
| 117 | + // name should be specified as ``envoy.lb``. An example boolean key-value pair |
| 118 | + // is ``canary``, providing the optional canary status of the upstream host. |
| 119 | + // This may be matched against in a route's |
| 120 | + // :ref:`RouteAction <envoy_v3_api_msg_config.route.v3.RouteAction>` metadata_match field |
| 121 | + // to subset the endpoints considered in cluster load balancing. |
| 122 | + core.v3.Metadata metadata = 3; |
| 123 | + |
| 124 | + // The optional load balancing weight of the upstream host; at least 1. |
| 125 | + // Envoy uses the load balancing weight in some of the built in load |
| 126 | + // balancers. The load balancing weight for an endpoint is divided by the sum |
| 127 | + // of the weights of all endpoints in the endpoint's locality to produce a |
| 128 | + // percentage of traffic for the endpoint. This percentage is then further |
| 129 | + // weighted by the endpoint's locality's load balancing weight from |
| 130 | + // LocalityLbEndpoints. If unspecified, will be treated as 1. The sum |
| 131 | + // of the weights of all endpoints in the endpoint's locality must not |
| 132 | + // exceed uint32_t maximal value (4294967295). |
| 133 | + google.protobuf.UInt32Value load_balancing_weight = 4 [(validate.rules).uint32 = {gte: 1}]; |
| 134 | +} |
| 135 | + |
| 136 | +// [#not-implemented-hide:] |
| 137 | +// A configuration for a LEDS collection. |
| 138 | +message LedsClusterLocalityConfig { |
| 139 | + // Configuration for the source of LEDS updates for a Locality. |
| 140 | + core.v3.ConfigSource leds_config = 1; |
| 141 | + |
| 142 | + // The xDS transport protocol glob collection resource name. |
| 143 | + // The service is only supported in delta xDS (incremental) mode. |
| 144 | + string leds_collection_name = 2; |
| 145 | +} |
| 146 | + |
| 147 | +// A group of endpoints belonging to a Locality. |
| 148 | +// One can have multiple LocalityLbEndpoints for a locality, but only if |
| 149 | +// they have different priorities. |
| 150 | +// [#next-free-field: 9] |
| 151 | +message LocalityLbEndpoints { |
| 152 | + option (udpa.annotations.versioning).previous_message_type = |
| 153 | + "envoy.api.v2.endpoint.LocalityLbEndpoints"; |
| 154 | + |
| 155 | + // [#not-implemented-hide:] |
| 156 | + // A list of endpoints of a specific locality. |
| 157 | + message LbEndpointList { |
| 158 | + repeated LbEndpoint lb_endpoints = 1; |
| 159 | + } |
| 160 | + |
| 161 | + // Identifies location of where the upstream hosts run. |
| 162 | + core.v3.Locality locality = 1; |
| 163 | + |
| 164 | + // The group of endpoints belonging to the locality specified. |
| 165 | + // [#comment:TODO(adisuissa): Once LEDS is implemented this field needs to be |
| 166 | + // deprecated and replaced by ``load_balancer_endpoints``.] |
| 167 | + repeated LbEndpoint lb_endpoints = 2; |
| 168 | + |
| 169 | + // [#not-implemented-hide:] |
| 170 | + oneof lb_config { |
| 171 | + // The group of endpoints belonging to the locality. |
| 172 | + // [#comment:TODO(adisuissa): Once LEDS is implemented the ``lb_endpoints`` field |
| 173 | + // needs to be deprecated.] |
| 174 | + LbEndpointList load_balancer_endpoints = 7; |
| 175 | + |
| 176 | + // LEDS Configuration for the current locality. |
| 177 | + LedsClusterLocalityConfig leds_cluster_locality_config = 8; |
| 178 | + } |
| 179 | + |
| 180 | + // Optional: Per priority/region/zone/sub_zone weight; at least 1. The load |
| 181 | + // balancing weight for a locality is divided by the sum of the weights of all |
| 182 | + // localities at the same priority level to produce the effective percentage |
| 183 | + // of traffic for the locality. The sum of the weights of all localities at |
| 184 | + // the same priority level must not exceed uint32_t maximal value (4294967295). |
| 185 | + // |
| 186 | + // Locality weights are only considered when :ref:`locality weighted load |
| 187 | + // balancing <arch_overview_load_balancing_locality_weighted_lb>` is |
| 188 | + // configured. These weights are ignored otherwise. If no weights are |
| 189 | + // specified when locality weighted load balancing is enabled, the locality is |
| 190 | + // assigned no load. |
| 191 | + google.protobuf.UInt32Value load_balancing_weight = 3 [(validate.rules).uint32 = {gte: 1}]; |
| 192 | + |
| 193 | + // Optional: the priority for this LocalityLbEndpoints. If unspecified this will |
| 194 | + // default to the highest priority (0). |
| 195 | + // |
| 196 | + // Under usual circumstances, Envoy will only select endpoints for the highest |
| 197 | + // priority (0). In the event all endpoints for a particular priority are |
| 198 | + // unavailable/unhealthy, Envoy will fail over to selecting endpoints for the |
| 199 | + // next highest priority group. |
| 200 | + // |
| 201 | + // Priorities should range from 0 (highest) to N (lowest) without skipping. |
| 202 | + uint32 priority = 5 [(validate.rules).uint32 = {lte: 128}]; |
| 203 | + |
| 204 | + // Optional: Per locality proximity value which indicates how close this |
| 205 | + // locality is from the source locality. This value only provides ordering |
| 206 | + // information (lower the value, closer it is to the source locality). |
| 207 | + // This will be consumed by load balancing schemes that need proximity order |
| 208 | + // to determine where to route the requests. |
| 209 | + // [#not-implemented-hide:] |
| 210 | + google.protobuf.UInt32Value proximity = 6; |
| 211 | +} |
0 commit comments