Skip to content

davosian/home-cluster-v2

BranchesTags

Repository files navigation

home-cluster-v2

Cluster running apps and services for my smarthome

Current Status

This repository is currently under heavy development as it tracks my various attemps for setting up the services. In a first step, all installation will be done manually and this document serves as a notebook to record the steps taken and the resources consulted.

Disclaimer: I am new to Nomad, Consul and Vault, so do not take this setup as best practice. It might contain serious security holes! Should you find issues with this setup, please open an issue or propose a fix (PR).

I am using Ubuntu Multipass for a local development environment. This ensures that we a clean, reproducable base line. Vagrant is not an option since I am using an M1 based Mac and there is no good virtualization support that plays nicely with Vagrant.

For an initial testing and for everyone else to reproduce, I am using Hetzner to build up a virtual cluster before erasing my current set of servers running at home.

In order to simplify setting up the cluster, some basic automation is being done with Task.

Progress

  • Provision hardware
  • Provide storage
  • Install nomad, consul and vault
  • VPN access to the cluster
  • Initial configuration for Vault
  • Automate setup & provisioning with Task
  • Ingress setup
  • Test storage in nomad
  • Setup ingress with test load
  • Integrate Vault with Nomad
  • Integrate Consul KV
  • Set up observability stack (logs, traces, metrics)

References

Test environment

Development environment provisioning

Download and install multipass from https://multipass.run/.

Set up a VM called dev with 2GB RAM, 2 CPUs and 4GB disk space:

multipass launch -n dev -m 2G -c 2 -d 4G
multipass start dev
multipass shell dev

Prepare the local environment:

# install task
sudo sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin

# get the sources
mkdir -p ~/src && cd ~/src
git clone https://github.com/davosian/home-cluster-v2.git
cd home-cluster-v2

Automated setup

Note: These scripts are still incomplete, untested and contain bugs. Use the manual steps in the meantime.

# provision the local environment
task devsetup:install

# prepare the cloud integration
task devsetup:cloudinstall

# cloud provisioning
task cloudprovisioning:install

Manual setup

In case you want to manually perform the steps, follow them in the sections below.

Provision the local environment

We are using 1Password to maintain all passwords. Feel free to switch to an alternative option like pass. This allows us to never store any sensitive information in files and makes it easy to share our configuration on github. The only downside is that loading the environment variables takes a few seconds and requires an internet connection.

# update the system
sudo apt update && sudo apt upgrade
sudo apt install -y unzip direnv neovim

# install 1password cli
curl -sS https://downloads.1password.com/linux/keys/1password.asc | \
 sudo gpg --dearmor --output /usr/share/keyrings/1password-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/1password-archive-keyring.gpg] https://downloads.1password.com/linux/debian/$(dpkg --print-architecture) stable main" |
 sudo tee /etc/apt/sources.list.d/1password.list
sudo mkdir -p /etc/debsig/policies/AC2D62742012EA22/
curl -sS https://downloads.1password.com/linux/debian/debsig/1password.pol | \
 sudo tee /etc/debsig/policies/AC2D62742012EA22/1password.pol
sudo mkdir -p /usr/share/debsig/keyrings/AC2D62742012EA22
curl -sS https://downloads.1password.com/linux/keys/1password.asc | \
 sudo gpg --dearmor --output /usr/share/debsig/keyrings/AC2D62742012EA22/debsig.gpg
sudo apt update && sudo apt install 1password-cli

# verify 1password installation
op --version

# add 1password account
op account add

# login to 1password (valid for 30 minutes)
eval $(op signin)

# add bash completion
echo "source <(op completion bash)" >> ~/.bashrc

# configure direnv
# add to the bottom of ~/.bashrc
eval "$(direnv hook bash)"

# reload the shell
source ~/.bashrc

# prepare the environment
cp .envrc.example .envrc
direnv allow

# create a ssh key without passphrase for convenience
ssh-keygen

Prepare the cloud integration

Connect into the multipass VM if not done so already in the previous section. All other steps in this section will be performed inside this VM.

multipass shell dev

Install the Hetzner CLI:

# install hcloud manually since the one from apt is outdated and 
# does not work with the following instructions
cd ~/dl
# note: get the latest release for your platform from https://github.com/hetznercloud/cli/releases
curl -OL https://github.com/hetznercloud/cli/releases/download/v1.29.0/hcloud-linux-arm64.tar.gz
tar -xvf hcloud-linux-arm64.tar.gz
sudo mv hcloud /usr/local/bin
rm -f CHANGES.md LICENSE README.md hcloud hcloud-linux-arm64.tar.gz

# add to the bottom of ~/.bashrc
source <(hcloud completion bash)

# reload the shell
source ~/.bashrc

# prepare the hcloud cli
# first follow the steps from https://github.com/hetznercloud/cli, then continue here

# add the hetzner api key and context to .envrc
# also add your public ssh key (in double quotes, without `user@server` at the end)
export HCLOUD_TOKEN=YOUR_TOKEN
export HCLOUD_CONTEXT=home-cluster
export SSH_PUBLIC_KEY=YOUR_KEY
export SSH_USER=root

direnv allow

