KOSI

• 1: Release Notes
• 1.1: KOSI Versions
• 1.2: KOSI 2.14.0.4
• 1.3: KOSI 2.13.0.2
• 1.4: KOSI 2.12.1.0
• 1.5: KOSI 2.13.0.1
• 1.6: KOSI 2.12.0.19
• 1.7: KOSI 2.12.0.13_Beta0
• 1.8: KOSI 2.12.0.12_Beta0
• 1.9: KOSI 2.12.0.12_Alpha1
• 1.10: KOSI 2.12.0.11_Alpha0
• 1.11: KOSI 2.11.8
• 1.12: KOSI 2.11.7
• 1.13: KOSI 2.11.6
• 1.14: KOSI 2.11.5
• 1.15: KOSI 2.11.4
• 1.16: KOSI 2.11.3
• 1.17: KOSI 2.11.2
• 1.18: KOSI 2.11.1
• 1.19: KOSI 2.11.0
• 1.20: KOSI 2.11.0 Beta1
• 1.21: KOSI 2.11.0 Beta0
• 1.22: KOSI 2.11.0 Alpha1
• 1.23: KOSI 2.11.0 Alpha0
• 2: Getting Started
• 2.1: About Kosi
• 2.2: About KubeOps Licences
• 2.3: Installation Guide
• 2.4: Create a KOSI account (with SSO)
• 2.5: Creating a Basic KOSI-Package and Deployment
• 2.6: KubeOps Migration
• 3: How to Guides
• 3.1: Accessing kubeops-community packages
• 3.2: How to install KOSI as a user
• 3.3: How to use Variables in KOSI Packages
• 3.4: Install package from Hub
• 3.5: How to install and access the Plugins from the Hub
• 3.6: How to update KOSI
• 3.7: How to install KOSI Proxy
• 3.8: How to template within the package.kosi
• 3.9: Create Kosi package
• 4: Plugins
• 4.1: auditLog-1.7.0
• 4.2: bash-1.7.0
• 4.3: chmod-1.7.0
• 4.4: cmd-1.7.0
• 4.5: containerd-1.7.0
• 4.6: Plugin References
• 4.7: containerRuntime-1.7.0
• 4.8: copy-1.7.0
• 4.9: editFile-1.7.0
• 4.10: firewall-1.7.0
• 4.11: firewallD-1.7.0
• 4.12: fprint-1.7.0
• 4.13: helm-1.7.0
• 4.14: hostname-1.7.0
• 4.15: if-1.7.0
• 4.16: ipTables-1.7.0
• 4.17: kosi-2.12.0
• 4.18: kubeadm-1.7.0
• 4.19: kubectl-1.7.0
• 4.20: loop-1.7.0
• 4.21: merge-1.7.0
• 4.22: osCheck-1.7.0
• 4.23: packagemanager-1.7.0
• 4.24: pia-1.7.0
• 4.25: print-1.7.0
• 4.26: service-1.7.0
• 4.27: set-1.7.0
• 4.28: sh-1.7.0
• 4.29: sudo-1.7.0
• 4.30: template-1.7.0
• 4.31: writeplugin
• 5: Reference
• 5.1: Fileformats
• 5.2: KOSI Language Reference
• 5.3: Full Documentation KOSI-2.14.x
• 5.4: Full Documentation KOSI-2.13.x
• 5.5: Full Documentation KOSI-2.12.x
• 5.6: Full Documentation KOSI-2.11.x

1 - Release Notes

1.1 - KOSI Versions

KOSI versions and deprication dates

Here are the current supported KOSI Versions. The list contains: The KOSI version, Supported KOSI language version, Supported KOSI plugins and the Deprication date of all KOSI versions. X of the versions must be X of the plugins

1.2 - KOSI 2.14.0.4

Changelog KOSI 2.14.0.4_Beta0 - Release Date 02.03.2026

New

Permission management

• added manage add user command

• added manage add group command

• added manage add-user-to-group command

• added manage create group command

• added manage list permissions command

• added manage remove user command

• added manage remove group command

• added manage remove permission command

• added manage user-from-group command

Update

• Update internal Dependencies

Bugfix

• fixed a bug where the groupname always includes the hubname. Now it can leave it if the user is kubeops

Changelog Plugins 2.0.0

1.3 - KOSI 2.13.0.2

Changelog KOSI 2.13.0.2

New

• Create a config.yaml if there is no config.yaml

Update

• Update internal Dependencies

Bugfix

• fixed an issue where kosi crashes if there is no config
• fixed an issue where kosi could not installed on ubuntu
• fixed an Issue that local package installation calls dispatcher

Changelog Plugins 2.0.0

Update

• Update internal Dependencies

1.4 - KOSI 2.12.1.0

Changelog KOSI 2.12.1.0

New

• Now creates a default config.yaml, if there is no config.yaml.

Update

• Update Dependencies
• Update plugins

Bugfix

• fixed an issue with the config.yaml
• fixed an issue with the installation for ubuntu, where kubeopsroot was not used correctly.

BREAKING CHANGE

KOSI 2.12.0 does not support the old dispatcher url. it requires the new dispatcher: dispatcher.kubeops.net/v4/dispatcher. also supports only the new registry: registry.kubeops.net

Changelog Plugins 1.7.1

Update

• Update Dependencies

1.5 - KOSI 2.13.0.1

Changelog KOSI 2.13.0.1

New

• Create a config.yaml if there is no config.yaml

Update

• Update internal Dependencies

Bugfix

• fixed an issue where kosi crashes if there is no config
• fixed an issue where kosi could not installed on ubuntu

Changelog Plugins 2.0.0

Update

• Update internal Dependencies

1.6 - KOSI 2.12.0.19

Changelog KOSI 2.12.0.19

New

• Added Licence verification
• Increase Upload-size for packages to 3Gb

Change

• Clientrequest timeouts set to 60 seconds
• Changed the image format on push to OCI

Update

• Update Dependencies
• Update plugins

Bugfix

• KOSI lint linting package.yaml correctly
• fixed templating in lists
• fixed issue when pushing image to localregistry and not being authorized
• fixed an issue where kosi install with multiple value-files was not possible

BREAKING CHANGE

KOSI 2.12.0 does not support the old dispatcher url. it requires the new dispatcher: dispatcher.kubeops.net/v4/dispatcher.

Changelog Plugins 1.7.0

New

• set plugin: for setting variables

Change

• move some messages from info to debug in template-plugin and if-plugin
• change file destination from pia ssh-mode from /home/pia to /var/kubeops/pia

Update

• Update Dependencies

Bugfix

• fixed an issue that kosi plugin pull command requires retag buts optional
• fixed an issue that kosi plugin pull was not able to pull packages.
• fixed an issue that kubectl run operation was not executed correctly.

1.7 - KOSI 2.12.0.13_Beta0

Changelog KOSI 2.12.0.13_Beta1

New

• Added Licence verification
• Increase Upload-size for packages to 3Gb

Change

• Clientrequest timeouts set to 60 seconds
• Changed the image format on push to OCI

Update

• Update Dependencies
• Update plugins

Bugfix

• KOSI lint linting package.yaml correctly
• fixed templating in lists
• fixed issue when pushing image to localregistry and not being authorized
• fixed an issue where kosi install with multiple value-files was not possible

BREAKING CHANGE

KOSI 2.12.0 does not support the old dispatcher url. it requires the new dispatcher: dispatcher.kubeops.net/v4/dispatcher.

Changelog Plugins 1.7.0

New

• set plugin: for setting variables

Change

• move some messages from info to debug in template-plugin and if-plugin
• change file destination from pia ssh-mode from /home/pia to /var/kubeops/pia

Update

• Update Dependencies

Bugfix

• fixed an issue that kosi plugin pull command requires retag buts optional
• fixed an issue that kosi plugin pull was not able to pull packages.
• fixed an issue that kubectl run operation was not executed correctly.
• fixed an issue that cmd plugin could not work if SHELL env was not set.

1.8 - KOSI 2.12.0.12_Beta0

Changelog KOSI 2.12.0.12_Beta0

New

• Added Licence verification
• Increase Upload-size for packages to 3Gb

Change

• Clientrequest timeouts set to 60 seconds
• Changed the image format on push to OCI

Update

• Update Dependencies
• Update plugins

Bugfix

• KOSI lint linting package.yaml correctly
• fixed templating in lists
• fixed issue when pushing image to localregistry and not being authorized
• fixed an issue where kosi install with multiple value-files was not possible

BREAKING CHANGE

KOSI 2.12.0 does not support the old dispatcher url. it requires the new dispatcher: dispatcher.kubeops.net/v4/dispatcher.

Changelog Plugins 1.7.0

New

• set plugin: for setting variables

Change

• move some messages from info to debug in template-plugin and if-plugin
• change file destination from pia ssh-mode from /home/pia to /var/kubeops/pia

Update

