KubeOpsDoku – KubeOps Container Manager

Kubeops-Container-Manager: KubeOpsCtl CLI Commands

Mon, 01 Jan 0001 00:00:00 +0000

This documentation shows all commands of kubeopsctl and how to use them.

⚠ Warning The kosi software must be installed from the start.

General commands

Overview of all KUBEOPSCTL commands

Description:
  kubeopsctl is a kubernetes cluster manager

Usage:
  kubeopsctl [command] [options]

Options:
  --version       Show version information
  -?, -h, --help  Show help and usage information

Commands:
  version  kubeopsctl version information
  login    Login to kubeops hub and registry
  logout   Logout from kubeops hub
  pull     Pull kosi packages for kubernetes cluster setup and plattform tools
  apply    Apply values on kubernetes cluster

Command ‘kubeopsctl –version’

The kubeopsctl --version command shows you the current version of kubeopsctl.

kubeopsctl --version

The output should be:

2.0.3

Command ‘kubeopsctl –help’

The command kubeopsctl --help gives you an overview of all available commands:

kubeopsctl --help

Alternatively, you can also enter kubeopsctl or kubeopsctl -? in the command line.

The command kubeopsctl login performs a login against the KOSI HUB. A valid login session is neccessary to pull the packages.

Description:
  Login to kubeops hub and registry

Usage:
  kubeopsctl login [options]

Options:
  -u, --username <username> (REQUIRED)  Username
  -p, --password <password>             Password
  -?, -h, --help                        Show help and usage information

Example:

kubeopsctl login -u <username> -p <password>

Command ‘kubeopsctl logout’

The command kubeopsctl logout performs a logout from the KOSI HUB.

Description:
  Logout from kubeops hub

Usage:
  kubeopsctl logout [options]

Options:
  -?, -h, --help  Show help and usage information

Example:

kubeopsctl logout

Command ‘kubeopsctl pull’

The command kubeopsctl pull downloads all necessary KOSI packages to the admin node:

Description:
  Pull kosi packages for kubernetes cluster setup and plattform tools

Usage:
  kubeopsctl pull [options]

Options:
  -k, --kubernetesVersion <kubernetesVersion>  Kubernetes version
  -f, --tools <tools>                          Tools values file
  -?, -h, --help                               Show help and usage information

Example:

kubeopsctl pull

If you do not specify a parameter, the latest from kubeopsctl supported Kubernetes version will be pulled.
With parameter --kubernetesVersion 1.30.8 you can pull an older Kubernetes version.

Example:

kubeopsctl pull --kubernetesVersion 1.30.8

⚠ Warning In order to download the KOSI packages, the ADMIN node must have an internet connection to the KubeOps hub
https://dispatcher.kubeops.net/v4/dispatcher/

Command ‘kubeopsctl apply’

The command kubeopsctl apply is used to set up the kubeops platform with a configuration file.

Description:
  Apply values on kubernetes cluster

Usage:
  kubeopsctl apply [options]

Options:
  -f, --file <file> (REQUIRED)  Values files for cluster, tools and user
  -?, -h, --help                Show help and usage information

-f flag

The -f parameter is used to use value parameter yaml-files

Example:

kubeopsctl apply -f cluster-values.yaml

To install your KubeOps KubeOps Container Manager Applications, you have to use a second value file. It is called enterprise-value.yaml

Note Value-parameter will be explained in the references and can be found here.

Example:

kubeopsctl apply -f cluster-values.yaml -f enterprise-values.yaml

–delete flag

The -- delete parameter is used to perform a delete action.

This flag delete all nodes which are not present in the cluster-values.yaml - file Example:

kubeopsctl apply --delete -f cluster-values.yaml

Note For a detailed use case click here.

Kubeops-Container-Manager: Getting-Started

Mon, 01 Jan 0001 00:00:00 +0000

Kubeops-Container-Manager: About KubeOps Container Manager (CM)

Mon, 01 Jan 0001 00:00:00 +0000

What is KubeOps Container Manager (CM)?

KubeOps Container Manager, or in short “CM”, serves as a versatile utility designed specifically to efficiently manage both the configuration and status of a cluster.

With its capabilities, users can articulate their desired cluster state in detail, outlining configurations and specifications.

Subsequently, CM orchestrates the creation of a cluster that precisely matches the specified state, ensuring alignment between intentions and operational reality.

Why use KubeOps Container Manager?

In CM, configuration management involves defining, maintaining, and updating the desired state of a cluster, including configurations for nodes, pods, services, and other resources in the application environment.

The main goal of CM is to match the clusters actual state with the desired state specified in the configuration files. With a declarative model, CM enables administrators to express their desired system setup, focusing on „what“ they want rather than „how“ to achieve it.

This approach improves flexibility and automation in managing complex systems, making the management process smoother and allowing easy adjustment to changing needs.

