Skip to content

Commit 4c1acae

Browse files
committed
clarify how to use custom domain when rewriting images
1 parent fa9854b commit 4c1acae

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/vendor/helm-native-v2-using.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To support Helm chart installations with the KOTS `kots.io/v1beta2` HelmChart cu
1919
## Task 1: Rewrite Image Names {#rewrite-image-names}
2020

2121
Configure the KOTS HelmChart custom resource `values` key so that KOTS rewrites the names for both private and public images in your Helm values during deployment. This allows images to be accessed at one of the following locations, depending on where they were pushed:
22-
* The [Replicated proxy registry](private-images-about) (`proxy.replicated.com`)
22+
* The [Replicated proxy registry](private-images-about) (`proxy.replicated.com` or your custom domain)
2323
* A public image registry
2424
* Your customer's local registry
2525
* The built-in registry used in Replicated Embedded Cluster or Replicated kURL installations in air-gapped environments
@@ -39,11 +39,12 @@ You will use the following KOTS template functions to conditionally rewrite imag
3939

4040
For any private images used by your application, configure the HelmChart custom resource so that image names are rewritten to either the Replicated proxy registry (for online installations) or to the local registry in the user's installation environment (for air gap installations or online installations where the user configured a local registry).
4141

42-
To rewrite image names to the location of the image in the proxy registry, use the format `proxy.replicated.com/proxy/<app-slug>/<image>`, where:
42+
To rewrite image names to the location of the image in the proxy registry, use the format `<proxy-domain>/proxy/<app-slug>/<image>`, where:
43+
* `<proxy-domain>` is `proxy.replicated.com` or your custom domain. For more information about configuring a custom domain for the proxy registry, see [Using Custom Domains](/vendor/custom-domains-using).
4344
* `<app-slug>` is the unique application slug in the Vendor Portal
4445
* `<image>` is the path to the image in your registry
4546

46-
For example, if the private image is `quay.io/my-org/nginx:v1.0.1`, then the image name should be rewritten to `proxy.replicated.com/proxy/my-app-slug/quay.io/my-org/nginx:v1.0.1`.
47+
For example, if the private image is `quay.io/my-org/nginx:v1.0.1` and no custom domain is used for the proxy registry, then the image name should be rewritten to `proxy.replicated.com/proxy/my-app-slug/quay.io/my-org/nginx:v1.0.1`.
4748

4849
For more information, see the example below.
4950

@@ -63,10 +64,10 @@ spec:
6364
values:
6465
image:
6566
# If a registry is configured by the user or by Embedded Cluster/kURL, use that registry's hostname
66-
# Else use proxy.replicated.com
67-
registry: '{{repl HasLocalRegistry | ternary LocalRegistryHost "proxy.replicated.com" }}'
67+
# Else use proxy.replicated.com or your custom proxy registry domain
68+
registry: '{{repl HasLocalRegistry | ternary LocalRegistryHost "my.registry.io" }}'
6869
# If a registry is configured by the user or by Embedded Cluster/kURL, use that registry namespace
69-
# Else use the image's namespace at proxy.replicated.com
70+
# Else use the image's namespace at the proxy registry domain
7071
repository: '{{repl HasLocalRegistry | ternary LocalRegistryNamespace "proxy/my-app/quay.io/my-org" }}/nginx'
7172
tag: v1.0.1
7273
```
@@ -171,6 +172,7 @@ metadata:
171172
spec:
172173
values:
173174
image:
175+
# Use proxy.replicated.com or your custom domain for the proxy registry
174176
registry: '{{repl HasLocalRegistry | ternary LocalRegistryHost "proxy.replicated.com" }}'
175177
repository: '{{repl HasLocalRegistry | ternary LocalRegistryNamespace "proxy/my-app/ecr.us-east-1.amazonaws.com/my-org" }}/api'
176178
pullSecrets:

0 commit comments

Comments
 (0)