Getting started

This is the installation guide for Kubero. It will guide you through the installation of the required components, the Kubero Operator and the Kubero UI.

All these steps can be performed with the Kubero CLI. You can download the latest version from the releases page

Prerequisites

• Kubernetes cluster
• kubectl

Components

Ingress Controller

The Installation of the Ingress Controller depends on your Kubernetes provider. For example, if you are using Kind, you can use the following command:

kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/deploy/static/provider/kind/deploy.yaml

For other Kubernetes providers, please use one of the following resources

Metrics Server

The Metrics Server is required for the Kubero UI to display CPU and Memory usage. You can install it with the following command:

kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml

Cert Manager

The Certmanager is requirede to generate and manage TLS certificates.

kubectl apply -f https://operatorhub.io/install/cert-manager.yaml

Kubero Operator

There are two ways to install Kubero: 1) Minimal installation 2) Full installation with OLM (Operator Lifecycle Manager)

Option 1) Minimal installation

The minimal installation will install the Kubero Operator and the required CRDs. The Kubero UI will be installed on a later step.

kubectl apply -f hhttps://raw.githubusercontent.com/kubero-dev/kubero-operator/main/deploy/operator.yaml

Option 2) Full installation with OLM

The OLM installation will install the Operator Lifecycle Manager and the Kubero Operator. The Kubero UI will be installed on a later step.

OLM (Operator Lifecycle Manager)

kubectl create -f https://raw.githubusercontent.com/operator-framework/operator-lifecycle-manager/master/deploy/upstream/quickstart/crds.yaml

kubectl create -f https://raw.githubusercontent.com/operator-framework/operator-lifecycle-manager/master/deploy/upstream/quickstart/olm.yaml

Kubero Operator

kubectl create -f https://operatorhub.io/install/kubero-operator.yaml

Kubero UI

The Kubero UI provides an API and a web interface to manage your Kubero installation. Without the Kubero UI, you can still use the Kubero Operator to manage your applications but you will need to use the kubectl to apply the rescources.

kubectl create namespace kubero

Create the secrets

kubectl create secret generic kubero-secrets \
    --from-literal=KUBERO_WEBHOOK_SECRET=$(openssl rand -hex 20) \
    --from-literal=KUBERO_SESSION_KEY=$(openssl rand -hex 20) \
    --from-literal=GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_TOKEN \
    -n kubero

Variable	Required	Description
GIT_DEPLOYMENTKEY_PUBLIC	deprecated	(Bug in Operator =< v0.0.70, set to random string)
GIT_DEPLOYMENTKEY_PRIVATE_B64	deprecated	(Bug in Operator =< v0.0.70, set to random string)
KUBERO_WEBHOOK_SECRET	required	Random secret string
KUBERO_SESSION_KEY	required	Random secret string
KUBECONFIG_BASE64	optional	Base64 encoded Kubeconfig, may contain multiple contexts (required for multi cluster)
KUBERO_USERS	optional	Base64 encoded jsonfile (see Authentication chapter)
GITHUB_PERSONAL_ACCESS_TOKEN	optional	Personal access token for GitHub API
GITEA_PERSONAL_ACCESS_TOKEN	optional	Personal access token for Gitea API

Deploy the Kubero UI

kubectl apply -f https://raw.githubusercontent.com/kubero-dev/kubero-operator/main/config/samples/application_v1alpha1_kubero.yaml -n kubero

Customize the Kubero configuration

kubectl edit configmap kubero-config -n kubero