How to install KOSI as a user

How to install KOSI as a user

This guide shows you how to install KOSI as a user. KOSI can be downloaded only from our official website.

Prerequisites

Before you begin, check the following prerequisites:

  1. A machine with any of the following operating systems

    • RHEL 8
    • openSUSE or SUSE Linux Enterprise Server Version 15 SP3
  2. You must have Helm installed on your machine.

    Refer Helm Official Documentation for Installation Guide.

  3. For KOSI versions you must have installed Podman on your machine.

    Note : Before installing podman, make sure that The number of user namespaces (max_user_namespaces) is specified on your system if you are a non root-user.
    For more information, follow this Github link

    To install podman on your OS use command:

    sudo dnf install podman
    sudo zypper install podman

    Important: Only supports secure registries. If you use an insecure registry, it is important to list your registry as an insecure registry in registry.conf (/etc/containers/registries.conf).

Installation Steps

Every release of KOSI provides a rpm file for manual installation. You need to login into your KubeOps account to download the file.

  1. Create an KubOps account on the KubeOps website if you don’t have already and login into your account.

  2. Download your desired version of KOSI .rpm file from our official download page https://kubeops.net/products/downloads/kosi-downloads-en

  3. Install the KOSI rpm on your admin node.

    echo 'export KUBEOPSROOT=/home/<user>/kubeops' >> $HOME/.bashrc
    source $HOME/.bashrc
    sudo dnf install <path to rpm>/<kosi file name>
    
    echo 'export KUBEOPSROOT=/home/<user>/kubeops' >> $HOME/.bashrc
    source $HOME/.bashrc
    sudo zypper install <path to rpm>/<kosi file name>
    

    path to rpm : the directory path in which the file is available.
    kosi file name : the exact file name of the file with .rpm extension.

$KUBEOPSROOT Variable

The $KUBEOPSROOT environment variable stores the location of the KOSI plugins, deployment.yaml and the config.yaml.
If you change the KUBEOPSROOT variable after installation, the deployment.yaml, the config.yaml and the plugins have to be copied manually.

echo 'export KUBEOPSROOT=/home/<user>/kubeops' >> $HOME/.bashrc
source $HOME/.bashrc
cp -r /var/kubeops/kosi/config.yaml $KUBEOPSROOT/kosi/config.yaml
cp -r /var/kubeops/kosi/deployment.yaml $KUBEOPSROOT/kosi/deployment.yaml
cp -r /var/kubeops/plugins $KUBEOPSROOT/

For a clean installation it is not neccessary to move the deployment.yaml

Check Installation

You can check if the kosi is installed correctly on your machine simply with command kosi version.

kosi version

If the output indicates kosi version and relative information, KOSI is installed successfully. For example the output should look like this

2024-08-07 13:49:00 Info:      KOSI version: 2.11.0.11_Beta0_1723014878
2024-08-07 13:49:00 Info:      This work is licensed under Creative Commons Attribution - NoDerivatives 4.0 International License(see https://creativecommons.org/licenses/by-nd/4.0/legalcode for more details).
2024-08-07 13:49:00 Info:      © KubeOps GmbH, Hinter Stöck 17, 72406 Bisingen - Germany, 2023