feat: add nameOverride as a way to brand the sdk chart#4033
Merged
banjoh merged 4 commits intoMay 7, 2026
Merged
Conversation
Signed-off-by: Evans Mungai <evans@replicated.com>
Signed-off-by: Evans Mungai <evans@replicated.com>
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ 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
Signed-off-by: Evans Mungai <evans@replicated.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
paigecalvert
reviewed
May 6, 2026
| * [Set the `replicated.nameOverride` value](#brand-sdk-name-override): You can set the SDK's `replicated.nameOverride` value in your application's `values.yaml` file. Use `nameOverride` if the SDK is installed as a top-level chart instead of a subchart. The Helm `alias` field is only available on chart dependencies. | ||
|
|
||
| :::note | ||
| Branding the SDK doesn't change the `proxy.replicated.com` domain where the SDK chart is pulled during installation. For information about how to set a custom domain for the Replicated proxy registry, see [About custom domains](custom-domains). |
Contributor
There was a problem hiding this comment.
I changed this to proxy.replicated.com instead of registry.replicated.com per https://github.com/replicatedhq/replicated-sdk/blob/main/chart/values.yaml#L55
(SDK pulls through the proxy registry by default)
paigecalvert
reviewed
May 6, 2026
|
|
||
| ### Brand the SDK with a Helm alias {#brand-sdk-alias} | ||
|
|
||
| If the Replicated SDK is installed as a subchart, you can use Helm's `alias` key to brand the SDK. For more information, see [Alias field in dependencies](https://helm.sh/docs/topics/charts/#alias-field-in-dependencies) in the Helm documentation. |
Contributor
There was a problem hiding this comment.
^ added this link to helm docs
paigecalvert
reviewed
May 6, 2026
| - name: replicated | ||
| alias: yourcompany-sdk | ||
| repository: oci://registry.replicated.com/library | ||
| version: 1.19.3 |
Contributor
There was a problem hiding this comment.
^ figured I'd leave this part out since it's likely to get out of date easily
paigecalvert
reviewed
May 6, 2026
| ## Brand the SDK with a Helm alias {#brand-sdk-alias} | ||
| ## Brand the SDK {#brand-sdk} | ||
|
|
||
| When the Replicated SDK is installed as a subchart, it creates Kubernetes resources using the name `replicated`. This includes a `replicated` Deployment, Service, ServiceAccount, and Role. To make these resources match your product or company branding rather than exposing the `replicated` name to end customers in the cluster, you can rename the SDK subchart using Helm's [`alias`](https://helm.sh/docs/topics/charts/#tags-and-condition-fields-in-dependencies) field on the dependency. |
Contributor
There was a problem hiding this comment.
When the Replicated SDK is installed as a subchart,
I removed this part because I think this applies regardless of if it's top-level or it's a subchart right? (If not, it seems like the whole nameOverride section doesn't apply)
Member
Author
There was a problem hiding this comment.
That's correct. The section duplicated information
paigecalvert
approved these changes
May 6, 2026
Member
Author
|
I'll merge once the implementation PRs are merged |
banjoh
deleted the
evansmungai/sc-136261/support-helm-native-alias-field-for-renaming
branch
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
3 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.
https://deploy-preview-4033--replicated-docs.netlify.app/vendor/replicated-sdk-customizing#brand-sdk