Quick Start Guide

If you want to create a yk8s cluster on OpenStack, follow the following steps. A bare-metal yk8s cluster requires further preparations.

Commands are assumed to be executed at the top level of the Cluster Repository, if not stated otherwise.

If you are having problems, please visit our FAQ.

  1. Install system requirements.

  2. Create required resources.

  3. Initialize cluster repository.

  4. Configure cluster in ./config/config.toml.

    • If you plan on deploying OpenStack using yaook/operator on top of your yk8s cluster, please refer to the cluster requirements of yaook/operator to see which features are recommended or required to be present in your kubernetes cluster.

    • There are many configuration options available, but the minimum changes that need to be made to the configuration file are:

      • You need to add your gpg key to the additional passwordstore users.

        • Please also ensure that your gpg keyring is up-to-date.

      • You need to add your (public) wireguard key to the wireguard peer configuration.

      • If your cluster runs on top of OpenStack, you can enable the ch-k8s-lbaas loadbalancing. If you do, you also need to create the ch-k8s-lbaas.shared_secret secret.

  5. Initialize the Vault secret store.

  6. Deploy cluster by executing the apply.sh script.

    $ ./managed-k8s/actions/apply.sh
  7. Get yourself a hot beverage and joyfully watch as your yk8s cluster gets created and tested.

  8. Start using your cluster.