Skip to content

Commit d532ec3

Browse files
authored
Merge pull request #2868 from replicatedhq/release-sequencing-edit
Clarify release/instance sequencing info
2 parents b92a9d9 + f42b445 commit d532ec3

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

docs/vendor/releases-about.mdx

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -116,13 +116,11 @@ The following graphic shows release sequence numbers in the Vendor Portal:
116116

117117
#### Instance Sequences
118118

119-
When a KOTS instance checks for an application update, the Vendor Portal returns a release identifier (a sequence number or a version label) to the instance. The Replicated admin console then assigns the release a unique instance sequence number. This instance sequence is separate from a release sequence in the Vendor Portal. The instance sequence in the admin console starts at 0 and increments for each release identifier that is returned when KOTS checks for an update.
119+
When a new version is available for upgrade, including when KOTS checks for upstream updates as well as when the user syncs their license or makes a config change, the KOTS Admin Console assigns a unique instance sequence number to that version. The instance sequence in the Admin Console starts at 0 and increments for each identifier that is returned when a new version is available.
120120

121-
A single release sequence, such as `181`, can have multiple instance sequences in the deployed instances, depending on when those instances came online and how many other releases were seen before release sequence `181`.
121+
This instance sequence is unrelated to the release sequence dispalyed in the Vendor Portal, and it is likely that the instance sequence will differ from the release sequence. Instance sequences are only tracked by KOTS instances, and the Vendor Portal has no knowledge of these numbers.
122122

123-
Note that instance sequences are only tracked by KOTS instances, and the Vendor Portal has no knowledge of these numbers.
124-
125-
The following graphic shows instance sequence numbers on the admin console dashboard:
123+
The following graphic shows instance sequence numbers on the Admin Console dashboard:
126124

127125
<img alt="Instance sequence numbers" src="/images/instance-sequences.png" width="550px"/>
128126

@@ -142,17 +140,17 @@ Ordering is more complex if some or all of the releases in a channel have a sema
142140

143141
#### Semantic Versioning Sequence
144142

145-
For channels with semantic versioning enabled, the admin console sequences instance releases by their semantic versions instead of their promotion dates.
143+
For channels with semantic versioning enabled, the Admin Console sequences instance releases by their semantic versions instead of their promotion dates.
146144

147-
If releases without a valid semantic version are already promoted to a channel, the admin console sorts the releases that do have semantic versions starting with the earliest version and proceeding to the latest. The releases with non-semantic versioning stay in the order of their promotion dates. For example, assume that you promote these releases in the following order to a channel:
145+
If releases without a valid semantic version are already promoted to a channel, the Admin Console sorts the releases that do have semantic versions starting with the earliest version and proceeding to the latest. The releases with non-semantic versioning stay in the order of their promotion dates. For example, assume that you promote these releases in the following order to a channel:
148146

149147
- 1.0.0
150148
- abc
151149
- 0.1.0
152150
- xyz
153151
- 2.0.0
154152

155-
Then, you enable semantic versioning on that channel. The admin console sequences the version history for the channel as follows:
153+
Then, you enable semantic versioning on that channel. The Admin Console sequences the version history for the channel as follows:
156154

157155
- 0.1.0
158156
- 1.0.0
@@ -245,4 +243,4 @@ You can do the following tasks on the **Draft** page:
245243

246244
- Select the Config custom resource to preview how your application's Config page will look to your customers. The **Config preview** pane only appears when you select that file. For more information, see [About the Configuration Screen](config-screen-about).
247245

248-
- Select the Application custom resource to preview how your application icon will look in the admin console. The **Application icon preview** only appears when you select that file. For more information, see [Customizing the Application Icon](admin-console-customize-app-icon).
246+
- Select the Application custom resource to preview how your application icon will look in the Admin Console. The **Application icon preview** only appears when you select that file. For more information, see [Customizing the Application Icon](admin-console-customize-app-icon).

0 commit comments

Comments
 (0)