# connect to hetzner
hcloud context create home-cluster

# make sure the connection is working
hcloud server-type list
hcloud server list

Hardware provisionig

Provision the cloud infrastructure:

# Create private network
hcloud network create --name network-nomad --ip-range 10.0.0.0/16
hcloud network add-subnet network-nomad --network-zone eu-central --type server --ip-range 10.0.0.0/16

# Create placement group
hcloud placement-group create --name group-spread --type spread

# Prepare a ssh key to use for connecting to the servers
hcloud ssh-key create --name home-cluster --public-key-from-file ~/.ssh/id_rsa.pub

# Create VMs
hcloud server create --datacenter fsn1-dc14 --type cx11 --name server-1 --image debian-10 --ssh-key home-cluster --network network-nomad --placement-group group-spread
hcloud server create --datacenter fsn1-dc14 --type cx11 --name server-2 --image debian-10 --ssh-key home-cluster --network network-nomad --placement-group group-spread
hcloud server create --datacenter fsn1-dc14 --type cx11 --name server-3 --image debian-10 --ssh-key home-cluster --network network-nomad --placement-group group-spread
hcloud server create --datacenter fsn1-dc14 --type cx11 --name client-1 --image debian-10 --ssh-key home-cluster --network network-nomad --placement-group group-spread
hcloud server create --datacenter fsn1-dc14 --type cx11 --name client-2 --image debian-10 --ssh-key home-cluster --network network-nomad --placement-group group-spread

# Create firewall
hcloud firewall create --name firewall-nomad

# Allow incoming SSH and ICMP
hcloud firewall add-rule firewall-nomad --description "Allow SSH In" --direction in --port 22 --protocol tcp --source-ips 0.0.0.0/0 --source-ips ::/0
hcloud firewall add-rule firewall-nomad --description "Allow ICMP In" --direction in --protocol icmp --source-ips 0.0.0.0/0 --source-ips ::/0

# Allow outgoing ICMP, DNS, HTTP, HTTPS and NTP
hcloud firewall add-rule firewall-nomad --description "Allow ICMP Out" --direction out --protocol icmp --destination-ips 0.0.0.0/0 --destination-ips ::/0
hcloud firewall add-rule firewall-nomad --description "Allow DNS TCP Out" --direction out --port 53 --protocol tcp --destination-ips 0.0.0.0/0 --destination-ips ::/0
hcloud firewall add-rule firewall-nomad --description "Allow DNS UDP Out" --direction out --port 53 --protocol udp --destination-ips 0.0.0.0/0 --destination-ips ::/0
hcloud firewall add-rule firewall-nomad --description "Allow HTTP Out" --direction out --port 80 --protocol tcp --destination-ips 0.0.0.0/0 --destination-ips ::/0
hcloud firewall add-rule firewall-nomad --description "Allow HTTPS Out" --direction out --port 443 --protocol tcp --destination-ips 0.0.0.0/0 --destination-ips ::/0
hcloud firewall add-rule firewall-nomad --description "Allow NTP UDP Out" --direction out --port 123 --protocol udp --destination-ips 0.0.0.0/0 --destination-ips ::/0

# Apply firewall rules to all servers
hcloud firewall apply-to-resource firewall-nomad --type server --server server-1
hcloud firewall apply-to-resource firewall-nomad --type server --server server-2
hcloud firewall apply-to-resource firewall-nomad --type server --server server-3
hcloud firewall apply-to-resource firewall-nomad --type server --server client-1
hcloud firewall apply-to-resource firewall-nomad --type server --server client-2

# Check the connections and accept the keys when prompted
# Update debian to the latest patches
hcloud server ssh server-1
apt update && apt upgrade -y

hcloud server ssh server-2
apt update && apt upgrade -y

hcloud server ssh server-3
apt update && apt upgrade -y

hcloud server ssh client-1
apt update && apt upgrade -y

hcloud server ssh client-2
apt update && apt upgrade -y

# add the server IPs to .envrc
export SERVER_1_IP= # get it with `hcloud server ip server-1`
export SERVER_2_IP= # get it with `hcloud server ip server-2`
export SERVER_3_IP= # get it with `hcloud server ip server-3`
export CLIENT_1_IP= # get it with `hcloud server ip client-1`
export CLIENT_2_IP= # get it with `hcloud server ip client-2`
export SERVER_1_IP_INTERNAL= # get it from the private network created, e.g. 10.0.0.2 from `hcloud server describe -o json server-1 | jq -r .private_net[0].ip`
export SERVER_2_IP_INTERNAL= # get it from the private network created, e.g. 10.0.0.3 from `hcloud server describe -o json server-2 | jq -r .private_net[0].ip`
export SERVER_3_IP_INTERNAL= # get it from the private network created, e.g. 10.0.0.4 from `hcloud server describe -o json server-3 | jq -r .private_net[0].ip`
export CLIENT_1_IP_INTERNAL= # get it from the private network created, e.g. 10.0.0.5 from `hcloud server describe -o json client-1 | jq -r .private_net[0].ip`
export CLIENT_2_IP_INTERNAL= # get it from the private network created, e.g. 10.0.0.6 from `hcloud server describe -o json client-2 | jq -r .private_net[0].ip`