• Update Dependencies

1.9 - KOSI 2.12.0.12_Alpha1

Changelog KOSI 2.12.0.12_Alpha1

New

• Added Licence verification
• Increase Upload-size for packages to 3Gb

Change

• Clientrequest timeouts set to 60 seconds
• Changed the image format on push to OCI

Update

• Update Dependencies
• Update plugins

Bugfix

• KOSI lint linting package.yaml correctly
• fixed templating in lists
• fixed issue when pushing image to localregistry and not being authorized
• fixed an issue where kosi install with multiple value-files was not possible

BREAKING CHANGE

KOSI 2.12.0 does not support the old dispatcher url. it requires the new dispatcher: dispatcher.kubeops.net/v4/dispatcher.

Changelog Plugins 1.7.0

New

• set plugin: for setting variables

Change

• move some messages from info to debug in template-plugin and if-plugin
• change file destination from pia ssh-mode from /home/pia to /var/kubeops/pia

Update

• Update Dependencies

1.10 - KOSI 2.12.0.11_Alpha0

Changelog KOSI 2.12.0.11_Alpha0

New

• Added Licence verification
• Increase Upload-size for packages to 3Gb

Change

• Clientrequest timeouts set to 60 seconds
• Changed the image format on push to OCI

Update

• Update Dependencies
• Update plugins

Bugfix

• KOSI lint linting package.yaml correctly
• fixed templating in lists
• fixed issue when pushing image to localregistry and not being authorized

BREAKING CHANGE

KOSI 2.12.0 does not support the old dispatcher url. it requires the new dispatcher: dispatcher.kubeops.net/v4/dispatcher.

Changelog Plugins 1.7.0

New

• set plugin: for setting variables

Change

• move some messages from info to debug in template-plugin and if-plugin
• change file destination from pia ssh-mode from /home/pia to /var/kubeops/pia

Update

• Update Dependencies

1.11 - KOSI 2.11.8

Changelog KOSI 2.11.8.0

Update

• update supported plugins to 1.6.8
• update dependencies

Bugfix

• fixed an issue where the user don´t get any notification, that image push failed
• fixed an issue where kosi install with multiple value-files was not possible

Changelog Plugins 1.6.8

Update

• Update Dependencies

Bugfix

• fixed an issue that kosi plugin pull command requires retag buts optional
• fixed an issue that kosi plugin pull was not able to pull packages.
• fixed an issue that kubectl run operation was not executed correctly.
• fixed an issue that cmd plugin could not work if SHELL env was not set.

1.12 - KOSI 2.11.7

Changelog KOSI 2.11.7.1

Update

• update supported plugins to 1.6.7
• update dependencies

Bugfix

• fixed an issue where the user don´t get any notification, that image push failed
• fixed an issue where kosi install with multiple value-files was not possible

Changelog Plugins 1.6.7

Change

• Move some messages from info to debug in template-plugin and if-plugin
• KOSI plugin local package paths now working proberly

Update

• Update Dependencies

1.13 - KOSI 2.11.6

Changelog KOSI 2.11.6.1

Update

• update supported plugins to 1.6.6
• update dependencies

Bugfix

• fixed an issue where the user don´t get any notification, that image push failed

Changelog Plugins 1.6.6

Change

• Move some messages from info to debug in template-plugin and if-plugin
• KOSI plugin local package paths now working proberly

Update

• Update Dependencies

1.14 - KOSI 2.11.5

Changelog KOSI 2.11.5.1

Update

• update supported plugins to 1.6.5

Change

• fixed templating in lists

Known Issues

• digists as string templating in lists could be recognized as int.

1.15 - KOSI 2.11.4

Changelog KOSI 2.11.4.0

Bugfix

• KOSI lint linting package.yaml correctly

1.16 - KOSI 2.11.3

Changelog KOSI 2.11.3.0

Change

• Change image format for pushing packages to registry to OCI.

Known Issues

• KOSI lint just linting a package.kosi for linting package.yaml it will throw an unable to cast exception.

1.17 - KOSI 2.11.2

Changelog KOSI 2.11.2.0

Fixed

• Fixed an issue where invalid permissions was not displayed correctly

1.18 - KOSI 2.11.1

Changelog KOSI 2.11.1.1

Fixed

• Fixed an issue where duplicate podman errors could be occured

1.19 - KOSI 2.11.0

Changelog KOSI 2.11.0

New

• added kosi language version check
• increase user experience, with removing the single, double-quote scenario
• added Debian-package support for KOSI.
• Batchengine V2 Plugin Support
• kubeops commons remove observer method

Update

• update KOSI plugin
• update KOSI Basic Plugins
• update KOSI Professional Plugins
• update KOSI Enterprise Plugins

Fixed

• bugfix unable to cast object of type Tree to Boolean
• bugfix podman push force compression
• bugfix kosi tmp path
• bugfix missleading error for removing package when not logged in
• bugfix missleading error for using encrypted files as value files and vice versa
• bugfix consider KUBEOPSROOT environment variable at Installation
• bugfix immutable image sha tag

1.20 - KOSI 2.11.0 Beta1

Changelog KOSI 2.11.0_Beta1

New

• added kosi language version check
• increase user experience, with removing the single, double-quote scenario
• added Debian-package support for KOSI.
• Batchengine V2 Plugin Support
• kubeops commons remove observer method

Update

• update KOSI plugin
• update KOSI Basic Plugins
• update KOSI Professional Plugins
• update KOSI Enterprise Plugins

Fixed

• bugfix unable to cast object of type Tree to Boolean
• bugfix podman push force compression
• bugfix kosi tmp path
• bugfix missleading error for removing package when not logged in
• bugfix missleading error for using encrypted files as value files and vice versa
• bugfix consider KUBEOPSROOT environment variable at Installation
• bugfix immutable image sha tag

1.21 - KOSI 2.11.0 Beta0

Changelog KOSI 2.11.0 Beta0

New

• added kosi language version check
• increase user experience, with removing the single, double-quote scenario
• added Debian-package support for KOSI.
• Batchengine V2 Plugin Support
• kubeops commons remove observer method

Update

• update KOSI plugin
• update KOSI Basic Plugins
• update KOSI Professional Plugins
• update KOSI Enterprise Plugins

Fixed

• bugfix unable to cast object of type Tree to Boolean
• bugfix podman push force compression
• bugfix kosi tmp path
• bugfix missleading error for removing package when not logged in
• bugfix missleading error for using encrypted files as value files and vice versa
• bugfix consider KUBEOPSROOT environment variable at Installation

1.22 - KOSI 2.11.0 Alpha1

Changelog KOSI 2.11.0 Alpha1

New

• added kosi language version check
• increase user experience, with removing the single, double-quote scenario
• added Debian-package support for KOSI.
• Batchengine V2 Plugin Support
• kubeops commons remove observer method

Update

• update KOSI plugin
• update KOSI Basic Plugins
• update KOSI Professional Plugins
• update KOSI Enterprise Plugins

Fixed

• bugfix unable to cast object of type Tree to Boolean
• bugfix podman push force compression
• bugfix kosi tmp path
• bugfix missleading error for removing package when not logged in
• bugfix missleading error for using encrypted files as value files and vice versa
• bugfix consider KUBEOPSROOT environment variable at Installation

1.23 - KOSI 2.11.0 Alpha0

Changelog KOSI 2.11.0 Alpha0

New

• added kosi language version check
• increase user experience, with removing the single, double-quote scenario
• added Debian-package support for KOSI.

2 - Getting Started

2.1 - About Kosi

What is KOSI

KOSI is a professional software installation tool tailored for Kubernetes clusters. Its primary function is to streamline the process of defining, installing, and overseeing self-contained packages within Kubernetes environments. These packages are versatile and can be adjusted to suit various requirements and configurations.

By packaging applications and their associated Kubernetes resources into KOSI-packages, developers can easily share and distribute their applications. Users can then use KOSI to install, upgrade, and manage these charts, making it easier to deploy complex applications in Kubernetes environments.

KOSI uses a quick-to-learn command line interface (CLI).

Why use KOSI?

KOSI, drawing inspiration from Helms user-friendly design, empowers software developers to craft comprehensive packages. These packages can encompass multiple artifacts and essential dependencies, consolidated into a single KOSI package.

When deploying software into your environments, you simply retrieve this package from the KubeOps hub. KOSI efficiently manages all pertinent dependencies, ensuring smooth installation processes.

This makes the process of installing software with KOSI into your cluster simplified, secure and flawless.

Highlights

