Skip to content

Commit e5eb8eb

Browse files
authored
Merge pull request #3579 from replicatedhq/update-helmcahrt-v2-step-6
edit optionalvalues steps in helmchart v2 doc
2 parents 2fc3588 + eb4d469 commit e5eb8eb

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To configure a release to support installations with HelmChart v2:
1818

1919
1. For each HelmChart resource in the release, configure the `builder` key. This ensures that all the required and optional images for your application are available for users to push to their own local image registry. Using a local image registry is required in air gap installations and optional in online installations. See [`builder`](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_.
2020

21-
1. For each HelmChart resource in the release, configure the [`optionalValues`](/reference/custom-resource-helmchart-v2#optionalValues) key so that KOTS conditionally rewrites any application image references in your Helm values if a local image registry is used.
21+
1. For each HelmChart resource in the release, configure the [`optionalValues`](/reference/custom-resource-helmchart-v2#optionalValues) key so that KOTS rewrites any application image references in your Helm values when a local image registry is used.
2222

2323
**Example:**
2424

@@ -42,16 +42,15 @@ To configure a release to support installations with HelmChart v2:
4242
registry: '{{repl LocalRegistryHost }}'
4343
# Use KOTS LocalRegistryNamespace to inject
4444
# the image namespace in the user's registry
45-
repository: '{{repl LocalRegistryNamespace }}'/cloudnative-pg/cloudnative-pg
45+
repository: '{{repl LocalRegistryNamespace }}'/cloudnative-pg
4646
```
47-
48-
For more information about the KOTS template functions used, see [HasLocalRegistry](/reference/template-functions-config-context#haslocalregistry), [LocalRegistryHost](/reference/template-functions-config-context#localregistryhost), and [LocalRegistryNamespace](/reference/template-functions-config-context#localregistrynamespace).
49-
50-
<details>
51-
<summary>What is the registry namespace?</summary>
52-
53-
The registry namespace is the path between the registry and the image name. For example, `images.registry.com/namespace/image:tag`.
54-
</details>
47+
The following describes how to configure the image registry and repository fields:
48+
* For the `when` statement, use the [HasLocalRegistry](/reference/template-functions-config-context#haslocalregistry) template function to evaluate if a local registry is configured.
49+
* For the image registry, use the [LocalRegistryHost](/reference/template-functions-config-context#localregistryhost) template function to inject the local registry's hostname.
50+
* For the image repository, use the [LocalRegistryNamespace](/reference/template-functions-config-context#localregistrynamespace) template function to inject the local registry's namespace, followed by the image name and any tags. For example, for an image located at `registryhostname.com/namespace/more-path/name:tag`, set the repository in `optionalValues` to `'{{repl LocalRegistryNamespace }}'/name:tag`. You do not need to include the full path because KOTS automatically strips everything from the image name except `name:tag` when pushing an image to a local registry.
51+
:::note
52+
Image names must be unique. If you have more than one image with the same name (even if the images are in different registries or namespaces) KOTS will overwrite one with the other.
53+
:::
5554

5655
1. In the HelmChart resource that corresponds to the chart where the Replicated SDK is declared as a dependency, configure the [`optionalValues`](/reference/custom-resource-helmchart-v2#optionalValues) key using the same method as in the previous step to conditionally rewrite the Replicated SDK image reference.
5756

@@ -74,7 +73,7 @@ To configure a release to support installations with HelmChart v2:
7473
registry: '{{repl LocalRegistryHost }}'
7574
# The default location for the SDK image is
7675
# proxy.replicated.com/library/replicated-sdk-image
77-
repository: '{{repl LocalRegistryNamespace }}/library/replicated-sdk-image'
76+
repository: '{{repl LocalRegistryNamespace }}/replicated-sdk-image'
7877
```
7978
For more information about declaring the SDK as a dependency, see [Install the SDK as a Subchart](/vendor/replicated-sdk-installing#install-the-sdk-as-a-subchart) in _Install the Replicated SDK_.
8079

0 commit comments

Comments
 (0)