direnv allow

Storage

Decided to give GlusterFS a go since it is easy to set up, light weight and integrates into Nomad through CSI.

# connect to the server node
hcloud server ssh server-x # replace x with 1 to 3

# download and install glusterfs
apt-get update && apt-get install -y gnupg2
wget -O - https://download.gluster.org/pub/gluster/glusterfs/10/rsa.pub | apt-key add -
DEBID=$(grep 'VERSION_ID=' /etc/os-release | cut -d '=' -f 2 | tr -d '"')
DEBVER=$(grep 'VERSION=' /etc/os-release | grep -Eo '[a-z]+')
DEBARCH=$(dpkg --print-architecture)
echo deb https://download.gluster.org/pub/gluster/glusterfs/LATEST/Debian/${DEBID}/${DEBARCH}/apt ${DEBVER} main > /etc/apt/sources.list.d/gluster.list
apt update && apt install -y glusterfs-server
systemctl enable glusterd && systemctl start glusterd

# check that the service is running
systemctl status glusterd

# create the storage bricks
mkdir -p /data/glusterfs/nomad/brick1
mkdir -p /mnt/gluster-nomad

# done
exit

Repeat the above steps for all servers (not the clients since they will not carry glusterfs).

Let's make server-1 the master node and add the other nodes as peers:

hcloud server ssh server-1
gluster peer probe 10.0.0.3 # $SERVER_2_IP_INTERNAL
gluster peer probe 10.0.0.4 # $SERVER_3_IP_INTERNAL
gluster peer status

Next create the volume. Also only run this on the master node.

hcloud server ssh server-1
gluster volume create nomadvol replica 3 \
    10.0.0.2:/data/glusterfs/nomad/brick1/brick \ # $SERVER_1_IP_INTERNAL
    10.0.0.3:/data/glusterfs/nomad/brick1/brick \ # $SERVER_2_IP_INTERNAL
    10.0.0.4:/data/glusterfs/nomad/brick1/brick \ # $SERVER_3_IP_INTERNAL
    force
gluster volume start nomadvol
gluster volume info

On all server nodes, mount the newly created GlusterFS volume:

hcloud server ssh server-x # replace x with 1 to 3
echo "127.0.0.1:/nomadvol /mnt/gluster-nomad glusterfs defaults,_netdev 0 0" >> /etc/fstab
mount /mnt/gluster-nomad

Test the volume by creating a file and making sure it is accessible on all three hosts:

hcloud server ssh server-3
mkdir /mnt/gluster-nomad/storagetest1
echo "Hello World!" > /mnt/gluster-nomad/storagetest1/index.html

Check the existence on all server nodes:

hcloud server ssh server-x # replace x with 1 to 3
less /mnt/gluster-nomad/storagetest1/index.html

Set up the clients:

# connect to the client node
hcloud server ssh client-x # replace x with 1 to 2

# download and install glusterfs
apt-get update && apt-get install -y gnupg2
wget -O - https://download.gluster.org/pub/gluster/glusterfs/10/rsa.pub | apt-key add -
DEBID=$(grep 'VERSION_ID=' /etc/os-release | cut -d '=' -f 2 | tr -d '"')
DEBVER=$(grep 'VERSION=' /etc/os-release | grep -Eo '[a-z]+')
DEBARCH=$(dpkg --print-architecture)
echo deb https://download.gluster.org/pub/gluster/glusterfs/LATEST/Debian/${DEBID}/${DEBARCH}/apt ${DEBVER} main > /etc/apt/sources.list.d/gluster.list
apt update && apt install -y glusterfs-client

# check the installation
glusterfs --version

# mount the storage pool
mkdir -p /mnt/gluster-nomad
export SERVER_1_IP_INTERNAL=GLUSTERFS_IP # set to the correct IP of one of the GlusterFS servers, e.g. 10.0.0.2
echo "$SERVER_1_IP_INTERNAL:/nomadvol /mnt/gluster-nomad glusterfs defaults,_netdev 0 0" >> /etc/fstab
mount /mnt/gluster-nomad

# check if the data is available 
less /mnt/gluster-nomad/storagetest1/index.html

# done
exit

Repeat the above steps for all clients.

Initial Backup

At this point, it is a good idea to create snapshots of the VMs using the Hetzner Web UI. This way, it is easy to go back to this state should you have to start over.

Nomad, Consul and Vault installation

The installation is meant to be highly available so that if one of the servers goes down, the system should still function properly.

Install hashi-up:

# connect to the dev server
multipass start dev
multipass shell dev

# install hashi-up
curl -sLS https://get.hashi-up.dev | sudo sh
hashi-up version

Install Consul

# server
hashi-up consul install \
  --ssh-target-addr $SERVER_1_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --server \
  --bind-addr '{{ GetPrivateInterfaces | include "network" "10.0.0.0/16" | attr "address" }}' \
  --client-addr 0.0.0.0 \
  --bootstrap-expect 3 \
  --retry-join $SERVER_1_IP_INTERNAL --retry-join $SERVER_2_IP_INTERNAL --retry-join $SERVER_3_IP_INTERNAL
  
hashi-up consul install \
  --ssh-target-addr $SERVER_2_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --server \
  --bind-addr '{{ GetPrivateInterfaces | include "network" "10.0.0.0/16" | attr "address" }}' \
  --client-addr 0.0.0.0 \
  --bootstrap-expect 3 \
  --retry-join $SERVER_1_IP_INTERNAL --retry-join $SERVER_2_IP_INTERNAL --retry-join $SERVER_3_IP_INTERNAL
  
hashi-up consul install \
  --ssh-target-addr $SERVER_3_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --server \
  --bind-addr '{{ GetPrivateInterfaces | include "network" "10.0.0.0/16" | attr "address" }}' \
  --client-addr 0.0.0.0 \
  --bootstrap-expect 3 \
  --retry-join $SERVER_1_IP_INTERNAL --retry-join $SERVER_2_IP_INTERNAL --retry-join $SERVER_3_IP_INTERNAL

# clients
hashi-up consul install \
  --ssh-target-addr $CLIENT_1_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --bind-addr '{{ GetPrivateInterfaces | include "network" "10.0.0.0/16" | attr "address" }}' \
  --retry-join $SERVER_1_IP_INTERNAL --retry-join $SERVER_2_IP_INTERNAL --retry-join $SERVER_3_IP_INTERNAL

hashi-up consul install \
  --ssh-target-addr $CLIENT_2_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --bind-addr '{{ GetPrivateInterfaces | include "network" "10.0.0.0/16" | attr "address" }}' \
  --retry-join $SERVER_1_IP_INTERNAL --retry-join $SERVER_2_IP_INTERNAL --retry-join $SERVER_3_IP_INTERNAL

# Check that all services are up and consul is running:
hcloud server ssh server-1
consul members
exit

The installation sets up the following configuration:

  • consul binary put into /usr/local/bin
  • configuration put into /etc/consul.d/consul.hcl
  • certificates and other resources are put into /etc/consul.d and /opt/consul

Install Vault

hashi-up vault install \
    --ssh-target-addr $SERVER_1_IP \
    --ssh-target-user $SSH_USER \
    --ssh-target-key ~/.ssh/id_rsa \
    --storage consul \
    --api-addr http://$SERVER_1_IP_INTERNAL:8200

hashi-up vault install \
    --ssh-target-addr $SERVER_2_IP \
    --ssh-target-user $SSH_USER \
    --ssh-target-key ~/.ssh/id_rsa \
    --storage consul \
    --api-addr http://$SERVER_2_IP_INTERNAL:8200

hashi-up vault install \
    --ssh-target-addr $SERVER_3_IP \
    --ssh-target-user $SSH_USER \
    --ssh-target-key ~/.ssh/id_rsa \
    --storage consul \
    --api-addr http://$SERVER_3_IP_INTERNAL:8200

# Check that all services are up and vault is running in HA mode:
hcloud server ssh server-1
vault status -address=http://127.0.0.1:8200
exit

The installation sets up the following configuration:

  • vault binary put into /usr/local/bin
  • configuration put into /etc/vault.d/vault.hcl
  • certificates and other resources are put into /etc/vault.d and /opt/vault

Install Nomad

# server
hashi-up nomad install \
  --ssh-target-addr $SERVER_1_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --server \
  --advertise "{{ GetPrivateInterfaces | include \"network\" \"10.0.0.0/16\" | attr \"address\" }}" \
  --bootstrap-expect 3
   
hashi-up nomad install \
  --ssh-target-addr $SERVER_2_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --server \
  --advertise "{{ GetPrivateInterfaces | include \"network\" \"10.0.0.0/16\" | attr \"address\" }}" \
  --bootstrap-expect 3

hashi-up nomad install \
  --ssh-target-addr $SERVER_3_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --server \
  --advertise "{{ GetPrivateInterfaces | include \"network\" \"10.0.0.0/16\" | attr \"address\" }}" \
  --bootstrap-expect 3

# clients
# check the content of ./hashi-up/nomad-client.hcl first before applying the next command
hashi-up nomad install \
  --ssh-target-addr $CLIENT_1_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --config-file ./nomad/config/nomad-client.hcl
  
# check the content of ./hashi-up/nomad-client.hcl first before applying the next command
hashi-up nomad install \
  --ssh-target-addr $CLIENT_2_IP \
  --ssh-target-user $SSH_USER \
  --ssh-target-key ~/.ssh/id_rsa \
  --config-file ./nomad/config/nomad-client.hcl

# check the cluster
hcloud server ssh server-1
nomad server members -address=http://10.0.0.2:4646
nomad node status -address=http://10.0.0.2:4646
exit

The installation sets up the following configuration:

  • nomad binary put into /usr/local/bin
  • configuration put into /etc/nomad.d/nomad.hcl
  • certificates and other resources are put into /etc/nomad.d and /opt/nomad

Install docker for nomad to use on all clients:

# connect to the client node
hcloud server ssh client-x # replace x with 1 to 2
curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
apt-get update && apt-get install docker-ce docker-ce-cli containerd.io git
# git is needed for the `artifact` stanza to pull files

