Local deployment

If you want to deploy ArmoniK on your machine, this section is for you.

Note

This deployment is for development purposes.

WSL installation on Windows

Warning

Currently, ArmoniK is only available on Linux. But you can use WSL2 with systemdto install ArmoniK on Windows.

This installation method is not recommended for production environments.

ArmoniK can be installed on Windows 10 and 11 using the Windows Subsystem for Linux.

Note

You can read more about WSL2 on the Microsoft documentation.

Prerequisites

Kubernetes

Danger

If you plan to install ArmoniK for development purposes, you must install K3s instead of Kubernetes.

ArmoniK uses Kubernetes to orchestrate containers. You must have Kubernetes installed on your machine. You can follow the official documentation to install Kubernetes on your machine.

Note

What is Kubernetes? Kubernetes, also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications. It groups containers that make up an application into logical units for easy management and discovery. Read more.

K3s

ArmoniK uses K3s as it uses Kubernetes but for development environment.

Note

What is K3s? K3s is a lightweight Kubernetes distribution built for production workloads in unattended, resource-constrained, remote locations or inside IoT appliances. Read more.

K3S Installation

If you already have a K3s installation, start by uninstalling it properly.

Step 1: Run the installation script

Option B: Use the official installation script

You can also use the official installation script to install K3s

Step 2: Verify the installation

Ensure K3s is running and kubectl can access the cluster.

sudo systemctl status k3s
kubectl get nodes
Troubleshooting: Kube Configuration

Note: If your kube configuration was not created during installation or if you get permission errors, you can manually configure it:

  • Create the kube directory

  • Copy your kube config to a new config file

  • Adjust permissions

mkdir -p ~/.kube
sudo cp /etc/rancher/k3s/k3s.yaml ~/.kube/config
sudo chown $(id -u):$(id -g) ~/.kube/config

Simplified installer

You can easily install all of them using the ArmoniK prerequisites installer from the root repository.

./tools/installation/prerequisites-installer.sh

Note

Please, read the script before running it and make sure to have Docker Desktop disabled if you are on Windows.

Warning

We do not recommend you to manually install the pre-requisites for compatibility reasons. If you want to install them manually, please follow the prerequisites installer script.

Warning

You could encounter some issues with the execution of the prerequisites installer script. Please verify you’ve right permissions on the script. If not, you can use chmod +x <file|directory/*> to add the execution permissions.

# Add execution permissions to the prerequisites installer script
chmod +x ./tools/installation/prerequisites-installer.sh
# Add execution permissions to every script in the prerequisites directory
chmod +x ./tools/installation/prerequisites/*

Install ArmoniK

Now, you are ready to deploy ArmoniK on Kubernetes ! See Kubernetes deployment for how to do so !