-
Notifications
You must be signed in to change notification settings - Fork 28
doc how to use custom domain for sdk #3244
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
4111d22
5348c3b
cbd04e9
c753a53
1f631b0
cb8adc0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 |
||
|
||
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. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ^ updated the About Custom Domains page to explain how the sdk image is also located at the replicated registry by default |
||
|
||
## Limitations | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^ updated rn to point to the new steps on how to use a custom domain