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

clarify 10.0.2 helm chart upgrade path #4776

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

conceptualshark
Copy link
Contributor

@conceptualshark conceptualshark commented Dec 13, 2024

Description

Resolves #4640

Initial internal report/suggestion

A customer upgrading from v9.x.x did not interpret the existing requirement of "10.0.2+" as inclusive of v10.4.5. However, any v10.x.x > 10.0.1 can be used to upgrade from v9.x.x.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@conceptualshark conceptualshark requested a review from a team December 13, 2024 19:09
@akeller
Copy link
Member

akeller commented Dec 13, 2024

I think this is more descriptive, but I can't pinpoint what else might be missing.

We announced this in the 8.5 docs, which made me wonder how long we maintain a Helm chart version or what version we expect users to be on for 8.6 and 8.7.

@conceptualshark conceptualshark added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Dec 16, 2024
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm - 👍 🚀

Only non-blocking suggestions would be:

  • Perhaps make the last two sentences into a list, so it is easier to scan/read?
  • Make these two sentences active voice/address the reader directly?

e.g.
The upgrade path for Camunda Helm Chart v9.x.x is to the latest patch version of v10.

  • You can use any minor or patch version after (and including) 10.0.2.
  • You cannot upgrade from v9.x.x to v10.0.0 or v10.0.1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

Supported upgrade paths don't convey the helm chart's semantic versioning well
3 participants