From 2e63285fbfa6403f500dc12d643699e23f82c6cb Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 3 Dec 2024 14:57:17 -0700 Subject: [PATCH 1/3] Update info about installer-only annotation --- docs/partials/helm/_helm-install-prereqs.mdx | 14 ++++++++-- .../helm/_installer-only-annotation.mdx | 11 ++++++++ docs/vendor/licenses-install-types.mdx | 28 +++++++------------ 3 files changed, 33 insertions(+), 20 deletions(-) create mode 100644 docs/partials/helm/_installer-only-annotation.mdx diff --git a/docs/partials/helm/_helm-install-prereqs.mdx b/docs/partials/helm/_helm-install-prereqs.mdx index 2855f83967..98af7b7bc1 100644 --- a/docs/partials/helm/_helm-install-prereqs.mdx +++ b/docs/partials/helm/_helm-install-prereqs.mdx @@ -1,5 +1,15 @@ -* 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). +import InstallerOnlyAnnotation from "./_installer-only-annotation.mdx" + +* 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). + +* 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). + +* 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. + + + + For more information, see [Understand Install Types](/vendor/licenses-install-types#install-types) in _Managing Install Types for a License_. * 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). -* (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_. \ No newline at end of file +* 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_. \ No newline at end of file diff --git a/docs/partials/helm/_installer-only-annotation.mdx b/docs/partials/helm/_installer-only-annotation.mdx new file mode 100644 index 0000000000..beedd26aad --- /dev/null +++ b/docs/partials/helm/_installer-only-annotation.mdx @@ -0,0 +1,11 @@ +The `kots.io/installer-only` annotation indicates that the Kubernetes resource is used only by the Replicated installers (Embedded Cluster, KOTS, and kURL). + +Example: +```yaml +apiVersion: v1 +kind: Service +metadata: + name: my-service + annotations: + kots.io/installer-only: "true" +``` \ No newline at end of file diff --git a/docs/vendor/licenses-install-types.mdx b/docs/vendor/licenses-install-types.mdx index 20e9917df6..90cc130350 100644 --- a/docs/vendor/licenses-install-types.mdx +++ b/docs/vendor/licenses-install-types.mdx @@ -1,3 +1,5 @@ +import InstallerOnlyAnnotation from "../partials/helm/_installer-only-annotation.mdx" + # Managing Install Types for a License (Beta) This topic describes how to manage which installation types and options are enabled for a license. @@ -34,13 +36,17 @@ The following describes each installation type available, as well as the require - + - - + + @@ -48,7 +54,7 @@ The following describes each installation type available, as well as the require @@ -77,20 +83,6 @@ The following describes each installation type available, as well as the require
Install TypeDescriptionDescription Requirements
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 the `kots.io/installer-only` annotation. See kots.io/installer-only Annotation below.

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

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

+

Any other Kubernetes resources in the release (such as Kubernetes Deployments or Services) must include the `kots.io/installer-only` annotation.

+ +
Existing Cluster (KOTS install)
  • Your Vendor Portal team must have the KOTS entitlement
    • -
  • The latest release promoted to the channel where the customer is assigned must contain KOTS custom resources
    • +
  • 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).
-### `kots.io/installer-only` Annotation {#installer-only-annotation} - -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 -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 d2313a3b4ce631ddf31693d803b1ff91cb0d912b Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 3 Dec 2024 15:53:32 -0700 Subject: [PATCH 2/3] edits --- docs/partials/helm/_helm-install-prereqs.mdx | 4 +--- docs/partials/helm/_installer-only-annotation.mdx | 2 ++ docs/vendor/licenses-install-types.mdx | 3 +-- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/partials/helm/_helm-install-prereqs.mdx b/docs/partials/helm/_helm-install-prereqs.mdx index 98af7b7bc1..0d07abd298 100644 --- a/docs/partials/helm/_helm-install-prereqs.mdx +++ b/docs/partials/helm/_helm-install-prereqs.mdx @@ -4,12 +4,10 @@ import InstallerOnlyAnnotation from "./_installer-only-annotation.mdx" * 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). -* 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. +* The release that will be installed must include 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. - For more information, see [Understand Install Types](/vendor/licenses-install-types#install-types) in _Managing Install Types for a License_. - * 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). * 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_. \ No newline at end of file diff --git a/docs/partials/helm/_installer-only-annotation.mdx b/docs/partials/helm/_installer-only-annotation.mdx index beedd26aad..e63ec7ae0d 100644 --- a/docs/partials/helm/_installer-only-annotation.mdx +++ b/docs/partials/helm/_installer-only-annotation.mdx @@ -1,3 +1,5 @@ +Any other Kubernetes resources in the release (such as Kubernetes Deployments or Services) must include the `kots.io/installer-only` annotation. + The `kots.io/installer-only` annotation indicates that the Kubernetes resource is used only by the Replicated installers (Embedded Cluster, KOTS, and kURL). Example: diff --git a/docs/vendor/licenses-install-types.mdx b/docs/vendor/licenses-install-types.mdx index 90cc130350..ed7f97e42d 100644 --- a/docs/vendor/licenses-install-types.mdx +++ b/docs/vendor/licenses-install-types.mdx @@ -43,8 +43,7 @@ The following describes each installation type available, as well as the require Existing Cluster (Helm CLI)

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

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

-

Any other Kubernetes resources in the release (such as Kubernetes Deployments or Services) must include the `kots.io/installer-only` annotation.

+

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.

From 2f212c57d485f48f99125c8b29bfb0b721b9952c Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 3 Dec 2024 16:05:30 -0700 Subject: [PATCH 3/3] remove installer-only from prereqs --- docs/partials/helm/_helm-install-prereqs.mdx | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/partials/helm/_helm-install-prereqs.mdx b/docs/partials/helm/_helm-install-prereqs.mdx index 0d07abd298..40f9d540c9 100644 --- a/docs/partials/helm/_helm-install-prereqs.mdx +++ b/docs/partials/helm/_helm-install-prereqs.mdx @@ -1,13 +1,7 @@ -import InstallerOnlyAnnotation from "./_installer-only-annotation.mdx" - * 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). * 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). -* The release that will be installed must include 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. - - - * 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). * 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_. \ No newline at end of file