Skip to content

Commit aa5bf0a

Browse files
authored
Update documentation for installer-only annotation
Clarified the usage of the kots.io/installer-only annotation for both HelmChart and standard Kubernetes resources, including examples and troubleshooting information.
1 parent 9dca586 commit aa5bf0a

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

docs/partials/helm/_helmchart-installer-only-annotation.mdx

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
## kots.io/installer-only Annotation
22

3-
When added to a HelmChart custom resource and set to true, the `kots.io/installer-only` annotation does the following:
3+
When added to a HelmChart custom resource or other Kubernetes resource and set to true, the `kots.io/installer-only` annotation does the following:
44
- Excludes the chart from the Helm CLI install and upgrade instructions displayed in the Vendor Portal and Enterprise Portal
55
- Excludes the chart from Security Center reports for Helm CLI installations
66

77
Charts with `kots.io/installer-only: "true"` are still deployed when using Replicated installers (Embedded Cluster, KOTS, and kURL) and are still included in Security Center reports for Replicated installer deployments.
88

99
This annotation is useful for charts that are required for Replicated installer-based deployments but should not be visible or installed when customers use the Helm CLI.
1010

11-
### Example
11+
### Example: HelmChart Custom Resource
1212

1313
```yaml
1414
apiVersion: kots.io/v1beta2
@@ -22,3 +22,36 @@ spec:
2222
name: kots-only-chart
2323
chartVersion: 1.0.0
2424
```
25+
26+
### Example: Standard Kubernetes Resource
27+
28+
```yaml
29+
apiVersion: apps/v1
30+
kind: Deployment
31+
metadata:
32+
name: installer-setup-job
33+
annotations:
34+
kots.io/installer-only: "true"
35+
spec:
36+
replicas: 1
37+
selector:
38+
matchLabels:
39+
app: installer-setup
40+
template:
41+
metadata:
42+
labels:
43+
app: installer-setup
44+
spec:
45+
containers:
46+
- name: setup-container
47+
image: myregistry/installer-tool:v1.0
48+
```
49+
50+
### Troubleshooting
51+
52+
This annotation capability uses intelligent many-to-many tracking for container images. An image is **only excluded from Helm airgap bundles if ALL resources that reference it are marked as installer-only**. Example scenarios:
53+
* Annotated image only in installer-only Deployment → Excluded from Helm
54+
* Annotated image in both installer-only Job AND regular Deployment → Still included in Helm (because at least one source is not installer-only)
55+
* Image in multiple installer-only resources → Excluded from Helm
56+
57+

0 commit comments

Comments
 (0)