CM uses YAML files to store configuration data in a human-readable format. These files document important metadata about the objects managed by CM, such as pods, services, and deployments.

Highlights

creating a cluster
adding nodes to your cluster
drain nodes
updating single nodes
label nodes for zones
adding platform software into your cluster

Kubeops-Container-Manager: About KubeOps Container Manager Licences

Mon, 01 Jan 0001 00:00:00 +0000

KubeOps Container Manager is available with a KubeOps Container Manager licence.

When you create an account, you receive a free 30 day trial version of our licences.

Note The free license includes only 1 control plane and 3 worker nodes.

Functions	KubeOps Container Manager
Cluster Lifecycle Management	✓
Build Cluster	✓
Build Airgap Cluster	✓
Security Hardening	✓
Price	Contact Sales

Kubeops-Container-Manager: KubeOps Container Manager (CM)

Mon, 01 Jan 0001 00:00:00 +0000

Start with KubeOps Container Manager

Follow the quickstart guides to learn how to create cluster in a secure, fast way with KubeOps Container Manager.

Kosi: Software Bill of Materials (SBOM)

Mon, 01 Jan 0001 00:00:00 +0000

KubeOps publishes a Software Software Bill of Materials (SBOM) for the kosi command-line tooling that ships in the package repositories. It lists every bundled component with its exact version and license, in CycloneDX format. The published document is the authoritative source — link to it rather than copying its contents, so the list never drifts out of date.

Download

The SBOM is served at a fixed path in each package repository. Both repositories ship the same SBOM document, so the only difference is the retrieval URL for your platform.

curl -fsSLO https://packagerepo.kubeops.net/rpm/sbom/kosi-2.15.1.0-0.x86_64.xml

You can checkout all SBOMs here sbom

curl -fsSLO https://packagerepo.kubeops.net/deb/pool/main/sbom/kosi-2.15.1.0-0.x86_64.xml

You can checkout all SBOMs here sbom

Using the SBOM

The CycloneDX document can be fed directly into SBOM-aware vulnerability scanners and license-compliance tooling without re-resolving dependencies, for example:

grype sbom:./kosi-bom.xml   # vulnerability scan
trivy sbom ./kosi-bom.xml   # vulnerability scan

Scanner output reflects advisories at the time you run the scan, not at the time the SBOM was generated. Re-run scans regularly rather than relying on a single point-in-time result.

Kubeops-Container-Manager: Software Bill of Materials (SBOM)

Mon, 01 Jan 0001 00:00:00 +0000

KubeOps publishes a Software Software Bill of Materials (SBOM) for the kubeopsctl command-line tooling that ships in the package repositories. It lists every bundled component with its exact version and license, in CycloneDX format. The published document is the authoritative source — link to it rather than copying its contents, so the list never drifts out of date.

Download

The SBOM is served at a fixed path in each package repository. Both repositories ship the same SBOM document, so the only difference is the retrieval URL for your platform.

curl -fsSLO https://packagerepo.kubeops.net/rpm/sbom/kubeopsctl-2.2.1.0-0.x86_64.xml

You can checkout all SBOMs here sbom

curl -fsSLO https://packagerepo.kubeops.net/deb/pool/main/sbom/kubeopsctl-2.2.1.0-0.x86_64.xml

You can checkout all SBOMs here sbom

Using the SBOM

The CycloneDX document can be fed directly into SBOM-aware vulnerability scanners and license-compliance tooling without re-resolving dependencies, for example:

grype sbom:./kubeopsctl-bom.xml   # vulnerability scan
trivy sbom ./kubeopsctl-bom.xml   # vulnerability scan

Scanner output reflects advisories at the time you run the scan, not at the time the SBOM was generated. Re-run scans regularly rather than relying on a single point-in-time result.

KubeOpsDoku – KubeOps Container Manager

Kubeops-Container-Manager: KubeOpsCtl CLI Commands

General commands

Overview of all KUBEOPSCTL commands

Command ‘kubeopsctl –version’

Command ‘kubeopsctl –help’

Command ‘kubeopsctl login’

Command ‘kubeopsctl logout’

Command ‘kubeopsctl pull’

Command ‘kubeopsctl apply’

-f flag

–delete flag

Kubeops-Container-Manager: Getting-Started

Kubeops-Container-Manager: About KubeOps Container Manager (CM)

What is KubeOps Container Manager (CM)?

Why use KubeOps Container Manager?

Highlights

Kubeops-Container-Manager: About KubeOps Container Manager Licences

Kubeops-Container-Manager: KubeOps Container Manager (CM)

Kosi: Software Bill of Materials (SBOM)

Download

Using the SBOM

Kubeops-Container-Manager: Software Bill of Materials (SBOM)

Download

Using the SBOM