From c2dd672d12c0540c95053a99bcca8dac88c71856 Mon Sep 17 00:00:00 2001 From: phlax Date: Sun, 2 May 2021 21:51:20 +0100 Subject: [PATCH] docs: Remove api v2 (#16077) Signed-off-by: Ryan Northey Signed-off-by: Gokul Nair --- api/BUILD | 6 ------ api/xds_protocol.rst | 6 +++--- docs/build.sh | 17 +++-------------- docs/conf.py | 2 -- .../api-v3/config/filter/thrift/thrift.rst | 1 - .../config/health_checker/health_checker.rst | 1 - .../resource_monitor/resource_monitor.rst | 1 - docs/root/api-v3/config/retry/retry.rst | 1 - .../configuration/http/http_conn_man/rds.rst | 2 +- .../configuration/http/http_conn_man/vhds.rst | 2 +- docs/root/configuration/listeners/lds.rst | 2 +- .../dubbo_filters/router_filter.rst | 2 +- docs/root/configuration/overview/xds_api.rst | 18 +++--------------- .../upstream/cluster_manager/cds.rst | 2 +- docs/v2-api-header.rst | 5 ----- 15 files changed, 14 insertions(+), 54 deletions(-) delete mode 100644 docs/v2-api-header.rst diff --git a/api/BUILD b/api/BUILD index 7a6671dd681f..d8782fb96b23 100644 --- a/api/BUILD +++ b/api/BUILD @@ -133,18 +133,12 @@ proto_library( "//envoy/config/common/matcher/v3:pkg", "//envoy/config/core/v3:pkg", "//envoy/config/endpoint/v3:pkg", - "//envoy/config/filter/thrift/router/v2alpha1:pkg", "//envoy/config/grpc_credential/v3:pkg", - "//envoy/config/health_checker/redis/v2:pkg", "//envoy/config/listener/v3:pkg", "//envoy/config/metrics/v3:pkg", "//envoy/config/overload/v3:pkg", "//envoy/config/ratelimit/v3:pkg", "//envoy/config/rbac/v3:pkg", - "//envoy/config/resource_monitor/fixed_heap/v2alpha:pkg", - "//envoy/config/resource_monitor/injected_resource/v2alpha:pkg", - "//envoy/config/retry/omit_canary_hosts/v2:pkg", - "//envoy/config/retry/previous_hosts/v2:pkg", "//envoy/config/route/v3:pkg", "//envoy/config/tap/v3:pkg", "//envoy/config/trace/v3:pkg", diff --git a/api/xds_protocol.rst b/api/xds_protocol.rst index edd12f6bb5c3..71c5f646627b 100644 --- a/api/xds_protocol.rst +++ b/api/xds_protocol.rst @@ -772,12 +772,12 @@ Later the xDS client spontaneously requests the "wc" resource. On reconnect the Incremental xDS client may tell the server of its known resources to avoid resending them over the network by sending them in -:ref:`initial_resource_versions `. +:ref:`initial_resource_versions `. Because no state is assumed to be preserved from the previous stream, the reconnecting client must provide the server with all resource names it is interested in. Note that for wildcard requests (CDS/LDS/SRDS), the request must have no resources in both -:ref:`resource_names_subscribe ` and -:ref:`resource_names_unsubscribe `. +:ref:`resource_names_subscribe ` and +:ref:`resource_names_unsubscribe `. .. figure:: diagrams/incremental-reconnect.svg :alt: Incremental reconnect example diff --git a/docs/build.sh b/docs/build.sh index 7b6eee6ba76d..fc3e89d117bd 100755 --- a/docs/build.sh +++ b/docs/build.sh @@ -97,11 +97,8 @@ function generate_api_rst() { # Fill in boiler plate for extensions that have google.protobuf.Empty as their # config. We only have v2 support here for version history anchors, which don't point at any empty # configs. - if [[ "${API_VERSION}" != "v2" ]] - then - bazel run "${BAZEL_BUILD_OPTIONS[@]}" //tools/protodoc:generate_empty \ - "${PWD}"/docs/empty_extensions.json "${GENERATED_RST_DIR}/api-${API_VERSION}"/config - fi + bazel run "${BAZEL_BUILD_OPTIONS[@]}" //tools/protodoc:generate_empty \ + "${PWD}"/docs/empty_extensions.json "${GENERATED_RST_DIR}/api-${API_VERSION}"/config # We do ** matching below to deal with Bazel cache blah (source proto artifacts # are nested inside source package targets). @@ -129,18 +126,10 @@ function generate_api_rst() { declare DST="${GENERATED_RST_DIR}/api-${API_VERSION}/${PROTO_FILE_CANONICAL#envoy/}".rst mkdir -p "$(dirname "${DST}")" - if [[ "${API_VERSION}" == "v2" ]] - then - cat docs/v2-api-header.rst "${SRC}" > "$(dirname "${DST}")/$(basename "${SRC}")" - else - cp -f "${SRC}" "$(dirname "${DST}")" - fi + cp -f "${SRC}" "$(dirname "${DST}")" done } -# TODO(htuch): remove v2 support once we have a good story for version history RST links that refer -# to v2 APIs. -generate_api_rst v2 generate_api_rst v3 # Fixup anchors and references in v3 so they form a distinct namespace. diff --git a/docs/conf.py b/docs/conf.py index 5fcc251d0060..6524873d43aa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -147,8 +147,6 @@ def setup(app): '_venv', 'Thumbs.db', '.DS_Store', - 'api-v2/api/v2/endpoint/load_report.proto.rst', - 'api-v2/service/discovery/v2/hds.proto.rst', ] # The reST default role (used for this markup: `text`) to use for all diff --git a/docs/root/api-v3/config/filter/thrift/thrift.rst b/docs/root/api-v3/config/filter/thrift/thrift.rst index 7e40e6f95194..688961fd16c1 100644 --- a/docs/root/api-v3/config/filter/thrift/thrift.rst +++ b/docs/root/api-v3/config/filter/thrift/thrift.rst @@ -5,5 +5,4 @@ Thrift filters :glob: :maxdepth: 2 - router/v2alpha1/* ../../../extensions/filters/network/thrift_proxy/**/v3/* diff --git a/docs/root/api-v3/config/health_checker/health_checker.rst b/docs/root/api-v3/config/health_checker/health_checker.rst index b533d675ad7b..4f4230a6137f 100644 --- a/docs/root/api-v3/config/health_checker/health_checker.rst +++ b/docs/root/api-v3/config/health_checker/health_checker.rst @@ -5,5 +5,4 @@ Health checkers :glob: :maxdepth: 2 - */v2/* ../../extensions/health_checkers/*/v3/* diff --git a/docs/root/api-v3/config/resource_monitor/resource_monitor.rst b/docs/root/api-v3/config/resource_monitor/resource_monitor.rst index c755d656cc8b..767f4ffeb182 100644 --- a/docs/root/api-v3/config/resource_monitor/resource_monitor.rst +++ b/docs/root/api-v3/config/resource_monitor/resource_monitor.rst @@ -8,4 +8,3 @@ Resource monitors :maxdepth: 2 ../../extensions/resource_monitors/*/v3/* - */v2alpha/* diff --git a/docs/root/api-v3/config/retry/retry.rst b/docs/root/api-v3/config/retry/retry.rst index 2ba4572ab2ed..b26870b1e956 100644 --- a/docs/root/api-v3/config/retry/retry.rst +++ b/docs/root/api-v3/config/retry/retry.rst @@ -6,5 +6,4 @@ Retry Predicates :maxdepth: 2 */empty/* - */v2/* ../../extensions/retry/**/v3/* diff --git a/docs/root/configuration/http/http_conn_man/rds.rst b/docs/root/configuration/http/http_conn_man/rds.rst index d124d694c50b..06990756ae33 100644 --- a/docs/root/configuration/http/http_conn_man/rds.rst +++ b/docs/root/configuration/http/http_conn_man/rds.rst @@ -11,7 +11,7 @@ fetch its own route configuration via the API. Optionally, the :ref:`virtual host discovery service ` can be used to fetch virtual hosts separately from the route configuration. -* :ref:`v2 API reference ` +* :ref:`v3 API reference ` Statistics ---------- diff --git a/docs/root/configuration/http/http_conn_man/vhds.rst b/docs/root/configuration/http/http_conn_man/vhds.rst index 6a92c94d1319..45ed3ea7d8a5 100644 --- a/docs/root/configuration/http/http_conn_man/vhds.rst +++ b/docs/root/configuration/http/http_conn_man/vhds.rst @@ -69,7 +69,7 @@ on-demand :ref:`scoped RDS ` +* :ref:`v3 API reference ` Statistics ---------- diff --git a/docs/root/configuration/listeners/lds.rst b/docs/root/configuration/listeners/lds.rst index f5b8c778e95e..21560e958c6f 100644 --- a/docs/root/configuration/listeners/lds.rst +++ b/docs/root/configuration/listeners/lds.rst @@ -36,7 +36,7 @@ The semantics of listener updates are as follows: Configuration ------------- -* :ref:`v3 LDS API ` +* :ref:`v3 LDS API ` Statistics ---------- diff --git a/docs/root/configuration/other_protocols/dubbo_filters/router_filter.rst b/docs/root/configuration/other_protocols/dubbo_filters/router_filter.rst index 615a0b03da27..02e3a1fe264f 100644 --- a/docs/root/configuration/other_protocols/dubbo_filters/router_filter.rst +++ b/docs/root/configuration/other_protocols/dubbo_filters/router_filter.rst @@ -7,5 +7,5 @@ The router filter implements Dubbo forwarding. It will be used in almost all Dub scenarios. The filter's main job is to follow the instructions specified in the configured :ref:`route table `. -* :ref:`v3 API reference ` +* :ref:`v3 API reference ` * This filter should be configured with the name *envoy.filters.dubbo.router*. diff --git a/docs/root/configuration/overview/xds_api.rst b/docs/root/configuration/overview/xds_api.rst index dca8e99265c3..919e4ec4a3af 100644 --- a/docs/root/configuration/overview/xds_api.rst +++ b/docs/root/configuration/overview/xds_api.rst @@ -9,14 +9,13 @@ REST-JSON cases, a :ref:`DiscoveryRequest ` received following the :ref:`xDS protocol `. -Below we describe endpoints for the v2 and v3 transport API versions. +Below we describe endpoints for the v3 transport API. -.. _v2_grpc_streaming_endpoints: +.. _v3_grpc_streaming_endpoints: gRPC streaming endpoints ^^^^^^^^^^^^^^^^^^^^^^^^ -.. http:post:: /envoy.api.v2.ClusterDiscoveryService/StreamClusters .. http:post:: /envoy.service.cluster.v3.ClusterDiscoveryService/StreamClusters See :repo:`cds.proto ` for the service definition. This is used by Envoy @@ -37,7 +36,6 @@ is set in the :ref:`dynamic_resources ` of the :ref:`Bootstrap ` config. -.. http:post:: /envoy.api.v2.EndpointDiscoveryService/StreamEndpoints .. http:post:: /envoy.service.endpoint.v3.EndpointDiscoveryService/StreamEndpoints See :repo:`eds.proto @@ -59,7 +57,6 @@ is set in the :ref:`eds_cluster_config ` field of the :ref:`Cluster ` config. -.. http:post:: /envoy.api.v2.ListenerDiscoveryService/StreamListeners .. http:post:: /envoy.service.listener.v3.ListenerDiscoveryService/StreamListeners See :repo:`lds.proto @@ -81,7 +78,6 @@ is set in the :ref:`dynamic_resources ` of the :ref:`Bootstrap ` config. -.. http:post:: /envoy.api.v2.RouteDiscoveryService/StreamRoutes .. http:post:: /envoy.service.route.v3.RouteDiscoveryService/StreamRoutes See :repo:`rds.proto @@ -105,7 +101,6 @@ is set in the :ref:`rds of the :ref:`HttpConnectionManager ` config. -.. http:post:: /envoy.api.v2.ScopedRoutesDiscoveryService/StreamScopedRoutes .. http:post:: /envoy.service.route.v3.ScopedRoutesDiscoveryService/StreamScopedRoutes See :repo:`srds.proto @@ -130,7 +125,6 @@ is set in the :ref:`scoped_routes field of the :ref:`HttpConnectionManager ` config. -.. http:post:: /envoy.service.discovery.v2.SecretDiscoveryService/StreamSecrets .. http:post:: /envoy.service.secret.v3.SecretDiscoveryService/StreamSecrets See :repo:`sds.proto @@ -152,7 +146,6 @@ for the service definition. This is used by Envoy as a client when is set inside a :ref:`SdsSecretConfig ` message. This message is used in various places such as the :ref:`CommonTlsContext `. -.. http:post:: /envoy.service.discovery.v2.RuntimeDiscoveryService/StreamRuntime .. http:post:: /envoy.service.runtime.v3.RuntimeDiscoveryService/StreamRuntime See :repo:`rtds.proto @@ -177,7 +170,6 @@ field. REST endpoints ^^^^^^^^^^^^^^ -.. http:post:: /v2/discovery:clusters .. http:post:: /v3/discovery:clusters See :repo:`cds.proto @@ -197,7 +189,6 @@ is set in the :ref:`dynamic_resources ` of the :ref:`Bootstrap ` config. -.. http:post:: /v2/discovery:endpoints .. http:post:: /v3/discovery:endpoints See :repo:`eds.proto @@ -217,7 +208,6 @@ is set in the :ref:`eds_cluster_config ` field of the :ref:`Cluster ` config. -.. http:post:: /v2/discovery:listeners .. http:post:: /v3/discovery:listeners See :repo:`lds.proto @@ -237,7 +227,6 @@ is set in the :ref:`dynamic_resources ` of the :ref:`Bootstrap ` config. -.. http:post:: /v2/discovery:routes .. http:post:: /v3/discovery:routes See :repo:`rds.proto @@ -295,7 +284,6 @@ ADS is only available for gRPC streaming (not REST) and is described more fully in :ref:`xDS ` document. The gRPC endpoint is: -.. http:post:: /envoy.service.discovery.v2.AggregatedDiscoveryService/StreamAggregatedResources .. http:post:: /envoy.service.discovery.v3.AggregatedDiscoveryService/StreamAggregatedResources See :repo:`discovery.proto @@ -315,7 +303,7 @@ is set in the :ref:`dynamic_resources ` of the :ref:`Bootstrap ` config. -When this is set, any of the configuration sources :ref:`above ` can +When this is set, any of the configuration sources :ref:`above ` can be set to use the ADS channel. For example, a LDS config could be changed from .. code-block:: yaml diff --git a/docs/root/configuration/upstream/cluster_manager/cds.rst b/docs/root/configuration/upstream/cluster_manager/cds.rst index 9d747f4c8349..2449f4ae5234 100644 --- a/docs/root/configuration/upstream/cluster_manager/cds.rst +++ b/docs/root/configuration/upstream/cluster_manager/cds.rst @@ -12,7 +12,7 @@ clusters depending on what is required. Any clusters that are statically defined within the Envoy configuration cannot be modified or removed via the CDS API. -* :ref:`v3 CDS API ` +* :ref:`v3 CDS API ` Statistics ---------- diff --git a/docs/v2-api-header.rst b/docs/v2-api-header.rst deleted file mode 100644 index 2d2307096126..000000000000 --- a/docs/v2-api-header.rst +++ /dev/null @@ -1,5 +0,0 @@ -:orphan: - -.. warning:: - The v2 xDS API is not supported in Envoy v1.18.0 and above. -