• Supports Images and Artifacts in one Package - KOSI stands out among other package managers because of its distinctive capability to help you package images alongside other artifacts within the same package.
• Self-Contained Packages - KOSIs capacity to generate a single self-contained package eradicates the possibility of human errors stemming from manual processing during software deployment.
• Customizable Plugins - KOSI offers pre-built plugins that facilitate the execution of several common tasks directly through KOSI packages. Additionally, you can effortlessly access additional plugins via our KubeOps hub.
• Scalable and Secure - KOSI enables you to distribute your software even in complex environments, where outgoing proxies restrict broad internet access.
• Integration and Support of other Tools - KOSI seamlessly integrates with Helm, Podman and Docker, ensuring compatibility across various containerized environments. This compatibility allows users to leverage the strengths of Helms package management capabilities and Dockers containerization technology within the KOSI ecosystem. By supporting these widely used tools, KOSI enhances flexibility and efficiency in deploying and managing software across diverse infrastructure setups.

Click here to download and get started with KOSI now.

2.2 - About KubeOps Licences

About KubeOps Licences

For KubeOps 1.7+ licences are required. KubeOps is a tool set which consists of 3 tools: KOSI, KubeOps Platform (Compliance and Compliance + VM). In the table you can see which functions are accessable with given licence.

If you create an account, you get a free 10 days trail-version of our licences.

KubeOps KOSI

* Basic Packages: Package-build-process is limited by the basic plugins. Click Here

** Advanced Packages: Package-build-process hase full access to all plugins. Click Here

KubeOps Platform

2.3 - Installation Guide

In this quickstart you will learn about:

• KOSI system requirements
• how to install KOSI
• how to use the official KubeOps Website to download KOSI
• how to install required software

KOSI seamlessly integrates with other package management software such as Helm and Podman. To ensure compatibility across different containerized environments, KOSI requires the installation of this software.

After the installation, KOSI is available as command line interface.

Prerequisites

To get the most out of this guide, the following requirements should be met:

• basic understanding of Linux environments, bash / shell
• sudo privileges (root) to install packages

Step 1 - System Requirements

Make sure you have prepared the listed requirements before installing KOSI.

KOSI is designed to work with the latest versions of the following operating systems:

Step 2 - Include Package Repo

To easily install the kosi package you should add the kubeops package repo to your operating system’s package manager.

• Operating-System:
• Ubuntu 24.04
• RHEL 9.6

wget https://packagerepo.kubeops.net/pgp-key.public
cat pgp-key.public | sudo gpg --dearmor -o /usr/share/keyrings/kubeops.gpg
echo 'deb [arch=amd64 signed-by=/usr/share/keyrings/kubeops.gpg] https://packagerepo.kubeops.net/deb stable main' | sudo tee /etc/apt/sources.list.d/kubeops.list
sudo apt update

sudo dnf config-manager --add-repo https://packagerepo.kubeops.net/rpm/kubeops.repo

Step 3 - Install KOSI

There are two ways to install kosi.

a) quick via the package repo of your operating system’s package manager.

• Operating-System:
• Ubuntu 24.04
• RHEL 9.6

sudo apt update
sudo apt install -y kosi=2.14* 

sudo dnf install -y --disableexcludes=kubeops-repo kosi-2.14.0.0-0

b) manual download the kosi package from the official KubeOps Website and install it.

Downloading KOSI

Login into your KubeOps account. If you don‘t have an account, you can create one by following the instructions for Create a KOSI account (with SSO).

Download your desired version of the KOSI package file (.rpm or .deb) from the official download page.

• Operating-System:
• Ubuntu 24.04 manual
• RHEL 9.6 manual

# download kosi deb manually and install with
sudo dpkg --install kosi_2.14.0.0-1_amd64.deb

# download kosi rpm manually and install with
sudo rpm --install -v kosi-2.14.0.0-0.x86_64.rpm

Step 4 - Set the KUBEOPSROOT env var

Set KUBEOPSROOT and XDG_RUNTIME_DIR in ~/.bashrc

# file ~/.bashrc
# Append these values to the end of your ~/.bashrc file
export KUBEOPSROOT=/home/<yourUser>/kubeops
export XDG_RUNTIME_DIR=$KUBEOPSROOT

Source .bashrc to apply the values

source ~/.bashrc
echo $KUBEOPSROOT
echo $XDG_RUNTIME_DIR

As a result you should see your KUBEOPSROOT-path two times.

Step 5 - Adjust KOSI Configuration

This creates a kubeops directory in your home directory and transfers all necessary files, e.g., the kosi-config and the plugins, to it.

mkdir ~/kubeops
cd ~/kubeops
cp -R /var/kubeops/kosi/ .
cp -R /var/kubeops/plugins/ .

The config.yaml is in your KUBEOPSROOT-path (typically in ~/kubeops/kosi)

• Set hub in your kosi config to hub: https://dispatcher.kubeops.net/v4/dispatcher/

• Set the “plugins”-entry in your kosi config to plugins: /home/<yourUser>/kubeops/plugins, where is changed to your username

# file $KUBEOPSROOT/kosi/config.yaml
apiversion: kubernative/sina/config/v2

spec:
  hub: https://dispatcher.kubeops.net/v4/dispatcher/ # <-- set hub url
  plugins: <your kubeopsroot>/kubeops/plugins/ # <-- set the path to your plugin folder (~ for home or $KUBEOPSROOT don't work, it has to be the full path)
  workspace: /tmp/kosi/process/
  logging: info
  housekeeping: false
  proxy: false

Step 6 - Install KOSI enterprise plugins

kosi install --hub kosi-enterprise kosi/enterprise-plugins:2.0.0

Step 7 - Install Podman

To ensure compatibility across different containerized environments, KOSI requires the installation of Podman (latest version).

Install Podman using the inbuilt package manager.

• Operating-System:
• Ubuntu 24.04
• RHEL 9.6

sudo apt update
sudo apt install -y podman 

sudo dnf install -y podman

Step 8 - Install Helm

Many KOSI packages use helm. Therefore, it is recommended to install helm.

Install Helm using the KubeOps package repo.

• Operating-System:
• Ubuntu 24.04
• RHEL 9.6

sudo apt update
sudo apt install -y helm 

sudo dnf install -y helm

Verify your Installation

To verify the installation of KOSI on your system, use the command kosi version.

kosi version

The output displays the KOSI version along with relevant information. It confirms the successful installation of KOSI.

2026-01-23 16:09:55 Info:      KOSI version: 2.14.0.0
2026-01-23 16:09:55 Info:      Latest KOSI-package-apiversion: kubernative/kubeops/sina/user/v4
2026-01-23 16:09:55 Info:      Latest KOSI-lanugage-version is: 1.0.0
2026-01-23 16:09:55 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).
2026-01-23 16:09:55 Info:      © KubeOps GmbH, Hinter Stöck 17, 72406 Bisingen - Germany, 2025

Check if you can log in with the command kosi login.

kosi login -u <yourUser>

The output confirms that you are successfully loged in.

2026-01-23 16:11:40 Info:      KOSI version: 2.14.0.0
2026-01-23 16:11:47 Info:      Login Succeeded to Hub.
2026-01-23 16:11:48 Info:      The login to registry was successful. You are now logged in as kubeops and can use the public and private registry.

2.4 - Create a KOSI account (with SSO)

How to register an KubeOps account

Register account via Website

You can create an account on our website by scrolling to the bottom and clicking on the “login”-button.

This will forward you to our login website:

On the bottom of the form, you can find the REGISTRATION-Button, where you can fill in your data and create an account.

Activate your account in order to use KOSI

After successful registration, you must log in once into the KubeOps-Registry. Once logged in, you can switch to KOSI and use it as normal.

(alternative) Register account via KubeOps-registry

You can register a user account by using the KubeOps-Registry page. Click on LOGIN WITH keycloak. You will be redirected to the SSO page where you can REGISTER a new user account.

Activate your account in order to use KOSI

After successful registration, you must log in once into the KubeOps-Registry. Once logged in, you can switch to KOSI and use it as normal.

How to manually push images in my KubeOps-Registry project space

To manually push container images into your KubeOps-Registry project space, you need to use your Harbor CLI secret for authentication when using podman.

How to get your CLI secret

1. Click on your username and select User Profile.

   

2. On the User Profile page, you can copy or change your CLI secret if needed.

   

Now you can push your image using the CLI secret:

podman login registry.kubeops.net -u <username> -p <CLI_secret>

Note: Replace <username> with your KubeOps username and <CLI_secret> with your actual CLI secret.

2.5 - Creating a Basic KOSI-Package and Deployment

In this quickstart you will learn about:

• how to get to know KOSI-packages
• add repositories and download helm charts
• create a KOSI-package
• configure a KOSI-package to deploy a demo WordPress page
• optional: install and deploy the KOSI-package to a cluster

Prerequisites

To get the most out of this guide, the following requirements should be met:

• KOSI is installed, see KOSI Installation Guide
• basic understanding of Kubernetes, network clusters and tools such as Helm or Podman
• basic understanding of Linux environments, bash / shell
• administrator privileges (root) are granted

Step 1 - Create a KOSI-Package

After the installation, KOSI is available as command line interface.

Login into the machine where KOSI is installed.

