Skip to content

Commit b671bf2

Browse files
committed
wip: clarify how builder is used for helm air gap installs
1 parent f6ed9d4 commit b671bf2

File tree

2 files changed

+22
-28
lines changed

2 files changed

+22
-28
lines changed

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

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

9090
## builder
9191

92-
The `builder` key is used to provide Helm values that are used during various stages of processing the Helm chart.
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.
9393

94-
The `builder` key is required for the following use cases:
95-
96-
* To create an `.airgap` bundle for installations into air gap environments.
97-
98-
<BuilderAirgapIntro/>
99-
100-
For more information, see [Package Air Gap Bundles for Helm Charts](/vendor/helm-packaging-airgap-bundles).
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.
10195

102-
* To support online installations that use a local private registry, the `builder` field renders the Helm chart with all of the necessary images so that KOTS knows where to pull the images.
96+
The `builder` key is required for the following use cases:
10397

104-
You cannot prevent customers from configuring a local private registry in the Admin Console. If you think any of your customers will use a local private registry, you should use the `builder` key. For more information, see [Configuring Local Image Registries](/enterprise/image-registry-settings).
98+
* Air gap installations with a Replicated installer (Embedded Cluster, KOTS, kURL)
99+
* Air gap installations with Helm
100+
* Online installations with a Replicated installer where the user configured a local image registry
105101

106102
<HelmBuilderRequirements/>
107103

108-
* Use the same `builder` configuration to support the use of local registries in both online and air gap installations. If you already configured the `builder` key to support air gap installations, then no additional configuration is required.
109-
110104
**Example:**
111105

112106
<BuilderExample/>
107+
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).
109+
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).

docs/vendor/helm-install-airgap.mdx

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,36 @@
1-
import Prerequisites from "../partials/helm/_helm-install-prereqs.mdx"
2-
31
# Install and Update with Helm in Air Gap Environments
42

5-
This topic describes how to use Helm to install releases that contain one or more Helm charts in air-gapped environments.
3+
This topic describes how to use Helm to install and update releases that contain one or more Helm charts in air-gapped environments.
64

75
## Overview
86

9-
Replicated supports installing and updating Helm charts in air-gapped environments with no outbound internet access. In air gap Helm installations, customers are guided through the process with instructions provided in the [Replicated Download Portal](/vendor/releases-share-download-portal).
7+
Replicated supports installing and updating Helm charts in _air-gapped_ environments with little or no outbound internet access. In air gap Helm installations, customers are guided through the installation process with instructions provided in either the [Replicated Enterprise Portal](/vendor/enterprise-portal-about) or the [Replicated Download Portal](/vendor/releases-share-download-portal), depending on which is enabled for the customer.
108

11-
When air gap Helm installations are enabled, an **Existing cluster with Helm** option is displayed in the Download Portal on the left nav. When selected, **Existing cluster with Helm** displays three tabs (**Install**, **Manual Update**, **Automate Updates**), as shown in the screenshot below:
9+
These instructions assume that the customer is accessing the portal from a workstation that can access the internet and their internal private registry. Direct access to the target cluster is not required. The instructions also assume that the customer is familiar with `curl`, `docker`, `helm`, and `kubernetes`, and that they have some familiarity with `bash`, particularly for automating updates.
1210

13-
![download helm option](/images/download-helm.png)
11+
## Prerequisites
1412

15-
[View a larger version of this image](/images/download-helm.png)
13+
Before you install, complete the following prerequisites:
1614

17-
Each tab provides instructions for how to install, perform a manual update, or configure automatic updates, respectively.
15+
* Declare the SDK as a dependency in your Helm chart. For more information, see [Install the SDK as a Subchart](replicated-sdk-installing#install-the-sdk-as-a-subchart) in _Installing the Replicated SDK_.
1816

19-
These installing and updating instructions assume that your customer is accessing the Download Portal from a workstation that can access the internet and their internal private registry. Direct access to the target cluster is not required.
17+
* Configure the HelmChart custom resource `builder` key. This ensures that the Vendor Portal can successfully template the chart to discover the full list of container images required to install and run the chart in an air-gapped environment. The Vendor Portal uses this list of required images to create the Helm air gap installation instructions for the customer. For more information, see [builder](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_.
2018

21-
Each method assumes that your customer is familiar with `curl`, `docker`, `helm`, `kubernetes`, and a bit of `bash`, particularly for automating updates.
19+
* The customer used to install must have the following:
2220

23-
## Prerequisites
21+
* A valid email address. This email address is only used as a username for the Replicated registry and is never contacted. For more information, see [Creating a Customer](/vendor/releases-creating-customer).
2422

25-
Before you install, complete the following prerequisites:
23+
* The **Existing Cluster (Helm CLI)** install type enabled. For more information, see [Manage Install Types for a License](licenses-install-types).
2624

27-
<Prerequisites/>
25+
* The **Helm CLI Air Gap Instructions** install option enabled.
2826

2927
## Install
3028

31-
The installation instructions provided in the Download Portal are designed to walk your customer through the first installation of your chart in an air gap environment.
32-
3329
To install with Helm in an air gap environment:
3430

3531
1. In the [Vendor Portal](https://vendor.replicated.com), go to **Customers > [Customer Name] > Reporting**.
3632

37-
1. In the **Download portal** section, click **Visit download portal** to log in to the Download Portal for the customer.
33+
1. In the **Enterprise portal** or **Download portal** section (depending on which is enabled for the customer), click **Visit** to log in to the portal.
3834

3935
1. In the Download Portal left nav, click **Existing cluster with Helm**.
4036

0 commit comments

Comments
 (0)