From 4111d22111e809299c8c2cbf7bd877bd95100820 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 13 May 2025 09:44:16 -0600 Subject: [PATCH 1/5] doc how to use custom domain for sdk --- docs/release-notes/rn-replicated-sdk.md | 2 +- docs/vendor/custom-domains-using.md | 22 ++++++++++++++++++++++ docs/vendor/custom-domains.md | 2 +- 3 files changed, 24 insertions(+), 2 deletions(-) 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 From cbd04e9491bc0054d8f4377305a48fe6f0b3ba15 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Wed, 11 Jun 2025 13:03:16 -0600 Subject: [PATCH 2/5] edits --- docs/vendor/custom-domains-using.md | 22 +++++----------------- docs/vendor/helm-image-registry.mdx | 4 +++- docs/vendor/replicated-sdk-customizing.md | 4 ++-- 3 files changed, 10 insertions(+), 20 deletions(-) diff --git a/docs/vendor/custom-domains-using.md b/docs/vendor/custom-domains-using.md index e82f105457..9fac0bdf65 100644 --- a/docs/vendor/custom-domains-using.md +++ b/docs/vendor/custom-domains-using.md @@ -1,6 +1,6 @@ # Use Custom Domains -This topic describes how to use the Replicated Vendor Portal to add and manage custom domains to alias the Replicated registry, the Replicated proxy registry, the Replicated app service, the Replicated Enterprise Portal and the Replicated Download Portal. +This topic describes how to use the Replicated Vendor Portal to add and manage custom domains to alias Replicated endpoints, including the Replicated registry, the Replicated proxy registry, the Replicated app service, the Replicated Enterprise Portal, and the Replicated Download Portal. For information about adding and managing custom domains with the Vendor API v3, see the [customHostnames](https://replicated-vendor-api.readme.io/reference/createcustomhostname) section in the Vendor API v3 documentation. @@ -91,25 +91,13 @@ To configure Embedded Cluster to use your custom domains for the proxy registry ### 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. +The default location for the image used by the Replicated SDK Helm chart is `proxy.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. +Because the SDK is located at the proxy registry domain, the SDK image is automatically pulled through the proxy registry during deployment. -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:** +To use a custom domain for the SDK image: - ```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 - ``` +* Add a custom domain for the Replicated proxy registry. See [Add a Custom Domain in the Vendor Portal](#add-domain) above. ### Set a Default Domain diff --git a/docs/vendor/helm-image-registry.mdx b/docs/vendor/helm-image-registry.mdx index 377df12dae..b3d1ee9dec 100644 --- a/docs/vendor/helm-image-registry.mdx +++ b/docs/vendor/helm-image-registry.mdx @@ -9,7 +9,9 @@ This topic describes how to use the Replicated proxy registry to proxy images fo With the Replicated proxy registry, each customer's unique license can grant proxy access to images in an external private 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. +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. ## Pull Private Images Through the Proxy Registry in Helm Installations diff --git a/docs/vendor/replicated-sdk-customizing.md b/docs/vendor/replicated-sdk-customizing.md index 5ec22b3284..5f54c3c17a 100644 --- a/docs/vendor/replicated-sdk-customizing.md +++ b/docs/vendor/replicated-sdk-customizing.md @@ -1,8 +1,8 @@ # Customize the Replicated SDK -This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, adding tolerations, and more. +This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, adding tolerations, and more. 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 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_. ## Customize RBAC for the SDK From c753a53418926f4a801ff66400cc32e787ba690f Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Wed, 11 Jun 2025 15:20:06 -0600 Subject: [PATCH 3/5] copy edit --- docs/vendor/custom-domains-using.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/vendor/custom-domains-using.md b/docs/vendor/custom-domains-using.md index 9fac0bdf65..50066c90c4 100644 --- a/docs/vendor/custom-domains-using.md +++ b/docs/vendor/custom-domains-using.md @@ -91,9 +91,9 @@ To configure Embedded Cluster to use your custom domains for the proxy registry ### 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`. 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. +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. -Because the SDK is located at the proxy registry domain, the SDK image is automatically pulled through the proxy registry during deployment. +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: From 1f631b0993e6269f4147a880a9e297bb7db5c0e6 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Wed, 11 Jun 2025 15:27:05 -0600 Subject: [PATCH 4/5] copyedits --- docs/vendor/custom-domains-using.md | 2 +- docs/vendor/custom-domains.md | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/vendor/custom-domains-using.md b/docs/vendor/custom-domains-using.md index 50066c90c4..f84fcd60d9 100644 --- a/docs/vendor/custom-domains-using.md +++ b/docs/vendor/custom-domains-using.md @@ -93,7 +93,7 @@ To configure Embedded Cluster to use your custom domains for the proxy registry 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. -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. +You can see the Replicated SDK image properties in 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: diff --git a/docs/vendor/custom-domains.md b/docs/vendor/custom-domains.md index 814771c5b2..fc50146740 100644 --- a/docs/vendor/custom-domains.md +++ b/docs/vendor/custom-domains.md @@ -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). + ::: + - **Replicated app service:** Upstream application YAML and metadata, including a license ID, are pulled from the app service. By default, this service uses the domain `replicated.app`. Replicated recommends using a CNAME such as `updates.{your app name}.com`. - **Enterprise Portal:** The Enterprise Portal is a web-based portal that provides end customers with a centralized location for managing their installation. By default, the Enterprise Portal uses the domain **`[DOMAIN].replicated.com`**. Replicated recommending using a CNAME such as `portal.{your app name}.com` or `enterprise.{your app name}.com`. - **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. 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`. +- **Replicated registry:** Images and Helm charts can be pulled from the Replicated registry. By default, the Replicated registry uses the domain `registry.replicated.com`. Replicated recommends using a CNAME such as `registry.{your app name}.com`. ## Limitations From cb8adc0b025ee4f6e2cb0242ded99440b8fbe008 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Wed, 11 Jun 2025 15:28:53 -0600 Subject: [PATCH 5/5] undo changes to rns --- docs/release-notes/rn-replicated-sdk.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/rn-replicated-sdk.md b/docs/release-notes/rn-replicated-sdk.md index 9462a16cb0..8563152253 100644 --- a/docs/release-notes/rn-replicated-sdk.md +++ b/docs/release-notes/rn-replicated-sdk.md @@ -20,7 +20,7 @@ Released on Jun 9, 2025 Released on Apr 16, 2025 ### Improvements {#improvements-1-5-1} -* 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). +* 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. ## 1.5.0