Create a new folder and use the command kosi create to create a default KOSI-package with pre-built files.

mkdir ~/kosi-demo
cd ~/kosi-demo

kosi create

Example output:

2024-08-07 13:49:00 Info:      KOSI version: 2.14.0.0_XXXXXXXXXX
2024-08-07 13:49:00 Info:      Write package.kosi to /root/kosi-demo
2024-08-07 13:49:00 Info:      Write template.yaml to /root/kosi-demo
2024-08-07 13:49:00 Info:      Write logo.png to /root/kosi-demo
2024-08-07 13:49:00 Info:      Write docs.tgz to /root/kosi-demo

Step 2 - Understand the Package Logic

The package.kosi file contains the „logic“ of the package. This file uses the kosi format which itself uses the highly expressive KOSI Language.

Among other things the package.kosi file defines:

• a preambel for meta data and descriptions
• a files section to - manages files, such as templates, to be included and target files
• a set of commands - for example „install“ or „upgrade“ which work as scripts within the kosi file

Templates make it possible to use variantes for your packages. For example, you want to reuse a package for different environments. Templates also allow to parse additional „value files“ as command line arguments.

Advanced templating makes it possible to split one large value files into smaller ones. In this case we use some of the defaultvalues but all values will be transfered.

Step 3 - Modify the Template File

For the transfer of values into a package, a valuestemplate.yaml file is needed.

Use an editor to edit the file:

nano ~/kosi-demo/valuestemplate.yaml

To get the most out of this guide, add the following lines:

{{values}}

This command will allow to parse the values of the file values.yaml. On installing, the file values.yaml will be automatically transcluded into the cluster. This is helpful to reuse a package for different environments.

Notice the exact same naming of the command with the file.

Step 4 - Add Necessary Repositories and Pull Charts

In this guide we want to create a KOSI-package containing a demo WordPress page. Therefore you need to add the necessary repository via helm. Afterwards you need to pull the latest version of the helm chart.

helm repo add bitnami https://charts.bitnami.com/bitnami
helm pull bitnami/wordpress --version X.Y.Z

Step 5 - Configure the Package

Configure the package to inlucde the valuestemplate.yaml file. Also add commands for install, update, and delete.

Use an editor to edit the file:

nano ~/kosi-demo/package.kosi

To get the most out of this guide, overwrite the file with the following lines:

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v3";
name = "wordpressdemo";
description = "Deploys a wordpress helm chart";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    wordpressvaluestemplate= "valuestemplate.yaml";
    chart = "wordpress-X.Y.Z.tgz";
}


install
{
    template(tmpl="valuestemplate.yaml";target="wordpressvalues.yaml");
    helm(command="upgrade";tgz="wordpress-X.Y.Z.tgz";values="['wordpressvalues.yaml']";deploymentName="wordpressdemo";namespace="wordpressdemo";flags="['--create-namespace',' --install']");
}

update
{
    template(tmpl="valuestemplate.yaml";target="wordpressvalues.yaml");
    helm(command="upgrade";tgz="wordpress-X.Y.Z.tgz";values="['wordpressvalues.yaml']";deploymentName="wordpressdemo";namespace="wordpressdemo";flags="['--create-namespace',' --install']");
}

delete
{
    cmd(command="echo delete wordpressdemo helm deployment.");
    helm(command="delete";deploymentName="wordpressdemo";namespace="wordpressdemo";flags="['--wait']");
    cmd(command="echo delete wordpressdemo namespace.");
    cmd(command="kubectl delete namespace wordpressdemo");
}

Step 6 - Create Package Documentation

It is always a good practice to document your packages.

Within your package folder, create a docs folder:

mkdir -p ~/kosi-demo/docs

Create a simple README file (for example markdown format) and write some helpful descriptions. For example:

echo „My first KOSI-package. Contains a demo WordPress page.“ > ~/kosi-demo/docs/README.md

Afterwards you need to compress the whole docs folder using the tgs format.

cd ~/kosi-demo/
tar -cvzf docs.tgz docs/

These docs will be included when building the deployable package file.

Step 7 - Build the Package

When the package.kosi is finished and the documentation is done, the KOSI-package can be built. Navigate to the package folder and simply use the kosi build command.

cd ~/kosi-demo/
kosi build

During the build process, the files package.tgz and package.yaml are created.

Step 8 - Setting Values for the Package

To install the package.tgz, you need the package itself and some values. Among other things, you need to define the nodePorts for http at 30123. This node port will be needed to access and test your WordPress page.

In a previous step we made the package reuseable by using the valuestemplate.yaml file. This files expects a values.yaml file as command line argument.

Use an editor to edit the file:

nano ~/kosi-demo/values.yaml

To get the most out of this guide, add the following lines:

global:
    storageClass: rook-cephfs
service:
    type: NodePort
    nodePorts:
        http: 30123
mariadb:
    enabled: true
    auth:
        rootPassword: topsecretChangeMe
        password: secretChangeMe
    primary:
        persistence:
            enabled: true
            storageClass: rook-cephfs
            accessModes:
                - ReadWriteOnce
persistence:
    enabled: true
    storageClass: rook-cephfs

Optional Step 9 - Installing the Package and Deploy to Cluster

As recommended you need a running Kubernetes cluster to install and deploy your new KOSI-package. You must also be logged in to the Admin machine where you have created the KOSI-package. To set up a cluster easily and conveniently, you can use kubeopsctl (see kubeopsctl documentation).

Navigate to your built KOSI-package. Install the package and pass the prepared values.yaml file as command line argument.

cd ~/kosi-demo
kosi install -p package.tgz -f values.yaml

Optional Step 10 - Test the WordPress Page

After you deployed the KOSI-package you can test the access via your cluster to the WordPress page.

Depending on your setup you need the following:

• the IP or hostname of a master node
• tunneling or expossing of ports according to the nodePorts as set in values.yaml

In this guides we set 30123 as nodePort. For example, in your browser navigate to:

http://master1:30123

2.6 - KubeOps Migration

About KubeOps Migration

For KubeOps 1.7+ licences are required. KubeOps is a tool set which consists of 3 tools: KOSI, KubeOps Platform (Compliance and Compliance + VM). Since 1.7 the background process is diffrent then in the older versions. To use your account in the future you have to do some steps to migrate your account.

KubeOps Account

If you had created your account before March 2025 you have to do the steps of the migration. The most of the steps will be done from us but some steps have to be done by you:

IMPORTANT: These steps are only necessary if you want to use tools of the KubeOps 1.7+ and does not have any effect on Versions below 1.7.

• Every user before march 2025 has to choose a new password, due to a change in our login process. On your next login attempt you will be forced to choose a new password.

• If you want to use the KubeOps tools you have to login into the kubeops-registry first. A guide will help you Here.

• We created new hub and registry spaces, so you have to upload you old packages into your brand new private space. The public hub is no longer available. If you have problems with migrating your packages to the new hub send us an E-Mail for technical support and we will help you. Existing permissions will be migrated to the new system.

IMPORTANT: Both systems are not synced so you have to do uploads on both if you want them hold in sync.

3 - How to Guides

In the following sections, you will find everything from initial setup and configuration, to advanced tips and tricks that will help you get the most out of the software. Our aim is to assist you in becoming proficient with kosi, enhancing both your productivity and your user experience.

Lets get started on your journey to mastering kosi!

3.1 - Accessing kubeops-community packages

Accessing kubeops-community packages

This documentation describes how to search for, install, and manage packages from the kubeops-community hub using the Kosi CLI.

Searching for Packages

To list all available packages within the KubeOps community, you use the search command.

Command:

kosi search --hub kubeops-community

Example Output:

Note: This overview shows you the exact path needed for the installation step in addition to the package name and version.

Installing Packages

Once you have found a suitable package, you can deploy it into your Kubernetes cluster using the install command. You can assign a specific name to your deployment using the --dname flag.

General Syntax:

kosi install --hub <Hub_Name> <Install_Path> --dname <Deployment_Name>

Examples

Installing HashiCorp Vault:

kosi install --hub kubeops-community kubeops-community/hashicorp-vault:0.32.0 --dname hashicorp-vault

Installing Jenkins:

kosi install --hub kubeops-community kubeops-community/jenkins:5.8.142 --dname jenkins

Installing Elasticsearch:

kosi install --hub kubeops-community kubeops-community/elasticsearch:8.5.1 --dname elasticsearch

Listing Deployed Packages

To view all currently installed packages and their deployment names, use the list command. The deployment name is required for updates and deletions.

Command:

kosi list

Example Output:

Updating and Deleting Packages

To modify or remove an existing deployment, use the update or delete commands and include the --dname flag to specify which deployment you are targeting.

Updating a Package

The update command executes the update logic and updates the deployment in the Kubernetes cluster.

Example (Updating HashiCorp Vault):

kosi update --hub kubeops-community kubeops-community/hashicorp-vault:<new-version> --dname hashicorp-vault

