Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release: Gateway 3.0 #4323

Merged
merged 225 commits into from
Sep 10, 2022
Merged

Release: Gateway 3.0 #4323

merged 225 commits into from
Sep 10, 2022

Conversation

lena-larionova
Copy link
Contributor

@lena-larionova lena-larionova commented Aug 24, 2022

Release roll-up PR for Gateway 3.0 release.

DO NOT COMMIT DIRECTLY TO THIS BRANCH. THIS PR IS FOR QA AND PREVIEW.

Please open PRs against release/gateway-3.0.

Preview: https://release-gateway-3-0--kongdocs.netlify.app/

Release checklist

  • Release branch (Lena)
  • Changelog (Lena)
  • Create release PR (Lena)
  • Update docs normally generated via autodocs:
    • Config reference
    • CLI reference (Lena)
    • Admin API (Lena)
    • PDK
  • Update support policy table (Lena)
  • Final rebase, resolve conflicts (angel)
  • Merge release PR
  • After merge, run Algolia indexer GH action to update all records

Testing/QA

For each page under /gateway/ (3.0.x):

  • Check that the breadcrumbs make sense. They’re auto-generated from the URL, so the URL needs to make sense (Angel)
  • Visual check that content renders correctly (Angel)
  • Click through entire Gateway 3.0 nav and ensure all pages have content; there are no placeholders (angel, Amy)
  • Kong Manager section: no screenshots of old UI (Amy)

For each page under /gateway/2.8.x/:

  • Ensure that the “latest documentation here” link at the top takes you to the exact page needed in 3.0. There should be a 1:1 mapping from old to new content. This is achieved using app/moved_urls.yml. (angel)

General:

  • For every Kong plugin: the latest version in the dropdown should be 3.0. (Lena)
  • Work through https://release-gateway-3-0--kongdocs.netlify.app/gateway/latest/get-started/get-kong/ and subsequent "get started" pages step by step (Amy; complete to the end of Key Authentication except for disabling key)
  • Work through all installation topics to ensure that they’re accurate (Diana)
    • Docker with DB (Michael)
    • Docker DB-less (Michael)
    • Amazon Linux (Michael)
    • Debian (Michael)
    • RHEL (Michael)
    • Ubuntu (Michael)
    • macOS
    • Kubernetes (Michael)
    • Helm (Michael)
    • OpenShift
  • Run a full broken link check locally (this can take 30+ mins) (Diana) - DB: I checked it and it said there were no broken links detected.
     make clean && make build
     netlify dev
     cd broken-link-checker
     node full.js
    

lena-larionova and others added 30 commits July 14, 2022 10:41
* move everything before 2.0 into an archive directory
* set archive version to 2.0; link to archive netlify site
* add missing menu entry for enterprise dropdown
* update enterprise version
* Fix version switcher smoke tests

Co-authored-by: Michael Heap <m@michaelheap.com>
#3932)

* single-source ip restriction plugin, delete old versions

* single-source bot detection plugin, delete old version

* single source acl plugin, delete old version

* Fix field.maximum_version for plugin table

* add version-specific text; switch acl plugin to delegate_versions

* add missing note for ip restriction plugin

* apply feedback

Co-authored-by: Michael Heap <m@michaelheap.com>
…3944)

* chore(debian 8) add deprecation notice ala centos

* fix(ci) double wait timeout for netlify (w. 60)
* chore(amzn) add amazon linux 1 deprecate notice

* fix(amzn1) rm redundant dep notice lines

per PR feedback

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
* fix(httplog) render custom_fields_by_lua properly

* change(httplog) update docs to 3.0.0

and clarify 2.x

* fix(http-log) fix example

* single-source the http log plugin docs

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
* docs(gateway): dynamic plugin ordering

https://konghq.atlassian.net/browse/DOCU-2305

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* split plugin ordering doc into two; minor edits

* formatting, phrasing, typo cleanup; pulled 'workspaces' into 'performance limitations'

* docs(gateway): drop kong manager instructions

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* grammar, spelling, formatting cleanup; added info about Kong Manager to the overview

* fix typos; improve formatting and phrasing

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
* add graphql_server_path; set up single-sourced version; minor grammar and formatting cleanup

* minor grammar edits

* set required: true for graphql_server_path

* attempt to rephrase
* create one topic for all supported and deprecated linux OSes

* remove centos from 3.0 doc and set up redirect

* add links to support tables; move deprecation notices to changelog; remove link blocks

* remove unused 'os_version'

* add note to install doc; fix typo

* group linux distibutions into their own section

* update smoke test
Fix `layout` type

Changed `layout` type from boolean to string.
* update description of route.path about URI normalization

* grammar

Co-authored-by: angel <angel.guarisma@konghq.com>
* docs(keyring) add recovery key

* Fix typo

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Add refer link

Co-authored-by: Angel <Guaris@users.noreply.github.com>
…ult and workspace_identifier_default (#4067)

* feat(plugin) add consumer_identifier_default, service_identifier_default and workspace_identifier_default

* copy edit

* changes to future proof this PR

* formatting issues

Co-authored-by: angel <angel.guarisma@konghq.com>
)