# test
docker run hello-world

VPN

I will be setting up Zerotier since I have been using it in the past successfully.

Create an account and a new network under https://my.zerotier.com. Take note of the network ID.

Download and install ZeroTier on your host (not inside the multipass VM since we want our browser to access the services). Join the network from the host using the Zerotier UI or the CLI.

Open the firewall for Zerotier:

# Allow incoming ZeroTier
hcloud firewall add-rule firewall-nomad --description "Allow ZeroTier In" --direction in --port 9993 --protocol udp --source-ips 0.0.0.0/0 --source-ips ::/0

# Allow outgoing ZeroTier
hcloud firewall add-rule firewall-nomad --description "Allow ZeroTier Out" --direction out --port 9993 --protocol udp --destination-ips 0.0.0.0/0 --destination-ips ::/0

Install the ZeroTier client on all nodes:

hcloud server ssh any-x # replace any with `client` or `server` and x with 1 to 3
curl -s https://install.zerotier.com | sudo bash
zerotier-cli join NETWORK_ID

Install the ZeroTier client on the dev VM:

multipass start dev
multipass shell dev
curl -s https://install.zerotier.com | sudo bash
sudo zerotier-cli join NETWORK_ID

Approve all joining requests on https://my.zerotier.com/ and give the nodes names that help you identify them. All clients should be online now with IPs assigned.

Test the access: take note of an IP for one of the server nodes. On your local machine try to access the web UIs:

  • Nomad: http://SERVER_IP_ZEROTIER:4646/
  • Consul: http://SERVER_IP_ZEROTIER:8500/
  • Vault: http://SERVER_IP_ZEROTIER:8200/

Note that Consul is not yet happy with the Vault server since that one is still lacking the initial configuration.

Add the ZeroTier IPs to our environment variables so that we can interact with the cluster from externally:

# add the ZeroTier server IPs to .envrc
export ZT_SERVER_1_IP=ZEROTIER_IP # get it at https://my.zerotier.com`
export ZT_SERVER_2_IP=ZEROTIER_IP # get it at https://my.zerotier.com`
export ZT_SERVER_3_IP=ZEROTIER_IP # get it at https://my.zerotier.com`
export ZT_CLIENT_1_IP=ZEROTIER_IP # get it at https://my.zerotier.com`
export ZT_CLIENT_2_IP=ZEROTIER_IP # get it at https://my.zerotier.com`

Consul KV integration

You can create key/values with the consul web ui or with the commandline:

consul kv put config/domain example.com
consul kv get config/domain

Now you can use it inside a nomad job like so:

task "server" {
      
      ...

      template {
        data   = <<EOF
my domain: {{key "config/domain"}}
EOF
        destination = "local/domain.txt"
      }
    }

Run the job:

nomad job plan nomad/jobs/demo-webapp.nomad
nomad job run -check-index 99999 nomad/jobs/demo-webapp.nomad

After running the job, you will find the domain.txt file in the nomad web ui or from within the container:

# find the most recent allocation
export ALLOCATION_ID=$(nomad job allocs -json demo-webapp | jq -r '.[0].ID')

# get a shell for the `server` task
nomad alloc exec -i -t -task server $ALLOCATION_ID /bin/sh

# inside the shell, check the content of the secret file
cat /local/domain.txt

Vault configuration

Each node of the vault cluster has to be unsealed first before it can be used.

# create the unseal keys
hcloud server ssh server-1
vault operator init -address=http://127.0.0.1:8200
exit

Store the 5 unseal keys and the Initial Root Token in a password manager. In order to unseal the vaults on each server, repeat the following command for each server node. Enter one of the 5 keys and repeat three times with a different key each time.

hcloud server ssh server-x # replace x with 1 to 3
# run the command 3 times, use a different key each time. Note how the `Unseal Progress` counts up
vault operator unseal -address=http://127.0.0.1:8200
vault operator unseal -address=http://127.0.0.1:8200
vault operator unseal -address=http://127.0.0.1:8200
exit

You should see that the Sealed status is now false. Repeat the unseal steps on each server node.

Now set VAULT_TOKEN to the root token inside the .envrc file. If you do not want to persist this data for security reasons, do an export VAULT_TOKEN=YOUR_ROOT_TOKEN in the current shell so that is available for the rest of this configuration section.

Next, integrate Vault with Nomad using token role based integration:

# Download the policy
curl https://nomadproject.io/data/vault/nomad-server-policy.hcl -o vault/policies/nomad-server-policy.hcl -s -L

# Write the policy to Vault
vault policy write nomad-server vault/policies/nomad-server-policy.hcl

# Download the token role
curl https://nomadproject.io/data/vault/nomad-cluster-role.json -o vault/roles/nomad-cluster-role.json -s -L

# Create the token role with Vault
vault write /auth/token/roles/nomad-cluster @vault/roles/nomad-cluster-role.json

# Retrieve a token for nomad to use in the policy
vault token create -policy nomad-server -period 72h -orphan
# Take note of the `token` value.

On each Nomad server, add the following section to the Nomad server configuration /etc/nomad.d/nomad.hcl.

