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

docs(upgrade) instructions for 3.0 #9404

Merged
merged 8 commits into from
Sep 12, 2022
Merged

docs(upgrade) instructions for 3.0 #9404

merged 8 commits into from
Sep 12, 2022

Conversation

StarlightIbuki
Copy link
Contributor

We support 3 ways to migrate to 3.0 with no downtime:

  1. 2 steps migration, up and finish;
  2. Hybrid mode, old DPs do not sync config with new CP;
  3. Hybrid mode, CP downgrades config for old DPs.

The first 1 requires 2.8.2, the second 1 requires 2.8.x, and the last one support any version that can be migrated with migrations up.

@StarlightIbuki StarlightIbuki requested a review from a team as a code owner September 8, 2022 09:53
@StarlightIbuki StarlightIbuki added this to the 3.0 milestone Sep 8, 2022
Copy link
Member

@dndx dndx left a comment

Choose a reason for hiding this comment

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

We should chat about what will happen if user use a declarative config file from 2.x in 3.0.

StarlightIbuki added a commit to Kong/docs.konghq.com that referenced this pull request Sep 9, 2022
@StarlightIbuki
Copy link
Contributor Author

The failing test should be unrelated.

Copy link
Member

@kikito kikito left a comment

Choose a reason for hiding this comment

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

Approving this but not merging yet in order to give the docs team some time to review.

@Guaris
Copy link
Contributor

Guaris commented Sep 9, 2022

@suika-kong could you point this PR to the release/gateway-3.0 branch

detail for hybrid mode upgrade

fix: we should not mention bg mig here

rephrase

Apply suggestions from code review

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

add example for expected log

docs(upgrade) Update from docs.konghq.com copy editing

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>
lena-larionova added a commit to Kong/docs.konghq.com that referenced this pull request Sep 9, 2022
* 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>
dndx
dndx previously requested changes Sep 10, 2022
Copy link
Member

@dndx dndx left a comment

Choose a reason for hiding this comment

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

I just want to emphasize again the importance of consistency, we can not have "data store" and "datastore" mixed in the same document. Also, pay attention to the capitalization of well defined Kong specific terms like "Control Plane" instead of "control plane".

I also want to emphasize the importance of explaining what we are doing in each of the steps, in order to educate the user who might not be familiar with what each command does.

StarlightIbuki and others added 6 commits September 10, 2022 09:51
Co-authored-by: Datong Sun <datong.sun@konghq.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>
@StarlightIbuki StarlightIbuki requested a review from dndx September 10, 2022 02:10
@kikito kikito dismissed dndx’s stale review September 12, 2022 10:10

Dismissing this review, changes were accepted by Xumin and merged.

@kikito kikito merged commit 546daf7 into master Sep 12, 2022
@kikito kikito deleted the docu/upgrade_28_30 branch September 12, 2022 10:11
kikito pushed a commit that referenced this pull request Sep 12, 2022
Co-authored-by: Makito <sumimakito@hotmail.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants