GitHubContribute in GitHub: Edit online

Install Required Software for Installation

To install AREMA in a Kubernetes cluster, the following applications need to be installed on the host computer, from which the AREMA installation is executed. This manual assumes that a Linux RHEL 7+ operating system (or comparable CentOS and Fedora) is used.

Kubernetes CLI kubectl

The command line program kubectl provides an interface to the Kubernetes REST API and implements a technical access to the cluster. Follow the steps below to install kubectl. (Full installation instructions can be found on kubectl.)

# Install using CURL
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/`curl \
    -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl
$ chmod +x ./kubectl
$ sudo mv ./kubectl /usr/local/bin/kubectl
$ kubectl version --client

# Install using native package management for CentOS or RHEL
$ cat <<EOF > /etc/yum.repos.d/kubernetes.repo
[kubernetes]
name=Kubernetes
baseurl=https://packages.cloud.google.com/yum/repos/kubernetes-el7-x86_64
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg
EOF
$ yum install -y kubectl

Helm

Helm 3 is used to render the Helm Chart and install AREMA. The only requirement for that is a functional Kubernetes CLI (see Kubernetes CLI kubectl). Every release of Helm provides binary packages that can be found on GitHub.

# Install using CURL
$ curl -LO https://get.helm.sh/helm-v3.5.3-linux-amd64.tar.gz
$ tar -zxvf helm-v3.5.3-linux-amd64.tar.gz
$ sudo mv linux-amd64/helm /usr/local/bin/helm

Docker

Docker is used as the container engine for the current AREMA version. Alternatives like podman have not been tested extensively and are thus not fully supported. The recommended solution is the Docker Community Edition (Docker CE) in the latest version. (Full installation instructions can be found at Docker Doc.)

# Install docker-ce
$ sudo yum install -y yum-utils
$ sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
$ sudo yum install docker-ce docker-ce-cli containerd.io

# Start docker
$ sudo systemctl start docker

# To run docker without using sudo add the user to the docker group
$ sudo usermod -aG docker your-user

Git

Git is used by the AREMA images to inject custom configurations. The cluster therefore needs SSH credentials as secret, which is described on the Set Up Configuration Git Repository page.

Furthermore, the management of the injected configuration is handled by Git.

# Install Git, using the standard package manager
$ yum install git

IBM Cloud CLI

If the Kubernetes cluster is running on IBM Cloud, using IBM Kubernetes Service (IKS), the ibmcloud command line tool is required (official documentation: IBM Cloud CLI). This tool offers interfaces to the Kubernetes service (ks) and container registry (cr). To install the CLI, run the following commands:

# Install ibmcloud cli
$ curl -fsSL https://clis.cloud.ibm.com/install/linux | sh

# Install plugin for container registry
$ ibmcloud plugin install container-registry

# Install plugin for kubernetes services
$ ibmcloud plugin install kubernetes-service