Skip to content

Commit 65398bf

Browse files
committed
edits
1 parent 43c1a57 commit 65398bf

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Configure the KOTS HelmChart custom resource `values` key so that KOTS rewrites
2525
* The built-in registry used in Replicated Embedded Cluster or Replicated kURL installations in air-gapped environments
2626

2727
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.
2929
* [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.
3030
* [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.
3131

@@ -37,7 +37,7 @@ You will use the following KOTS template functions to conditionally rewrite imag
3737

3838
### Task 1a: Rewrite Private Image Names
3939

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).
4141

4242
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:
4343
* `<app-slug>` is the unique application slug in the Vendor Portal
@@ -62,12 +62,10 @@ spec:
6262
...
6363
values:
6464
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
6766
# Else use proxy.replicated.com
6867
registry: '{{repl HasLocalRegistry | ternary LocalRegistryHost "proxy.replicated.com" }}'
69-
# If the user configured a registry, use the registry namespace they provided
70-
# If air gap Embedded Cluster/kURL install, use the buit-in registry's hostname
68+
# If a registry is configured by the user or by Embedded Cluster/kURL, use that registry namespace
7169
# Else use the image's namespace at proxy.replicated.com
7270
repository: '{{repl HasLocalRegistry | ternary LocalRegistryNamespace "proxy/my-app/quay.io/my-org" }}/nginx'
7371
tag: v1.0.1
@@ -101,7 +99,7 @@ spec:
10199

102100
### Task 1b: Rewrite Public Image Names
103101

104-
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.
105103

106104
For more information, see the example below.
107105

@@ -123,7 +121,7 @@ spec:
123121
# If a local registry is used, use that registry's hostname
124122
# Else, use the public registry host (ghcr.io)
125123
registry: '{{repl HasLocalRegistry | ternary LocalRegistryHost "ghcr.io" }}'
126-
# If the user configured a registry, use the registry namespace provided
124+
# If a local registry is used, use the registry namespace provided
127125
# Else, use the path to the image in the public registry
128126
repository: '{{repl HasLocalRegistry | ternary LocalRegistryNamespace "cloudnative-pg" }}/cloudnative-pg'
129127
tag: catalog-1.24.0
@@ -272,7 +270,7 @@ spec:
272270

273271
## Task 4: Support the Use of Local Image Registries {#local-registries}
274272

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).
276274

277275
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_.
278276

0 commit comments

Comments
 (0)