Skip to content

Commit 4111d22

Browse files
committed
doc how to use custom domain for sdk
1 parent a3b751e commit 4111d22

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

docs/release-notes/rn-replicated-sdk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This topic contains release notes for the [Replicated SDK](/vendor/replicated-sd
1313
Released on Apr 16, 2025
1414

1515
### Improvements {#improvements-1-5-1}
16-
* 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.
16+
* 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).
1717

1818
## 1.5.0
1919

docs/vendor/custom-domains-using.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,28 @@ To configure Embedded Cluster to use your custom domains for the proxy registry
8989
9090
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.
9191
92+
### Use a Custom Domain for the Replicated SDK Image {#sdk}
93+
94+
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.
95+
96+
To use a custom domain for the SDK image:
97+
98+
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.
99+
100+
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.
101+
102+
**Example:**
103+
104+
```yaml
105+
# SDK Helm chart values.yaml
106+
image:
107+
# update image.registry with your custom domain
108+
registry: example.your-domain.com
109+
repository: "library/replicated-sdk-image"
110+
tag: "1.0.0"
111+
pullPolicy: IfNotPresent
112+
```
113+
92114
### Set a Default Domain
93115

94116
Setting a default domain is useful for ensuring that the same domain is used across channels for all your customers.

docs/vendor/custom-domains.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can configure custom domains for the following services:
1818

1919
- **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`.
2020

21-
- **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`.
21+
- **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`.
2222

2323
## Limitations
2424

0 commit comments

Comments
 (0)