Deleting a Package

The delete command executes the delete logic and removes the deployment from the Kubernetes cluster.

Example (Deleting HashiCorp Vault):

kosi delete --hub kubeops-community kubeops-community/hashicorp-vault:0.32.0 --dname hashicorp-vault

3.2 - 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

• Operating System: A machine running RHEL 8.

• Helm: Must be installed on your machine. Refer to the Helm Official Documentation.

• Podman:
  KOSI requires Podman to be installed on your machine.

  Note: If you are a non-root user, ensure that the number of user namespaces (max_user_namespaces) is properly configured. For more details, refer to this GitHub tutorial.

  Installation on RHEL8:

  sudo dnf 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

1. Download the KOSI RPM:

   • Log in to your KubeOps account.
   • Download your desired version of the KOSI RPM from the official download page.

2. Install the KOSI RPM on your admin node:
   Run the following commands:

   echo 'export KUBEOPSROOT=/home/<user>/kubeops' >> $HOME/.bashrc
   source $HOME/.bashrc
   sudo dnf install <path_to_rpm>/<kosi_file_name>.rpm
   

   Note:

   • Replace <path_to_rpm> with the directory path where the file is located.
   • Replace <kosi_file_name> with the exact RPM file name (including the .rpm extension).

$KUBEOPSROOT Variable

The $KUBEOPSROOT environment variable stores the location of the KOSI plugins, deployment.yaml, and config.yaml.
If you change the KUBEOPSROOT variable after installation, you must manually copy the updated deployment.yaml, config.yaml, and plugins.

Run the following commands to update:

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/

Note: For a clean installation, it is not necessary to move the deployment.yaml.

Check Installation

To verify that KOSI is installed correctly on your machine, simply run:

kosi version

A successful installation will display version details, it will look like this:

2024-08-07 13:49:00 Info:      KOSI version: 2.14.0.0_XXXXXXXXXX
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

3.3 - How to use Variables in KOSI Packages

How to use Variables in KOSI Packages

KOSI plugins can produce internal variables during execution, which you can reference in subsequent steps of your package (for example in conditions or output messages). The following guide explains how to use variables set by various KOSI plugins and how to consume them using e.g. the if and fprint plugins (which allow conditional logic and formatted output, respectively).

Plugins that set Variables

Several plugins store their results in named variables. These include:

• Firewall / Firewalld / IPTables – All three firewall plugins support a key like getFirewallStatus = "<var>". For example:

  firewall
  (
      type = "firewalld";
      action = "enable";
      getFirewallStatus = "status";
  );
  

  This stores the firewall status ("running" or "not running") into the variable status. You can then reference this status variable in later steps.

• Hostname – The hostname plugin can get the current hostname into a variable or set a new hostname from a variable. Its keys are: get = "<var>" to save the current hostname and setVar = "<var>" to restore from a saved variable. For example:

  hostname(get = "oldHostname");
  

  This saves the machine’s current hostname into the variable oldHostname.

• kubeadm – The kubeadm plugin runs kubeadm commands. Its outputVar = "<var>" option captures the command’s output into a variable. For example:

  kubeadm
  (
      operation = "version";
      kubeadmVersion = "version";
      outputVar = "kubeadmVersionOutput";
  );
  

  This saves the output of kubeadm version into the variable kubeadmVersionOutput.

• kubectl – The kubectl plugin executes kubectl commands. Its outputVar = "<var>" captures the command output. For example:

  kubectl
  (
      operation = "get";
      resource = "pods";
      flags = "-n kube-system -o wide";
      outputVar = "podsOutput";
      outputFile = "/root/output.txt";
  );
  

  This saves the kubectl get pods output into podsOutput. You can then use podsOutput in subsequent steps.

• osCheck – The osCheck plugin detects the OS name and version. It has two keys: getOSVar="<var>" for the OS name and getOSVersionVar="<var>" for the OS version. For example:

  osCheck(getOSVar="osName"; getOSVersionVar="osVersion");
  

  This stores the OS name in osName and the version in osVersion.

• set – The set plugin lets you define arbitrary variables. Use variable="<name>"; value="<something>" to create a variable. For example:

  set(variable = "envType"; value = "production");
  

  This creates a variable named envType with value "production". Variables set by the set plugin are accessed via vars.<variableName>.

Referencing Plugin Variables

KOSI provides two main ways to use these variables:

• Conditional checks with the if plugin: The if plugin evaluates an expression and branches accordingly. In the condition string, you can include plugin variables by name, enclosed in $...$. For example:

  if(condition = "$oldHostname$ = 'myHost'") then {
      # ... do something ...
  }
  

  For variables set via the set plugin, access them as $vars.<name>$, e.g. $vars.envType$.

• Formatted output with the fprint plugin: The fprint plugin prints a message and can include plugin-variable values. You provide a list of variable names in its variables key and placeholders {0}, {1}, etc. in the message. For example:

  fprint
  (
      message = "Firewall status is {0}";
      variables = "['status']";
  );
  

  For variables from the set plugin:

  set(variable="userName"; value="Alice");
  set(variable="userIP"; value="10.0.0.1");
  fprint
  (
      message = "User {0} has IP {1}";
      variables = "['vars.userName','vars.userIP']";
  );
  

Example Workflow

1. Set or retrieve a variable:

   hostname(get = "myHostname");
   osCheck(getOSVar = "osName"; getOSVersionVar = "osVersion");
   

2. Conditionally act on it:

    if(condition = "$myHostname$ = 'expectedHost'") then {
        fprint
        (
            message = "Got expected hostname: {0}";
            variables = "['myHostname']";
        );
    }
   

3. Output or log values:

   fprint
   (
       message = "Running on {0} version {1}";
       variables = "['osName','osVersion']";
   );
   

Related Plugin Documentation

Plugins mentioned in this How to Guide that set or use variables

• firewall
• firewalld
• iptables
• hostname
• kubeadm
• kubectl
• oscheck
• set
• if
• fprint

3.4 - Install package from Hub

Installing KOSI packages from KubeOps Hub

To install KOSI packages from the KubeOps Hub on your machines, follow these steps:

1. Search for the Package:
   Use the kosi search command to find the desired package on the KubeOps Hub.
   (Refer to kosi search for more info.)

2. Install the Package:
   Copy the installation address of the desired package and use it with the kosi install command:

   [root@localhost ~]# kosi install --hub <hubname> <installation address>
   

Note: The --hub parameter is used to install packages from the software Hub.

To be able to install a package from the software Hub, you must be logged in as a user.

Install from Private Hub

Example:
The package livedemo of user kosi with version 2.7.1 is to be installed from the private software Hub:

[root@localhost ~]# kosi install kosi/livedemo:2.7.1

Install from Public Hub

Example:
The package livedemo of user kosi with version 2.7.1 is to be installed from the public software Hub:

[root@localhost ~]# kosi install --hub public kosi/livedemo:2.7.1

Install along with yaml files

The -f parameter is used to provide YAML files from the user.

[root@localhost ~]# kosi install <package> -f <user.yaml>

Example:
The package livedemo of user kosi with version 2.7.1 is installed from the public software Hub with user-specific YAML files:

[root@localhost ~]# kosi install --hub public kosi/livedemo:2.7.1 -f userfile1.yaml

Install in specific namespace

The --namespace flag allows you to specify a Kubernetes namespace for the installation.

[root@localhost ~]# kosi install --hub <hubname> <package> --namespace <namespace>

Example:
The package livedemo of user kosi with version 2.7.1 is installed from the public software Hub in a custom Kubernetes namespace:

[root@localhost ~]# kosi install --hub public kosi/livedemo:2.7.1 --namespace MyNamespace

Note: If no --namespace parameter is specified, the default namespace will be used.

Install with specific deployment name

The --dname flag allows you to assign a specific name to the deployment.

[root@localhost ~]# kosi install --hub <hubname> <package> --dname <deploymentname>

Example:
The package livedemo of user kosi with version 2.7.1 is installed from the public software Hub with a deployment name set:

[root@localhost ~]# kosi install --hub public kosi/livedemo:2.7.1 --dname MyDeployment

If no --dname parameter is specified, a random deployment name will be generated.

Note: The deployment name is stored in the file /home/<user>/var/kubeops/kosi/deployment.yaml.

In these few steps, you can successfully install and use a KOSI package.

For additional functionality and features provided by KOSI, always refer to the Full Documentation.

Install on a machine with no internet connection

1. Download the Package:
   Use kosi pull on a machine with an internet connection to download the package:

[root@localhost ~]# kosi pull [package name from hub] -o [your preferred name] --hub public

2. Transfer the Package:
   Move the downloaded package to the machine without an internet connection (which has KubeOps installed).

3. Install the Package:
   Install the transferred package with the following command:

[root@localhost ~]# kosi install -p [package name]

3.5 - How to install and access the Plugins from the Hub

