Skip to content

Commit d8d9ed0

Browse files
authored
Merge pull request #3434 from replicatedhq/clarify-demotion
clarify how release demotion works for each installer
2 parents 522acb0 + dd55b49 commit d8d9ed0

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/vendor/releases-about.mdx

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,30 @@ A release cannot be edited after it is promoted to a channel. This means that yo
7676

7777
### Demotion
7878

79-
A channel release can be demoted from a channel. When a channel release is demoted, the release is no longer available for download, but is not withdrawn from environments where it was already downloaded or installed.
79+
A release can be demoted from a channel. When a release is demoted, the release is no longer available for download, but is _not_ withdrawn from environments where it was already downloaded or installed. The reason you would demote a release is to prevent customers from fetching the release when they check for new versions of your application.
8080

8181
The demoted release's channel sequence and version are not reused. For customers, the release will appear to have been skipped. Un-demoting a release will restore its place in the channel sequence making it again available for download and installation.
8282

8383
For information about how to demote a release, see [Demote a Release](/vendor/releases-creating-releases#demote-a-release) in _Managing Releases with the Vendor Portal_.
8484

85+
The following describes how each installation method handles a demoted release:
86+
87+
* **Helm CLI**: When a release is demoted, it is no longer listed in the customer's Enterprise Portal as available for update, unless the customer had already downloaded the release before it was demoted.
88+
89+
* **Embedded Cluster**: Embedded Cluster fetches available upstream releases, but does not automatically download them. Therefore, when a release is demoted, it is removed from the list of available updates in the Admin Console the next time that an upstream version check occurs, unless the customer had already deployed the release before it was demoted.
90+
91+
* **Existing Cluster KOTS and kURL**: After the Admin Console checks for upstream updates, it automatically downloads metadata for the newly-available releases. Therefore, whether or not the customer can see a demoted release in the Admin Console depends on the last time the customer checked for updates:
92+
* If the customer checked for updates and fetched a release _before_ it was demoted, then the release will remain listed in the Admin Console the next time an update check occurs. This is because a release cannot be withdrawn from the customer’s environment after it has been downloaded.
93+
* If the customer checks for udpates _after_ a release was demoted, then the demoted release is not fetched and is not listed in the Admin Console.
94+
95+
### Archived Releases
96+
97+
You can archive releases to remove them from view on the Vendor Portal **Releases** page. Archiving a release that has been promoted does _not_ remove the release from the channel's **Release History** page or prevent customers from being able to fetch the release.
98+
99+
Archiving a release is most useful when you want to reduce the number of releases that you see on the **Releases** page, while ensuring that all of the archived releases are still available for use.
100+
101+
For information about how to demote a release, see [Archive a Release](/vendor/releases-creating-releases#archive-a-release) in _Managing Releases with the Vendor Portal_.
102+
85103
### Release Properties
86104

87105
Each release has properties. You define release properties when you promote a release to a channel. You can edit release properties at any time from the channel **Release History** page in the Vendor Portal. For more information, see [Edit Release Properties](releases-creating-releases#edit-release-properties) in _Managing Releases with the Vendor Portal_.

0 commit comments

Comments
 (0)