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

Correct Istio Upgrade version step message #13747

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cathal-c
Copy link

Please provide a description for what this PR is for.

And to help us figure out who should review this PR, please
put an X in all the areas that this PR affects.

  • Ambient
  • Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure

The existing message implies that upgrading two minor versions is supported, and indeed this has historically been the case, at least anecdotally.

The Istio 1.17 control plane however, is not compatible with Istio 1.15 proxies, breaking that soft rule. That should be reflected here, to prevent users from incorrectly jumping multiple minor versions.

The existing message implies that upgrading two minor versions is supported, and indeed this has historically been the case, at least anecdotally.

The Istio 1.17 control plane however, is not compatible with Istio 1.15 proxies, breaking that soft rule. That should be reflected here, to prevent users from incorrectly jumping multiple minor versions.
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 18, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: CathalC2011 / name: Cathal (42ba7f1)

@istio-policy-bot
Copy link

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been awhile since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, about our style guidelines,
    and about all the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be
    built as a full copy of the istio.io website. You can find this preview by clicking on
    the Details link next to the deploy/netlify entry in the Status section of this
    page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation
    is top notch. We do spell checking, we sanitize the markdown, we ensure all hyperlinks point
    to valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
    status section of the page. Click on the Details link to get a list of the problems with your PR.
    Fix those problems and push an update to your PR. This will automatically rerun the tests and
    hopefully this time everything will be perfect.

  • Once your changes are accepted and merged into the repository, they will initially show up
    on https://preliminary.istio.io. The changes will be published to https://istio.io
    the next time we do a major release (which typically happens every 3 months or so).

Thanks for contributing!

Courtesy of your friendly welcome wagon.

@istio-testing istio-testing added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test labels Aug 18, 2023
@istio-testing
Copy link
Contributor

Hi @CathalC2011. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ericvn
Copy link
Contributor

ericvn commented Aug 18, 2023

Would you point to where this is discussed. Is this maybe related to this istio/istio#43785? I believe there was an issue upgrading to 1.17.0 and 1.17.1 but it was fixed in 1.17.2.

@@ -7,5 +7,5 @@ test: n/a
---

{{< warning >}}
Upgrading across more than two minor versions (e.g., `1.6.x` to `1.9.x`) in one step is not officially tested or recommended.
Upgrading across more than one minor version (e.g., `1.15.x` to `1.17.x`) in one step is not officially tested or recommended.
Copy link
Member

@dhawton dhawton Aug 18, 2023

Choose a reason for hiding this comment

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

Suggested change
Upgrading across more than one minor version (e.g., `1.15.x` to `1.17.x`) in one step is not officially tested or recommended.
Upgrading across more than two minor version (e.g., `1.15.x` to `1.17.x`) in one step is not officially tested or recommended. Upgrades that skip a minor version should only be done when using [Canary Upgrades](https://istio.io/latest/docs/setup/upgrade/canary/).

Per John's guidance but still clarify the statement.

Copy link
Member

Choose a reason for hiding this comment

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

+1 should be supported for canary

Copy link
Contributor

@ericvn ericvn Aug 18, 2023

Choose a reason for hiding this comment

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

We do test some upgrade testing across two versions although I need to verify what it's doing: https://github.com/istio/istio/tree/master/tests/integration/helm/upgrade

Copy link
Member

Choose a reason for hiding this comment

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

Should we say - Upgrading across more than two minor version (e.g., 1.15.x to 1.17.x) in one step is not officially tested or recommended for in place upgrade.

Copy link
Member

Choose a reason for hiding this comment

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

Personally would like to specifically call out Canary Upgrades and link to doc to help guide toward a set procedure that is better practice.

Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

/ok-to-test

@istio-testing istio-testing added ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. and removed needs-ok-to-test labels Aug 19, 2023
Copy link
Contributor

@craigbox craigbox left a comment

Choose a reason for hiding this comment

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

Saying "Upgrading across" implies skipping a version, and the original line read "Upgrading across two minor versions (e.g. 1.6 to 1.9)".

I think we need to clarify the statement a little further.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/environments area/user experience kind/docs ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants