Skip to content

Commit 5e72ae0

Browse files
kots.io/installer-only docs (#2864)
* kots.io/installer-only docs * Update licenses-install-types.mdx --------- Co-authored-by: Paige Calvert <[email protected]>
1 parent 9ec9d4a commit 5e72ae0

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/vendor/licenses-install-types.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The following describes each installation type available, as well as the require
4040
<tr>
4141
<th>Existing Cluster (Helm CLI)</th>
4242
<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 at the top level of the directory.</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>
4444
</tr>
4545
<tr>
4646
<th>Existing Cluster (KOTS install)</th>
@@ -77,6 +77,20 @@ The following describes each installation type available, as well as the require
7777
</tr>
7878
</table>
7979

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+
8094
## Understanding Additional Install Options {#install-options}
8195
8296
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)