Installing and removing KUMA

To install KUMA, you need the distribution kit:

kuma-ansible-installer-<build number>.tar.gz contains all necessary files for installing KUMA without Kubernetes. You can perform a distributed installation of KUMA Core in a cluster based on the Raft algorithm (hereinafter referred to as the "Raft cluster").
kuma-ansible-installer-k8s-<build number>.tar.gz contains all necessary files for installing KUMA in a high-availability configuration based on Kubernetes.

To complete the installation, you need the install.sh installer file and an inventory file that describes your infrastructure. You can create an inventory file based on a template. Each distribution contains an install.sh installer file and the following inventory file templates:

single.inventory.yml.template
distributed.inventory.yml.template
expand.inventory.yml.template
k0s.inventory.yml.template

KUMA keeps its files in the /opt directory, so we recommend making /opt a separate partition and allocating 16 GB for the operating system and the remainder of the disk space for the /opt partition.

KUMA is installed in the same way on all hosts using the installer and your prepared inventory file in which you describe your configuration. We recommend taking time to think through the setup before you proceed.

The following installation options are available:

Installation on a single server
Single-server installation diagram

Installation on a single server

Example inventory file for installation on a single server

all:

vars:

deploy_to_k8s: false

need_transfer: false

generate_etc_hosts: false

deploy_example_services: true

no_firewall_actions: false

kuma:

vars:

ansible_connection: ssh

ansible_user: root

children:

kuma_core:

hosts:

kuma1.example.com:

kuma_collector:

hosts:

kuma1.example.com

kuma_correlator:

hosts:

kuma1.example.com

kuma_storage:

hosts:

kuma1.example.com:

shard: 1

replica: 1

keeper: 1

You can install all KUMA components on the same server: specify the same server in the single.inventory.yml inventory file for all components. An "all-in-one" installation can handle a small stream of events, up to 10,000 EPS. If you plan to use many dashboard layouts and process a lot of search queries, a single server might not be sufficient. In that case, we recommend the distributed installation.
Distributed installation
Distributed Installation diagram

Distributed installation diagram

Example inventory file for distributed installation

all:

vars:

deploy_to_k8s: false

need_transfer: false

generate_etc_hosts: false

deploy_example_services: false

no_firewall_actions: false

kuma:

vars:

ansible_connection: ssh

ansible_user: root

children:

kuma_core:

hosts:

kuma-core-1.example.com:

ip: 0.0.0.0

kuma_collector:

hosts:

kuma-collector-1.example.com:

ip: 0.0.0.0

kuma_correlator:

hosts:

kuma-correlator-1.example.com:

ip: 0.0.0.0

kuma_storage:

hosts:

kuma-storage-cluster1-server1.example.com:

ip: 0.0.0.0

shard: 2

replica: 2

keeper: 0

kuma-storage-cluster1-server2.example.com:

ip: 0.0.0.0

shard: 2

replica: 2

keeper: 0

kuma-storage-cluster1-server3.example.com:

ip: 0.0.0.0

shard: 2

replica: 2

keeper: 0

kuma-storage-cluster1-server4.example.com:

ip: 0.0.0.0

shard: 2

replica: 2

keeper: 0

kuma-storage-cluster1-server5.example.com:

ip: 0.0.0.0

shard: 0

replica: 0

keeper: 3

kuma-storage-cluster1-server6.example.com:

ip: 0.0.0.0

shard: 0

replica: 0

keeper: 2

kuma-storage-cluster1-server7.example.com:

ip: 0.0.0.0

shard: 0

replica: 0

keeper: 3

