diff --git a/docs/release-notes/rn-replicated-sdk.md b/docs/release-notes/rn-replicated-sdk.md index 0c8e69db96..aecc55d1dd 100644 --- a/docs/release-notes/rn-replicated-sdk.md +++ b/docs/release-notes/rn-replicated-sdk.md @@ -20,7 +20,7 @@ Released on February 19, 2025 Released on February 4, 2025 ### New Features {#new-features-1-1-0} -* Adds the ability to pass custom labels to the Replicated SDK Helm Chart via the `commonLabels` and `podLabels` Helm values. +* 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_. ## 1.0.0 diff --git a/docs/vendor/replicated-sdk-customizing.md b/docs/vendor/replicated-sdk-customizing.md index 05533c8fa5..63c1b521a0 100644 --- a/docs/vendor/replicated-sdk-customizing.md +++ b/docs/vendor/replicated-sdk-customizing.md @@ -1,6 +1,6 @@ # Customizing the Replicated SDK -This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, and adding tolerations. +This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, adding tolerations, and more. ## Customize RBAC for the SDK @@ -208,3 +208,40 @@ replicated: values: - private-node-pool ``` +## Add Custom Labels + +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. + +### Requirement + +The `replicated.commonLabels` and `replicated.podLabels` values are available with the Replicated SDK version 1.1.0 and later. + +### commonLabels + +The `replicated.commonLabels` value allows you to add one or more labels to all resources created by the SDK chart. + +For example: + +```yaml +# Helm chart values.yaml + +replicated: + commonLabels: + environment: production + team: platform +``` + +### podLabels + +The `replicated.podLabels` value allows you to add pod-specific labels to the pod template. + +For example: + +```yaml +# Helm chart values.yaml + +replicated: + podLabels: + monitoring: enabled + custom.company.io/pod-label: value +``` \ No newline at end of file