Minimum K8s Install

This article will install Kato on Kubernetes in a minimal way, which can help you save resources.


  • The version of Kubernetes must be greater than or equal to 1.13
  • NFS client. If it is not installed, you can refer to:
# CentOS system
yum install -y nfs-utils
# Ubuntu/Debian system
apt install -y nfs-common
  • If the firewall is turned on, make sure it meets port requirements
  • Hardware: 2 core CPU, 8G memory, 50G disk

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 install (if Helm 3 is already installed, you can skip this step):

wget && chmod +x helm && mv helm /usr/local/bin/

Install Kato Operator

  1. Create the namespace used by Kato: rbd-system:
kubectl create ns rbd-system
  1. Add the chart repository of Kato Operator:
helm repo add kato
  1. Install Kato Operator
helm install kato-operator kato/kato-operator \
--namespace rbd-system \
--version 1.1.1

To learn more about Kato Operator parameters, 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 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 acquired 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.

    Tip: If you cannot search and select a gateway IP, please refer to Cannot select gateway node.

  2. Configure Build Service Running Node

    By default, Kato Operator will select the master node in the Kubernetes cluster to install the 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. Shared Storage

    Shared storage provides multi-read and multi-write features for data sharing between system components and application global shared storage types.

    By default, Kato will use nfs as shared storage. If it is an Alibaba Cloud environment, it is recommended to use Aliyun NAS. Of course, you can also use the existing StorageClass in the cluster, mainly it supports multiple read and multiple write (RWX).

  4. 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.

  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.


In the process of installation and use, please refer to Installation Troubleshooting Document and Cluster Problem Diagnosis Document

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