Update steps for using the proxy registry in Helm installs #3141
Conversation
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
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
paigecalvert
commented
Mar 27, 2025
| During Helm installations, after customers provide their license ID, a `global.replicated.dockerconfigjson` field that contains a base64 encoded Docker configuration file is automatically injected in the Helm chart values. You can use this `global.replicated.dockerconfigjson` field to create the required pull secret. | ||
| During Helm installations, after customers provide their license ID, a `global.replicated.dockerconfigjson` field that contains a base64 encoded Docker configuration file is automatically injected in the Helm chart values. You can use this `global.replicated.dockerconfigjson` field to create the pull secret required to authenticate with the proxy registry. | ||
|
|
||
| For information about how Kubernetes uses the `kubernetes.io/dockerconfigjson` Secret type to authenticate to a private image registry, see [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) in the Kubernetes documentation. |
Contributor
Author
There was a problem hiding this comment.
^ moved some of this preamble down to the relevant step(s)
paigecalvert
commented
Mar 27, 2025
paigecalvert
commented
Mar 27, 2025
| 1. <StepCustomDomain/> | ||
|
|
||
| 1. In your Helm chart templates, create a Kubernetes Secret to evaluate if the `global.replicated.dockerconfigjson` value is set, and then write the rendered value into a Secret on the cluster: | ||
| 1. In your Helm chart values file, set your image repository URL to the location of the image on the proxy registry. If you added a custom domain, use your custom domain. Otherwise, use `proxy.replicated.com`. |
Contributor
Author
There was a problem hiding this comment.
^ tell them to update their Helm values rather than having the user pass a values.yaml file to set the registry during install
paigecalvert
commented
Mar 27, 2025
| registry: proxy.replicated.com | ||
| repository: proxy/your-app-slug/ghcr.io/cloudnative-pg/cloudnative-pg | ||
| tag: catalog-1.24.0 | ||
| ``` |
Contributor
Author
There was a problem hiding this comment.
^ is it generally preferable to have separate registry and repository values over just repository (with the full url)? if so I can update the first example too do split registry and repository
ajp-io
reviewed
Mar 28, 2025
docs/vendor/helm-image-registry.mdx
Outdated
| # values.yaml | ||
| images: | ||
| your-app: | ||
| apiImageRepository: images.yourcompany.com/proxy/your-app-slug/ghcr.io/org-name/api |
Member
There was a problem hiding this comment.
i'd probably match the style of the example below with the same reg, repo, tag fields. that's more standard anyway.
| registry: proxy.replicated.com | ||
| repository: proxy/your-app-slug/ghcr.io/cloudnative-pg/cloudnative-pg | ||
| tag: catalog-1.24.0 | ||
| ``` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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-3141--replicated-docs.netlify.app/vendor/helm-image-registry