doc how to use custom domain for sdk #3244
Open
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
✅ 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
paigecalvert
commented
May 13, 2025
| @@ -13,7 +13,7 @@ This topic contains release notes for the [Replicated SDK](/vendor/replicated-sd | |||
| Released on Apr 16, 2025 | |||
|
|
|||
| ### Improvements {#improvements-1-5-1} | |||
| * Changed the default location of the image this chart uses to be registry.replicated.com/library/replicated-sdk-image. This is anonymous and will support custom domains. | |||
| * Changes the default location of the image that the Replicated SDK chart uses to the Replicated registry at `registry.replicated.com/library/replicated-sdk-image`. This is anonymous and supports the use of custom domains. To use a custom domain for the SDK, add the custom domain for the Replicated registry in the Vendor Portal and then specify the domain in the `registry` value for the SDK. For more information about how to add and use custom domains, see [Use a Custom Domain for the Replicated SDK Image](/vendor/custom-domains-using#sdk). | |||
There was a problem hiding this comment.
^ updated rn to point to the new steps on how to use a custom domain
paigecalvert
commented
May 13, 2025
docs/vendor/custom-domains.md
Outdated
| @@ -18,7 +18,7 @@ You can configure custom domains for the following services: | |||
|
|
|||
| - **Download Portal:** The Download Portal can be used to share customer license files, air gap bundles, and so on. By default, the Download Portal uses the domain `get.replicated.com`. Replicated recommends using a CNAME such as `portal.{your app name}.com` or `enterprise.{your app name}.com`. | |||
|
|
|||
| - **Replicated registry:** Images and Helm charts can be pulled from the Replicated registry. By default, this registry uses the domain `registry.replicated.com`. Replicated recommends using a CNAME such as `registry.{your app name}.com`. | |||
| - **Replicated registry:** Images and Helm charts can be pulled from the Replicated registry. Additionally, the default location for the image used by the Replicated SDK Helm chart is `registry.replicated.com/library/replicated-sdk-image`. By default, the Replicated registry uses the domain `registry.replicated.com`. Replicated recommends using a CNAME such as `registry.{your app name}.com`. | |||
There was a problem hiding this comment.
^ updated the About Custom Domains page to explain how the sdk image is also located at the replicated registry by default
paigecalvert
commented
Jun 11, 2025
| @@ -89,6 +89,16 @@ To configure Embedded Cluster to use your custom domains for the proxy registry | |||
|
|
|||
| 1. Add the Embedded Cluster Config to a new release. Promote the release to a channel that your team uses for testing, and install with Embedded Cluster in a development environment to test your changes. | |||
|
|
|||
| ### Use a Custom Domain for the Replicated SDK Image {#sdk} | |||
There was a problem hiding this comment.
new section with info about how configuring a custom domain for the proxy registry will also result in the sdk using that custom domain
we may or may not need to doc this since there's no extra work here, but I think it's helpful to have a section that describes how this works for anyone searching for it
paigecalvert
commented
Jun 11, 2025
| @@ -89,6 +89,16 @@ To configure Embedded Cluster to use your custom domains for the proxy registry | |||
|
|
|||
| 1. Add the Embedded Cluster Config to a new release. Promote the release to a channel that your team uses for testing, and install with Embedded Cluster in a development environment to test your changes. | |||
|
|
|||
| ### Use a Custom Domain for the Replicated SDK Image {#sdk} | |||
|
|
|||
| The default location for the image used by the Replicated SDK Helm chart is `proxy.replicated.com/library/replicated-sdk-image`. The SDK image is automatically pulled through the Replicated proxy registry during deployment. | |||
There was a problem hiding this comment.
The default location for the image used by the Replicated SDK Helm chart is
proxy.replicated.com/library/replicated-sdk-image.
I see this at: https://github.com/replicatedhq/replicated-sdk/blob/main/chart/values.yaml#L33
paigecalvert
commented
Jun 11, 2025
| @@ -14,13 +14,17 @@ You can configure custom domains for the following services: | |||
|
|
|||
| - **Proxy registry:** Images can be proxied from external private registries using the Replicated proxy registry. By default, the proxy registry uses the domain `proxy.replicated.com`. Replicated recommends using a CNAME such as `proxy.{your app name}.com`. | |||
|
|
|||
| :::note | |||
| The default location for the image used by the Replicated SDK Helm chart is `proxy.replicated.com/library/replicated-sdk-image`. When you configure a custom domain for the Replicated proxy registry, the SDK is pulled from that custom domain. For more information about the Replicated SDK, see [About the Replicated SDK](/vendor/replicated-sdk-overview). | |||
| ::: | |||
There was a problem hiding this comment.
^ added a note to the custom domains overview page to explain how the sdk image is located at the proxy registry domain by default
paigecalvert
commented
Jun 11, 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 pull secret required to authenticate with the proxy registry. | ||
| 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, allowing you to use the proxy registry for images in your Helm charts. | ||
|
|
||
| Additionally, if you include the Replicated SDK as a dependency in your Helm chart, the image used by the Replicated SDK is automatically proxied through the proxy registry. |
There was a problem hiding this comment.
^ small addition here
Additionally, if you include the Replicated SDK as a dependency in your Helm chart, the image used by the Replicated SDK is automatically proxied through the proxy registry.
paigecalvert
commented
Jun 11, 2025
|
|
||
| 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. | ||
| For information about how to use a custom domain for the Replicated SDK image, see [Use a Custom Domain for the Replicated SDK Image](custom-domains-using#sdk) in _Using Custom Domains_. |
There was a problem hiding this comment.
^ added a link to the docs on adding a custom domain in case anyone comes to "Customize the Replicated SDK" looking for it
staciegravy
approved these changes
Jun 11, 2025
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-3244--replicated-docs.netlify.app/vendor/custom-domains-using#sdk