Skip to content

Commit 85a1dfb

Browse files
committed
add subheadings
1 parent 604d749 commit 85a1dfb

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/reference/custom-resource-helmchart-v2.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,22 +89,26 @@ For an example of recursive and non-recursive merging, see [About Recursive Merg
8989

9090
## builder
9191

92-
The `builder` key contains the minimum Helm values required so that the output of `helm template` includes all container images needed to install and run the chart in an air-gapped environment.
92+
#### Overview
9393

94-
The Replicated Vendor Portal uses the values in the `builder` key to run `helm template` on the chart, then parses the output to discover the list of images that the Helm chart requires. This list of required images is used to create the `.airgap` bundle for the release, and to build the Helm air gap installation instructions available in the Replicated Enterprise Portal.
94+
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.
9595

96-
The `builder` key is required for the following use cases:
96+
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 discover the list of required images for the chart. This list of required images is used to create the `.airgap` bundle for the release (for air gap installations with a Replicated installer), and to create the Helm air gap installation instructions available to customers in the Replicated Enterprise Portal or Download Portal.
97+
98+
The `builder` key is required to support the following installation types:
9799

98100
* Air gap installations with a Replicated installer (Embedded Cluster, KOTS, kURL)
99101
* Air gap installations with Helm
100-
* Online installations with a Replicated installer where the user configured a local image registry
102+
* Online installations with a Replicated installer where the user configured a local image registry in the Admin Console
103+
104+
#### Requirements
101105

102106
<HelmBuilderRequirements/>
103107

104-
**Example:**
108+
#### Example
105109

106110
<BuilderExample/>
107111

108-
For more information about building `.airgap` bundles for installations with a Replicated installer (Embedded Cluster, KOTS, kURL), see [Package Air Gap Bundles for Helm Charts](/vendor/helm-packaging-airgap-bundles).
112+
For more information about how to build `.airgap` bundles for installations with a Replicated installer (Embedded Cluster, KOTS, kURL), see [Package Air Gap Bundles for Helm Charts](/vendor/helm-packaging-airgap-bundles).
109113

110-
For more information about installing with Helm in air-gapped environments, see [Install and Update with Helm in Air Gap Environments](/vendor/helm-install-airgap).
114+
For more information about how to install with Helm in air-gapped environments, see [Install and Update with Helm in Air Gap Environments](/vendor/helm-install-airgap).

0 commit comments

Comments
 (0)