Skip to main content

Prerequisites

Node requirements​

All Kubernetes nodes should be accessible via SSH.

The Kubernetes nodes should have enough RAM and CPU cores to handle at least 3 heavy containers:

  • At least 16GB of RAM
  • At least 4 CPU cores

All Kubernetes nodes should have a Linux distribution with:

  • The Linux kernel version higher than 3.10.
  • An init system based on SystemD or OpenRC.

ClusterFactory has been fully tested on Rocky Linux which is our recommended OS.

Required utilities​

  • cfctl, for deployment, backing up, and upgrading of the Kubernetes cluster.
  • kubectl, for managing your Kubernetes cluster.
  • kubeseal, for encrypting the secrets.
  • helm, for Helm chart template.

There is a script inside the scripts directory to install and set up a working environment.

Just run:

. ./scripts/setup-env

The binaries are stored inside the bin directory and the PATH is automatically set.

Recommended tools​

We recommend:

  • VSCode. Any IDE with YAML support is a good alternative.
  • Lens to manage your Kubernetes cluster.

Recommended documentation​

warning

Before using ClusterFactory, it is strongly advised to have a comprehensive understanding of how Kubernetes operates, specifically with regard to storage and network management using features such as PersistentVolume, StorageClass, Service, Ingresses, LoadBalancer, and more.

To try a "mini" version of Kubernetes we recommend k0s or minikube.