Customizing the Replicated SDK Pod Name - How to Override the Default "replicated-sdk" Resource Names with Helm

How do I?
,
1

If you’re distributing your application with the Replicated SDK as a subchart, you may have noticed that the SDK’s resources (pod, service, deployment, etc.) all use the default name replicated-sdk. Depending on your application’s naming conventions, you might want to customize this.

The good news is that this is already supported today using the nameOverride value in the SDK’s Helm chart. You just need to set it.

How it works

The Replicated SDK Helm chart includes a nameOverride value that, when set, replaces the default chart name (replicated-sdk) across all generated resource names. This affects the:

  • Deployment

  • Service

  • ServiceAccount

  • Role and RoleBinding

  • Secret

  • Support Bundle collector

Under the hood, the SDK’s templates use a standard Helm name helper that respects this override:

{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}

So if you set nameOverride, that value becomes the base name for every resource the chart creates.

How to set it

In the chart’s values.yaml, set the chart name override.

# Override the chart name
nameOverride: "acme-platform"

This would produce resources like:

Default Name Overridden Name
replicated-sdk (Deployment) acme-platform-sdk
replicated-sdk (Service) acme-platform-sdk
replicated-sdk-role (Role) acme-platform-sdk-role
replicated-sdk-rolebinding (RoleBinding) acme-platform-sdk-rolebinding

There’s also a namespace override

If you need to deploy the SDK into a different namespace than the release namespace, you can use namespaceOverride:

# Override the chart namespace
  namespaceOverride: "my-tools-namespace"

What to keep in mind

  • The name is truncated to 63 characters per Kubernetes naming requirements, so keep your override value reasonably short.

  • If you’re using serviceAccountName to specify a custom service account, that value takes precedence over the name generated from nameOverride for the ServiceAccount resource specifically.