Quick Deployment

This guide will use the easiest and most convenient way to deploy Kato. Help you quickly evaluate Kato.

If you are already familiar with Kato or want to know other more advanced installation methods, please refer to Deployment Cluster.

Build Kubernetes

Before installing Kato, a Kubernetes version 1.13 and above is required.

If you don’t have Kubernetes ready, you can refer to Quick Install Kubernetes

Use Helm 3 to install Kato Operator

It is recommended to use Helm to install Kato Opeartor.

Install Helm 3

Use the following command to mirror the installation:

# Download the release package of helm and unzip it
wget https://get.helm.sh/helm-v3.0.3-linux-amd64.tar.gz && tar xvf helm-v3.0.3-linux-amd64.tar.gz
# Copy the helm command to the specified directory
cp linux-amd64/helm /usr/local/bin/

For the installation details of helm, please refer to Installing Helm.

Install Kato Operator

  1. Create namespace, recommend using rbd-system:
 kubectl create ns rbd-system
  1. Download the chart package of Kato Operator:
 wget https://registry.gitlab.com/gridworkz/kato/offline/5.2/kato-operator-chart-v5.2.0-release.tgz && tar xvf kato-operator-chart-v5.2.0-release .tgz
  1. Install Kato Operator
 helm install kato-operator ./chart --namespace=rbd-system

If you want to know the parameters of Kato Operator, please refer to here.

  1. Confirm Kato Operator status
 $ kubectl get pod -n rbd-system
 kato-operator-0 2/2 Running 0 110s

Wait for a while (depending on the specific network environment) until the status (STATUS) of kato-operator-0 becomes Running.

Install Kato

Visit Kato Operator to start the installation of Kato.

  1. Open the browser and enter the host IP address: http://<SERVER_IP>:30008. You can obtain SERVER_IP through the following command:
 echo $(kubectl get po kato-operator-0 -n rbd-system -o jsonpath="{..hostIP}")

Note that the obtained SERVER_IP is an internal network address, please use it directly or replace it with an external network address according to the actual situation.

  1. Configure Gateway Installation Node

    By default, Kato Operator will select eligible master nodes in the Kubernetes cluster to install gateway. If there is no master node in your cluster, you can search and select a node node whose ports such as 80 and 443 are not occupied, as the gateway node.

  2. Configure build service running node

    By default, Kato Operator will select the master node in the Kubernetes cluster to install build service. If there is no master node in your cluster, then you can search and select a node node as the build service running node.

  3. Optional: Gateway external network IP

    By default, Kato Operator will select the IP address of the first gateway node as the gateway external IP. You also fill in the appropriate other gateway node IP or public network IP.

  4. Other configurations

    Skip the other configuration items, they are not important now.

  5. After completing the above configuration, click Configuration is ready to start installation.

If the installation is blocked, you can refer to Troubleshooting, or contact the corresponding manager.

Verify Installation

When the installation progress is completed, it will jump to the following page:

The installation is complete. Click Access Address to register and start using Kato.

Install Command Line Tools

To facilitate the operation and maintenance of the cluster, please refer to document to install the grctl command line tool.


The uninstaller will delete RBAC permissions, rbd-system namespace and all related resources.

Uninstall Kato

Visit the UI interface of Kato Operator and click Uninstall.

Uninstall Kato Operator

helm delete kato-operator -n rbd-system