Skip to content

Prerequisites

The following packages are required:

  • CONDA: is an open source package management system. It enables users of Windows, macOS, or Linux, to create, save, load, and switch between software environments on your computer. See here for installation instructions
  • Igwpy39 is the python environment custumed for igwn. see here for installation instructions
  • Docker (>= 23.0) is a software that uses OS-level virtualization to deliver software in packages called containers. Containers are isolated from one another and bundle their own software, libraries and configuration files; they can communicate with each other through well-defined channels. Basic usage command are reported here
  • Kubectl (>= 1.25) is a portable, extensible, open source platform for managing containerized workloads and services, that facilitates both declarative configuration and automation. The Kubernetes command-line tool, kubectl, allows you to run commands against Kubernetes clusters. You can use kubectl to deploy applications, inspect and manage cluster resources, and view logs.
  • Minikube (>= 1.27) minikube is local Kubernetes, focusing on making it easy to learn and develop for Kubernetes.
  • Helm 3 helps to manage Kubernetes applications. It allow to create and manage packages named helm chart (i.e. a .yaml file) that can be installed inside kubernetes containers fulfilling the requisites and maintaning the coherence.
  • OpenSSL

Then, ensure to have a read_api scoped personal acces active. This can be obtained from [ligo-git]{https://git.ligo.org/} under Preferences->Access Tokens->Add new token indicating in Select scopes the option read_api.

Installing CONDA

CONDA may be installed using instruction at this link

installing igwpy39

These commands conda creates a special environment with all igwn packages needed

wget https://computing.docs.ligo.org/conda/environments/linux-64/igwn-py39.yaml
conda env create --file igwn-py39.yaml
rm igwn-py39.yaml

To activate the environment use conda activate igwn-py39

DOCKER basic commands

To start docker program one can use the GUI command or execute

systemctl --user start docker-desktop

To see the actual status of the service

systemctl --user status docker-desktop

To stop docker-desktop

systemctl --user stop docker-desktop

Kubernetes (k8s) basic commands

Here we assume to use a minkube k8s cluster named igwn-kube. The basic instruction to create, start, stop, and delete the k8s cluster are:

minikube start --profile igwn-kube --cpus=4 --memory=8GiB
minikube -p igwn-kube start
minikube -p igwn-kube stop
minikube -p igwn-kube delete
The installation status and the k8s cluster can be monitored using the provided k8s dashboard:
minikube -p igwn-kube addons enable metrics-server
minikube -p igwn-kube dashboard