Skip to content

Commit 29d2995

Browse files
authored
Merge pull request #3507 from replicatedhq/required-releases-update
Marking a release as no longer required in KOTS 1.126.0 and later
2 parents 45c9ae4 + 5bd71f2 commit 29d2995

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
When a release is required, KOTS requires users to upgrade to that version before they can upgrade to a later version. For example, if you select **Prevent this release from being skipped during upgrades** for release v2.0.0, users with v1.0.0 deployed must upgrade to v2.0.0 before they can upgrade to a version later than v2.0.0, such as v2.1.0.
1+
When a release is marked as required, users must upgrade to the required release version before they can upgrade to a later version. For example, if 2.0.0 is a required release, users with 1.5.0 deployed must upgrade to 2.0.0 before they can upgrade to 2.1.0.
2+
3+
For online (internet-connected) installations using KOTS 1.126.0 or later, you can disable the **Prevent this release from being skipped during upgrades** option for a release to mark the release as no longer required. The requirement will be removed from the given release in the Admin Console the next time that an upstream update check occurs.

docs/partials/releases/_required-releases-limitations.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,7 @@ Required releases have the following limitations:
33
* Required releases are supported in KOTS v1.68.0 and later.
44
* 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.
55
* 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_.
6-
* Required releases are supported for KOTS installations only and are not supported for releases installed with Helm. The **Prevent this release from being skipped during upgrades** option has no affect if the user installs with Helm.
6+
* Required releases are not supported for Helm CLI installations. The **Prevent this release from being skipped during upgrades** option has no affect when the user installs with Helm.
7+
* For installations using KOTS 1.125.2 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.
8+
9+
To skip a previously required release during upgrades, users must first update their installation to KOTS 1.126.0 or later. In KOTS 1.126.0 and later, release metadata in the Admin Console (including the release's requirement status) is updated during upstream update checks.

0 commit comments

Comments
 (0)