|
| 1 | +import InstallerOnlyAnnotation from "../partials/helm/_installer-only-annotation.mdx" |
| 2 | + |
1 | 3 | # Managing Install Types for a License (Beta) |
2 | 4 |
|
3 | 5 | This topic describes how to manage which installation types and options are enabled for a license. |
@@ -34,21 +36,24 @@ The following describes each installation type available, as well as the require |
34 | 36 | <table> |
35 | 37 | <tr> |
36 | 38 | <th width="30%">Install Type</th> |
37 | | - <th>Description</th> |
| 39 | + <th width="35%">Description</th> |
38 | 40 | <th>Requirements</th> |
39 | 41 | </tr> |
40 | 42 | <tr> |
41 | 43 | <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 only Helm charts and Replicated Custom Resources. Any other Kubernetes resources must include the `kots.io/installer-only` annotation. See <a href="#installer-only-annotation">kots.io/installer-only Annotation</a> below.</td> |
| 44 | + <td><p>Allows the customer to install with Helm in an existing cluster. The customer does not have access to the Replicated installers (Embedded Cluster, KOTS, and kURL).</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> |
| 45 | + <td> |
| 46 | + <p>The latest release promoted to the channel where the customer is assigned must contain one or more Helm charts. It can also include Replicated custom resources, such as the Embedded Cluster Config custom resource, the KOTS HelmChart, Config, and Application custom resources, or the Troubleshoot Preflight and SupportBundle custom resources.</p> |
| 47 | + <InstallerOnlyAnnotation/> |
| 48 | + </td> |
44 | 49 | </tr> |
45 | 50 | <tr> |
46 | 51 | <th>Existing Cluster (KOTS install)</th> |
47 | 52 | <td>Allows the customer to install with Replicated KOTS in an existing cluster.</td> |
48 | 53 | <td> |
49 | 54 | <ul> |
50 | 55 | <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> |
| 56 | + <li>The latest release promoted to the channel where the customer is assigned must contain KOTS custom resources, such as the KOTS HelmChart, Config, and Application custom resources. For more information, see [About Custom Resources](/reference/custom-resource-about).</li> |
52 | 57 | </ul> |
53 | 58 | </td> |
54 | 59 | </tr> |
@@ -77,20 +82,6 @@ The following describes each installation type available, as well as the require |
77 | 82 | </tr> |
78 | 83 | </table> |
79 | 84 |
|
80 | | -### `kots.io/installer-only` Annotation {#installer-only-annotation} |
81 | | - |
82 | | -The `kots.io/installer-only` annotation indicates that the Kubernetes resource is only used by the Replicated installers (Embedded Cluster, KOTS, or kURL). This annotation is required for releases that support the `Existing Cluster (Helm CLI)` install type and include resources other than Helm charts. |
83 | | - |
84 | | -Example: |
85 | | -```yaml |
86 | | -apiVersion: v1 |
87 | | -kind: Service |
88 | | -metadata: |
89 | | - name: my-service |
90 | | - annotations: |
91 | | - kots.io/installer-only: "true" |
92 | | -``` |
93 | | -
|
94 | 85 | ## Understanding Additional Install Options {#install-options} |
95 | 86 |
|
96 | 87 | After enabling installation types in the **Available install types** field, you can also enable the following options in the **Additional install options** field: |
|
0 commit comments