Clarify details about global.replicated values for Helm installs#3850
Open
paigecalvert wants to merge 3 commits intomainfrom
Open
Clarify details about global.replicated values for Helm installs#3850paigecalvert wants to merge 3 commits intomainfrom
paigecalvert wants to merge 3 commits intomainfrom
Conversation
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
paigecalvert
commented
Feb 24, 2026
|
|
||
| For more information about the Replicated SDK API, see [Replicated SDK API](/reference/replicated-sdk-apis). | ||
|
|
||
| ## Limitation |
Contributor
Author
There was a problem hiding this comment.
unrelated correction. looks like a mistake from another recent pr that removed some out of date limitations
paigecalvert
commented
Feb 24, 2026
|
|
||
| * Pull the Helm chart at deploy time only, rather than committing the chart in Git | ||
|
|
||
| * Alternatively, remove the `global.replicated` values from the chart's `values.yaml` file before committing the chart. Then re-inject the `global.replicated` values at deploy time using a secret manager. No newline at end of file |
Contributor
Author
There was a problem hiding this comment.
I decided to add this advise to a partial so it can be injected in the following pages:
- Helm global.replicated Values Schema
- About Helm Installations with Replicated
paigecalvert
commented
Feb 24, 2026
| @@ -0,0 +1 @@ | |||
| The Replicated SDK reads its configuration from Helm values only and does not support reading from Kubernetes Secrets or CSI-mounted volumes. Any values used by the SDK must be set in the chart's `values.yaml` or with the `--set` flag during deployment. No newline at end of file | |||
Contributor
Author
There was a problem hiding this comment.
Add new sdk limitation about how you can only pass config to the sdk through helm values
I added this to the sdk overview and to the page on Customizing the Replicated SDK
paigecalvert
commented
Feb 24, 2026
| Customers can install your Helm chart by first logging in to the Replicated registry with their unique license ID. This step ensures that any customer who installs your chart from the registry has a valid, unexpired license. After the customer logs in to the Replicated registry, they can run `helm install` to install the chart from the registry. | ||
|
|
||
| During installation, the Replicated registry injects values into the `global.replicated` key of the parent Helm chart's values file. For more information about the values schema, see [Helm global.replicated Values Schema](helm-install-values-schema). | ||
| When an authenticated user pulls a Helm chart from the Replicated registry (with `helm pull`, `helm install`, or `helm upgrade`, or from any OCI-compatible client), the Replicated registry injects customer-specific values into the `global.replicated` key of the chart's `values.yaml` file before serving the chart. For more information about the values schema, see [Helm global.replicated Values Schema](helm-install-values-schema). |
Contributor
Author
There was a problem hiding this comment.
or from any OCI-compatible client)
I wasn't sure precisely what this part was referring to. Is this if you are pulling the image from the replicated registry outside of a typical replicated helm cli installation/upgrade workflow?
paigecalvert
commented
Feb 24, 2026
| * The Replicated Admin Console | ||
| * Strict preflight checks that block installation | ||
| * Backup and restore with snapshots | ||
| * Backup and restore functionality powered by Velero |
Contributor
Author
There was a problem hiding this comment.
^ not only snapshots, but also backup and restore with EC
paigecalvert
commented
Feb 24, 2026
| ## Overview | ||
|
|
||
| When a user installs a Helm application with the Helm CLI, the Replicated registry injects a set of customer-specific values into the `global.replicated` key of the parent Helm chart's values file. | ||
| During Helm CLI installations with Replicated, the application Helm chart(s) are pulled from the Replicated registry. When an authenticated user pulls a chart from the Replicated registry (with `helm pull`, `helm install`, or `helm upgrade`, or from any OCI-compatible client), the Replicated registry injects customer-specific values into the `global.replicated` key of the chart's `values.yaml` file before serving the chart. |
Contributor
Author
There was a problem hiding this comment.
updated this overview in the same way based on #3839
paigecalvert
commented
Feb 24, 2026
| * The fields in the customer's license, such as the field names, descriptions, signatures, values, and any custom license fields that you define. Vendors can use this license information to check entitlements before the application is installed. For more information, see [Check Entitlements in Helm Charts Before Deployment](/vendor/licenses-reference-helm). | ||
|
|
||
| * A base64 encoded Docker configuration file. To proxy images from an external private registry with the Replicated proxy registry, you can use the `global.replicated.dockerconfigjson` field to create an image pull secret for the proxy registry. For more information, see [Proxying Images for Helm Installations](/vendor/helm-image-registry). | ||
| * A base64-encoded Docker configuration file (`global.replicated.dockerconfigjson`) that contains registry authentication credentials. To proxy images from an external private registry with the Replicated proxy registry, you use this `global.replicated.dockerconfigjson` field to create an image pull secret for the proxy registry. For more information, see [Use the Proxy Registry with Helm CLI Installations](/vendor/helm-image-registry). |
Contributor
Author
There was a problem hiding this comment.
make sure it's clear that dockerconfigjson is auth credentials
paigecalvert
commented
Feb 24, 2026
| | `licenseID` | String | The unique identifier for the license | | ||
| | `licenseType` | String | The type of license, such as "dev" or "prod". For more information, see [Customer Types](/vendor/licenses-about#customer-types) in _About Customers and Licensing_. | | ||
|
|
||
| ## About Securely Storing Charts in Git |
Contributor
Author
There was a problem hiding this comment.
new section in helm values schema page about being careful when storing charts in git
paigecalvert
commented
Feb 24, 2026
| This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, adding tolerations, and more. For a complete list of supported configuration options for the SDK, see the [`values.yaml`](https://github.com/replicatedhq/replicated-sdk/blob/main/chart/values.yaml) file for the SDK Helm chart in GitHub. | ||
| This topic describes how to customize the Replicated SDK, including customizing RBAC, setting environment variables, adding tolerations, and more. | ||
|
|
||
| ## About Customizing the Replicated SDK |
Contributor
Author
There was a problem hiding this comment.
added this overview to explain how you customize the sdk by working with its helm values
paigecalvert
commented
Feb 24, 2026
|
|
||
| ## Limitation | ||
|
|
||
| <SdkValuesLimitation/> |
Contributor
Author
There was a problem hiding this comment.
^ add the limitation about how you can't pull config for the sdk from sources other than helm values
paigecalvert
commented
Feb 24, 2026
|
|
||
| :::note | ||
| The Replicated SDK `replicated` values are different from the `global.replicated` values that are injected by the Replicated registry as part of Helm CLI installations. The `global.replicated` values are injected regardless of if the Replicated SDK is distributed alongside the application as dependency. For more information about the `global.replicated` values, see [Helm global.replicated Values Schema](/vendor/helm-install-values-schema). | ||
| ::: |
Contributor
Author
There was a problem hiding this comment.
^ just pulled this pre-existing content out of the SdkValues partial below. There was no need for this part to appear in the Helm Values Schema page as well, which is the other place this partial is included
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #3839