Air-gapped
Suse Rancher Prime
This document provides a step-by-step guide for installing Rancher Prime Observability using Helm charts in an air-gapped environment. The process involves preparing the necessary Docker images and Helm charts on a host with internet access, transferring them to a host within a private network, copying Docker images to a private registry, and then deploying the Helm charts.
Prerequisites
On the Local Host (Internet Access)
Operating System: Linux or MacOS
Internet Access: Required to pull Docker images from Quay.io and Helm charts from ChartMuseum.
On the Private Network Host
Access: SSH access to the host.
Preparing the Docker Images and Helm Charts
Run the following commands on the local host to obtain the required Docker images and Helm charts:
Adding Helm repositories to the local Helm cache:
# Adding the Helm repository for Rancher Prime Observability
helm repo add rancher-prime-observability https://helm-rancher-prime.stackstate.io
helm repo update
Fetching the latest versions of the charts. These commands will download TGZ archives of the charts:
# Downloading the chart for Rancher Prime Observability
# The file will be named stackstate-k8s-A.B.C.tgz
helm fetch rancher-prime-observability/stackstate-k8s
# Downloading the helper chart that generates values for Rancher Prime Observability
# The file will be named stackstate-values-L.M.N.tgz
helm fetch rancher-prime-observability/stackstate-values
Downloading the Bash scripts to save Docker images:
# o11y-get-images.sh
curl -LO https://raw.githubusercontent.com/StackVista/helm-charts/stackstate-6.x/stable/stackstate-k8s/installation/o11y-get-images.sh
# o11y-save-images.sh
curl -LO https://raw.githubusercontent.com/StackVista/helm-charts/stackstate-6.x/stable/stackstate-k8s/installation/o11y-save-images.sh
# Make the scripts executable
chmod a+x o11y-get-images.sh o11y-save-images.sh
Extracting and Saving Docker Images:
# Extract the list of images from the Helm chart and save it to a file.
./o11y-get-images.sh -f stackstate-k8s-A.B.C.tgz > o11y-images.txt
# Save Docker images to an archive.
# The script expects the file o11y-images.txt to contain the list of images used by Rancher Prime Observability.
# The Docker images will be saved to o11y-images.tar.gz.
./o11y-save-images.sh -i o11y-images.txt -f o11y-images.tar.gz
Copying the Required Files to the Remote Host
Copy the following files from the local host to the host in the private network:
o11y-images.txt (List of images required by the Rancher Prime Observability chart)
o11y-images.tar.gz (An archive with the Rancher Prime Observability's Docker images)
o11y-load-images.sh (Bash script to upload Docker images to a registry)
Helm charts downloaded earlier:
stackstate-k8s-A.B.C.tgz
stackstate-values-L.M.N.tgz
Restoring Docker Images from the Archive to the Private Registry
Upload the images to the private registry:
# Load Docker images from the archive and push them to the private registry.
# Replace <private-registry> with your private registry's URL.
export DST_REGISTRY_USERNAME="..."
export DST_REGISTRY_PASSWORD="..."
./o11y-load-images.sh -d registry.example.com:5043 -i o11y-images.txt -f o11y-images.tar.gz
Installing Rancher Prime Observability
Custom Helm values
Installing Rancher Prime Observability Helm charts in an air-gapped environment requires overriding the registries used in Docker image URLs. This can be achieved by customizing Helm values.
Create a private-registry.yaml file with the following content:
global:
imageRegistry: registry.example.com:5043
elasticsearch:
prometheus-elasticsearch-exporter:
image:
repository: registry.example.com:5043/stackstate/elasticsearch-exporter
victoria-metrics-0:
server:
image:
repository: registry.example.com:5043/stackstate/victoria-metrics
victoria-metrics-1:
server:
image:
repository: registry.example.com:5043/stackstate/victoria-metrics
This guide follows the Installing a default HA setup for up to 250 Nodes setup, but instead of using publicly available Helm and Docker repositories/registries, it uses pre-downloaded Helm archives and private Docker registries.
Command to Generate Helm Chart Values File:
helm template \
--set license='<licenseKey>' \
--set baseUrl='<baseURL>' \
--set pullSecret.username='trial' \
--set pullSecret.password='trial' \
prime-observability-values stackstate-values-L.M.N.tgz\
> values.yaml
Deploying the Rancher Prime Observability Helm Chart:
helm upgrade --install \
--namespace prime-observability \
--create-namespace \
--values values.yaml \
--values private-registry.yaml \
prime-observe \
stackstate-k8s-A.B.C.tgz
Validating the Deployment:
kubectl get pod -n prime-observability
Last updated