Skip to content

Commit b6f20fb

Browse files
committed
doc the release metadata improvements for admin console
1 parent 7b62993 commit b6f20fb

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-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 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 2.0.0, users with 1.5.0 deployed must upgrade to 2.0.0 before they can upgrade to 2.1.0.
2+
3+
You can disable the **Prevent this release from being skipped during upgrades** option after promoting a release if needed to allow users to skip the release during upgrades. After a release's properties are changed in the Vendor Portal, its metadata is updated in the Admin Console the next time that an upstream update occurs.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ 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.

0 commit comments

Comments
 (0)