Skip to content

Update info about installer-only annotation #2869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 3, 2024
Merged

Update info about installer-only annotation #2869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e63285
Update info about installer-only annotation
paigecalvert Dec 3, 2024
d2313a3
edits
paigecalvert Dec 3, 2024
2f212c5
remove installer-only from prereqs
paigecalvert Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/partials/helm/_helm-install-prereqs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
* 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).
* 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).
Copy link
Contributor Author

@paigecalvert paigecalvert Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ Added this prerequisite to enable the Helm CLI install type for the customer.


* 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_.
* 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_.
13 changes: 13 additions & 0 deletions docs/partials/helm/_installer-only-annotation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
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:
```yaml
apiVersion: v1
kind: Service
metadata:
name: my-service
annotations:
kots.io/installer-only: "true"
```
27 changes: 9 additions & 18 deletions docs/vendor/licenses-install-types.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -34,21 +36,24 @@ The following describes each installation type available, as well as the require
<table>
<tr>
<th width="30%">Install Type</th>
<th>Description</th>
<th width="35%">Description</th>
<th>Requirements</th>
</tr>
<tr>
<th>Existing Cluster (Helm CLI)</th>
<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>
<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>
<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>
<td>
<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>
Copy link
Contributor Author

@paigecalvert paigecalvert Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ Edited this description which previously said that the release must only include helm charts or Replicated resources. Now, it can include other resources as long as they have the annotation

Also added some examples of what we're talking about when we say Replicated custom resources

<InstallerOnlyAnnotation/>
Copy link
Contributor Author

@paigecalvert paigecalvert Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ Moved the info that was previously in the installer-only subsection below into the cell in the table, including the YAML sample. (Needed to make this a partial so that the YAML would render)

</td>
</tr>
<tr>
<th>Existing Cluster (KOTS install)</th>
<td>Allows the customer to install with Replicated KOTS in an existing cluster.</td>
<td>
<ul>
<li>Your Vendor Portal team must have the KOTS entitlement</li>
<li>The latest release promoted to the channel where the customer is assigned must contain KOTS custom resources</li>
<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>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -77,20 +82,6 @@ The following describes each installation type available, as well as the require
</tr>
</table>

### `kots.io/installer-only` Annotation {#installer-only-annotation}
Copy link
Contributor Author

@paigecalvert paigecalvert Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved this info up into the cell in the table


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:
Expand Down