Document customer-facing required releases behavior #3647
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
paigecalvert
commented
Nov 17, 2025
| <VersionLabelReqsHelm/> | ||
|
|
||
| * **Requirements**: Select **Prevent this release from being skipped during upgrades** to mark the release as required. | ||
| * **Requirements**: Enable **Prevent this release from being skipped during upgrades** to mark the release as required. For more information, [Required Releases](#required-releases). |
Contributor
Author
There was a problem hiding this comment.
^ link down to new section
paigecalvert
commented
Nov 17, 2025
| ### Required Releases | ||
|
|
||
| * **Release notes (supports markdown)**: Detailed release notes for the release. The release notes support markdown and are shown to your customer. | ||
| You can enable the **Prevent this release from being skipped during upgrades** release property to mark a release as required. The following describes the end customer experience for required releases in the Admin Console and Enterprise Portal: |
Contributor
Author
There was a problem hiding this comment.
The following describes the end customer experience for required releases in the Admin Console and Enterprise Portal:
Decided to split this out by user interface: how are they handled in the Admin Console and in the Enterprise Portal?
paigecalvert
commented
Nov 17, 2025
| * **Release notes (supports markdown)**: Detailed release notes for the release. The release notes support markdown and are shown to your customer. | ||
|
|
||
| <RequiredReleasesLimitations/> | ||
| ### Required Releases |
paigecalvert
commented
Nov 17, 2025
|
|
||
| Required releases have the following limitations: | ||
|
|
||
| * Required releases are not enforced for Helm CLI installations. When the **Prevent this release from being skipped during upgrades** option is enabled, Helm CLI customers will see that the release is labeled as "required" in the Enterprise Portal. However, this label does not prevent users from skipping a required release version when installing with the Helm CLI. |
Contributor
Author
There was a problem hiding this comment.
^ edited this one a bit to say that required releases are not enforced for Helm CLI installs. Previously, it said they weren't supported for Helm CLI installs. This didn't seem accurate because they are still labeled as required in the Enterprise Portal for Helm CLI customers. And, they don't break anything.
paigecalvert
commented
Nov 17, 2025
| * Required releases are not enforced for Helm CLI installations. When the **Prevent this release from being skipped during upgrades** option is enabled, Helm CLI customers will see that the release is labeled as "required" in the Enterprise Portal. However, this label does not prevent users from skipping a required release version when installing with the Helm CLI. | ||
| * After users deploy a required version, they can no longer redeploy (roll back to) versions earlier than the required version, even if `allowRollback` is true in the Application custom resource manifest. For more information, see [`allowRollback`](/reference/custom-resource-application#allowrollback) in the Application custom resource topic. | ||
| * If you change the channel an existing customer is assigned to, the Admin Console always fetches the latest release on the new channel, regardless of any required releases on the channel. For more information, see [Channel Assignment](licenses-about#channel-assignment) in _About Customers_. | ||
| * For installations using KOTS 1.125.2 or earlier (Embedded Cluster 2.9.0 or earlier), if you disable the **Prevent this release from being skipped during upgrades** option for a promoted release, the release will still be marked as required in the Admin Console, and users must still upgrade to the given version before they can upgrade to later versions. To skip a previously-required release during upgrades, users must first update their installation to KOTS 1.126.0 or later (Embedded Cluster 2.10.0 or later). For more information, see [Remove Release Requirement](/vendor/releases-creating-releases#remove-req) in _Manage Releases with the Vendor Portal_. |
Contributor
Author
There was a problem hiding this comment.
For more information, see Remove Release Requirement in Manage Releases with the Vendor Portal.
link to the how-to for more info
paigecalvert
commented
Nov 17, 2025
| ::: | ||
| 1. Click **Update Release**. | ||
|
|
||
| ## Remove Release Requirement {#remove-req} |
Contributor
Author
There was a problem hiding this comment.
split this out into it's own procedure to give a little more space to explain how it works
seemed like users might land here when looking for info about enabling/disabling release properties
paigecalvert
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previews: