You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/vendor/helm-native-v2-using.md
+7-9Lines changed: 7 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Configure the KOTS HelmChart custom resource `values` key so that KOTS rewrites
25
25
* The built-in registry used in Replicated Embedded Cluster or Replicated kURL installations in air-gapped environments
26
26
27
27
You will use the following KOTS template functions to conditionally rewrite image names depending on where the given image should be accessed:
28
-
*[HasLocalRegistry](/reference/template-functions-config-context#haslocalregistry): Returns true if the installation environment is configured to use a local image registry. HasLocalRegistry is always true in air gap installations. HasLocalRegistry is also true in online installations if the user pushed images to their own registry.
28
+
*[HasLocalRegistry](/reference/template-functions-config-context#haslocalregistry): Returns true if the installation environment is configured to use a local image registry. HasLocalRegistry is always true in air gap installations. HasLocalRegistry is also true in online installations if the user configured a local private registry.
29
29
*[LocalRegistryHost](/reference/template-functions-config-context#localregistryhost): Returns the host of the local registry that the user configured. Alternatively, for air gap installations with Embedded Cluster or kURL, LocalRegistryHost returns the host of the built-in registry.
30
30
*[LocalRegistryNamespace](/reference/template-functions-config-context#localregistrynamespace): Returns the namespace of the local registry that the user configured. Alternatively, for air gap installations with Embedded Cluster or kURL, LocalRegistryNamespace returns the namespace of the built-in registry.
31
31
@@ -37,7 +37,7 @@ You will use the following KOTS template functions to conditionally rewrite imag
37
37
38
38
### Task 1a: Rewrite Private Image Names
39
39
40
-
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 images were pushed to a local registry).
40
+
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).
41
41
42
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:
43
43
*`<app-slug>` is the unique application slug in the Vendor Portal
@@ -62,12 +62,10 @@ spec:
62
62
...
63
63
values:
64
64
image:
65
-
# If the user configured a registry, use that registry's hostname
66
-
# If air gap Embedded Cluster/kURL install, use the buit-in registry's hostname
65
+
# If a registry is configured by the user or by Embedded Cluster/kURL, use that registry's hostname
For any public images used by your application, configure the HelmChart custom resource so that image names are rewritten to either the location of the image in the public registry (for online installations) or the local registry (for air gap installations or online installations where images were pushed to a local registry).
102
+
For any public images used by your application, configure the HelmChart custom resource so that image names are rewritten to either the location of the image in the public registry (for online installations) or the local registry (for air gap installations or online installations where the user configured a local registry.
105
103
106
104
For more information, see the example below.
107
105
@@ -123,7 +121,7 @@ spec:
123
121
# If a local registry is used, use that registry's hostname
## Task 4: Support the Use of Local Image Registries {#local-registries}
274
272
275
-
Local image registries are required for KOTS installations in air-gapped environments with no outbound internet connection. Also, users in online environments can optionally push images to a local registry. For more information about how users configure a local image registry with KOTS, see [Using Private Registries](/enterprise/image-registry-settings).
273
+
Local image registries are required for KOTS installations in air-gapped environments with no outbound internet connection. Also, users in online environments can optionally use a local registry. For more information about how users configure a local image registry with KOTS, see [Using Private Registries](/enterprise/image-registry-settings).
276
274
277
275
To support the use of local registries, configure the `builder` key. For more information about how to configure the `builder` key, see [`builder`](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_.
0 commit comments