docs: Remove api v2 by phlax · Pull Request #16077 · envoyproxy/envoy

phlax · 2021-04-20T09:29:28Z

Signed-off-by: Ryan Northey ryan@synca.io

Commit Message: docs: Remove api v2
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Deprecated:]
[Optional API Considerations:]

phlax · 2021-04-20T09:53:42Z

@htuch as your comment in docs/build.sh suggests the biggest challenge to removing the v2 build is with the version history - i think that will require its own solution

there are a few more failures:

api/xds_protocol.rst throws a ton of errors
configuration/arch_overview/operations and maybe a few others - small number of errors

if we can agree a way forward for the version history (perhaps linking to old docs ?) then im happy to go through and update

not sure about the xds protocol doc - but i guess its a case of updating/rewriting it to point only to v3 xds

the other errors are pretty small in number, and im guessing we again just need to update the relevant docs

htuch · 2021-04-20T14:32:17Z

Yeah, for version history, let's replace these with HTTP references to the 1.17.0 v2 API docs. It should be possible to sed this, since the references follow a regular pattern, e.g. envoy_api vs. envoy_v3_api.

The rest of the docs should just point to the v3 counterparts.

phlax · 2021-04-21T10:42:52Z

docs here - https://storage.googleapis.com/envoy-pr/16077/docs/index.html

htuch · 2021-04-21T21:01:17Z

@phlax output looks good, happy to review when in ready state.

repokitteh-read-only · 2021-04-24T07:44:14Z

CC @envoyproxy/dependency-shepherds: Your approval is needed for changes made to (bazel/.*repos.*\.bzl)|(bazel/dependency_imports\.bzl)|(api/bazel/.*\.bzl)|(.*/requirements\.txt)|(.*\.patch).

🐱

Caused by: #16077 was synchronize by phlax.

see: more, trace.

phlax · 2021-04-27T10:10:34Z

@htuch once #16155 has landed there will be one outstanding issue with this - the not_so_simple_http_cache issue - once that is resolved we should be able to remove v2 from the docs

repokitteh-read-only · 2021-05-01T08:37:32Z

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/envoy/.
envoyproxy/api-shepherds assignee is @htuch
CC @envoyproxy/api-watchers: FYI only for changes made to api/envoy/.

🐱

Caused by: #16077 was synchronize by phlax.

see: more, trace.

Signed-off-by: Ryan Northey <ryan@synca.io>

phlax · 2021-05-02T15:42:48Z

.azure-pipelines/pipelines.yml

              BAZEL_REMOTE_INSTANCE: projects/envoy-ci/instances/default_instance
              GCP_SERVICE_ACCOUNT_KEY: $(GcpServiceAccountKey)
            displayName: "Generate docs"
+            continueOnError: true


Signed-off-by: Ryan Northey <ryan@synca.io>

phlax · 2021-05-02T17:28:46Z

@htuch this doesnt remove all of the v2 references - but it gets most of them and prevents the v2 proto -> rst build - so its a pretty good start i think

htuch

LGTM, thanks!

alyssawilk · 2021-05-05T13:11:15Z

hmmm, I noticed over on #15926 if I fix_proto and fix_format it adds these back:

--- a/api/BUILD
+++ b/api/BUILD
@@ -133,12 +133,18 @@ 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",

I'll just stash those changes and see if CI is happy, but I think we need to fix some auto-gen thing to avoid these being added back

phlax · 2021-05-05T13:12:38Z

@alyssawilk i think the fix is #16330

Commit Message: api: Fix generated_api_shadow BUILD Additional Description: Some changes were made to the api/BUILD file in #16077 which were not propagated to generated_api_shadow this is also a possible reason that a dev reported an issue with ci formatting Signed-off-by: Ryan Northey <ryan@synca.io>

Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>

Commit Message: api: Fix generated_api_shadow BUILD Additional Description: Some changes were made to the api/BUILD file in envoyproxy#16077 which were not propagated to generated_api_shadow this is also a possible reason that a dev reported an issue with ci formatting Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>

Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>

Commit Message: api: Fix generated_api_shadow BUILD Additional Description: Some changes were made to the api/BUILD file in envoyproxy#16077 which were not propagated to generated_api_shadow this is also a possible reason that a dev reported an issue with ci formatting Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>

phlax marked this pull request as draft April 20, 2021 09:29

phlax mentioned this pull request Apr 20, 2021

gzip: drop deprecated filter #15867

