diff --git a/docs/release-notes/rn-replicated-sdk.md b/docs/release-notes/rn-replicated-sdk.md index 497ed75c3d..60789f1638 100644 --- a/docs/release-notes/rn-replicated-sdk.md +++ b/docs/release-notes/rn-replicated-sdk.md @@ -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). ## 1.5.0 diff --git a/docs/vendor/custom-domains-using.md b/docs/vendor/custom-domains-using.md index 12d3b58a34..96d3648370 100644 --- a/docs/vendor/custom-domains-using.md +++ b/docs/vendor/custom-domains-using.md @@ -89,6 +89,28 @@ 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 `registry.replicated.com/library/replicated-sdk-image`. To view the Replicated SDK image properties, see the SDK Helm chart [values.yaml](https://github.com/replicatedhq/replicated-sdk/blob/main/chart/values.yaml#L33) file in GitHub. + +To use a custom domain for the SDK image: + +1. Add a custom domain for the Replicated registry in the Vendor Portal. See [Add a Custom Domain in the Vendor Portal](#add-domain) above. + +1. In the Replicated SDK Helm chart [`values.yaml`](https://github.com/replicatedhq/replicated-sdk/blob/main/chart/values.yaml#L33), update the `image.registry` field with the custom domain that you added. + + **Example:** + + ```yaml + # SDK Helm chart values.yaml + image: + # update image.registry with your custom domain + registry: example.your-domain.com + repository: "library/replicated-sdk-image" + tag: "1.0.0" + pullPolicy: IfNotPresent + ``` + ### Set a Default Domain Setting a default domain is useful for ensuring that the same domain is used across channels for all your customers. diff --git a/docs/vendor/custom-domains.md b/docs/vendor/custom-domains.md index 6f5e3f8719..a595261b6a 100644 --- a/docs/vendor/custom-domains.md +++ b/docs/vendor/custom-domains.md @@ -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`. ## Limitations