* docs(perf) add new API to perf test framework and mark it support
Enterprise

* copy edit

Co-authored-by: angel <angel.guarisma@konghq.com>
#4097)

* doc(keyring) reorder the structure, mention new options for Data Plane

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>
* copy changes from #4080

* copy changes from #4081

* copy changes from #4060

* copy changes from #4063

* copy chnges from #4061

* copy changes from #4069

* copy changes from #4038, #3999, #3995, and #3982

* copy changes from #4015

* copy changes from #3999

* copy changes from 67b6df8

* copy changes from 7e53c74

* copy changes from  #3950

* copy changes from #3948

* copy changes from #3925

* copy changes from e2c1040

* copy changes from #3926

* copy changes from 68a340e

* copy change from 935189c

* copy changes from #3807 and c3556fd

* copy changes from #3895

* copy changes from #3861

* update nav for 3.0 and fix tests
* single-source azure plugin

* single-source cors

* single-source exit transformer

* single-source graphql proxy cache

* single-source graphql rate limiting

* single-source newer plugins

* vale edits

* delete plugins that haven't existed for many releases

* redirects for removed plugin folders
…nsive docs. (#4137)

* remove KM, Deck, and HTTPIE instructions

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Integrate Diana feedback

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
* wip

* add otel plugin

* add otel to nav bar

* Render map examples correctly in Plugin Hub

* Apply suggestions from code review

* Fix Vale issues

* Update version to single src

* add otel icon

* add recommendation & apply suggestions

* Apply suggestions from code review

* Update app/_hub/kong-inc/opentelemetry/_index.md

* Update app/_hub/kong-inc/opentelemetry/_index.md

Co-authored-by: Michael Heap <m@michaelheap.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
bungle and others added 5 commits September 8, 2022 09:59
* docs(secret-management) update secret management docs for GA

* fix links

* fix more links

* remove outdated source urls

* Formatting & grammar edits

* vale edits

* some better formatting for referenceable values section

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
* clean up command prompt marker in src and plugin hub

* remove outdated source_url parameter from plugin metadata

* fix some indents

* remove $ marker from hub examples
rename source_url to source_code for plugins
* Add OpenTracing item to Known Limitations

* Add deprecation notice for nginx-opentracing

* Minor copy editing improvements

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: Tyler Ball <2481463+tyler-ball@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
* We accidently removed RFC3987 validation from route paths

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>

* Update app/gateway/changelog.md

Co-authored-by: Datong Sun <datong.sun@konghq.com>

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>
tyler-ball and others added 9 commits September 9, 2022 12:19
… of that until we can fix the issue (#4416)

* The FIPS package has an issue, so we are delaying the 3.0.0.0 release of that until we can fix the issue

Reverts #4306 temporarily
while we fix the FIPS package. When we release the 3.0.0.0 FIPS package
we will add these releae notes back.

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>

* remove fips from gateway features table

* remove fips config parameters from reference

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
* create doc for upstream timeout plugin

* vale fixes; disable vale on certain sections

* typo

* appease linter with some reorganizing

* remove numbers from headers; adjust links to point to routing ref

* vale

* add real icon
…#4420)

* add callouts for declarative config and general breaking changes in release

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* apply fix to other file

Co-authored-by: Angel <Guaris@users.noreply.github.com>
* Correcting information about blue-green deploys from 2.8 to 3.0

For EE, users will need to update to 2.8.1.5 before trying a blue-green
upgrade to 3.0.0.0

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>

* style: Update app/gateway/changelog.md

Add missing comma

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* style: better grammar

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* style: add missing comma

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Correct statements of blue-green deploys (#4409)

1. OSS also support bg migration for hybrid mode;
2. Instruction and explanation of the migrations process

* typo fix

* Formatting & language

* better formatting for blue-green section in upgrade guide

* Attempting to clarify our support upgrade strategies and topologies

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>

* follow the change of Kong/kong/pull/9404

* Formatting, grammar

* fix duplicate info in changelog

* add callout for blue-green to top of guide

* traditional mode

* better grammar

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>
Co-authored-by: Hans Hübner <hans.huebner@gmail.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Xumin <100666470+Suika-Kong@users.noreply.github.com>
Co-authored-by: suika-kong <xumin.zhou@konghq.com>
Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
@lena-larionova lena-larionova marked this pull request as ready for review September 9, 2022 19:57
@lena-larionova lena-larionova requested a review from a team as a code owner September 9, 2022 19:57
fix 2.8.x nav
@Guaris Guaris self-requested a review September 9, 2022 20:58
* We switched our convenience tags from Alpine base to Debian base

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>

* Update app/gateway/changelog.md

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
@Guaris Guaris merged commit 56338e0 into main Sep 10, 2022
@mheap mheap deleted the release/gateway-3.0 branch October 4, 2022 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:check-skipped:generated-files do not merge Issues/ PRs whose changes should not be merged at this time review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.