Skip to content

Commit 2e63285

Browse files
committed
Update info about installer-only annotation
1 parent 5f4b000 commit 2e63285

File tree

3 files changed

+33
-20
lines changed

3 files changed

+33
-20
lines changed
Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1-
* You must have a customer in the Replicated Vendor Portal with a valid email address. This email address is only used as a username for the Replicated registry and is never contacted. For more information about creating and editing customers in the Vendor Portal, see [Creating a Customer](/vendor/releases-creating-customer).
1+
import InstallerOnlyAnnotation from "./_installer-only-annotation.mdx"
2+
3+
* The customer used to install must have a valid email address. This email address is only used as a username for the Replicated registry and is never contacted. For more information about creating and editing customers in the Vendor Portal, see [Creating a Customer](/vendor/releases-creating-customer).
4+
5+
* The customer used to install must have the **Existing Cluster (Helm CLI)** install type enabled. For more information about enabling install types for customers in the Vendor Portal, see [Managing Install Types for a License](licenses-install-types).
6+
7+
* If the release that will be installed includes any Kubernetes resources, add the `kots.io/installer-only` annotation to each resource. It is not necessary to add the `kots.io/installer-only` annotation to any Replicated custom resources, such as the Embedded Cluster Config custom resource, the KOTS HelmChart, Config, or Application custom resources, or the Troubleshoot Preflight or SupportBundle custom resources.
8+
9+
<InstallerOnlyAnnotation/>
10+
11+
For more information, see [Understand Install Types](/vendor/licenses-install-types#install-types) in _Managing Install Types for a License_.
212

313
* To ensure that the Replicated proxy registry can be used to grant proxy access to your application images during Helm installations, you must create an image pull secret for the proxy registry and add it to your Helm chart. To do so, follow the steps in [Using the Proxy Registry with Helm Installations](/vendor/helm-image-registry).
414

5-
* (Recommended) To install the Replicated SDK alongside the application, declare the SDK as a dependency. For more information, see [Install the SDK as a Subchart](replicated-sdk-installing#install-the-sdk-as-a-subchart) in _Installing the Replicated SDK_.
15+
* Declare the SDK as a dependency in your Helm chart. For more information, see [Install the SDK as a Subchart](replicated-sdk-installing#install-the-sdk-as-a-subchart) in _Installing the Replicated SDK_.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
The `kots.io/installer-only` annotation indicates that the Kubernetes resource is used only by the Replicated installers (Embedded Cluster, KOTS, and kURL).
2+
3+
Example:
4+
```yaml
5+
apiVersion: v1
6+
kind: Service
7+
metadata:
8+
name: my-service
9+
annotations:
10+
kots.io/installer-only: "true"
11+
```

docs/vendor/licenses-install-types.mdx

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import InstallerOnlyAnnotation from "../partials/helm/_installer-only-annotation.mdx"
2+
13
# Managing Install Types for a License (Beta)
24

35
This topic describes how to manage which installation types and options are enabled for a license.
@@ -34,21 +36,25 @@ The following describes each installation type available, as well as the require
3436
<table>
3537
<tr>
3638
<th width="30%">Install Type</th>
37-
<th>Description</th>
39+
<th width="35%">Description</th>
3840
<th>Requirements</th>
3941
</tr>
4042
<tr>
4143
<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. The release can also optionally include Replicated custom resources (such as Embedded Cluster Config and KOTS HelmChart, Config, and Application).</p>
47+
<p>Any other Kubernetes resources in the release (such as Kubernetes Deployments or Services) must include the `kots.io/installer-only` annotation.</p>
48+
<InstallerOnlyAnnotation/>
49+
</td>
4450
</tr>
4551
<tr>
4652
<th>Existing Cluster (KOTS install)</th>
4753
<td>Allows the customer to install with Replicated KOTS in an existing cluster.</td>
4854
<td>
4955
<ul>
5056
<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>
57+
<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>
5258
</ul>
5359
</td>
5460
</tr>
@@ -77,20 +83,6 @@ The following describes each installation type available, as well as the require
7783
</tr>
7884
</table>
7985

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-
9486
## Understanding Additional Install Options {#install-options}
9587

9688
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

Comments
 (0)