You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/vendor/licenses-install-types.mdx
+34-22Lines changed: 34 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
This topic describes how to manage which installation types and options are enabled for a license.
4
4
5
5
:::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.
7
7
:::
8
8
9
9
## Overview
@@ -23,7 +23,7 @@ The installation types that are enabled or disabled for a license determine the
23
23
24
24
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.
In the customer license, under **Install types**, the **Available install types** field allows you to enable and disable different installation methods for the customer.
29
29
@@ -43,14 +43,14 @@ The following describes each installation type available, as well as the require
43
43
<td>The latest release promoted to the channel where the customer is assigned must contain at least one Helm chart.</td>
44
44
</tr>
45
45
<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>
@@ -60,7 +60,7 @@ The following describes each installation type available, as well as the require
60
60
</td>
61
61
<td>
62
62
<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>
64
64
<li>A kURL installer spec must be promoted to the channel where the customer is assigned. For more information, see <ahref="/vendor/packaging-embedded-kubernetes">Creating a kURL Installer</a>.</li>
65
65
</ul>
66
66
</td>
@@ -69,10 +69,10 @@ The following describes each installation type available, as well as the require
<td>Allows the customer to install with Replicated Embedded Cluster on a VM or bare metal server.</td>
71
71
<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 <ahref="/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 <ahref="/reference/embedded-config">Embedded Cluster Config</a>.</li>
75
+
</ul>
76
76
</td>
77
77
</tr>
78
78
</table>
@@ -83,14 +83,14 @@ After enabling installation types in the **Available install types** field, you
83
83
84
84
<table>
85
85
<tr>
86
-
<thwidth="30%">Install Type</th>
87
-
<th>Description</th>
88
-
<th>Requirements</th>
86
+
<thwidth="30%">Install Type</th>
87
+
<th>Description</th>
88
+
<th>Requirements</th>
89
89
</tr>
90
90
<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>
94
94
</tr>
95
95
<tr>
96
96
<th>Air Gap Installation Option (Replicated Installers only)</th>
@@ -108,4 +108,16 @@ After enabling installation types in the **Available install types** field, you
108
108
109
109
## About Migrating Existing Licenses to Use Install Types
110
110
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:
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