Skip to content

Commit 7360497

Browse files
authored
Merge pull request #4061 from replicatedhq/update-helmchart-cr-ec-v3
Update Helmchart cr docs for ec v3
2 parents d7a8bf1 + d59e9bc commit 7360497

36 files changed

Lines changed: 426 additions & 468 deletions
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
The `builder` key has the following requirements and recommendations:
2-
* Replicated recommends that you include only the minimum Helm values in the `builder` key that are required to template the Helm chart with the correct image tags.
3-
* Use only static, or _hardcoded_, values in the `builder` key. You cannot use template functions in the `builder` key because values in the `builder` key are not rendered in a customer environment.
4-
* Any `required` Helm values that need to be set to render the chart templates must have a value supplied in the `builder` key. For more information about the Helm `required` function, see [Using the 'required' function](https://helm.sh/docs/howto/charts_tips_and_tricks/#using-the-required-function) in the Helm documentation.
2+
* Replicated recommends that you include only the minimum Helm values in the `builder` key required to template the Helm chart with the correct image tags.
3+
* Use only static, or _hardcoded_, values in the `builder` key. You can't use template functions in the `builder` key because values in the `builder` key are not rendered in a customer environment.
4+
* Any `required` Helm values that need to be set to render the chart templates must have a value in the `builder` key. For more information about the Helm `required` function, see [Using the 'required' function](https://helm.sh/docs/howto/charts_tips_and_tricks/#using-the-required-function) in the Helm documentation.
55
* Specify `kubeVersion` in the root Helm chart. The Vendor Portal renders Helm charts with the minimum Kubernetes minor version that satisfies the `kubeVersion` in the root Helm chart. For example, if the chart specifies `kubeVersion: >=1.24.1`, then it's rendered with Kubernetes 1.25.0. If this fails or if a `kubeVersion` is not specified in the root Helm chart, then the Vendor Portal attempts to render the chart with each supported minor version of Kubernetes up to the latest version.

docs/partials/helm/_helm-cr-builder-airgap-intro.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
The `builder` key contains the minimum Helm values required so that the output of `helm template` exposes all container images needed to install the chart in an air-gapped environment.
22

3-
The Replicated Vendor Portal uses the Helm values that you provide in the `builder` key to run `helm template` on the chart, then parses the output to generate a list of required images for the chart.
3+
The Replicated Vendor Portal uses the Helm values in the `builder` key to run `helm template` on the chart. It then parses the output to generate a list of required images.
44

55
The Vendor Portal then uses this list of images to do the following:
66
* Create the Helm CLI air gap installation instructions that are automatically made available to customers in the [Enterprise Portal](/vendor/enterprise-portal-about) or Download Portal.
77
* Build the `.airgap` bundle for a release to support air gap installations with a Replicated installer (Embedded Cluster, KOTS, kURL).
88
* Determine which images to scan and report on in the [Security Center (Alpha)](/vendor/security-center-about).
99

10-
The `builder` key is required to support the following installation types:
10+
You must configure the `builder` key to support the following installation types:
1111

1212
* Air gap installations with a Replicated installer (Embedded Cluster, KOTS, kURL)
1313
* Air gap installations with the Helm CLI

docs/partials/helm/_helm-cr-builder-example.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
Many applications have images that are included or excluded based on a given condition.
1+
Many applications include or exclude images based on a given condition.
22

3-
For example, a Helm chart might include a conditional PostgreSQL Deployment, as shown in the Helm template below:
3+
For example, a Helm chart might include a conditional PostgreSQL Deployment,
4+
as shown in the following Helm template:
45

56
```yaml
67
{{- if .Values.postgresql.enabled }}
@@ -29,7 +30,8 @@ spec:
2930
{{- end }}
3031
```
3132

32-
To ensure that the `postgresql` image is included in the air gap bundle for the release, the `postgresql.enabled` value is added to the `builder` key of the HelmChart custom resource and is hardcoded to `true`:
33+
To include the `postgresql` image in the air gap bundle,
34+
add `postgresql.enabled` to the `builder` key of the HelmChart custom resource and set it to `true`:
3335

3436
```yaml
3537
apiVersion: kots.io/v1beta2

docs/partials/helm/_helm-cr-chart-name.mdx

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
Specifies the release name to use when installing this instance of the Helm chart. Defaults to the chart name.
1+
Specifies the release name to use when installing this instance of the Helm chart.
2+
Defaults to the chart name.
23

3-
The release name must be unique across all charts deployed in the namespace. To deploy multiple instances of the same Helm chart in a release, you must add an additional HelmChart custom resource with a unique release name for each instance of the Helm chart.
4+
The release name must be unique across all charts deployed in the namespace.
5+
To deploy multiple instances of the same Helm chart in a release,
6+
add a separate HelmChart custom resource with a unique release name for each instance.
47

58
Must be a valid Helm release name that matches regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` and is no longer than 53 characters.

docs/partials/helm/_helm-cr-chart-version.mdx

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
The `chart` key allows for a mapping between the data in this definition and the chart archive itself.
2-
More than one `kind: HelmChart` can reference a single chart archive, if different settings are needed.
2+
You can create multiple HelmChart resources that all reference a single chart archive.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
When the installer processes your release, it excludes any Helm chart if the output of the `exclude` field is `true`.
22

3-
The `exclude` attribute can be parsed by template functions. See [About Replicated template functions](template-functions-about).
3+
Template functions can parse the `exclude` attribute.
4+
See [About Replicated template functions](template-functions-about).
Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
The `namespace` key specifies an alternative namespace where Replicated KOTS installs the Helm chart. **Default:** The Helm chart is installed in the same namespace as the Admin Console. The `namespace` attribute can be parsed by template functions. For more information about template functions, see [About template function contexts](template-functions-about).
1+
The `namespace` key specifies an alternative namespace to install the Helm chart.
2+
By default, for Embedded Cluster v2 and KOTS existing cluster installations,
3+
KOTS installs the chart in the same namespace as the Admin Console.
4+
For Embedded Cluster v3 installations, Embedded Cluster installs the chart in a namespace named `<your-app-slug>` by default.
25

6+
Template functions can parse the `namespace` attribute.
7+
For more information about template functions, see [About Replicated template functions](/reference/template-functions-about).
38

4-
If you specify a namespace in the HelmChart `namespace` field, you must also include the same namespace in the `additionalNamespaces` field of the Application custom resource manifest file. KOTS creates the namespaces listed in the `additionalNamespaces` field during installation. For more information, see [additionalNamespaces](custom-resource-application#additionalnamespaces) in the _Application_ reference.
9+
For Embedded Cluster v2 and KOTS existing cluster installations,
10+
if you specify a namespace in the HelmChart `namespace` field,
11+
you must also include the same namespace in the [additionalNamespaces](custom-resource-application#additionalnamespaces) field of the Application custom resource.

docs/partials/helm/_helm-cr-optional-values-recursive-merge.mdx

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)