Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc how to use custom domain for sdk #3244

wants to merge 1 commit into from

Conversation

paigecalvert
Copy link
Contributor

@paigecalvert paigecalvert commented May 13, 2025

@paigecalvert paigecalvert requested a review from a team as a code owner May 13, 2025 15:44
Copy link

netlify bot commented May 13, 2025

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit 4111d22
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs/deploys/682368f95bc086000845e0fc
😎 Deploy Preview https://deploy-preview-3244--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented May 13, 2025

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit 4111d22
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs-upgrade/deploys/682368f9c0dec20008809163
😎 Deploy Preview https://deploy-preview-3244--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels 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).
Copy link
Contributor Author

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

@@ -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`.
Copy link
Contributor Author

Choose a reason for hiding this comment

The 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::docs Improvements or additions to documentation type::feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants