docs: add cncf/xds protos (#20277)

Signed-off-by: Kuat Yessenov <kuat@google.com>

Mirrored from https://github.com/envoyproxy/envoy @ c39f2b2e951a5059d16c84b4786cc0de22d4f002
pull/626/head
data-plane-api(Azure Pipelines) 3 years ago
parent ee2b18aee1
commit 24454c243e
  1. 11
      BUILD
  2. 6
      bazel/repository_locations.bzl
  3. 9
      envoy/extensions/matching/common_inputs/network/v3/network_inputs.proto
  4. 4
      envoy/type/matcher/v3/http_inputs.proto

11
BUILD

@ -285,12 +285,23 @@ proto_library(
], ],
) )
proto_library(
name = "xds_protos",
visibility = ["//visibility:public"],
deps = [
"@com_github_cncf_udpa//xds/core/v3:pkg",
"@com_github_cncf_udpa//xds/type/matcher/v3:pkg",
"@com_github_cncf_udpa//xds/type/v3:pkg",
],
)
proto_library( proto_library(
name = "all_protos", name = "all_protos",
visibility = ["//visibility:public"], visibility = ["//visibility:public"],
deps = [ deps = [
":v2_protos", ":v2_protos",
":v3_protos", ":v3_protos",
":xds_protos",
], ],
) )