# this section was added manually
vault {
  enabled = true
  address = "http://active.vault.service.consul:8200"
  create_from_role = "nomad-cluster"
}

Also, change the service which starts Nomad to include the environment variable VAULT_TOKEN:

# edit the service configuration
vi /etc/systemd/system/nomad.service

# add the following line directly under [Service]
Environment="VAULT_TOKEN=TOKEN_FROM_COMMAND_ABOVE"

# reload the configuration
systemctl daemon-reload
systemctl restart nomad.service
systemctl status nomad.service

On each Nomad client, add the following section to the Nomad server configuration /etc/nomad.d/nomad.hcl.

# this section was added manually
vault {
  enabled = true
  address = "http://active.vault.service.consul:8200"
}

Now reload the configuration

systemctl restart nomad.service
systemctl status nomad.service

Next, we enable the KV secrets engine in Vault

vault secrets enable -version=2 kv

To use the secrets in a job, create a policy in vault specifically for that job and use it in your job description. Example:

# create a policy file like the example at vault/policies/demoapp.hcl
# note that we have to include `data` in the path for KV version 2
path "kv/data/*" {
  capabilities = ["read"]
}

path "kv/data/demoapp/*" {
  capabilities = ["create", "read", "update"]
}

# upload the policy
vault policy write demoapp vault/policies/demoapp.hcl

# check the policy
vault policy read demoapp

# create a secret that can be accessed through the new policy
vault kv put kv/demoapp greeting="Hello, I'm a secret!"
vault kv get kv/demoapp