You can install KUMA services on different servers; you can describe the configuration for a distributed installation in the distributed.inventory.yml inventory file.
Installation in a high availability configuration
- Distributed installation with KUMA Core in a Kubernetes cluster
  Distributed installation with KUMA Core in a Kubernetes cluster
  
  Distributed installation in a high availability configuration
  
  Example inventory file for distributed installation with KUMA Core in a Kubernetes cluster
  
  all:
  
  vars:
  
  deploy_to_k8s: true
  
  need_transfer: true
  
  generate_etc_hosts: false
  
  airgap: true
  
  deploy_example_services: false
  
  no_firewall_actions: false
  
  kuma:
  
  vars:
  
  ansible_connection: ssh
  
  ansible_user: root
  
  children:
  
  kuma_core:
  
  hosts:
  
  kuma-core-1.example.com:
  
  kuma_collector:
  
  hosts:
  
  kuma-collector-1.example.com:
  
  ip: 0.0.0.0
  
  kuma-collector-2.example.com:
  
  ip: 0.0.0.0
  
  kuma_correlator:
  
  hosts:
  
  kuma-correlator-1.example.com:
  
  ip: 0.0.0.0
  
  kuma-correlator-2.example.com:
  
  ip: 0.0.0.0
  
  kuma_storage:
  
  hosts:
  
  kuma-storage-cluster1-server1.example.com:
  
  ip: 0.0.0.0
  
  shard: 2
  
  replica: 2
  
  keeper: 0
  
  kuma-storage-cluster1-server2.example.com:
  
  ip: 0.0.0.0
  
  shard: 2
  
  replica: 2
  
  keeper: 0
  
  kuma-storage-cluster1-server3.example.com:
  
  ip: 0.0.0.0
  
  shard: 2
  
  replica: 2
  
  keeper: 0
  
  kuma-storage-cluster1-server4.example.com:
  
  ip: 0.0.0.0
  
  shard: 2
  
  replica: 2
  
  keeper: 0
  
  kuma-storage-cluster1-server5.example.com:
  
  ip: 0.0.0.0
  
  shard: 0
  
  replica: 0
  
  keeper: 3
  
  kuma-storage-cluster1-server6.example.com:
  
  ip: 0.0.0.0
  
  shard: 0
  
  replica: 0
  
  keeper: 2
  
  kuma-storage-cluster1-server7.example.com:
  
  ip: 0.0.0.0
  
  shard: 0
  
  replica: 0
  
  keeper: 3
  
  kuma_k0s:
  
  vars:
  
  ansible_connection: ssh
  
  ansible_user: root
  
  children:
  
  kuma_lb:
  
  hosts:
  
  kuma_lb.example.com:
  
  kuma_managed_lb: true
  
  kuma_control_plane_master:
  
  hosts:
  
  kuma_cpm.example.com:
  
  ansible_host: 10.0.1.10
  
  kuma_control_plane_master_worker:
  
  kuma_control_plane:
  
  hosts:
  
  kuma_cp1.example.com:
  
  ansible_host: 10.0.1.11
  
  kuma_cp2.example.com:
  
  ansible_host: 10.0.1.12
  
  kuma_control_plane_worker:
  
  kuma_worker:
  
  hosts:
  
  kuma-core-1.example.com:
  
  ansible_host: 10.0.1.13
  
  extra_args: "--labels=kaspersky.com/kuma-core=true,kaspersky.com/kuma-ingress=true,node.longhorn.io/create-default-disk=true"
  
  kuma_worker2.example.com:
  
  ansible_host: 10.0.1.14
  
  extra_args: "--labels=kaspersky.com/kuma-core=true,kaspersky.com/kuma-ingress=true,node.longhorn.io/create-default-disk=true"
  
  You can install the KUMA Core on a Kubernetes cluster for high availability. Describe the configuration in the k0s.inventory.yml inventory file.
- Distributed installation with KUMA Core in a Raft cluster
  Distributed installation with KUMA Core in a Raft cluster
  
  Example distributed.inventory.yml inventory file for initial installation
  
  all:
  
  vars:
  
  deploy_to_k8s: false
  
  need_transfer: false
  
  generate_etc_hosts: false
  
  deploy_example_services: false
  
  no_firewall_actions: false
  
  kuma:
  
  vars:
  
  ansible_connection: ssh
  
  ansible_user: root
  
  children:
  
  kuma_core:
  
  hosts:
  
  kuma-core-1.example.com:
  
  ip: 0.0.0.0
  
  raft_node_addr: ""
  
  kuma_core_peers:
  
  hosts:
  
  kuma-core-2.example.com:
  
  ip: 0.0.0.0
  
  kuma-core-1.example.com:
  
  ip: 0.0.0.0
  
  kuma_collector:
  
  hosts:
  
  kuma-collector-1.example.com:
  
  ip: 0.0.0.0
  
  kuma_correlator:
  
  hosts:
  
  kuma-correlator-1.example.com:
  
  ip: 0.0.0.0
  
  kuma_storage:
  
  hosts:
  
  kuma-storage-cluster1-server1.example.com:
  
  ip: 0.0.0.0
  
  shard: 2
  
  replica: 2
  
  keeper: 0
  
  kuma-storage-cluster1-server2.example.com:
  
  ip: 0.0.0.0
  
  shard: 2
  
  replica: 2
  
  keeper: 0
  
  kuma-storage-cluster1-server3.example.com:
  
  ip: 0.0.0.0
  
  shard: 2
  
  replica: 2
  
  keeper: 0
  
  kuma-storage-cluster1-server4.example.com:
  
  ip: 0.0.0.0
  
  shard: 2
  
  replica: 2
  
  keeper: 0
  
  kuma-storage-cluster1-server5.example.com:
  
  ip: 0.0.0.0
  
  shard: 0
  
  replica: 0
  
  keeper: 3
  
  kuma-storage-cluster1-server6.example.com:
  
  ip: 0.0.0.0
  
  shard: 0
  
  replica: 0
  
  keeper: 2
  
  kuma-storage-cluster1-server7.example.com:
  
  ip: 0.0.0.0
  
  shard: 0
  
  replica: 0
  
  keeper: 3
  
  Example inventory file for expanding the cluster using expand.sh
  
  kuma:
  
  vars:
  
  no_firewall_actions: false
  
  ansible_connection: ssh
  
  ansible_user: root
  
  children:
  
  kuma_core_peers:
  
  hosts:
  
  kuma-core-4.example.com:
  
  ip: 0.0.0.0
  
  kuma-core-5.example.com:
  
  ip: 0.0.0.0
  
  You can install multiple KUMA Cores in a Raft cluster for data replication and high availability in a distributed system. Describe the configuration in the distributed.inventory.yml inventory file.