Skip to content

Commit b22cb8c

Browse files
authored
Merge pull request #3000 from replicatedhq/florianhines/sc-118260/demote-channel-release-ui
Add documentation for channel release demotion
2 parents 7fcd06b + 6045182 commit b22cb8c

File tree

3 files changed

+29
-4
lines changed

3 files changed

+29
-4
lines changed

docs/vendor/releases-about.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,14 @@ If you enable semantic versioning for a channel and then promote releases to it,
179179

180180
You can enable semantic versioning on a channel that already has releases promoted to it without semantic versioning. Any subsequently promoted releases must use semantic versioning. In this case, the channel will have releases with and without semantic version numbers. For information about how Replicated organizes these release sequences, see [Semantic Versioning Sequences](#semantic-versioning-sequence).
181181

182+
### Demotion
183+
184+
A channel release can be demoted from a channel. When a channel release is demoted, the release is longer available for download, but is not withdrawn from environments where it was already downloaded or installed.
185+
186+
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.
187+
188+
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_.
189+
182190
## Vendor Portal Pages
183191

184192
This section provides information about the channels and releases pages in the Vendor Portal.
@@ -205,7 +213,7 @@ As shown in the image above, you can do the following from the **Channels** page
205213

206214
Click **Release history** to access the history of all releases promoted to the channel. From the **Release History** page, you can view the version labels and files in each release that has been promoted to the selected channel.
207215

208-
You can also build and download air gap bundles to be used in air gap installations with Replicated installers (Embedded Cluster, KOTS, kURL), and edit the release properties for each release promoted to the channel from the **Release History** page.
216+
You can also build and download air gap bundles to be used in air gap installations with Replicated installers (Embedded Cluster, KOTS, kURL), edit the release properties for each release promoted to the channel from the **Release History** page, and demote a release from the channel.
209217

210218
The following shows an example of the **Release History** page:
211219

docs/vendor/releases-creating-releases.mdx

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,14 +91,14 @@ To edit release properties:
9191

9292
1. Go to **Channels**.
9393
1. In the channel where the release was promoted, click **Release History**.
94-
1. For the release sequence that you want to edit, click **Edit Release**.
94+
1. For the release sequence that you want to edit, open the dot menu and click **Edit release**.
9595
1. Edit the properties as needed.
9696
<img src="/images/release-properties.png" alt="Release Properties dialog in the Vendor Portal" width="300"/>
9797

9898
[View a larger image](/images/release-properties.png)
9999
1. Click **Update Release**.
100100

101-
## Archiving Releases
101+
## Archive a Release
102102

103103
You can archive releases to remove them from view on the **Releases** page. Archiving a release that has been promoted does _not_ remove the release from the channel's **Release History** page or prevent KOTS from downloading the archived release.
104104

@@ -107,4 +107,21 @@ To archive one or more releases:
107107
1. From the **Releases** page, click the trash can icon in the upper right corner.
108108
1. Select one or more releases.
109109
1. Click **Archive Releases**.
110-
1. Confirm the archive action when prompted.
110+
1. Confirm the archive action when prompted.
111+
112+
## Demote a Release
113+
114+
A channel release can be demoted from a channel. When a channel release is demoted, the release is longer available for download, but is not withdrawn from environments where it was already downloaded or installed. For more information, see [Demotion](/vendor/releases-about#demotion) in _About Channels and Releases_.
115+
116+
For information about demoting and un-demoting releases with the Replicated CLI, see [channel demote](/reference/replicated-cli-channel-demote) and [channel un-demote](/reference/replicated-cli-channel-un-demote).
117+
118+
To demote a release in the Vendor Portal:
119+
120+
1. Go to **Channels**.
121+
1. In the channel where the release was promoted, click **Release History**.
122+
1. For the release sequence that you want to demote, open the dot menu and select **Demote Release**.
123+
124+
![Release history page](/images/channels-release-history.png)
125+
[View a larger version of this image](/images/channels-release-history.png)
126+
127+
After the release is demoted, the given release sequence is greyed out and a **Demoted** label is displayed next to the release on the **Release History** page.
-240 KB
Loading

0 commit comments

Comments
 (0)