Skip to content

Commit 767ef97

Browse files
committed
update license migration details
1 parent baa7f42 commit 767ef97

File tree

1 file changed

+34
-22
lines changed

1 file changed

+34
-22
lines changed

docs/vendor/licenses-install-types.mdx

Lines changed: 34 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This topic describes how to manage which installation types and options are enabled for a license.
44

55
:::note
6-
The "Install Types" licensing feature described in this topic is in Beta. To get access to this feature, reach out to your Replicated account rep.
6+
The "Install Types" licensing feature described in this topic is in Beta. To get access to this feature, reach out to your Replicated account representative.
77
:::
88

99
## Overview
@@ -23,7 +23,7 @@ The installation types that are enabled or disabled for a license determine the
2323

2424
Setting the supported installation types on a per-customer basis gives you greater control over the installation method used by each customer. It also allows you to provide a more curated Download Portal experience, in that customers will only see the installation assets and instructions that are relevant to them.
2525

26-
## Understanding Installation Types {#install-types}
26+
## Understanding Install Types {#install-types}
2727

2828
In the customer license, under **Install types**, the **Available install types** field allows you to enable and disable different installation methods for the customer.
2929

@@ -43,14 +43,14 @@ The following describes each installation type available, as well as the require
4343
<td>The latest release promoted to the channel where the customer is assigned must contain at least one Helm chart.</td>
4444
</tr>
4545
<tr>
46-
<th>Existing Cluster (KOTS install)</th>
47-
<td>Allows the customer to install with Replicated KOTS in an existing cluster.</td>
48-
<td>
49-
<ul>
50-
<li>Your Vendor Portal team must have the KOTS entitlement</li>
51-
<li>The latest release promoted to the channel where the customer is assigned must contain KOTS custom resources</li>
52-
</ul>
53-
</td>
46+
<th>Existing Cluster (KOTS install)</th>
47+
<td>Allows the customer to install with Replicated KOTS in an existing cluster.</td>
48+
<td>
49+
<ul>
50+
<li>Your Vendor Portal team must have the KOTS entitlement</li>
51+
<li>The latest release promoted to the channel where the customer is assigned must contain KOTS custom resources</li>
52+
</ul>
53+
</td>
5454
</tr>
5555
<tr>
5656
<th>kURL Embedded Cluster (first generation product)</th>
@@ -60,7 +60,7 @@ The following describes each installation type available, as well as the require
6060
</td>
6161
<td>
6262
<ul>
63-
<li>Your Vendor Portal team must have the KOTS/kURL entitlement</li>
63+
<li>Your Vendor Portal team must have the kURL entitlement</li>
6464
<li>A kURL installer spec must be promoted to the channel where the customer is assigned. For more information, see <a href="/vendor/packaging-embedded-kubernetes">Creating a kURL Installer</a>.</li>
6565
</ul>
6666
</td>
@@ -69,10 +69,10 @@ The following describes each installation type available, as well as the require
6969
<th>Embedded Cluster (current generation product)</th>
7070
<td>Allows the customer to install with Replicated Embedded Cluster on a VM or bare metal server.</td>
7171
<td>
72-
<ul>
73-
<li>Your Vendor Portal team must have the Embedded Cluster entitlement</li>
74-
<li>The latest release promoted to the channel where the customer is assigned must contain an Embedded Cluster Config custom resource. For more information, see <a href="/reference/embedded-config">Embedded Cluster Config</a>.</li>
75-
</ul>
72+
<ul>
73+
<li>Your Vendor Portal team must have the Embedded Cluster entitlement</li>
74+
<li>The latest release promoted to the channel where the customer is assigned must contain an Embedded Cluster Config custom resource. For more information, see <a href="/reference/embedded-config">Embedded Cluster Config</a>.</li>
75+
</ul>
7676
</td>
7777
</tr>
7878
</table>
@@ -83,14 +83,14 @@ After enabling installation types in the **Available install types** field, you
8383

8484
<table>
8585
<tr>
86-
<th width="30%">Install Type</th>
87-
<th>Description</th>
88-
<th>Requirements</th>
86+
<th width="30%">Install Type</th>
87+
<th>Description</th>
88+
<th>Requirements</th>
8989
</tr>
9090
<tr>
91-
<th>Helm CLI Air Gap Instructions (Helm CLI only)</th>
92-
<td><p>When enabled, a customer will see instructions on the Download Portal on how to pull Helm installable images into their local repository.</p><p><strong>Helm CLI Air Gap Instructions</strong> is enabled by default when you select the <strong>Existing Cluster (Helm CLI)</strong> install type.</p></td>
93-
<td>The <strong>Existing Cluster (Helm CLI)</strong> install type must be enabled</td>
91+
<th>Helm CLI Air Gap Instructions (Helm CLI only)</th>
92+
<td><p>When enabled, a customer will see instructions on the Download Portal on how to pull Helm installable images into their local repository.</p><p><strong>Helm CLI Air Gap Instructions</strong> is enabled by default when you select the <strong>Existing Cluster (Helm CLI)</strong> install type.</p></td>
93+
<td>The <strong>Existing Cluster (Helm CLI)</strong> install type must be enabled</td>
9494
</tr>
9595
<tr>
9696
<th>Air Gap Installation Option (Replicated Installers only)</th>
@@ -108,4 +108,16 @@ After enabling installation types in the **Available install types** field, you
108108

109109
## About Migrating Existing Licenses to Use Install Types
110110

111-
By default, when an existing license is migrated to include the **Install types** field, the Vendor Portal automatically enables installation types so that the customer does not experience any errors in their deployment...
111+
By default, when an existing customer license is migrated to include the Beta **Install types** field, the Vendor Portal automatically enables certain install types so that the customer does not experience any interruptions or errors in their deployment.
112+
113+
The Vendor Portal uses the following logic to enable install types for migrated licenses:
114+
115+
If the existing license has the **KOTS Install Enabled** field enabled, then the Vendor Portal enables the following install types in the migrated license by default:
116+
* Existing Cluster (Helm CLI)
117+
* Existing Cluster (KOTS install)
118+
* kURL Embedded Cluster (first generation product)
119+
* Embedded Cluster (current generation product)
120+
121+
Additionally, if the existing **KOTS Install Enabled** license also has the **Airgap Download Enabled** option enabled, then the Vendor Portal enables both of the air gap install options in the migrated license (**Helm CLI Air Gap Instructions (Helm CLI only)** and **Air Gap Installation Option (Replicated Installers only)**).
122+
123+
Otherwise, if the **KOTS Install Enabled** field is disabled for the existing license, then the Vendor Portal enables only the **Existing Cluster (Helm CLI)** install type by default. All other install types will be disabled by default.

0 commit comments

Comments
 (0)