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

[DOCU-3215] 3.3 upgrade guide #5590

Merged
merged 6 commits into from
May 18, 2023
Merged

Conversation

cloudjumpercat
Copy link
Contributor

@cloudjumpercat cloudjumpercat commented May 17, 2023

Description

What did you change and why?

  • I fixed the upgrades table so it applies to 3.3 and added 3.3 breaking changes (copy/pasted with a few small changes from the changelog)

Include any supporting resources, e.g. link to a Jira ticket, GH issue, FTI, Slack, Aha, etc.
DOCU-3215
Note: I recreated this PR from #5557 because that one had issues with a rebase and added a bunch of unnecessary commits.

Testing instructions

Netlify link:

Checklist

  • Review label added
  • PR pointed to correct branch (main for immediate publishing, or a release branch: e.g. release/gateway-3.2, release/deck-1.17)

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@cloudjumpercat cloudjumpercat added the review:sme Request for SME review, external to the docs team. label May 17, 2023
@netlify
Copy link

netlify bot commented May 17, 2023

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 70cfaf2
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/64665238b9eb2f0008c6bb25
😎 Deploy Preview https://deploy-preview-5590--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@cloudjumpercat
Copy link
Contributor Author

❗ Reviewers: Also, got this feedback from Slack and I'm not sure which path is the correct one: "Current the upgrade page says if you are on 2.8 upgrade to 3.1.x then to 3.2.x BUT if you click on the link which takes you to the 3.1.x upgrade page it then says, go 2.8->3.0->3.1 - honestly that is very confusing for users and I think we need to make that a bit clearer"

@cloudjumpercat cloudjumpercat added review:copyedit Request for writer review. and removed review:sme Request for SME review, external to the docs team. labels May 18, 2023
Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One tiny typo, otherwise LGTM

app/_src/gateway/upgrade-v2.md Outdated Show resolved Hide resolved
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
@cloudjumpercat cloudjumpercat marked this pull request as ready for review May 18, 2023 16:28
@cloudjumpercat cloudjumpercat requested a review from a team as a code owner May 18, 2023 16:28
@cloudjumpercat cloudjumpercat merged commit 0f80f0f into release/gateway-3.3 May 18, 2023
@cloudjumpercat cloudjumpercat deleted the upgrade-guide-3.3 branch May 18, 2023 16:44
lena-larionova added a commit that referenced this pull request May 19, 2023
* gateway 3.3 metadata