# update the nomad job file to link it to the policy
# different levels are possible, e.g. the group level:
group "demo" {
    count = 2

    vault {
      policies  = ["demoapp"]
    }
    ...

# update the nomad job file to use the secret, e.g. in a template
# note that we have to include `data` in the path for KV version 2
task "server" {

      ...

      template {
        data   = <<EOF
my secret: "{{ with secret "kv/data/demoapp" }}{{ .Data.data.greeting }}{{ end }}"
EOF
        destination = "local/demoapp.txt"
      }
    }

Run the job:

nomad job plan nomad/jobs/demo-webapp.nomad
nomad job run -check-index 99999 nomad/jobs/demo-webapp.nomad

After running the job, you will find the secret file in the nomad web ui or from within the container:

# find the most recent allocation
export ALLOCATION_ID=$(nomad job allocs -json demo-webapp | jq -r '.[0].ID')

# get a shell for the `server` task
nomad alloc exec -i -t -task server $ALLOCATION_ID /bin/sh

# inside the shell, check the content of the secret file
cat /local/demoapp.txt

Install the CLIs on the dev VM

In order to interact easier with Nomad and the other services, we install the CLIs on our multipass VM. Since the Ubuntu packages are outdated, we install the binaries directly:

multipass start dev
multipass shell dev
cd ~/dl

curl -OL https://releases.hashicorp.com/nomad/1.2.3/nomad_1.2.3_linux_arm64.zip
unzip nomad_1.2.3_linux_arm64.zip
sudo mv nomad /usr/local/bin
rm nomad_1.2.3_linux_arm64.zip
nomad -autocomplete-install
complete -C /usr/local/bin/nomad nomad
nomad -v

curl -OL https://releases.hashicorp.com/vault/1.9.2/vault_1.9.2_linux_arm64.zip
unzip vault_1.9.2_linux_arm64.zip
sudo mv vault /usr/local/bin
rm vault_1.9.2_linux_arm64.zip
vault -autocomplete-install
source ~/.bashrc
vault -v

curl -OL https://releases.hashicorp.com/consul/1.11.1/consul_1.11.1_linux_arm64.zip
unzip consul_1.11.1_linux_arm64.zip
sudo mv consul /usr/local/bin
rm consul_1.11.1_linux_arm64.zip
consul -autocomplete-install
source ~/.bashrc
consul -v

Check the connection (make sure the dev VM is connected to ZeroTier):

cd ~/src/home-cluster-v2/

# make sure VAULT_ADDR is set in `.envrc` so it connects remotely
vault status

# make sure CONSUL_HTTP_ADDR is set in `.envrc` so it connects remotely
consul members

# make sure NOMAD_ADDR is set in `.envrc` so it connects remotely
nomad server members

Install Nomad Pack

cd ~/dl
curl -OL https://github.com/hashicorp/nomad-pack/releases/download/nightly/nomad-pack_0.0.1-techpreview3_linux_arm64.zip
unzip nomad-pack_0.0.1-techpreview3_linux_arm64.zip
sudo mv nomad-pack /usr/local/bin
rm nomad-pack_0.0.1-techpreview3_linux_arm64.zip

DNS setup

In order to resolve .consul domain names, we have to configure a local DNS server for each server and client node. But first, we need to configure docker on the clients to make sure that docker uses dnsmasq for resolving the .consul domain:

# connect to the node
hcloud server ssh client-x # replace x with 1 to 2

# create a docker configuration file `/etc/docker/daemon.json` with the following content:
{
  "dns": ["172.17.0.1"],
  "bip": "172.17.0.1/24"
}

# restart the docker daemon
systemctl restart docker.service

# verify the configuration for the docker bridge network (subnet and gateway)
docker network inspect bridge

Repeat above setup for all server and clients.

Then we set up dnsmasq on all clients and servers:

# connect to the node
hcloud server ssh any-x # replace any with `client` or `server` and x with 1 to 3

# install dig (dnsutils), dnsmasq and resolvconf
apt install -y dnsutils dnsmasq resolvconf

# make sure resolvconf is started on boot
systemctl start resolvconf.service
systemctl enable resolvconf.service
systemctl status resolvconf.service # active (exited) is ok

# add the nameservers
vi /etc/resolvconf/resolv.conf.d/base

# add these lines:
# redirect to dnsmasq
nameserver 127.0.0.1
# clients only: add docker bridge - find ip with `route`
nameserver 172.17.0.1
# hetzner nameserver
nameserver 185.12.64.1
nameserver 185.12.64.2

# reload resolvconf
resolvconf -u

# configure dnsmasq
vi /etc/dnsmasq.d/10-consul

# insert the following snippet
# Enable forward lookup of the 'consul' domain:
server=/consul/127.0.0.1#8600

# Uncomment and modify as appropriate to enable reverse DNS lookups for
# common netblocks found in RFC 1918, 5735, and 6598:
#rev-server=0.0.0.0/8,127.0.0.1#8600
rev-server=10.0.0.0/8,127.0.0.1#8600
#rev-server=100.64.0.0/10,127.0.0.1#8600
rev-server=127.0.0.1/8,127.0.0.1#8600
#rev-server=169.254.0.0/16,127.0.0.1#8600
#rev-server=172.16.0.0/12,127.0.0.1#8600
#rev-server=192.168.0.0/16,127.0.0.1#8600
#rev-server=224.0.0.0/4,127.0.0.1#8600
#rev-server=240.0.0.0/4,127.0.0.1#8600

# restart the service
systemctl restart dnsmasq.service

# stop systemd-resolved. 
# Otherwise /etc/resolv.conf changes get reverted
systemctl stop systemd-resolved
systemctl disable systemd-resolved

# test
dig @127.0.0.1 -p 8600 consul.service.consul ANY
curl -L http://consul.service.consul:8500

# on the clients only, test that docker resolves dns to the bridge network `172.17.0.1`
docker run --rm alpine cat /etc/resolv.conf

Repeat above setup for all server and clients.

Backup before workload installation

At this point, it is a good idea to create snapshots of the VMs using the Hetzner Web UI. This way, it is easy to go back to this state should you have to start over.

Ingress setup

This section is still work in progress

Install and configure Traefik

# initialize a kv store for traefik. Can be used to store the traefik config instead
consul kv put traefik/

# install a sample web app
nomad run nomad/jobs/demo-webapp.nomad

# install traefik as load balancer. Verify that the job gets deployed succesfully.
nomad run nomad/jobs/traefik.nomad

# Note: `network_mode` set to `host` allows traefik to use Consul for service discovery.

# check that you can reach the traefik dashboard through curl or a local browser
# use a ZT client ip to connect
curl -L http://$ZT_CLIENT_1_IP:8081

# check that you can reach the load balanced app
# use a ZT client ip to connect
# execute 4 times to see how the servers and/or ports change
curl http://$ZT_CLIENT_1_IP:8080/myapp

# check that load balancing is working
hcloud server ssh client-1
curl http://traefik.service.consul:8080/myapp

Prepare a load balancer to direct traffic to the servers. We aim directly for https and will redirect all traffic to it. Since we are using a cloud load balancer, we terminate the TLS there and have only unencrypted traffic on the local network. This takes care of managing the TLS certificates for us and keeps the traefik configuration simple for now.

Unfortunately, creating the DNS zone cannot be done with hcloud. We will use the Hetzner web ui instead. Our steps are based on these instructions. In a future version, instead of using the web ui, the DNS API could be used instead to script and automate these steps: https://dns.hetzner.com/api-docs/#operation/CreateZone. In addition, Terraform could be used to automate the creation of Cloudflare NS records. This is something we do manually below.

First, go to https://dns.hetzner.com/ and click on Add new zone. Enter your domain name to use, select Add records and disable Auto scanning for records. Then click on Continue.

From the next screen, delete the three A and the MX record leaving only the NS records untouched. Click on Continue, then on Finished, go to Dashboard. You can ignore the warning that the nameservers need to be switched out since this is not needed in our case.

Now log into your domain registrar so that you can add additional DNS records overthere. For me, the registrar is Cloudflare. Add the following NS records to your domain so that ACME challenges get routed correctly:

_acme-challenge -> pointing to oxygen.ns.hetzner.com
_acme-challenge -> pointing to hydrogen.ns.hetzner.com
_acme-challenge -> pointing to helium.ns.hetzner.de

These records should match what you see in Hetzners DNS configuration for your newly created zone. Adjust the NS entries here if necessary.

The remaining steps create and configure our load balancer in Hetzner. For this we can leverage hcloud again:

# create the loadbalancer
hcloud load-balancer create --type lb11 --location fsn1 --name lb-nomad
hcloud load-balancer attach-to-network --network network-nomad --ip 10.0.0.254 lb-nomad

# direct traffic to the client nodes
hcloud load-balancer add-target lb-nomad --server client-1 --use-private-ip
hcloud load-balancer add-target lb-nomad --server client-2 --use-private-ip

# create wildcard certificate for load balancer and store its ID
hcloud certificate create --name "testcert" --type managed --domain *.$NOMAD_VAR_domain --domain $NOMAD_VAR_domain
CERT_ID=$(hcloud certificate describe "lb wildcard cert" -o json | jq '.id')

# proxy and health check
hcloud load-balancer add-service lb-nomad --protocol https --http-redirect-http --proxy-protocol --http-certificates $CERT_ID --destination-port 8080
hcloud load-balancer update-service lb-nomad --listen-port 443 --health-check-protocol tcp --health-check-port 8080

Hetzner will manage the certificates, automatically renewing them as necessary (every three months for Let's Encrypt).

Make sure to create CNAME entries for every service you deploy so it is reachable from externally like so:

CNAME subdomain -> points to $NOMAD_VAR_domain

Using environment variables in Nomad jobs

First, export environment variables on your dev VM. We are using the .envrc file for this.

Important: the name of the environment variable has to start with NOMAD_VAR_ followed by a lowercase name. Example:

export NOMAD_VAR_domain=example.com

Next, declare a variable stanza in your nomad job file above the actual job. The variable name has to match the one from the environment variable, but without the NOMAD_VAR_ part. See nomad/jobs/demo-webapp.nomad for an example:

variable "domain" {
  type = string
}

Also in the job, use it in any string with the ${var.varname} syntax:

"traefik.http.routers.http.rule=Host(`webapp.${var.domain}`)",

Upgrading Nomad

The steps are simple: stop the nomad service, find the latest binary on https://releases.hashicorp.com/nomad/ and replace the existing one. Then restart the service and make sure all servers are happy.

Upgrade one server at a time, starting with the servers, followed by the clients.

Before upgrading, check whether special tasks are required for the particular upgrade: https://www.nomadproject.io/docs/upgrade/upgrade-specific. In general, point releases (e.g. from 0.10 to 0.11) are only supported, so ideally take one step at a time.

curl -OL https://releases.hashicorp.com/nomad/1.2.6/nomad_1.2.6_linux_amd64.zip

Observability Stack

Enable telemetry

Add the following section to all nodes:

telemetry {
  collection_interval = "1s"
  disable_hostname = true
  prometheus_metrics = true
  publish_allocation_metrics = true
  publish_node_metrics = true
}

Restart each of the nodes for the changes to take effect.

Prometheus

Make sure prometheus.domain is configured as CNAME in Cloudflare.

Make sure a valid KV entry for config/domain exists in Consul.

Make sure the vault configuration over at /etc/vault.d/vault.hcl matches the configuration from this repository at vault/config/vault.hcl since a few entries have been added to enable prometheus telemetry.

Deploy the prometheus job with nomad job plan nomad/jobs/prometheus.nomad / nomad job run -check-index ... and verify that you can reach prometheus at prometheus.domain.

Also deploy consul-exporter.nomad.

Alertmanager

Make sure alertmanager.domain is configured as CNAME in Cloudflare.

Deploy the alertmanager job with nomad job plan nomad/jobs/alertmanager.nomad / nomad job run -check-index ... and verify that you can reach alertmanager at alertmanager.domain.

If not done so already, also deploy the prometheus job as it contains integration information for alertmanager with an example for monitoring the podinfo job. If podinfo is not running, you should find an active alert in prometheus and also see that alertmanager has received this alert.

Grafana

Make sure grafana.domain is configured as CNAME in Cloudflare.

Create two secrets in vault:

vault kv put kv/grafana admin_user=MYUSER admin_pw="MYPASSWORD"

To persist the data, we are using host volumes on our gluster filesystem. Make sure your nomad client configuration is aware of the volume:

  host_volume "grafana" {
    path = "/mnt/gluster-nomad/volumes/grafana"
  }

Make sure this folder exists, then restart all the nomad clients. Verify that they are aware of the volumes by making sure the following command lists the volume:

nomad node status -short -self

Now we need to create the following folder structure and copy the files over from this repo:

└── volumes
    └── grafana
        ├── grafana.ini
        └── provisioning
            ├── dashboards
            │   ├── dashboards.yaml
            │   ├── nomad-cluster.json
            │   ├── nomad-jobs.json
            │   └── traefik.json
            ├── datasources
            │   └── datasources.yaml
            ├── notifiers
            └── plugins

Also, inside the datasources.yaml file, we need to manually replace {{ key "config/domain" }} with the correct domain name. Since this file lives outside the allocation directory, we cannot use the template function to copy the final file over.

Now deploy the grafana job with nomad job plan nomad/jobs/grafana.nomad / nomad job run -check-index ... and verify that you can reach prometheus at grafana.domain.

Verify that 3 dashboards got deployed: Nomad Cluster, Nomad Services and Traefik.

Loki

OpenTelemetry

About

Cluster running apps and services for my smarthome

Resources

Readme
Activity

Stars

15 stars

Watchers

2 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages