Skip to content

Commit cbd04e9

Browse files
committed
edits
1 parent 5348c3b commit cbd04e9

File tree

3 files changed

+10
-20
lines changed

3 files changed

+10
-20
lines changed

docs/vendor/custom-domains-using.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Use Custom Domains
22

3-
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.
3+
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.
44

55
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.
66

@@ -91,25 +91,13 @@ To configure Embedded Cluster to use your custom domains for the proxy registry
9191
9292
### Use a Custom Domain for the Replicated SDK Image {#sdk}
9393
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.
94+
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.
9595

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.
96+
Because the SDK is located at the proxy registry domain, the SDK image is automatically pulled through the proxy registry during deployment.
9997

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:**
98+
To use a custom domain for the SDK image:
10399

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-
```
100+
* Add a custom domain for the Replicated proxy registry. See [Add a Custom Domain in the Vendor Portal](#add-domain) above.
113101

114102
### Set a Default Domain
115103

docs/vendor/helm-image-registry.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ This topic describes how to use the Replicated proxy registry to proxy images fo
99

1010
With the Replicated proxy registry, each customer's unique license can grant proxy access to images in an external private registry.
1111

12-
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.
12+
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.
13+
14+
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.
1315

1416
## Pull Private Images Through the Proxy Registry in Helm Installations
1517

docs/vendor/replicated-sdk-customizing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Customize the Replicated SDK
22

3-
This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, adding tolerations, and more.
3+
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.
44

5-
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.
5+
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_.
66

77
## Customize RBAC for the SDK
88

0 commit comments

Comments
 (0)