-
Notifications
You must be signed in to change notification settings - Fork 190
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
document the upgrade version flow for self-managed #3889
document the upgrade version flow for self-managed #3889
Conversation
docs/self-managed/setup/upgrade.md
Outdated
:::note | ||
The recommended upgrade path for any given installation is to the **latest patch** release of the **next minor version**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to see a review from the Distribution team, specifically for this note. Specifically because in the update instructions we mention the following:
When updating from one minor version to the next, you do not need to update to each patch version along the way. However, do not skip minor versions when updating.
Should we also mention (again), in this PR, that you should not skip minor versions? Or do we think this is clear enough as is?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hamza-m-masood, can we get your review here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry @akeller , you'll just have to put up with a review from me 😜 .
I do not find the two statements:
(statement A)
When updating from one minor version to the next, you do not need to update to each patch version along the way. However, do not skip minor versions when updating.
and
(statement B)
The recommended upgrade path for any given installation is to the latest patch release of the next minor version.
to be contradictory. I think the difference between them is that one states what not to do, and the other describes what to do. And I think both are clear that one minor upgrade at a time is the acceptable approach.
However, one thing that I'm realizing is that the "meaning" of a minor version is different now that we have the detached version numbers. We should re-think whether this statement is intended for people thinking about the camunda version numbers or the helm chart version numbers. if it's the helm chart version numbers, we need to say
:::note | |
The recommended upgrade path for any given installation is to the **latest patch** release of the **next minor version**. | |
:::note | |
The recommended upgrade path for any given installation is to the **latest patch** release of the **next major version**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jessesimpson36 appreciate you 🙂
Great point about the detached version numbers. The only additional thing I would add to your suggestion is to qualify that this is for Helm charts.
@conceptualshark can you have a look at this feedback and adjust the PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jessesimpson36 @akeller The original request is here - I was making the assumption it meant camunda versions, but documented on the Helm chart page. Would it be appropriate to update this note to include a specific recommendation for each?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm good with saying this page refers to major versions because we are within the context of Helm. So, we recommend the latest patch release of the next major version (of the Helm chart). I would rather not go into more detail about each. If we get more feedback on this page, we can always adjust it.
I'm reviewing this now |
I'm good with this change. I feel my comment left some points that were out of the scope of this PR, so I will approve now, and if you want to continue discussion on those points before merge, we can at your discretion. |
6816e19
Description
Clarify the recommended upgrade path for Camunda Helm charts, and clean up the Helm page introduction to match this information.
When should this change go live?
hold
label or convert to draft PR)PR Checklist