Skip to content

kots.io/installer-only docs #2864

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 2 commits into from
Dec 2, 2024
Merged

kots.io/installer-only docs #2864

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce3365d
kots.io/installer-only docs
divolgin Nov 27, 2024
6f21230
Update licenses-install-types.mdx
paigecalvert Dec 2, 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
16 changes: 15 additions & 1 deletion docs/vendor/licenses-install-types.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The following describes each installation type available, as well as the require
<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 at the top level of the directory.</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>
</tr>
<tr>
<th>Existing Cluster (KOTS install)</th>
Expand Down Expand Up @@ -77,6 +77,20 @@ The following describes each installation type available, as well as the require
</tr>
</table>

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