Install System Requirements

Install system package dependencies

yaook/k8s requires the following packages:

  • python3-poetry - please note that a version > v1.5.0 is required

  • jq

  • moreutils (for sponge)

  • wireguard

  • uuid-runtime

  • openssl

For Debian-based distros you can do:

$ sudo apt install python3-poetry jq moreutils wireguard uuid-runtime kubectl openssl

Additionally, kubectl is needed.

Furthermoe, please consult the documentations for your operation system to fulfill the following dependencies.

Install Terraform

Follow the upstream instructions on installing Terraform.

Install Vault

Follow the upstream instructions on installing Vault.

Install helm

Follow the upstream instructions on installing Helm.

We also strongly recommend installing and using:

Required System Resources

OpenStack Key-Pair

Assuming you are deploying your yk8s cluster on top of OpenStack, you have to create a ssh key pair in your OpenStack project. Since the SSH configuration on the kubernetes host nodes will be hardened, your key has to be in the format of a supported cryptographic algorithm. A list of these and an example of how to create such a key can be found in the appendix.

WireGuard Key

$ # Create working directory for wireguard
$ mkdir ~/.wireguard/

$ # Create wireguard key
$ (umask 0077 && wg genkey > ~/.wireguard/wg.key)

$ # Generate the public key
$ wg pubkey < ~/.wireguard/wg.key

Create and Initialize Cluster Repository

To deploy a yk8s cluster, you need to create a git repository which will serve as your cluster repository:

  1. Create an empty directory as your cluster repository:

    $ git init my-cluster-repository
    $ cd my-cluster-repository
  2. Clone the yaook/k8s repository to a location outside of your cluster repository:

    $ pushd $somewhere_else
    $ git clone
    $ popd
  3. Setup your environment variables:

    1. User specific variables (if not already exists):

      1. Copy the template located at $somewhere_else/k8s/templates/ to ~/.config/yaook-k8s/env.

        $ cp $somewhere_else/k8s/templates/ ~/.config/yaook-k8s/env
      2. Make the user specific minimal changes to ~/.config/yaook-k8s/env.

    2. Cluster specific variables:

      1. Copy the template located at $somewhere_else/k8s/templates/ to ./.envrc.

        $ cp $somewhere_else/k8s/templates/ ./.envrc
      2. Make the cluster specific minimal changes to ./.envrc.

    3. Make sure they have taken effect by running direnv allow.

  4. Initialize the cluster repository:

    $ $somewhere_else/k8s/actions/

    This script will:

    • Add all necessary submodules.

    • Copy a config.toml template to ./config/config.toml if no config exists in the cluster repository yet.

    • Update .gitignore to current standards.

  5. Make sure poetry is up to date (otherwise installing the dependencies might fail), see here

  6. Activate the virtual environment with all python dependencies


    This is handled automatically for you if you use the default .envrc

    $ poetry shell -C managed-k8s

Initialize Vault for a Development Setup

As of Summer 2023, yaook/k8s exclusively supports HashiCorp Vault as backend for storing secrets. Previously, pass was used. For details on the use of Vault in yaook/k8s, please see the Use of HashiCorp Vault in yaook/k8s section.

To initialize a local Vault instance for development purposes, do the following:

  1. Start the docker container:

    $ ./managed-k8s/actions/


    This is not suited for productive deployments or production use, for many reasons!


    If you are using rootless docker or podman, set VAULT_IN_DOCKER_USE_ROOTLESS=true in ~/.config/yaook-k8s/env

  2. Ensure that sourcing (comment in) is part of your .envrc.

    $ sed -i '/#source \"\$(pwd)\/managed-k8s\/actions\/\"/s/^#//g' .envrc
  3. Run the init command for vault

    $  ./managed-k8s/tools/vault/
  4. If you are starting with a new created cluster run:

    $ ./managed-k8s/tools/vault/

    If you are migrating an old cluster see here.


Allowed cryptographic algorithms for SSH

  - ""
  - "aes256-ctr"
  - ""

  - ""
  - ""
  - ""
  - "hmac-sha2-512"
  - "hmac-sha2-256"

  - ""
  - "diffie-hellman-group-exchange-sha256"

SSH key generation

Creating a valid SSH key can be achieved by generating the key as follows, before uploading the public part to OpenStack:

$ # Generating an ed25519 SSH key
$ ssh-keygen -t ed25519`