Install Kommander in an air-gapped environment

This topic shows how to run Kommander on top of an air-gapped Konvoy cluster installation.

Prerequisites

Before installing, ensure you have:

A Docker registry containing all the necessary Docker installation images, including the Kommander images. The kommander_image_bundle_v2.1.1_linux_amd64.tar tarball has the required artifacts.
Connectivity with clusters attaching to the management cluster:
- Both management and attached clusters must connect to the Docker registry.
- Management cluster must connect to the attached cluster’s API server.
- Management cluster must connect to load balancers created by some platform services.
A configuration file that you will adapt to your needs using the steps outlined in this topic. Make sure to create that file using the following command:

kommander install --init > install.yaml

All the prerequisites covered in air-gapped Konvoy installation.
MetalLB enabled and configured, which provides load-balancing services.

Use MetalLB

For an on-premises deployment, Kommander ships with MetalLB, which provides load-balancing services.

NOTE: Making a configuration change in the ConfigMap for the metallb application may not result in the configuration change applying. This is intentional behavior. MetalLB refuses to adopt changes to the ConfigMap that breaks existing Services. You can force MetalLB to load those changes by deleting the metallb controller pod:

kubectl -n kommander delete pod -l app=metallb,component=controller

To use MetalLB:

Identify and reserve a virtual IP (VIP) address range in your networking infrastructure.
Configure your networking infrastructure so that the reserved IP addresses is reachable:
- from all hosts specified in the inventory file.
- from the computer used to deploy Kubernetes.

NOTE: Ensure the MetalLB subnet does not overlap with podSubnet and serviceSubnet.

Your configuration is complete if the reserved virtual IP addresses are in the same subnet as the rest of the cluster nodes. If it is in a different subnet, configure appropriate routes to ensure connectivity with the virtual IP address. If the virtual IP addresses share an interface with the primary IP address of the interface, disable any IP or MAC spoofing from the infrastructure firewall.

You can configure MetalLB in two modes: Layer2 and BGP.

Layer2

The following example illustrates how to enable MetalLB and configure it with the Layer2 mode using the install.yaml configuration file created above:

apiVersion: config.kommander.mesosphere.io/v1alpha1
kind: Installation
apps:
 ...
  metallb:
    values: |
      configInline:
        address-pools:
          - name: default
            protocol: layer2
            addresses:
              - 10.0.50.25-10.0.50.50

The number of virtual IP addresses in the reserved range determines the maximum number of LoadBalancer service types you can create in the cluster.

BGP

MetalLB in bgp mode implements only a subset of the BGP protocol. In particular, it only advertises the virtual IP to peer BGP agent.

The following example illustrates the BGP configuration in the overrides ConfigMap:

apiVersion: config.kommander.mesosphere.io/v1alpha1
kind: Installation
apps:
 ...
  metallb:
    values: |
      configInline:
        peers:
          - my-asn: 64500
            peer-asn: 64500
            peer-address: 172.17.0.4
        address-pools:
          - name: my-ip-space
            protocol: bgp
            addresses:
              - 172.40.100.0/24

In the above configuration, peers defines the configuration of the BGP peer, such as peer IP address and autonomous system number (asn). The address-pools section is similar to layer2, except for the protocol.

MetalLB also supports advanced BGP configuration.

See Kommander Load Balancing for more information.

Determine the installation version

Set the VERSION environment variable to the version of Kommander you want to install, for example:

export VERSION=v2.1.1

Load the Docker images into your Docker registry

Download the image bundle file:

wget "https://downloads.d2iq.com/kommander/airgapped/${VERSION}/kommander_image_bundle_${VERSION}_linux_amd64.tar" -O - | tar -xvf -

See the NOTICES.txt file for 3rd party software attributions and place the kommander_image_bundle_v2.1.1_linux_amd64.tar bundle within a location where you can load and push the images to your private Docker registry.

Ensure you set the REGISTRY_URL and AIRGAPPED_TAR_FILE variable appropriately, then use the following script to load the air-gapped image bundle:

#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'

readonly AIRGAPPED_TAR_FILE=${AIRGAPPED_TAR_FILE:-"kommander_image_bundle_v2.1.1_linux_amd64.tar"}
readonly REGISTRY_URL=${REGISTRY_URL?"Need to set REGISTRY_URL. E.g: 10.23.45.67:5000"}

docker load <"${AIRGAPPED_TAR_FILE}"

while read -r IMAGE; do
    echo "Processing ${IMAGE}"
    REGISTRY_IMAGE="$(echo "${IMAGE}" | sed -E "s@^(quay|gcr|ghcr|docker|k8s.gcr).io@${REGISTRY_URL}@")"
    docker tag "${IMAGE}" "${REGISTRY_IMAGE}"
    docker push "${REGISTRY_IMAGE}"
done < <(tar xfO "${AIRGAPPED_TAR_FILE}" "index.json" | grep -oP '(?<="io.containerd.image.name":").*?(?=",)')

Based on the network latency between the environment of script execution and the docker registry, this can take a while to upload all the images to your image registry.

Install on Konvoy

Adapt the configuration file created from running kommander install --init > install.yaml for the air-gapped deployment by changing the .apps.kommander section. Ensure you use the actual version number everywhere ${VERSION} appears:

apiVersion: config.kommander.mesosphere.io/v1alpha1
kind: Installation
apps:
  ...
  kommander:
    values: |
      authorizedlister:
        image:
          tag: ${VERSION}-amd64
      controller:
        containers:
          manager:
            image:
              tag: ${VERSION}-amd64
      fluxOperator:
        containers:
          manager:
            image:
              tag: ${VERSION}-amd64
      kommander-licensing:
        controller:
          containers:
            manager:
              image:
                tag: ${VERSION}-amd64
        webhook:
          image:
            tag: ${VERSION}-amd64
      kubetools:
        image:
          tag: ${VERSION}-amd64
      webhook:
        image:
          tag: ${VERSION}-amd64
...

In the same file, adapt the other image tags accordingly and enable air-gapped mode. Replace ${VERSION} with the actual version number:
```
appManagementImageTag: "${VERSION}-amd64"
airgapped:
  enabled: true
  helmMirrorImageTag: "${VERSION}-amd64"
```

In the same file, if you are installing Kommander in an AWS VPC, set the Traefik annotation to create an internal facing ELB:

apps:
  traefik:
    values: |
      service:
        annotations:
          service.beta.kubernetes.io/aws-load-balancer-internal: "true"

Download and extract the kommander-applications bundle.
```
mkdir kommander-applications && wget https://downloads.d2iq.com/dkp/kommander-applications_${VERSION}.tar.gz -O - | tar xvzf - -C kommander-applications
```
NOTE: This Docker image includes code from the MinIO Project (“MinIO”), which is © 2015-2021 MinIO, Inc. MinIO is made available subject to the terms and conditions of the GNU Affero General Public License 3.0. Complete source code for MinIO is available here and here.
To install Kommander in your air-gapped environment using the above configuration file, enter the following command:
```
kommander install --installer-config ./install.yaml --kommander-applications-repository ./kommander-applications
```
Verify your installation.

This Docker image includes code from the MinIO Project (“MinIO”), which is © 2015-2021 MinIO, Inc. MinIO is made available subject to the terms and conditions of the [GNU Affero General Public License 3.0][https://www.gnu.org/licenses/agpl-3.0.en.html]. The complete source code for the versions of MinIO packaged with DKP 2.1.0 are available at these URLs:

https://github.com/minio/minio/tree/RELEASE.2021-07-30T00-02-00Z
https://github.com/minio/minio/tree/RELEASE.2020-12-03T05-49-24Z

How to host git repositories on Gitea for air gapped deployments…Read More

Install Kommander in an air-gapped environment

Install Kommander in an air-gapped environment

Prerequisites

Use MetalLB

Layer2

BGP

Determine the installation version

Load the Docker images into your Docker registry

Install on Konvoy

Host on Gitea