@ -33,9 +33,9 @@ REPOSITORY_LOCATIONS_SPEC = dict(
project_desc = "xDS API Working Group (xDS-WG)", project_desc = "xDS API Working Group (xDS-WG)",
project_url = "https://github.com/cncf/xds", project_url = "https://github.com/cncf/xds",
# During the UDPA -> xDS migration, we aren't working with releases. # During the UDPA -> xDS migration, we aren't working with releases.
version = "0fa49ea1db0ccf084453766a755b2e76434d99fc", version = "7f1daf1720fc185f3b63f70d25aefaeef83d88d7",
sha256 = "9369c65e20201ea43e2c293cf024f58167dd727d864706481972ccdf3aacdaab", sha256 = "62c0daaff43fd9a62c280bf2b0c2b670372b24377ea5e9ea4302cf748dd53cba",
release_date = "2022-01-12", release_date = "2022-03-14",
strip_prefix = "xds-{version}", strip_prefix = "xds-{version}",
urls = ["https://github.com/cncf/xds/archive/{version}.tar.gz"], urls = ["https://github.com/cncf/xds/archive/{version}.tar.gz"],
use_category = ["api"], use_category = ["api"],

@ -13,18 +13,22 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;
// [#protodoc-title: Common Network Matching Inputs] // [#protodoc-title: Common Network Matching Inputs]
// Specifies that matching should be performed by the destination IP address. // Specifies that matching should be performed by the destination IP address.
// [#extension: envoy.matching.inputs.destination_ip]
message DestinationIPInput { message DestinationIPInput {
} }
// Specifies that matching should be performed by the destination port. // Specifies that matching should be performed by the destination port.
// [#extension: envoy.matching.inputs.destination_port]
message DestinationPortInput { message DestinationPortInput {
} }
// Specifies that matching should be performed by the source IP address. // Specifies that matching should be performed by the source IP address.
// [#extension: envoy.matching.inputs.source_ip]
message SourceIPInput { message SourceIPInput {
} }
// Specifies that matching should be performed by the source port. // Specifies that matching should be performed by the source port.
// [#extension: envoy.matching.inputs.source_port]
message SourcePortInput { message SourcePortInput {
} }
@ -32,6 +36,7 @@ message SourcePortInput {
// will only be different from the source IP address when using a listener // will only be different from the source IP address when using a listener
// filter that overrides the source address, such as the :ref:`Proxy Protocol // filter that overrides the source address, such as the :ref:`Proxy Protocol
// listener filter <config_listener_filters_proxy_protocol>`). // listener filter <config_listener_filters_proxy_protocol>`).
// [#extension: envoy.matching.inputs.direct_source_ip]
message DirectSourceIPInput { message DirectSourceIPInput {
} }
@ -39,6 +44,7 @@ message DirectSourceIPInput {
// Specifies the source IP match type. The values include: // Specifies the source IP match type. The values include:
// //
// * ``local`` - matches a connection originating from the same host, // * ``local`` - matches a connection originating from the same host,
// [#extension: envoy.matching.inputs.source_type]
message SourceTypeInput { message SourceTypeInput {
} }
@ -46,6 +52,7 @@ message SourceTypeInput {
// //
// :ref:`TLS Inspector <config_listener_filters_tls_inspector>` provides the requested server name based on SNI, // :ref:`TLS Inspector <config_listener_filters_tls_inspector>` provides the requested server name based on SNI,
// when TLS protocol is detected. // when TLS protocol is detected.
// [#extension: envoy.matching.inputs.server_name]
message ServerNameInput { message ServerNameInput {
} }
@ -56,6 +63,7 @@ message ServerNameInput {
// * ``raw_buffer`` - default, used when no transport protocol is detected, // * ``raw_buffer`` - default, used when no transport protocol is detected,
// * ``tls`` - set by :ref:`envoy.filters.listener.tls_inspector <config_listener_filters_tls_inspector>` // * ``tls`` - set by :ref:`envoy.filters.listener.tls_inspector <config_listener_filters_tls_inspector>`
// when TLS protocol is detected. // when TLS protocol is detected.
// [#extension: envoy.matching.inputs.transport_protocol]
message TransportProtocolInput { message TransportProtocolInput {
} }
@ -84,5 +92,6 @@ message TransportProtocolInput {
// However, the use of ALPN is pretty much limited to the HTTP/2 traffic on the Internet, // However, the use of ALPN is pretty much limited to the HTTP/2 traffic on the Internet,
// and matching on values other than ``h2`` is going to lead to a lot of false negatives, // and matching on values other than ``h2`` is going to lead to a lot of false negatives,
// unless all connecting clients are known to use ALPN. // unless all connecting clients are known to use ALPN.
// [#extension: envoy.matching.inputs.application_protocol]
message ApplicationProtocolInput { message ApplicationProtocolInput {
} }

@ -18,6 +18,7 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;
// e.g. if the request contains two 'foo' headers with value 'bar' and 'baz', the input // e.g. if the request contains two 'foo' headers with value 'bar' and 'baz', the input
// string will be 'bar,baz'. // string will be 'bar,baz'.
// [#comment:TODO(snowp): Link to unified matching docs.] // [#comment:TODO(snowp): Link to unified matching docs.]
// [#extension: envoy.matching.inputs.request_headers]
message HttpRequestHeaderMatchInput { message HttpRequestHeaderMatchInput {
// The request header to match on. // The request header to match on.
string header_name = 1 string header_name = 1
@ -29,6 +30,7 @@ message HttpRequestHeaderMatchInput {
// e.g. if the request contains two 'foo' headers with value 'bar' and 'baz', the input // e.g. if the request contains two 'foo' headers with value 'bar' and 'baz', the input
// string will be 'bar,baz'. // string will be 'bar,baz'.
// [#comment:TODO(snowp): Link to unified matching docs.] // [#comment:TODO(snowp): Link to unified matching docs.]
// [#extension: envoy.matching.inputs.request_trailers]
message HttpRequestTrailerMatchInput { message HttpRequestTrailerMatchInput {
// The request trailer to match on. // The request trailer to match on.
string header_name = 1 string header_name = 1
@ -40,6 +42,7 @@ message HttpRequestTrailerMatchInput {
// e.g. if the response contains two 'foo' headers with value 'bar' and 'baz', the input // e.g. if the response contains two 'foo' headers with value 'bar' and 'baz', the input
// string will be 'bar,baz'. // string will be 'bar,baz'.
// [#comment:TODO(snowp): Link to unified matching docs.] // [#comment:TODO(snowp): Link to unified matching docs.]
// [#extension: envoy.matching.inputs.response_headers]
message HttpResponseHeaderMatchInput { message HttpResponseHeaderMatchInput {
// The response header to match on. // The response header to match on.
string header_name = 1 string header_name = 1
@ -51,6 +54,7 @@ message HttpResponseHeaderMatchInput {
// e.g. if the request contains two 'foo' headers with value 'bar' and 'baz', the input // e.g. if the request contains two 'foo' headers with value 'bar' and 'baz', the input
// string will be 'bar,baz'. // string will be 'bar,baz'.
// [#comment:TODO(snowp): Link to unified matching docs.] // [#comment:TODO(snowp): Link to unified matching docs.]
// [#extension: envoy.matching.inputs.response_trailers]
message HttpResponseTrailerMatchInput { message HttpResponseTrailerMatchInput {
// The response trailer to match on. // The response trailer to match on.
string header_name = 1 string header_name = 1

Loading…
Cancel
Save