Skip to content

Commit baa7f42

Browse files
paigecalvertpaigecalvert
committed
edits
1 parent 713fc32 commit baa7f42

File tree

1 file changed

+82
-29
lines changed

1 file changed

+82
-29
lines changed

‎docs/vendor/licenses-install-types.mdx‎

Lines changed: 82 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,42 +17,95 @@ The following shows an example of the **Install types** field in a license:
1717
[View a larger version of this image](/images/license-install-types.png)
1818

1919
The installation types that are enabled or disabled for a license determine the following:
20-
* The Replicated installers (Replicated KOTS, Replicated Embedded Cluster, Replicated kURL) that the customer's license entitles them to use
20+
* The Replicated installers ([Replicated KOTS](../intro-kots), [Replicated Embedded Cluster](/vendor/embedded-cluster-overview), [Replicated kURL](/vendor/intro-kurl)) that the customer's license entitles them to use
2121
* The installation assets and/or instructions provided in the Replicated Download Portal for the customer
2222
* The customer's KOTS Admin Console experience
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-
### About Available Install Types
27-
28-
The **Available install types** license field provides the following options:
29-
* **Existing Cluster (Helm CLI):** Show instructions in the Download Portal for installing with Helm CLI. Requires that the latest release promoted to the channel where the customer is assigned contains a Helm chart.
30-
* **Existing Cluster (KOTS install):** Allow the customer to install with Replicated KOTS in an existing cluster. This field has the following requirements:
31-
* Your Vendor Portal team must have the KOTS entitlement
32-
* The latest release promoted to the channel where the customer is assigned must contain KOTS custom resources
33-
* **kURL Embedded Cluster (first generation product):** Allow the customer to install with Replicated kURL. This field has the following requirements:
34-
* Your Vendor Portal team must have the KOTS/kURL entitlement
35-
* A kURL installer spec must be promoted to the channel where the customer is assigned
36-
* **Embedded Cluster (current generation product):** Allow the customer to install with Replicated Embedded Cluster. This field has the following requirements:
37-
* Your Vendor Portal team must have the Embedded Cluster entitlement
38-
* The latest release promoted to the channel where the customer is assigned must contain an Embedded Cluster Config custom resource
39-
40-
### About Additional Install Options
26+
## Understanding Installation Types {#install-types}
27+
28+
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+
30+
You can enable one or more installation types for a license.
31+
32+
The following describes each installation type available, as well as the requirements for enabling each type:
33+
34+
<table>
35+
<tr>
36+
<th width="30%">Install Type</th>
37+
<th>Description</th>
38+
<th>Requirements</th>
39+
</tr>
40+
<tr>
41+
<th>Existing Cluster (Helm CLI)</th>
42+
<td><p>The customer does not have access to the Replicated installers.</p><p>When the <strong>Helm CLI Air Gap Instructions (Helm CLI only)</strong> install option is also enabled, the Download Portal displays instructions on how to pull Helm installable images into a local repository. See <a href="#install-options">Understanding Additional Install Options</a> below.</p></td>
43+
<td>The latest release promoted to the channel where the customer is assigned must contain at least one Helm chart.</td>
44+
</tr>
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>
54+
</tr>
55+
<tr>
56+
<th>kURL Embedded Cluster (first generation product)</th>
57+
<td>
58+
<p>Allows the customer to install with Replicated kURL on a VM or bare metal server.</p>
59+
<p><strong>Note:</strong> For new installations, enable Replicated Embedded Cluster (current generation product) instead of Replicated kURL (first generation product).</p>
60+
</td>
61+
<td>
62+
<ul>
63+
<li>Your Vendor Portal team must have the KOTS/kURL entitlement</li>
64+
<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>
65+
</ul>
66+
</td>
67+
</tr>
68+
<tr>
69+
<th>Embedded Cluster (current generation product)</th>
70+
<td>Allows the customer to install with Replicated Embedded Cluster on a VM or bare metal server.</td>
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 <a href="/reference/embedded-config">Embedded Cluster Config</a>.</li>
75+
</ul>
76+
</td>
77+
</tr>
78+
</table>
79+
80+
## Understanding Additional Install Options {#install-options}
4181

4282
After enabling installation types in the **Available install types** field, you can also enable the following options in the **Additional install options** field:
4383

44-
* **Helm CLI Air Gap Instructions (Helm CLI only):** When enabled, a customer will see instructions on the Download Portal on how to pull Helm installable images into their local repository. **Helm CLI Air Gap Instructions** is enabled by default when you select the **Existing Cluster (Helm CLI)** install type.
45-
46-
* **Air Gap Installation Option (Replicated Installers only):** When enabled, new installations with this license will have an option to install from an air gap package or from a traditional online installation. Selecting this controls whether a customer sees this option in their Download Portal.
47-
48-
### How Install Types Determine the Download Portal Experience
49-
50-
Helm CLI Install + Helm Airgap = show the helm airgap install instructions
51-
Existing Cluster (KOTS install) + Airgap = show existing cluster airgap instructions
52-
kURL + Air Gap = show kURL air gap instructions
53-
Embedded Cluster + Airgap=False = Show online install instructions only
54-
Embedded Cluster + Airgap=True = Show instructions on air gap environment installation
55-
56-
## About Migrating Existing Licenses to Include Install Types
84+
<table>
85+
<tr>
86+
<th width="30%">Install Type</th>
87+
<th>Description</th>
88+
<th>Requirements</th>
89+
</tr>
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>
94+
</tr>
95+
<tr>
96+
<th>Air Gap Installation Option (Replicated Installers only)</th>
97+
<td><p>When enabled, new installations with this license have an option in their Download Portal to install from an air gap package or do a traditional online installation.</p></td>
98+
<td>
99+
<p>At least one of the following Replicated install types must be enabled:</p>
100+
<ul>
101+
<li>Existing Cluster (KOTS install)</li>
102+
<li>kURL Embedded Cluster (first generation product)</li>
103+
<li>Embedded Cluster (current generation product)</li>
104+
</ul>
105+
</td>
106+
</tr>
107+
</table>
108+
109+
## About Migrating Existing Licenses to Use Install Types
57110

58111
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...

0 commit comments

Comments
 (0)