Skip to main content
Version: 1.4

Install Elemental in an Air-Gapped Environment

Assumptions

A Rancher air-gapped installation should be already configured as per the official Rancher documentation. In particular, a private registry should be available in the air-gapped infrastructure.

Download Elemental charts and Elemental images

In order to run Elemental in an air-gapped environment the following artifacts are needed:

  • the Elemental Operator charts
  • the container images referenced in the charts (the elemental-operator and seedimage-builder images)
  • the containerized OS images

Moreover, it could be handy to create a channel image referencing the containerized OS images available. The official channel image (the elemental-teal-channel one) references absolute URLs of the OS images on the official suse registry, so it cannot be used in an air-gapped scenario.

All these steps can be performed by executing the elemental-airgap.sh script from a host with Internet access. You can provide manually downloaded Elemental charts to the script or let it download the helm charts for you. elemental-airgap.sh will inspect the Elemental Operator chart, identify all the required container images, download and save them in an archive. It will also build a new OS channel image with OS URLs pointing to the private registry (which must be specified as an argument on the command line).

Here we will download all the artifacts and build a custom channel from the latest stable release of Elemental:

wget https://raw.githubusercontent.com/rancher/elemental-operator/main/scripts/elemental-airgap.sh
chmod 755 elemental-airgap.sh
./elemental-airgap.sh stable -r <REGISTRY.YOURDOMAIN.COM:PORT>

once completed (the script may take a while) the following files will be available in the current dir:

  • elemental-operator-crds-chart-<*VERSION*>.tgz
  • elemental-operator-chart-<*VERSION*>.tgz
  • elemental-images.txt
  • elemental-images.tar.gz

Perform Elemental installation using the generated artifacts

All the above files should be copied to a host which:

  • Has access to the private registry. If the private registry requires authentication log into it:
docker login <REGISTRY.YOURDOMAIN.COM:PORT>
  • Has the kubectl binary installed and configured to access the air-gapped Rancher cluster.
  • Has the helm binary installed.

Two steps are needed to perform the Elemental installation:

  1. load the archive with all the required container images on the private registry: this could be done using the rancher-load-images.sh script distributed with the Rancher release and already used for the Rancher air-gapped deployment:
rancher-load-images.sh \
--image-list elemental-images.txt \
--images elemental-images.tar.gz \
--registry <REGISTRY.YOURDOMAIN.COM:PORT>
  1. install the downloaded elemental charts configuring the local registry and the newly created channel:
helm upgrade --create-namespace -n cattle-elemental-system \
--install elemental-operator-crds elemental-operator-crds-chart-<VERSION>.tgz

helm upgrade --create-namespace -n cattle-elemental-system \
--install elemental-operator elemental-operator-chart-<VERSION>.tgz \
--set registryUrl=<REGISTRY.YOURDOMAIN.COM:PORT> \
--set channel.repository=rancher/elemental-teal-channel-<REGISTRY.YOURDOMAIN.COM>
The elemental airgap script outputs the required commands

The elemental-airgap.sh scripts prints out the required commands shown above but using the actual chart version and the provided registry URL to allow to just copy and paste.

Elemental UI Extension

Rancher 2.7.x doesn't support UI extensions plugin in air-gapped environments, and so the Elemental UI is not available in Rancher 2.7.x.

The Elemental UI plugin will be present in the available UI extensions in Rancher 2.8.0.