Skip to content

Commit fa7e8d6

Browse files
committed
add enterprise portal install instructions
1 parent 16e9e79 commit fa7e8d6

File tree

2 files changed

+40
-6
lines changed

2 files changed

+40
-6
lines changed

docs/vendor/helm-install-airgap.mdx

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Install and Update with Helm in Air Gap Environments
22

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

55
## Overview
66

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.
7+
Replicated supports installing and updating with Helm in _air-gapped_ environments with little or no outbound internet access. In air gap installations with Helm, 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.
88

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.
9+
These instructions assume that the customer is logged in to the portal on a workstation that can access both the internet and their internal private image registry. Direct access to the target installation 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.
1010

1111
## Prerequisites
1212

1313
Before you install, complete the following prerequisites:
1414

1515
* 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_.
1616

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_.
17+
* Configure the HelmChart custom resource `builder` key. This ensures that the Vendor Portal can template the chart to discover the full list of container images required to install 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_.
1818

1919
* The customer used to install must have the following:
2020

@@ -26,11 +26,45 @@ Before you install, complete the following prerequisites:
2626

2727
## Install
2828

29-
To install with Helm in an air gap environment:
29+
Helm air gap installation instructions are provided in either the Enterprise Portal or the Download Portal, depending on which is enabled for the customer.
30+
31+
For more information about enabling the Enterprise Portal for a customer, see [Manage Enterprise Portal Access](/vendor/enterprise-portal-invite).
32+
33+
### Enterprise Portal (Beta)
34+
35+
To install with Helm in an air gap environment using the Enterprise Portal:
36+
37+
1. In the [Vendor Portal](https://vendor.replicated.com), go to **Customers > [Customer Name] > Reporting**.
38+
39+
1. In the **Enterprise portal** section, click **Visit** to log in to the portal.
40+
41+
1. In the Enterprise Portal, go to the **Install** tab then click **Helm** in the left nav.
42+
43+
1. On the first page of the installation wizard, complete any pre-install instructions. If the vendor did not include any custom pre-install instructions, continue to the next step.
44+
45+
1. Complete the following fields and then click **Continue**:
46+
47+
* **Instance Name**: Enter a name for the instance.
48+
* **Kubernetes Distribution**: Select the Kubernetes distribution of the cluster where you will install.
49+
* **Cluster Network Availability**: Select the network availability of the cluster. For air gap installations, select **No outbound requests allowed (air gap)**.
50+
* **Registry Access**: Select the option that describes your current workstation's access to the internal image registry where you will push application images during installation. For air gap installations, select either **My workstation can only access the internet AND the registry (NOT the cluster)** or **I need to download artifacts and transfer them for offline installation**.
51+
52+
The following shows an example of the Helm air gap installation instructions in the Enterprise Portal:
53+
54+
![Helm air gap installation guide](/images/enterprise-portal-installation-guide-helm-air-gap.png)
55+
[View a larger version of this image](/images/enterprise-portal-installation-guide-helm-air-gap.png)
56+
57+
1. On the **Helm Air Gap Install** page, follow the instructions provided to install the chart and then click **Continue**.
58+
59+
1. On the last page of the installation wizard, complete any custom post-installation instructions for the application.
60+
61+
### Download Portal
62+
63+
To install with Helm in an air gap environment using the Download Portal:
3064

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

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.
67+
1. In the **Download portal** section, click **Visit download portal** to log in to the portal.
3468

3569
1. In the Download Portal left nav, click **Existing cluster with Helm**.
3670

Loading

0 commit comments

Comments
 (0)