How to access the Plugins

Note: Be sure you have a supported KOSI version 2.10.0 or higher.

KOSI Basic Plugins Version 1.6.X

kosi search --hub kosi-basic

2024-08-07 13:47:02 Info:      KOSI version: 2.14.0.0_XXXXXXXXXX
| User | Name          | Version     | Description        | Install                        |
|------|---------------|-------------|--------------------|--------------------------------|
| kosi | basic-plugins | 1.5.0_beta0 | KOSI Basic Plugins | kosi/basic-plugins:1.5.0_beta0 |
| kosi | basic-plugins | 1.5.0       | KOSI Basic Plugins | kosi/basic-plugins:1.5.0       |
| kosi | basic-plugins | 1.4.0       | KOSI Basic Plugins | kosi/basic-plugins:1.4.0       |
| kosi | basic-plugins | 1.6.0_Beta0 | KOSI Basic Plugins | kosi/basic-plugins:1.6.0_Beta0 |
| kosi | basic-plugins | 1.4.2       | KOSI Basic Plugins | kosi/basic-plugins:1.4.2       |
| kosi | basic-plugins | 1.4.1       | KOSI Basic Plugins | kosi/basic-plugins:1.4.1       |

This package contains the following plugins:

KOSI Professional Plugins Version 1.6.X

kosi search --hub kosi-professional

2024-08-07 13:47:36 Info:      KOSI version: 2.14.0.0_XXXXXXXXXX
| User | Name                 | Version     | Description               | Install                               |
|------|----------------------|-------------|---------------------------|---------------------------------------|
| kosi | professional-plugins | 1.5.0_beta0 | KOSI Professional Plugins | kosi/professional-plugins:1.5.0_beta0 |
| kosi | professional-plugins | 1.4.0       | KOSI Professional Plugins | kosi/professional-plugins:1.4.0       |
| kosi | professional-plugins | 1.5.0       | KOSI Professional Plugins | kosi/professional-plugins:1.5.0       |
| kosi | professional-plugins | 1.4.2       | KOSI Professional Plugins | kosi/professional-plugins:1.4.2       |
| kosi | professional-plugins | 1.4.1       | KOSI Professional Plugins | kosi/professional-plugins:1.4.1       |
| kosi | professional-plugins | 1.6.0_Beta0 | KOSI Professional Plugins | kosi/professional-plugins:1.6.0_Beta0 |

This are the plugins which the packages contains:

KOSI Enterprise Plugins Version 1.6.X

kosi search --hub kosi-enterprise

2024-08-07 13:47:59 Info:      KOSI version: 2.14.0.0_XXXXXXXXXX
| User | Name               | Version     | Description                  | Install                             |
|------|--------------------|-------------|------------------------------|-------------------------------------|
| kosi | enterprise-plugins | 1.5.0       | KOSI Enterprise Plugins      | kosi/enterprise-plugins:1.5.0       |
| kosi | piaoperator        | 1.4.0       | Pia Operator Install Package | kosi/piaoperator:1.4.0              |
| kosi | enterprise-plugins | 1.4.2       | KOSI Enterprise Plugins      | kosi/enterprise-plugins:1.4.2       |
| kosi | enterprise-plugins | 1.5.0_beta0 | KOSI Enterprise Plugins      | kosi/enterprise-plugins:1.5.0_beta0 |
| kosi | enterprise-plugins | 1.4.0       | KOSI Enterprise Plugins      | kosi/enterprise-plugins:1.4.0       |
| kosi | enterprise-plugins | 1.6.0_Beta0 | KOSI Enterprise Plugins      | kosi/enterprise-plugins:1.6.0_Beta0 |
| kosi | enterprise-plugins | 1.4.1       | KOSI Enterprise Plugins      | kosi/enterprise-plugins:1.4.1       |

This package contains the following plugins:

How to install the Plugins

After installing the plugins with our KOSI install command, the plugins are automatically placed in the associated directory ($KUBEOPSROOT/plugins) and can be used directly.

kosi install --hub=<pluginhub> user/packagename:version

Example: The package enterprise-plugins of the user kosi with the version 1.6.0_Beta0 is to be installed from the kosi-enterprise hub.

kosi install --hub=kosi-enterprise kosi/enterprise-plugins:1.6.0_Beta0 

Note: You can also use the Install Tab from the output to help with installation.

3.6 - How to update KOSI

How to update KOSI

This guide shows you how to update KOSI. KOSI can be downloaded only from our official website.

Prerequisites

Before you begin, check the following prerequisites:

Before you begin, check the following prerequisites:

1. A machine with the RHEL 8 operating system.

2. You must have Helm installed on your machine.

   Refer to the Helm Official Documentation for the Installation Guide.

3. For KOSI versions, you must have Podman installed 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 use command:

   sudo dnf install podman
   

   Important: KOSI supports only secure registries. If you use an insecure registry, it is important to list your registry as an insecure registry in the registry.conf file located at /etc/containers/registries.conf.

Update Steps

Every release of KOSI provides an RPM file for manual installation. You need to log in to your KubeOps account to download the RPM.

1. Create a KubeOps Account:
   If you haven’t already, create a KubeOps account on the KubeOps website and log in to your account.

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

3. Update the KOSI RPM:
   On your admin node, update KOSI by installing the new RPM, which will override the existing version. Run the following command:

 sudo dnf install <path to rpm>/<kosi file name>

Note:

• Replace <path_to_rpm> with the directory path where the file is located.
• Replace <kosi_file_name> with the exact file name of the RPM (including the .rpm extension).

3.7 - How to install KOSI Proxy

How to install KOSI Proxy

This guide shows you how to install the KOSI Proxy.

Architecture

The diagram shows the architecture of the KOSI Proxy.
Packages and container images can be fetched via the KOSI Proxy.
Uploading packages and container images to the internet is blocked.
Access can be limited to a HUB.

Prerequisites

To install the KOSI Proxy you need a dedicated VM with RHEL8 OS and root access.
Minimum requirements for the VM are:

• 4 CPU
• 8 GB RAM
• 50 GB Disk

The following software must be installed on this VM:

• docker
• docker compose
• kosi

# docker
subscription-manager register
subscription-manager refresh
subscription-manager attach --auto
dnf config-manager --add-repo=https://download.docker.com/linux/centos/docker-ce.repo
dnf repolist -v
dnf install docker-ce
systemctl enable docker --now
systemctl status docker

# docker compose
curl -L "https://github.com/docker/compose/releases/download/v2.24.5/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose 

# kosi
dnf install -y kosi*.rpm

