docs: replace v1 API links to v2 ones (#4415)

To encourage users to use v2 configuration. Related to #2100.

Risk Level: N/A, documentation change.
Testing: N/A
Docs Changes: N/A
Release Notes: N/A

Signed-off-by: Taiki Ono <taiki-ono@cookpad.com>

Mirrored from https://github.com/envoyproxy/envoy @ 1d46c75024ebe3c5449647f8bbb9d5dcc532f836
pull/620/head
data-plane-api(CircleCI) 6 years ago
parent 2783fad783
commit 4619dc3f62
  1. 5
      envoy/api/v2/auth/cert.proto
  2. 2
      envoy/api/v2/core/address.proto
  3. 11
      envoy/api/v2/core/base.proto
  4. 4
      envoy/api/v2/core/config_source.proto
  5. 2
      envoy/config/bootstrap/v2/bootstrap.proto
  6. 5
      envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto

@ -245,8 +245,9 @@ message CommonTlsContext {
// Supplies the list of ALPN protocols that the listener should expose. In
// practice this is likely to be set to one of two values (see the
// :ref:`codec_type <config_http_conn_man_codec_type>` parameter in the HTTP connection
// manager for more information):
// :ref:`codec_type
// <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.codec_type>`
// parameter in the HTTP connection manager for more information):
//
// * "h2,http/1.1" If the listener is going to support both HTTP/2 and HTTP/1.1.
// * "http/1.1" If the listener is only going to support HTTP/1.1.

@ -36,7 +36,7 @@ message SocketAddress {
// in :ref:`FilterChainMatch <envoy_api_msg_listener.FilterChainMatch>`.] When used
// within an upstream :ref:`BindConfig <envoy_api_msg_core.BindConfig>`, the address
// controls the source address of outbound connections. For :ref:`clusters
// <config_cluster_manager_cluster>`, the cluster type determines whether the
// <envoy_api_msg_Cluster>`, the cluster type determines whether the
// address must be an IP (*STATIC* or *EDS* clusters) or a hostname resolved by DNS
// (*STRICT_DNS* or *LOGICAL_DNS* clusters). Address resolution can be customized
// via :ref:`resolver_name <envoy_api_field_core.SocketAddress.resolver_name>`.

@ -20,7 +20,7 @@ message Locality {
// Defines the local service zone where Envoy is running. Though optional, it
// should be set if discovery service routing is used and the discovery
// service exposes :ref:`zone data <config_cluster_manager_sds_api_host_az>`,
// service exposes :ref:`zone data <envoy_api_field_endpoint.LocalityLbEndpoints.locality>`,
// either in this message or via :option:`--service-zone`. The meaning of zone
// is context dependent, e.g. `Availability Zone (AZ)
// <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html>`_
@ -49,9 +49,10 @@ message Node {
// Defines the local service cluster name where Envoy is running. Though
// optional, it should be set if any of the following features are used:
// :ref:`statsd <arch_overview_statistics>`, :ref:`health check cluster
// verification <config_cluster_manager_cluster_hc_service_name>`,
// :ref:`runtime override directory <config_runtime_override_subdirectory>`,
// :ref:`user agent addition <config_http_conn_man_add_user_agent>`,
// verification <envoy_api_field_core.HealthCheck.HttpHealthCheck.service_name>`,
// :ref:`runtime override directory <envoy_api_msg_config.bootstrap.v2.Runtime>`,
// :ref:`user agent addition
// <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.add_user_agent>`,
// :ref:`HTTP global rate limiting <config_http_filters_rate_limit>`,
// :ref:`CDS <config_cluster_manager_cds>`, and :ref:`HTTP tracing
// <arch_overview_tracing>`, either in this message or via
@ -170,7 +171,7 @@ message DataSource {
}
// Configuration for transport socket in :ref:`listeners <config_listeners>` and
// :ref:`clusters <config_cluster_manager_cluster>`. If the configuration is
// :ref:`clusters <envoy_api_msg_Cluster>`. If the configuration is
// empty, a default transport socket implementation and configuration will be
// chosen based on the platform and existence of tls_context.
message TransportSocket {

@ -57,8 +57,8 @@ message AggregatedConfigSource {
}
// Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters
// <config_cluster_manager_cluster>`, :ref:`routes
// <config_http_conn_man_route_table>`, :ref:`endpoints
// <config_cluster_manager>`, :ref:`routes
// <envoy_api_msg_RouteConfiguration>`, :ref:`endpoints
// <arch_overview_service_discovery>` etc. may either be sourced from the
// filesystem or from an xDS API source. Filesystem configs are watched with
// inotify for updates.

@ -151,7 +151,7 @@ message ClusterManager {
// this configuration). In order to enable :ref:`zone aware routing
// <arch_overview_load_balancing_zone_aware_routing>` this option must be set.
// If *local_cluster_name* is defined then :ref:`clusters
// <config_cluster_manager_clusters>` must be defined in the :ref:`Bootstrap
// <envoy_api_msg_Cluster>` must be defined in the :ref:`Bootstrap
// static cluster resources
// <envoy_api_field_config.bootstrap.v2.Bootstrap.StaticResources.clusters>`. This is unrelated to
// the :option:`--service-cluster` option which does not `affect zone aware

@ -199,8 +199,9 @@ message HttpConnectionManager {
// :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header. This may be used in
// conjunction with HTTP filters that explicitly manipulate XFF after the HTTP connection manager
// has mutated the request headers. While :ref:`use_remote_address
// <config_http_conn_man_use_remote_address>` will also suppress XFF addition, it has consequences
// for logging and other Envoy uses of the remote address, so *skip_xff_append* should be used
// <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.use_remote_address>`
// will also suppress XFF addition, it has consequences for logging and other
// Envoy uses of the remote address, so *skip_xff_append* should be used
// when only an elision of XFF addition is intended.
bool skip_xff_append = 21;

Loading…
Cancel
Save