* feat(proxy-cache): add ignore_uri_case to configuring cache-key uri to be handled as lowercase (#5270)

* feat(proxy-cache): add cache_lowercase_uri param

* renaming parameter to ignore_uri_case

* feat(proxy-cache): apply suggestions from code review

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

* feat(proxy-cache): removed in proxy-cache-advanced

* feat(proxy-cache): apply suggestions from code review

Co-authored-by: Samuele Illuminati <samuele@konghq.com>

* feat(proxy-cache): add param to plugin-ignore

---------

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

* docs(acme): add account_key for acme plugin (#5222)

* docs(acme): add account_key for acme plugin

* docs(acme): add keys/keyset configuration for acme plugin

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

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

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

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

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

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

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

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

---------

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

* feat(logging): add workspace name in the logging payload (#5251)

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* docs(http-log): plugin schema update for 3.3 (#5326)

* feat(plugins): added second available content-type option to http-log plugin

* add version tags and a changelog entry

---------

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

* docs(proxy-cache-advanced): add ignore_uri_case (#5458)

* docs(proxy-cache-advanced): add ignore_uri_case

add ignore_uri_case parameter to proxy-cache-advanced docs

* Update app/_hub/kong-inc/proxy-cache-advanced/_index.md

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

* Set minimum version on param

---------

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

* docs(request-transformer): untrusted_lua (#5499)

add changelog for untrusted lua to request transformer and request
transformer advanced plugins

* docs(aws-lambda): add new disable_https field (#5486)

* docs(aws-lambda): add new disable_https field

* add changelog entry

* phrasing adjustment for changelog

---------

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

* docs(3.3) remove references to 'default tracing_sampling_rate' (#5517)

* docs(acme): support redis namespace (#5366)

* docs(acme): support redis namespace

correspond to [Kong/kong#10562](Kong/kong#10562)

`namespace` will be treated as a prefix of key and is default to empty string `""` for backward compatibility.
`namespace` must not be prefixed with any of the reserved words.

[KAG-615](https://konghq.atlassian.net/browse/KAG-615)

* update

* Fix Vale errors

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

---------

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

* feat(proxy-cache): add wildcard and parameter match support for content_type (#5420)

* feat(proxy-cache): add wildcard and parameter match support for content_type

* Apply suggestions from code review

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

* set version tags for 3.3; add missing changelog entry for proxy cache

---------

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Michael Heap <m@michaelheap.com>
Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* datadog: now host is referenceable (#5353)

* datadog: now host is referenceable

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

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

* kubernetes section

* Apply suggestions from code review

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

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

Co-authored-by: Harry <harrybagdi@gmail.com>

* - fix indents
- add changelog entry
- adjust phrasing for intro to kubernetes section and add navtabs
- set version tags

---------

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Victor Yu <44963973+VicYP@users.noreply.github.com>
Co-authored-by: Harry <harrybagdi@gmail.com>
Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* [DOCU-3216] Status Endpoint link (#5541)

* add status endpoint

* add absolute_url

* Fix description of routing priorities with multiple paths (#5533)

* Fix description of routing priorities with multiple paths

* Apply suggestions from code review

---------

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

* Revert "feat(logging): add workspace name in the logging payload (#52… (#5547)

Revert "feat(logging): add workspace name in the logging payload (#5251)"

This reverts commit 37df8eb.

* fix(oauth2): add a changelog entry (#5548)

* fix(oauth2): add a changelog entry

* rephrase for clarity

---------

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

* [DOCU-2921] Status endpoint + Kong health  check (#5419)

* Create health-check.md

New page + tutorial tempalte for KAG-76

* docs: health check

* Update health-check.md

* Update app/_src/gateway/production/monitoring/health-check.md

Co-authored-by: Chrono <chronolaw@gmail.com>

* Update app/_src/gateway/production/monitoring/health-check.md

Co-authored-by: Chrono <chronolaw@gmail.com>

* Update health-check.md

* Update app/_src/gateway/production/monitoring/health-check.md

Co-authored-by: Chrono <chronolaw@gmail.com>

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Update app/_src/gateway/production/monitoring/health-check.md

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

* Change some phrasing

These are all small adjustments.

* Update status_listen enablement step

* s/configured/enabled/ to match other updates

* Add response examples to usage instructions

* Fixup code blocks

* Add health check link to navbar

* Fixup response code/messages

* Use the correct link syntax

* Add reference to monitoring index/overview

* Inline port number comment in yaml block

* Prettify JSON for readability

* Update app/_src/gateway/production/monitoring/index.md

Co-authored-by: Vinicius Mignot <vinicius.mignot@gmail.com>

* readiness instead of health

* Apply suggestions from code review

Co-authored-by: Vinicius Mignot <vinicius.mignot@gmail.com>

* s/ready to work/ready to accept requests/

* add control_plane explanation

* apply review suggestions

* more review comments addressing

* Update app/_src/gateway/production/monitoring/readiness-check.md

Co-authored-by: Harry <harrybagdi@gmail.com>

* Revert "Update app/_src/gateway/production/monitoring/readiness-check.md"

This reverts commit d68d904.

* wording and formatting

* Copy edit

* link

---------

Co-authored-by: pluveto <i@pluvet.com>
Co-authored-by: Zijing Zhang <50045289+pluveto@users.noreply.github.com>
Co-authored-by: Chrono <chronolaw@gmail.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>
Co-authored-by: Michael Martin <flrgh@protonmail.com>
Co-authored-by: Michael Martin <3277009+flrgh@users.noreply.github.com>
Co-authored-by: Chrono <chrono_cpp@me.com>
Co-authored-by: Vinicius Mignot <vinicius.mignot@gmail.com>
Co-authored-by: Harry <harrybagdi@gmail.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Reworked plugin queues (#5088)

* Reworked plugin queues documentation

 * Add queueing parameters to relevant plugin docs
 * Mention queues in sizing guidelines
 * Add batch queue overview and reference

* Remove consumer batching section, add results sentence to why queues are needed

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply copy edits

Co-authored-by: Hans Hübner <hans.huebner@gmail.com>

* Rework how queue parameters are included in plugin docs

* Can't include paramters

* Quote queue parameter names

* remove comment

* remove comment

* Change batch queue to queue, fix links, add link to Zipkin to about plugin queues

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix links to queue reference

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply conditional rendering to queue content

* Add conditional rendering to queue parameters

* Fix minimum_version spacing

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix queue param spacing in http log plugin doc

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

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

* Update app/_src/gateway/production/sizing-guidelines.md

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

* Fix link and add conditional rendering to sizing guidelines page

---------

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

* [DOCU-3051] Auto docs 3.3 (#5549)

* autodocs

* Apply suggestions from code review

* config.md add EE info

* Update app/_src/gateway/reference/configuration.md

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

---------

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

* Timeout support for dynamic log levels (#5550)

* Timeout support for dynamic log levels

KAG-5
DOCU-2903

* Update app/_src/gateway/production/logging/update-log-level-dynamically.md

* Update app/_src/gateway/production/logging/update-log-level-dynamically.md

---------

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

* Spec links (#5553)

add links to specs

* chore: update 3.3 nav to include all updates in 3.2

* [DOCU-3065] Data plane labels in konnect (#5554)

* document using custom dp labels in konnect

* Update app/konnect/runtime-manager/runtime-instances/custom-dp-labels.md

---------

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

* [DOCU-3167] Add Amazon Linux 2023 to support page (#5536)

* Add Amazon Linux 2023 to support page

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add Amazon Linux 2023 tab to install instructions

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

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

* Add 3.3 to browser and third-party support, add AL2023 Yum repo tab

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update app/_data/tables/support/gateway/versions/33.yml

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

* Add Amazon Graviton note to install pages

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Remove mentions of Graviton

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix EOL date for 3.3

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

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

* Revert "[DOCU-3167] Add Amazon Linux 2023 to support page" (#5559)

Revert "[DOCU-3167] Add Amazon Linux 2023 to support page (#5536)"

This reverts commit 9c64603.

* Fixes to log level doc (#5570)

fixes

* Support page updates for 3.3 (#5569)

* update support pages for 3.3

* update one more version

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

---------

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

* Fix errors after rebase

* feat: add aws iam authentication to rds feature document (#5503)

* feat: add aws iam authentication to rds feature document

* refine doc

* add more tips

* ssl maximum version is limited by rds

* add mentioning cluster resource id syntax for aurora

* adjust a bit about IAM role assignment and add the case of running kong locally

* make onboarding smoother by providing ways to connect to rds using psql; refine the wording on read/write and read/only mode description

* mention tlsv1.3 not supported one more time in the limitations; refine wording of the highlight of this feature

* Edit title, introduction, and start of prereqs section

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Finish copy edits

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply tech review feedback

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix some grammar errors and spelling

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Qirui(Keery) Nie <windmgc@gmail.com>

* Update app/_src/gateway/kong-enterprise/aws-iam-auth-to-rds-database.md

Co-authored-by: Qirui(Keery) Nie <windmgc@gmail.com>

* Fix limitations descriptions based on tech review feedback

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

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

* Plugin queuing diagrams (#5583)

* Add plugin queue diagrams

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix Figure number on second one

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* add 3.3 compatibility table updates (#5573)

add 3.3 compatability issues

Adds compatability issues for release 3.3.

* Remove centos from 3.3 support table

* [DOCU-3169] Changelog for gateway 3.3.0.0 (#5562)

* changelog for gateway 3.3.0.0

* added reminders about deprecations and links to API specs

* set release date

* [DOCU-3215] 3.3 upgrade guide (#5590)

* Add upgrade table for 3.3

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix rolling upgrades column for 3.1.x releases

* Add info about plugin queue breaking changes to upgrade doc

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add traditional_compat and Plugins to breaking changes section

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix changelog link

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

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

---------

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

* [docu-3186] SOBM page (#5558)

* add page

* Apply suggestions from code review

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

* rename

---------

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

* [fix] 3.2.2 changelog (#5605)

* fix 3.2.2 changelog

* move content into the right places

---------

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* Add known issues to 3.3 changelog (#5599)

* lmdb known issue

* adding more known issues

* spacing

* Apply suggestions from code review

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

---------

Co-authored-by: Angel <Guaris@users.noreply.github.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Tobias Lindberg <tobias.ehlert@gmail.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Samuele Illuminati <samuele@konghq.com>
Co-authored-by: Steve Zesch <steve.zesch@konghq.com>
Co-authored-by: Xiaoyan Rao <270668624@qq.com>
Co-authored-by: Jack Tysoe <91137069+tysoekong@users.noreply.github.com>
Co-authored-by: Qirui(Keery) Nie <windmgc@gmail.com>
Co-authored-by: Enrique García Cota <kikito@gmail.com>
Co-authored-by: Zhefeng C <38037704+catbro666@users.noreply.github.com>
Co-authored-by: Yusheng Li <leeys.top@gmail.com>
Co-authored-by: Michael Heap <m@michaelheap.com>
Co-authored-by: Xumin <100666470+StarlightIbuki@users.noreply.github.com>
Co-authored-by: Victor Yu <44963973+VicYP@users.noreply.github.com>
Co-authored-by: Harry <harrybagdi@gmail.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>
Co-authored-by: Hans Hübner <hans.huebner@gmail.com>
Co-authored-by: Amy Goldsmith <59702069+acgoldsmith@users.noreply.github.com>
Co-authored-by: pluveto <i@pluvet.com>
Co-authored-by: Zijing Zhang <50045289+pluveto@users.noreply.github.com>
Co-authored-by: Chrono <chronolaw@gmail.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>
Co-authored-by: Michael Martin <flrgh@protonmail.com>
Co-authored-by: Michael Martin <3277009+flrgh@users.noreply.github.com>
Co-authored-by: Chrono <chrono_cpp@me.com>
Co-authored-by: Vinicius Mignot <vinicius.mignot@gmail.com>
Co-authored-by: Murillo <103451714+gruceo@users.noreply.github.com>
Co-authored-by: Fabian Rodriguez <fabian.rodriguez@konghq.com>
Co-authored-by: Alex Gaesser <agaesser@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:copyedit Request for writer review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants