hauler/README.md

Hauler - Kubernetes Air Gap Migration

#  _                 _           
# | |__   __ _ _   _| | ___ _ __ 
# | '_ \ / _` | | | | |/ _ \ '__|
# | | | | (_| | |_| | |  __/ |   
# |_| |_|\__,_|\__,_|_|\___|_| 
#
#                ,        ,  _______________________________
#    ,-----------|'------'|  |                             |
#   /.           '-'    |-'  |_____________________________|
#  |/|             |    |
#    |   .________.'----'    _______________________________
#    |  ||        |  ||      |                             |
#    \__|'        \__|'      |_____________________________|
#
# |‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾|
# |________________________________________________________|
#                                                          |
# |‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾|
# |________________________________________________________|

WARNING- Work In Progress

Prerequisites

• CentOS 7
• User with root/sudo privileges

Installing on an airgap network

1. (Skip if you aren't using SELINUX) Install the selinux dependencies. yum localinstall -y ./artifacts/yum/*.
2. For some reason, centos doesn't add /usr/local/bin to the path. Add it with echo 'export PATH=${PATH}:/usr/local/bin' >> ~/.bashrc

Charts to include

• Rancher
• Registry
• Minio
• Longhorn
• git-http-backend
• argo

TODO

• Write the thing
• Include Vagrantfile for testing

Other possible names

• k3vac
• k3ziplock
• k3wh - k3 wormhole
• k3cia - Comms insensensitive Assistant
• k3diode

Vagrant machine

A Vagrantfile is provided to allow easy provisioning of a local air-gapped CentOS environment. Some artifacts need to be collected from the internet, however; below are the steps required for successfully provisioning this machine, downloading all dependencies, and installing k3s (without hauler) into this machine.

First-time setup

1. Install vagrant, if needed: https://www.vagrantup.com/downloads
2. Install vagrant-vbguest plugin, as noted in the Vagrantfile:

vagrant plugin install vagrant-vbguest

3. Deploy Vagrant machine, disabling SELinux:

SELINUX=Disabled vagrant up

4. Access the Vagrant machine via SSH:

vagrant ssh

5. Run all prep scripts inside of the Vagrant machine:

sudo /opt/k3ama/vagrant-scripts/prep-all.sh

This script temporarily enables internet access from within the VM to allow downloading all dependencies. Even so, the air-gapped network configuration IS restored before completion.

All dependencies for all vagrant-scripts/*-install.sh scripts are now downloaded to the local repository under local-artifacts.

Installing k3s manually

1. Access the Vagrant machine via SSH:

vagrant ssh

2. Run the k3s install script inside of the Vagrant machine:

sudo /opt/k3ama/vagrant-scripts/k3s-install.sh

Installing RKE2 manually

1. Access the Vagrant machine via SSH:

vagrant ssh

2. Run the RKE2 install script inside of the Vagrant machine:

sudo /opt/k3ama/vagrant-scripts/rke2-install.sh

Go CLI

The initial MVP for a hauler CLI used to streamline the packaging and deploying processes is in the cmd/ and pkg/ folders, along with go.mod and go.sum. Currently only a package subcommand is supported, which generates a .tar.gz archive used in the future deploy subcommand.

Build

To build hauler, the Go CLI v1.14 or higher is required. See https://golang.org/dl/ for downloads and see https://golang.org/doc/install for installation instructions.

To build hauler for your local machine (usually for the package step), run the following:

mkdir bin
go build -o bin ./cmd/...

To build hauler for linux amd64 (required for the deploy step in an air-gapped environment), run the following:

mkdir bin-linux-amd64
GOOS=linux GOARCH=amd64 go build -o bin-linux-amd64 ./cmd/...