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:

   kosi install --hub <hubname> <installation address>
   

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 wordpressdemo of user kosi with version 0.1.0 is to be installed from the private software Hub:

kosi install --hub kubeops kosi/wordpressdemo:0.1.0

Install from Public Hub

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

kosi install --hub kubeops kosi/wordpressdemo:0.1.0

Install along with yaml files

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

kosi install --hub <hubname> <package> -f <user.yaml>

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

kosi install --hub kubeops kosi/wordpressdemo:0.1.0 -f userfile1.yaml

Install in specific namespace

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

kosi install --hub <hubname> <package> --namespace <namespace>

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

kosi install --hub kubeops kosi/wordpressdemo:0.1.0 --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.

kosi install --hub <hubname> <package> --dname <deploymentname>

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

kosi install --hub kubeops kosi/wordpressdemo:0.1.0 --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:

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:

kosi install -p [package name]