Prerequisites

Before proceeding with the setup, ensure that you have the following tools installed on your system. These tools will provide the necessary environment for containerization, orchestration, and DNS management throughout the process.

1. Docker and Minikube

We use Minikube as the Kubernetes setup for a maximum of flexibility.

• Docker Desktop:

  • macOS:

    brew install --cask docker

  • Windows:

    choco install docker-desktop

  • Check Version (on both macOS and Windows):

    docker --version

• Minikube:

  • macOS:

    brew install minikube
  • Windows:

    choco install minikube
  • Check Version (on both macOS and Windows):

    minikube version

2. Kubectl

Kubectl is the command-line tool for interacting with Kubernetes clusters. It allows you to deploy applications, inspect resources, and manage Kubernetes components.

• macOS:

  brew install kubectl
• Windows:

  choco install kubernetes-cli
• Check Version (on both macOS and Windows):

  kubectl version --client

3. Helm

Helm is a package manager for Kubernetes, simplifying the process of installing and managing Kubernetes applications by using "Helm charts" (pre-configured Kubernetes resources).

• macOS:

  brew install helm
• Windows:

  choco install kubernetes-helm
• Check Version (on both macOS and Windows):

  helm version

4. OpenSSL

OpenSSL is a toolkit for the implementation of SSL/TLS and cryptographic functions. It's necessary for generating secure certificates and managing encryption during the setup process.

• macOS:

  brew install openssl
• Windows:

  choco install openssl
• Check Version (on both macOS and Windows):

  openssl version

---

5. Acrylic DNS Proxy (Windows) or dnsmasq (Linux/macOS)

DNS management tools like Acrylic DNS Proxy (for Windows) and dnsmasq (for Linux/macOS) are used for local DNS caching and domain name resolution. They are essential for resolving custom domains like civitas.test in your local Kubernetes environment.

• Acrylic DNS Proxy (for Windows):

  • Download and install Acrylic DNS Proxy from here.

• dnsmasq (for macOS and Linux):

  brew install dnsmasq

---

Once you have installed these tools, verify that they are functioning correctly before proceeding.

Make also sure that all python and ansible modules are installed to fullfill the requirements for the control system. You can do that with these commands:

pip install -r requirements.txt
ansible-galaxy collection install -r ansible-collections.yml

The files are available in the respository.

For further information, please refer to the Intsallation Guide.