Merged

htuch self-assigned this Apr 20, 2021

phlax mentioned this pull request Apr 21, 2021

api: Update xds_protocol doc to remove v2 and cleanup #16097

Merged

phlax force-pushed the docs-remove-api-v2 branch from 0a31534 to 76400cc Compare April 24, 2021 07:44

repokitteh-read-only bot added the deps Approval required for changes to Envoy's external dependencies label Apr 24, 2021

phlax force-pushed the docs-remove-api-v2 branch 7 times, most recently from 37c8ebf to 679c18f Compare April 27, 2021 10:08

phlax force-pushed the docs-remove-api-v2 branch 2 times, most recently from 827e328 to 483fbd3 Compare April 27, 2021 16:37

repokitteh-read-only bot added the api label May 1, 2021

phlax force-pushed the docs-remove-api-v2 branch 3 times, most recently from 264bfb3 to a3c4a76 Compare May 1, 2021 11:55

phlax added 4 commits May 2, 2021 16:39

docs: Remove api v2

109eea0

Signed-off-by: Ryan Northey <ryan@synca.io>

continue-on-error

206406c

Signed-off-by: Ryan Northey <ryan@synca.io>

fail-format

ee6055b

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

e53f13f

Signed-off-by: Ryan Northey <ryan@synca.io>

phlax added 6 commits May 2, 2021 16:39

xds

43a9a27

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

8ddd636

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

d339507

Signed-off-by: Ryan Northey <ryan@synca.io>

api/

bfe7932

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

a8ae14e

Signed-off-by: Ryan Northey <ryan@synca.io>

docs/

ef71a8e

Signed-off-by: Ryan Northey <ryan@synca.io>

phlax force-pushed the docs-remove-api-v2 branch from 51155c6 to ef71a8e Compare May 2, 2021 15:40

phlax commented May 2, 2021

View reviewed changes

pipelines

336450f

Signed-off-by: Ryan Northey <ryan@synca.io>

phlax changed the title ~~[WIP] docs: Remove api v2~~ docs: Remove api v2 May 2, 2021

phlax marked this pull request as ready for review May 2, 2021 17:27

phlax requested a review from htuch May 2, 2021 17:27

htuch approved these changes May 2, 2021

View reviewed changes

htuch merged commit e22e4a1 into envoyproxy:main May 2, 2021

phlax mentioned this pull request May 5, 2021

api: Fix generated_api_shadow BUILD #16330

Merged

gokulnair pushed a commit to gokulnair/envoy that referenced this pull request May 6, 2021

docs: Remove api v2 (envoyproxy#16077)

c2dd672

Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>

gokulnair pushed a commit to gokulnair/envoy that referenced this pull request May 6, 2021

docs: Remove api v2 (envoyproxy#16077)

c452d32

Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Remove api v2#16077

docs: Remove api v2#16077
htuch merged 11 commits intoenvoyproxy:mainfrom
phlax:docs-remove-api-v2

phlax commented Apr 20, 2021

Uh oh!

phlax commented Apr 20, 2021

Uh oh!

htuch commented Apr 20, 2021

Uh oh!

phlax commented Apr 21, 2021

Uh oh!

htuch commented Apr 21, 2021

Uh oh!

repokitteh-read-only bot commented Apr 24, 2021

Uh oh!

phlax commented Apr 27, 2021

Uh oh!

repokitteh-read-only bot commented May 1, 2021

Uh oh!

phlax May 2, 2021

Uh oh!

phlax commented May 2, 2021

Uh oh!

htuch left a comment

Uh oh!

alyssawilk commented May 5, 2021

Uh oh!

phlax commented May 5, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

phlax commented Apr 20, 2021

Uh oh!

phlax commented Apr 20, 2021

Uh oh!

htuch commented Apr 20, 2021

Uh oh!

phlax commented Apr 21, 2021

Uh oh!

htuch commented Apr 21, 2021

Uh oh!

repokitteh-read-only bot commented Apr 24, 2021

Uh oh!

phlax commented Apr 27, 2021

Uh oh!

repokitteh-read-only bot commented May 1, 2021

Uh oh!

phlax May 2, 2021

Choose a reason for hiding this comment

Uh oh!

phlax commented May 2, 2021

Uh oh!

htuch left a comment

Choose a reason for hiding this comment

Uh oh!

alyssawilk commented May 5, 2021

Uh oh!

phlax commented May 5, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants