Skip to content

Marking a release as no longer required in KOTS 1.126.0 and later #3507

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Sep 3, 2025
Merged

Marking a release as no longer required in KOTS 1.126.0 and later #3507

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b6f20fb
doc the release metadata improvements for admin console
paigecalvert Sep 2, 2025
1e66429
edit
paigecalvert Sep 2, 2025
03165b9
edits
paigecalvert Sep 3, 2025
ce23216
edits
paigecalvert Sep 3, 2025
5bd71f2
add limitation
paigecalvert Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/partials/releases/_required-releases-description.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
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.
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.

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.
2 changes: 1 addition & 1 deletion docs/partials/releases/_required-releases-limitations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Required releases have the following limitations:
* Required releases are supported in KOTS v1.68.0 and later.
* 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_.
* 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.
* 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.
Copy link
Contributor Author

@paigecalvert paigecalvert Sep 3, 2025

Choose a reason for hiding this comment

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

Was drafting this new limitation to clarify how the requirement status doesn't get updated after an upstream update check in 1.125.2 and earlier:

  • 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.

Wasn't sure if there is some sort of workaround in this case (ie, the status doesn't change in the Admin Console but you can skip the previously required version if you upgrade from the CLI or something), or if you'd just need to upgrade to KOTS 1.126.0.

Copy link
Member

@ajp-io ajp-io Sep 3, 2025

Choose a reason for hiding this comment

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

you'd have to upgrade to KOTS. once KOTS knows about a version, it never processes it again. so it'll say, oh i know about netbox 1.2.3, and i know it's required, so you have to deploy it. and netbox can change that upstream, but kots will never change. (until now of course.)

Copy link
Contributor Author

@paigecalvert paigecalvert Sep 3, 2025

Choose a reason for hiding this comment

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

Gotcha. I'll add one more sentence to make sure that's clear