From ce3365deef41c5a37ef6597eb970c961871c5a22 Mon Sep 17 00:00:00 2001 From: divolgin Date: Wed, 27 Nov 2024 14:00:00 -0800 Subject: [PATCH 1/2] kots.io/installer-only docs --- docs/vendor/licenses-install-types.mdx | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/vendor/licenses-install-types.mdx b/docs/vendor/licenses-install-types.mdx index dfe3b752cf..e5ca5de201 100644 --- a/docs/vendor/licenses-install-types.mdx +++ b/docs/vendor/licenses-install-types.mdx @@ -40,7 +40,7 @@ The following describes each installation type available, as well as the require Existing Cluster (Helm CLI)

The customer does not have access to the Replicated installers.

When the Helm CLI Air Gap Instructions (Helm CLI only) install option is also enabled, the Download Portal displays instructions on how to pull Helm installable images into a local repository. See Understanding Additional Install Options below.

- 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. + 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 `kots.io/installer-only` annotation. See The kots.io/installer-only Annotation below. Existing Cluster (KOTS install) @@ -77,6 +77,20 @@ The following describes each installation type available, as well as the require +### The `kots.io/installer-only` Annotation {#installer-only-annotation} + +The `kots.io/installer-only` annotation is used to indicate that the Kubernetes resource is only used by the Replicated installer. This annotation is required for releases that include resources other than Helm charts but still want to use the `Existing Cluster (Helm CLI)` install type. + +Example: +```yaml +apiVersion: v1 +kind: Service +metadata: + name: my-service + annotations: + kots.io/installer-only: "true" +``` + ## Understanding Additional Install Options {#install-options} After enabling installation types in the **Available install types** field, you can also enable the following options in the **Additional install options** field: From 6f212303c302a4f000afebdfe5bd3a60659814cd Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 2 Dec 2024 11:45:31 -0700 Subject: [PATCH 2/2] Update licenses-install-types.mdx --- docs/vendor/licenses-install-types.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/vendor/licenses-install-types.mdx b/docs/vendor/licenses-install-types.mdx index e5ca5de201..20e9917df6 100644 --- a/docs/vendor/licenses-install-types.mdx +++ b/docs/vendor/licenses-install-types.mdx @@ -40,7 +40,7 @@ The following describes each installation type available, as well as the require Existing Cluster (Helm CLI)

The customer does not have access to the Replicated installers.

When the Helm CLI Air Gap Instructions (Helm CLI only) install option is also enabled, the Download Portal displays instructions on how to pull Helm installable images into a local repository. See Understanding Additional Install Options below.

- 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 `kots.io/installer-only` annotation. See The kots.io/installer-only Annotation below. + 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 kots.io/installer-only Annotation below. Existing Cluster (KOTS install) @@ -77,9 +77,9 @@ The following describes each installation type available, as well as the require -### The `kots.io/installer-only` Annotation {#installer-only-annotation} +### `kots.io/installer-only` Annotation {#installer-only-annotation} -The `kots.io/installer-only` annotation is used to indicate that the Kubernetes resource is only used by the Replicated installer. This annotation is required for releases that include resources other than Helm charts but still want to use the `Existing Cluster (Helm CLI)` install type. +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. Example: ```yaml