Skip to content

Commit b511ab0

Browse files
committed
add example of replicated sdk values
1 parent 55cb64f commit b511ab0

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/partials/replicated-sdk/_sdk-values.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
When a user installs a Helm chart that includes the Replicated SDK as a dependency, a set of default SDK values are included in the `replicated` key of the parent chart's values file.
22

3+
For example:
4+
5+
```yaml
6+
# values.yaml
7+
8+
replicated:
9+
enabled: true
10+
appName: gitea
11+
channelID: 2jKkegBMseH5w...
12+
channelName: Beta
13+
channelSequence: 33
14+
integration:
15+
enabled: true
16+
license: {}
17+
parentChartURL: oci://registry.replicated.com/gitea/beta/gitea-authoritative
18+
releaseCreatedAt: "2024-11-25T20:38:22Z"
19+
releaseNotes: 'CLI release'
20+
releaseSequence: 88
21+
replicatedAppEndpoint: https://replicated.app
22+
versionLabel: Beta-1234
23+
```
24+
325
These `replicated` values can be referenced by the application or set during installation as needed. For example, if users need to add labels or annotations to everything that runs in their cluster, then they can pass the labels or annotations to the relevant value in the SDK subchart.
426

527
For the default Replicated SDK Helm chart values file, see [values.yaml.tmpl](https://github.com/replicatedhq/replicated-sdk/blob/main/chart/values.yaml.tmpl) in the [replicated-sdk](https://github.com/replicatedhq/replicated-sdk) repository in GitHub.

0 commit comments

Comments
 (0)