Skip to content

Commit 66bbf6e

Browse files
committed
helm airgap docs
1 parent 6d93bfe commit 66bbf6e

File tree

4 files changed

+5886
-378
lines changed

4 files changed

+5886
-378
lines changed

docs/vendor/install-with-helm.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,24 @@ To install a Helm chart:
110110
**Example**:
111111

112112
![example customer in the Vendor Portal with an active instance](/images/sdk-customer-active-example.png)
113-
[View a larger version of this image](/images/sdk-customer-active-example.png)
113+
[View a larger version of this image](/images/sdk-customer-active-example.png)
114+
115+
116+
## Helm installs for Airgap Environments (Alpha)
117+
Replicated now supports installing and updating Helm charts in Airgapped environments and guiding end customers through the process with the [Download Portal](/vendor/releases-share-download-portal). Please ask your account rep to enable this feature if you're interested in trying it and providing feedback.
118+
119+
When this feature is enabled, a new option will be displayed for the Download Portal on the left nav, that when selected, will display 3 tabs (Install, Manual Update, Automate Updates):
120+
![download helm option](/images/download-helm.png)
121+
122+
Each of these instruction sets assumes 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 require. Each method assumes that your customer is familiar with `curl`, `docker`, `helm`, `kubernetes`, and a bit of `bash`, particularly for automate.
123+
124+
### Install
125+
The install instructions are designed to walk your customer through the first installation of your chart in a disconnected environment. They'll be presented with credentials (the license_id) to authenticate into the proxy registry that Replicated manages for you. From there, we present them with the full list of images and the corresponding `docker` `pull`, `tag`, and `push` commands for each. If they've provided their registry URI, we pre-configure the commands, else they'll need to manually replace the image names in the `tag` and `push` commands. Next they'll authenticate into the OCI registry that contains your Helm chart, and then install the `preflight` plugin. In the next steps, they'll get your default `values.yaml` and edit it to meet their environment's configuration needs. We recommend that your accompanying documentation include detailed instructions on what values they need to configure. Finally, your customer will specify how they access their cluster and then use the corresponding commands and their edited `values.yaml` to run the Preflight Checks and install the chart.
126+
127+
### Manual Updates
128+
The manual update instructions follow closely with the install instructions. However, the first step prompts the customer to select their current version and target version to install. This step takes [required releases](/vendor/releases-about#properties) into consideration, thereby guiding the customer to the versions that are upgradable from their current version. The additional steps are very consistent with install process until the `preflight` and `install` commands where we need to get the existing values from the cluster with the `helm get values` and `--reuse-values` commands. Should you introduce new images, or other values, you should call this out at the top of your release notes so that customers know they will need to make additional edits to the `values.yaml` before installing.
129+
130+
### Automate Updates
131+
The automate update instructions rely on a few new API endpoints that your customers can automate against. We provide each customer with example commands that can be put into a script that they run periodically (i.e. nightly, weekly) via GitHub Actions, Jenkins etc. This method assumes that the customer has already done a successful manual installation, including the configuration the appropriate `values`.
132+
133+
After logging into the registry, we have the customer export their current version and use that to query an endpoint that provides the latest installable version number (either the next required release, or the latest release) and export it as the target version. With the target version, they can now query an API for the list of images. With this list of images the provided `bash` script will automate the process of pulling updated images from the repository, tagging them with a name for an internal registry, and then pushing the newly tagged images to their internal registry. With the assumption that the customer has set up the `values` to preserve the updated tag, they should now be able to login to the OCI registry and perform the commands to install the updated chart.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
"@types/node": "18.15.11",
2323
"@types/react": "18.3.5",
2424
"clsx": "^2.1.0",
25+
"docusaurus": "^1.14.7",
2526
"loader-utils": "3.3.1",
2627
"prism-react-renderer": "^2.3.0",
2728
"react": "^18.2.0",

static/images/download-helm.png

193 KB
Loading

0 commit comments

Comments
 (0)