Skip to content

Commit 8fe1e3e

Browse files
authored
Merge pull request #3089 from replicatedhq/120737
Add docs for podLabels and commonLabels for SDK
2 parents 77a4219 + a6cf72a commit 8fe1e3e

File tree

2 files changed

+39
-2
lines changed

2 files changed

+39
-2
lines changed

docs/release-notes/rn-replicated-sdk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Released on February 19, 2025
2020
Released on February 4, 2025
2121

2222
### New Features {#new-features-1-1-0}
23-
* Adds the ability to pass custom labels to the Replicated SDK Helm Chart via the `commonLabels` and `podLabels` Helm values.
23+
* Adds the ability to pass custom labels to the Replicated SDK Helm Chart via the `commonLabels` and `podLabels` Helm values. For more information, see [Add Custom Labels](/vendor/replicated-sdk-customizing#add-custom-labels) in _Customizing the Replicated SDK_.
2424

2525
## 1.0.0
2626

docs/vendor/replicated-sdk-customizing.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Customizing the Replicated SDK
22

3-
This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, and adding tolerations.
3+
This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, adding tolerations, and more.
44

55
## Customize RBAC for the SDK
66

@@ -208,3 +208,40 @@ replicated:
208208
values:
209209
- private-node-pool
210210
```
211+
## Add Custom Labels
212+
213+
With the Replicated SDK version 1.1.0 and later, you can pass custom labels to the Replicated SDK Helm Chart by setting the `replicated.commonLabels` and `replicated.podLabels` Helm values in your Helm chart.
214+
215+
### Requirement
216+
217+
The `replicated.commonLabels` and `replicated.podLabels` values are available with the Replicated SDK version 1.1.0 and later.
218+
219+
### commonLabels
220+
221+
The `replicated.commonLabels` value allows you to add one or more labels to all resources created by the SDK chart.
222+
223+
For example:
224+
225+
```yaml
226+
# Helm chart values.yaml
227+
228+
replicated:
229+
commonLabels:
230+
environment: production
231+
team: platform
232+
```
233+
234+
### podLabels
235+
236+
The `replicated.podLabels` value allows you to add pod-specific labels to the pod template.
237+
238+
For example:
239+
240+
```yaml
241+
# Helm chart values.yaml
242+
243+
replicated:
244+
podLabels:
245+
monitoring: enabled
246+
custom.company.io/pod-label: value
247+
```

0 commit comments

Comments
 (0)