#### Set KOSI config  hub in __/var/kubeops/kosi/config.yaml__  
```yaml
apiversion: kubernative/sina/config/v2

spec:
  hub: https://dispatcher.preprod.kubeops.net/v4/dispatcher/ # <- set hub
  plugins: /var/kubeops/plugins/
  workspace: /tmp/kosi/process/
  logging: info
  housekeeping: false
  proxy: false # <- mandatory if kosi version >= 2.10.*

Install KOSI Proxy

If all prerequisites are met, the KOSI Proxy can be installed.
A values.yaml file is required for KOSI Proxy installation.
Below is an example values.yaml configuration for the environment:

# Proxy host IP address
proxyIP: 10.2.10.99

# Preprod config values
proxyPassthrough: preprod
proxyRegistry: registry.preprod.kubeops.net
aspnetcoreEnvironment: Development

# Prod config values
#proxyPassthrough: prod
#proxyRegistry: registry.kubeops.net
#aspnetcoreEnvironment: Production

After the values.yaml file has been created, the KOSI Proxy can be installed via a kosi package.
The KOSI Proxy is installed in ~/kosi-proxy.

kosi install --hub public kubeops/kubeops/kosi-proxy:2.13.0.1_Alpha7 -f values.yaml

Start KOSI Proxy:

cd ~/kosi-proxy
docker-compose up -d

Configure KOSI Proxy (Advanced)

The KOSI Proxy is already configured during installation; however, additional parameters can be adjusted.

1. Hub Whitelist

The hub whitelist can be configured in the app settings file ~/kosi-proxy/data/download-v4/appsettings.json.
By default the hubs kosi, kubeops and kosi-enterprise are set.

{
  "Logging": {
    "LogLevel": {
      "Microsoft": "Warning",
      "System": "Warning",
      "Microsoft.Hosting.Lifetime": "Information",
      "Kubeops": "Debug"
    },
    "Console": {
      "FormatterName": "simple",
      "FormatterOptions": {
        "SingleLine": false,
        "TimestampFormat": "HH:mm:ss ",
        "ColorBehavior": "Enabled",
        "UseUtcTimestamp": false
      }
    }
  },
  "AllowedHosts": "*",
  "Config": {
    "RepositoryPath": "/service/repository",
    "PermissionServiceUrl": "http://permission-v4/",
    "ProxyPassthroughUrl": "https://dispatcher.preprod.kubeops.net/v4/download/",
    "GuestQuota": 1000000,
    "HubWhitelist": "kosi, kubeops, kosi-enterprise"
  }
}

Install Harbor

Harbor is used as the registry endpoint in this setup.

1. Download installer

Download the Harbor offline installer:

# harbor
cd ~
curl -L https://github.com/goharbor/harbor/releases/download/v2.9.2/harbor-offline-installer-v2.9.2.tgz | tar -xvzf -
cd ~/harbor
cp harbor.yml.tmpl harbor.yml

2. Configure harbor.yml values

Edit the harbor.yml

Change:

hostname: 10.2.10.99  # line 5
insecure: true        # line 101 

Comment out:

#  port: 443                            # line 15
#  certificate: /your/certificate/path  # line 17
#  private_key: /your/private/key/path  # line 18

3. Run install script:

cd ~/harbor
./install.sh

Configure Harbor

1. Port Forward

To log in to Harbor, port 80 of the proxy host must be forwarded.
Example of port forwarding with ssh. Please adjust the values accordingly.

ssh -i "C:\Users\<user>\.ssh\id_rsa" -J <user>@10.9.112.19 -L 8080:10.2.10.99:80 root@10.2.10.99

You can then log in to Harbor -> http://localhost:8080
Default credentials:

• User: admin
• Initial Password: Harbor12345

2. Add Registry Endpoint

In Harbor, navigate to Administration → Registries → New Endpoint.

3. Add Project

In Harbor, navigate to Project → New Project.

Manage applications with docker compose

1. KOSI Proxy

KOSI Proxy is installed in the folder ~/kosi-proxy.

cd ~/kosi-proxy

# show kosi proxy containers
docker compose ps

# show kosi proxy logs 
docker compose logs -f

# stop kosi proxy
docker compose down

# start kosi proxy
docker compose up -d

2. Harbor

Harbor is installed in the folder ~/harbor.

cd ~/harbor

# show harbor containers
docker compose ps

# show harbor logs 
docker compose logs -f

# stop harbor
docker compose down

# start harbor
docker compose up -d

3.8 - How to template within the package.kosi

How to template within the package.kosi"

TBA

3.9 - Create Kosi package

Creating Kosi package

kosi create

To create a Kosi package, you must first run the kosi create command in your directory.

The kosi create command creates four files (package.yaml, template.yaml, logo.png and docs.tgz) in the current directory. These files can be edited.

[root@localhost ~]# kosi create

Created files:

• package.yaml - Defines properties of the Kosi package. (see below)
• template.yaml - Required if the template engine Scriban is to be used.
• logo.png - A package-thumbnail with the size of 50x50px, for showing logo on the KubeOpsHub.
• docs.tgz - A zipped directory with the documentation of the package, for showing documentation on the KubeOpsHub.

The documentation of the package is written in markdown. The file for the documentation is called readme.md.
To edit the markdown, you can unzip the docs.tgz in your directory with the command tar -xzf docs.tgz and zip it again with the command tar -czf docs.tgz docs/ after you finished.

Note: Please name your markdown files inside docs.tgz without a version-tag (docs/documentation-1.0.0.md).
Do not change the file names of any of the files above generated with the kosi create command.

package.yaml

The package.yaml defines a package in a specific version as well as the tasks needed to install it. The tasks which are used in the package.yaml are plugins, which can be created by the user.

Elements:

• includes.files: Describes the files which are inluded in the Kosi package.
• includes.containers: Used for docker images. A container for the docker images will be created when the kosi install, kosi update or kosi delete command is used.
• installation.tasks: The tree describes the tasks (Kosi plugins), which are executed with the kosi install command.
• update.tasks: The tree describes the tasks (Kosi plugins), which are executed with the kosi update command.
• delete.tasks: The tree describes the tasks (Kosi plugins), which are executed with the kosi delete command.

IMPORTANT: It is required to enter the package name in lowercase.
Do not use any docker tags (:v1.0.0) in your package name.

Example package.yaml

apiversion: kubernative/kubeops/sina/user/v4 # Required field
name: kosi-example-packagev3 # Required field
description: kosi-example-package # Required field
version: 0.1.0 # Required field
includes:  # Required field: When "files" or "containers" are needed.
  files:  # Optional field: IF file is attached, e.g. "rpm, .extension"
    input: "template.yaml"
  containers: # Optional field: When "containers" are needed.
    example:
      registry: docker.io
      image: nginx
      tag: latest
docs: docs.tgz
logo: logo.png
installation: # Required field
  includes: # Optional field: When "files" or "containers" are needed.
    files: # Optional field:
      - input # Reference to includes
    containers: # Optional field:
      - example # Reference to includes
  tasks: 
    - cmd:
        command: "touch ~/kosiExample1"
update: # Required field
  includes: # Optional field: When "files" or "containers" are needed.
    files: # Optional field:
      - input # Reference to includes
    containers: # Optional field:
      - example # Reference to includes
  tasks:
    - cmd:
        command: "touch ~/kosiExample2"
delete: # Required field
  includes: # Optional field: When "files" or "containers" are needed.
    files: # Optional field:
      - input # Reference to includes
    containers: # Optional field:
      - example # Reference to includes
  tasks:
    - cmd:
        command: "rm ~/kosiExample1"
    - cmd:
        command: "rm ~/kosiExample2"

kosi build

Now, after you created and edited the files from kosi create, you can simply build a Kosi package by just running the kosi build command in your directory.

[root@localhost ~]# kosi build

All files specified in the package.yaml are combined together with the package.yaml to form a kosi package.

In these few steps, you can successfully create and use the kosi package. This is the basic functionality offered by Kosi.

You can always explore Full Documentation to go through all the functionality and features provided by Kosi.

4 - Plugins

Plugin References

How to access the plugins

All plugins are available as KOSI packages in the KubeOpsHub. Our plugins are grouped into several KOSI packages described below. To see our KOSI packages in the KubeOpsHub use the command:

Search for kubeops-plugins

kosi search --ps kubeops --hub public

Install for kubeops-plugins

kosi install --hub=public <user/packagename:version> 

The plugins are automatically placed in the associated directory($KUBEOPSROOT/plugins) and can be used directly.

Plugin packages

In this section you can find the plugin packages and the documentation for each plugin.

4.1 - auditLog-1.7.0

Kosi Plugin auditLog Version 1.7.0

Summary

The auditLog plugin enables or disables audit logging for your Kubernetes cluster. This plugin allows you to control logging settings and define paths for policy and log storage.

Keys

Example 1 - enable auditLog

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    auditLog
    (
        state = "on"; 
        policyPath = "/root/test/policyDir/";
        logPath = "/root/test/logging/";
    );
}

Example 2 - disable auditLog

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    auditLog
    (
        state = "off"; 
        policyPath = "/root/test/policyDir/";
        logPath = "/root/test/logging/";
    );
}

4.2 - bash-1.7.0

KOSI Plugin bash Version 1.7.0

Summary

The bash plugin allows users to execute shell commands within a Bash environment. It is useful for running system commands, scripting automation tasks, or performing custom operations that require command-line execution within a KOSI package. This plugin ensures that commands are executed inside a Bash shell, which provides compatibility with shell scripting syntax and built-in commands. Supports command chaining using ;.

Keys

Examples

Example 1

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files = 
{
    input = "template.yaml";
}

install
{
    cmd(command = "echo Using the bash plugin.");

    bash(command = "echo Hello World!");
}

Output

2025-02-26 15:17:00 Info:      use plugin bash if available
2025-02-26 15:17:00 Info:      Executing with non sudo privilegs
2025-02-26 15:17:00 Info:      Using the bash plugin.

2025-02-26 15:17:00 Info:      Executing with non sudo privilegs
2025-02-26 15:17:00 Info:      Hello World!

2025-02-26 15:17:00 Info:      Installation successful.

Example 2

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files = 
{
    input = "template.yaml";
}

install
{
    cmd(command = "echo Using the bash plugin.");

    bash(command = "echo 1.Hello;echo 2.World;echo 3.Hello World.");
} 

Output

2025-02-26 15:18:28 Info:      run cmd plugin
2025-02-26 15:18:28 Info:      use plugin bash if available
2025-02-26 15:18:28 Info:      Executing with non sudo privilegs
2025-02-26 15:18:28 Info:      Using the bash plugin.

2025-02-26 15:18:28 Info:      Executing with non sudo privilegs
2025-02-26 15:18:28 Info:      1.Hello
2.World
3.Hello World.

2025-02-26 15:18:28 Info:      Installation successful.

Example 3

Using bash with the set and if plugins

This example shows the interaction of several plug-ins. In this example, we use the bash plugin together with the set and if plugins to check a condition (which is set before) before executing a bash command:

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v4";
name = "kosi-example-bash-if";
description = "Example using bash with set and if";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files = 
{
    input = "template.yaml";
}

install
{
    set
    (
        variable = "myVar";
        value = "Hello";
    );

    if (condition = "$vars.myVar$ = 'Hello'") then
    {
        bash(command = "echo Variable is 'Hello'");
    }
    else
    {
        bash(command = "echo Variable is not 'Hello'");
    }
}

Expected Output

If myVar is Hello:

2025-02-26 15:18:28 Info:      Variable is 'Hello'

If myVar is not Hello:

2025-02-26 15:18:28 Info:      Variable is not 'Hello'

4.3 - chmod-1.7.0

KOSI Plugin chmod Version 1.7.0

Summary

The chmod plugin allows you to modify access permissions for a specified file or directory. By defining a path, state, and mode, you can change file permissions using the Linux chmod command.

• The state value can be either file or directory. If directory is specified, the plugin applies permissions recursively.
• The mode value represents the permission settings in the standard numerical format used in Linux.
• If necessary, you can run chmod with sudo, requiring a password set by the root user.

Keys

Note: If you’re not yet familiar with Linux permissions, check out this short introduction from RedHat.

Example 1 - Changing file permissions

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    cmd(command = "echo Changing file permissions using the chmod-plugin");
    chmod
    (
        path = "/user/myuser/myUserApp.sh";
        state = "file";
        mode = "777"
    );
}

Example 2 - Changing directory permissions with sudo

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install 
{
    cmd(command = "echo Changing directory permissions using the chmod-plugin");
    chmod
    (
        path = "/root"; 
        state = "directory"; 
        mode = "777"; 
        sudo = "true"; 
        sudoPassword = "myPassword";
    );
    bash(command = "ls -la /root");
}

Example 3 - Restricting permissions to read-only

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install 
{
    cmd(command = "echo Restricting file permissions using chmod-plugin");
    chmod
    (
        path = "/user/myuser/myUserApp.sh"; 
        state = "file"; 
        mode = "444";
    );
}

4.4 - cmd-1.7.0

KOSI Plugin cmd Version 1.7.0

Summary

The cmd plugin allows execution of Linux shell commands within a deployment configuration. It relies on either the bash or sh plugin to process commands, depending on availability. If the bash plugin is present, it will be used; otherwise, the sh plugin will handle execution.

Plugin dependencies

If you want to use the plugin cmd you need one of following plugins:

• Plugin bash

• Plugin sh

Why is the bash or sh Plugin Required?

The cmd plugin itself does not execute commands directly. Instead, it acts as a wrapper, passing the specified command to a shell environment. Since bash and sh are the most common shell interpreters in Linux, the plugin requires at least one of them to function properly.

Note: Each cmd call is executed in its own shell instance. Changes to the shell environment (e.g., cd, export, etc.) do not persist across multiple cmd calls. If multiple commands depend on a shared shell context, they should be combined into a single cmd call.
For example: cmd(command="cd /root/test-cmd-Plugin && pwd && ls -lah")

Keys

Note: The command has to be surrounded by double quotes, otherwise it will not be recognized.

Usage

Example 1 - Executing a single commands

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input="template.yaml";
}

containers =
{
    example=["docker.io", "nginx", "latest"];
}

install
{
    cmd(command = "echo Using the cmd-plugin");
    cmd(command = "echo Hello World");
}

Expected Output

This will be printed to the console:

2023-12-01 10:44:30 Info:      use plugin bash if available
Using the cmd-plugin
Hello World

Example 2 - Multiple commands

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    cmd(command = "echo Using the cmd-plugin");
    cmd(command = "echo Hello World! '>' test.txt");
    cmd(command = "cat test.txt");
}

Expected Output

A file named test.txt is created and “Hello World!” is written to the file.
The second command outputs the contents of the file.

2023-12-01 11:06:17 Info:      run cmd plugin
Using the cmd-plugin
2023-12-01 11:06:17 Info:      run cmd plugin
Hello World!

Example 3 - Creating and listing a directory

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/sina/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}
install
{
    cmd(command = "mkdir -p /tmp/mydirectory");
    cmd(command = "ls -la /tmp/mydirectory");
}

4.5 - containerd-1.7.0

KOSI Plugin containerd Version 1.7.0

Summary

The containerd plugin allows you to manage your container runtime efficiently. It provides options to execute commands with or without flags and enables gathering information about the current container runtime status.

Keys

Available Operations:

• ps - Lists all existing containers.
• images - Lists all existing images.
• run - Starts a container.
• status - Displays the state of the container runtime (e.g., active).
• exec - Executes a command inside a running container.
• tag - Renames an image (e.g., docker tag ).
• pull - Pulls a specified image.
• push - Pushes a specified image.
• stop - Stops a given container.
• start - Starts a given container.
• deleteCon - Deletes a specified container.

*1:Note: For containerd, containers do not have names, only IDs. When using startTask, stopTask, or deleteTask, containerName is treated as the task name.

*2:Note: Only required for execution commands with containerd.

Example 1 - List Running Containers (ps)

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        option = "ps"; 
        flag = "--last";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 2 - List All Images

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        option = "images"; 
        flag = "--all";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 3 - Run a Container

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        option = "run"; 
        flag = "-w /path/to/dir/ -i -t";
        srcImage = "registry.kubernative.net/lima:v0.8.0";
        containerName = "myFirstContainer";
        runtime = "status";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 4 - Check Container Runtime Status

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        option = "status";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 5 - Execute a Command in a Running Container

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        option = "exec"; 
        execID = "exec1";
        containerName = "registry.kubernative.net/lima:v0.8.0";
        command = "mkdir /tmp/testdir";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 6 - Tag an Image

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        option = "tag"; 
        srcImage = "registry.kubernative.net/lima:v0.8.0";
        destImage = "yourRegistry/yourName:v0.8.0";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 7 - Pull or Push an Image

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        option = "pull/push"; 
        srcImage = "registry.kubernative.net/lima:v0.8.0";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 8 - Delete a Container

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        option = "deleteCon"; 
        containerName = "myFirstContainer";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 9 List Running Tasks (psTask)

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        type = "containerd"; 
        option = "psTask";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 10 Manage Tasks (stopTask / startTask / deleteTask)

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerd
    (
        option = "stopTask / startTask / deleteTask"; 
        containerName = "task1";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Notes

• Ensure that all required parameters are provided for each operation.
• Using sudo=true requires sudoPassword to be set.
• The containerName for containerd may refer to a container ID or task name, depending on the operation.

4.6 - Plugin References

Plugin References

How to access the plugins

All plugins are available as KOSI packages in the KubeOpsHub. Our plugins are grouped into several KOSI packages described below. To see our KOSI packages in the KubeOpsHub use the command:

kosi search --ps kubeops --hub public

kosi install --hub=public <user/packagename:version> 

The plugins are automatically placed in the associated directory($KUBEOPSROOT/plugins) and can be used directly.

Plugin packages

In this section you can find the plugin packages and the documentation for each plugin.

4.7 - containerRuntime-1.7.0

KOSI Plugin containerRuntime Version 1.7.0

Summary

The ContainerRuntime plugin allows you to manage container runtimes efficiently. It provides options to execute commands with or without flags and retrieve runtime status information. Supported runtimes include Docker, CRI-O, and containerd.

Plugin requirements

To use the ContainerRuntime plugin, you need the following dependencies installed:

• Docker
• CRI-O
• Contianerd

Keys

Supported option Values

ContainerD-Specific Commands

podConfig and containerConfig

These keys specify JSON or YAML configuration files required for pod creation (e.g., podConfiguration.json or podConfiguration.yaml).

Example 1 - List Running Containers (ps)

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerruntime
    (
        type = "docker / crio / containerd"; 
        option = "ps";
        flag = "--last";
        runtime = "status";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 2 - List Images (images)

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerruntime
    (
        type = "docker / crio / containerd"; 
        option = "images";
        flag = "--all";
        runtime = "status";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 3 - Run a Container (run)

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerruntime
    (
        type = "docker / crio / containerd"; 
        option = "run";
        flag = "-w /path/to/dir/ -i -t";
        srcImage = "registry.kubernative.net/lima:v0.8.0";
        containerName = "myFirstContainer";
        runtime = "status";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}

Example 4 - Run a CRI-O Pod

languageversion = "1.0.0";
apiversion = "kubernative/kubeops/kosi/user/v4";
name = "kosi-example-packagev3";
description = "kosi-example-package";
version = "0.1.0";
docs = "docs.tgz";
logo = "logo.png";

files =
{
    input = "template.yaml";
}

containers =
{
    example = ["docker.io", "nginx", "latest"];
}

install
{
    containerruntime
    (
        type = "crio"; 
        option = "run";
        containerConfig = "/root/podConfig.json / .yaml";
        podConfig = "/root/podConfig.json / .yaml";
        runtime = "status";
        sudo = "true";
        sudoPassword = "Drowssap";
    );
}