Skip to content

Commit de9ca4a

Browse files
authored
Merge pull request #3648 from replicatedhq/paigecalvert-patch-4
Update snapshots step to clarify that app slug must be an annotation
2 parents 050860d + 95b1794 commit de9ca4a

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/vendor/helm-native-v2-using.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ To configure a release to support installations with HelmChart v2:
8585

8686
To support KOTS existing cluster or kURL installations with HelmChart v2, complete these additional steps:
8787

88-
1. For each HelmChart v2 resource in the release, configure the [optionalValues](/reference/custom-resource-helmchart-v2#optionalvalues) key to add the `kots.io/backup: velero` and `kots.io/app-slug: APP_SLUG` labels to all resources that you want to be included in backups with Replicated snapshots. These labels are required to support the use of snapshots. In the `optionalValues` key, use a `when` statement that evaluates to true only when the customer has the [`isSnapshotSupported`](/vendor/licenses-using-builtin-fields#admin-console-feature-options) field enabled for their license.
88+
1. For each HelmChart v2 resource in the release, configure the [optionalValues](/reference/custom-resource-helmchart-v2#optionalvalues) key to add the `kots.io/backup: velero` label and `kots.io/app-slug: APP_SLUG` annotation to all resources that you want to be included in backups with Replicated snapshots. Use a `when` statement so that these are added to resources only when the customer has the [`isSnapshotSupported`](/vendor/licenses-using-builtin-fields#admin-console-feature-options) field enabled for their license.
8989

9090
:::note
9191
The Replicated [snapshots](snapshots-overview) feature for backup and restore is supported only for KOTS existing cluster and kURL installations. Snapshots are not supported for installations with Embedded Cluster. For more information about disaster recovery for Embedded Cluster installations, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery.mdx).
@@ -103,7 +103,8 @@ To support KOTS existing cluster or kURL installations with HelmChart v2, comple
103103
spec:
104104
...
105105
optionalValues:
106-
# Add backup labels only when the license supports snapshots.
106+
# Add backup label and app slug annotation only when the
107+
# license supports snapshots.
107108
# Use the LicenseFieldValue template function to check if
108109
# the isSnapshotSupported license field is enabled
109110
- when: "repl{{ LicenseFieldValue `isSnapshotSupported` }}"
@@ -112,13 +113,15 @@ To support KOTS existing cluster or kURL installations with HelmChart v2, comple
112113
mariadb:
113114
commonLabels:
114115
kots.io/backup: velero
115-
# Use the LicenseFieldValue template function and the
116-
# built-in appSlug license field value to inject your
117-
# unique app slug
118-
kots.io/app-slug: repl{{ LicenseFieldValue "appSlug" }}
119116
podLabels:
120117
kots.io/backup: velero
118+
commonAnnotations:
119+
# Use the LicenseFieldValue template function and the
120+
# built-in appSlug license field value to inject the
121+
# app slug
121122
kots.io/app-slug: repl{{ LicenseFieldValue "appSlug" }}
123+
podAnnotations:
124+
kots.io/app-slug: repl{{ LicenseFieldValue "appSlug" }}
122125
```
123126
For more information about the KOTS LicenseFieldValue template function, see [LicenseFieldValue](/reference/template-functions-license-context).
124127

0 commit comments

Comments
 (0)