Параметры конфигурации KUMA в файле инвентаря

ansible_connection

Способ подключения к целевым машинам.

Возможные значения:

• ssh – подключение к удаленным хостам по SSH. Если вы используете нестандартный порт для подключения к удаленным хостам по SSH, укажите значения переменной ansible_port.
• local – подключение к удаленным хостам не производится.

ansible_port

Переменная для указания нестандартного порта для подключения к удаленным хостам по SSH. Доступны следующие возможности настройки параметра ansible_port:

• Если на всех хостах, перечисленных в файле инвентаря, используется один и тот же нестандартный порт, укажите значение переменной ansible_port в файле инвентаря в блоке all в секции vars.

  Пример файла инвентаря distributed.inventory.yml с одним нестандартным портом для всех хостов

  all:

  vars:

  ansible_port: 2222

  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: 1

  replica: 1

  keeper: 0

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

  ip: 0.0.0.0

  shard: 1

  replica: 2

  keeper: 0

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

  ip: 0.0.0.0

  shard: 2

  replica: 1

  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: 1

  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 или kuma_k0s в секции vars. Например:

  Пример файла инвентаря distributed.inventory.yml с одним нестандартным портом для группы хостов хранилища

  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:

  vars:

  ansible_port: 2222

  hosts:

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

  ip: 0.0.0.0

  shard: 1

  replica: 1

  keeper: 0

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

  ip: 0.0.0.0

  shard: 1

  replica: 2

  keeper: 0

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

  ip: 0.0.0.0

  shard: 2

  replica: 1

  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: 1

  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

  Пример файла инвентаря k0s.inventory.yml с одним нестандартным портом для всех хостов в секции kuma_control_plane

  all:

  vars:

  ansible_connection: ssh

  ansible_user: root

  deploy_to_k8s: true

  need_transfer: false

  generate_etc_hosts: false

  deploy_example_services: false

  no_firewall_actions: false

  metrics_disk_request: 150Gi

  core_disk_request: 100Gi

  kuma:

  children:

  kuma_collector:

  hosts:

  kuma-collector.example.com:

  kuma_correlator:

  hosts:

  kuma-correlator.example.com:

  kuma_storage:

  hosts:

  kuma-storage-cluster1.server1.example.com

  kuma-storage-cluster1.server2.example.com

  kuma-storage-cluster1.server3.example.com

  kuma-storage-cluster1.server4.example.com

  kuma-storage-cluster1.server5.example.com

  kuma-storage-cluster1.server6.example.com

  kuma-storage-cluster1.server7.example.com

  kuma_k0s:

  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:

  vars:

  ansible_port: 2222

  hosts:

  kuma_cp2.example.com:

  ansible_host: 10.0.1.11

  kuma_cp3.example.com:

  ansible_host: 10.0.1.12

  kuma_control_plane_worker:

  kuma_worker:

  hosts:

  kuma-w1.example.com:

  ansible_host: 10.0.2.11

  extra_args: "--labels=kaspersky.com/kuma-core=true,kaspersky.com/kuma-ingress=true,node.longhorn.io/create-default-disk=true"

  kuma-w2.example.com:

  ansible_host: 10.0.2.12

  extra_args: "--labels=kaspersky.com/kuma-core=true,kaspersky.com/kuma-ingress=true,node.longhorn.io/create-default-disk=true"

  Пример файла инвентаря distributed.inventory.yml для отказоустойчивой установки с Ядром KUMA в кластере Raft с одним нестандартным портом для всех хостов с Ядром KUMA

  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: ""

  ansible_port: 2222

  kuma_core_peers:

  vars:

  ansible_port: 2222

  hosts:

  kuma-core-2.example.com:

  ip: 0.0.0.0

  kuma-core-3.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: 1

  replica: 1

  keeper: 0

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

  ip: 0.0.0.0

  shard: 1

  replica: 2

  keeper: 0

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

  ip: 0.0.0.0

  shard: 2

  replica: 1

  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: 1

  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

• Если вы используете отдельный нестандартный порт для каждого хоста для подключения по SSH, укажите значение переменной ansible_port для каждого хоста в файле инвентаря.

  Пример файла инвентаря distributed.inventory.yml с отдельным нестандартным портом для каждого хоста хранилища

  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_ssh_private_key_file: <полный путь к файлу с ключом SSH>

  ansible_user: <пользователь из группы sudo>

  ansible_become: true

  children:

  kuma_core:

  hosts:

  kuma-core-1.example.com:

  raft_node_addr: ""

  ip: 0.0.0.0

  kuma_metrics:

  hosts:

  kuma-metrics.example.com

  ip: 0.0.0.0

  kuma_collector:

  hosts:

  kuma-collector-1.example.com:

  ansible_port: 2222

  ip: 0.0.0.0

  kuma_correlator:

  hosts:

  kuma-correlator-1.example.com:

  ansible_port: 2223

  ip: 0.0.0.0

  kuma_storage:

  vars:

  ansible_port: 2224

  hosts:

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

  ip: 0.0.0.0

  shard: 1

  replica: 1

  keeper: 0

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

  ip: 0.0.0.0

  shard: 1

  replica: 2

  keeper: 0

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

  ip: 0.0.0.0

  shard: 2

  replica: 1

  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: 1

  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

  Пример файла инвентаря k0s.inventory.yml с отдельным нестандартным портом для каждого хоста в группе kuma_control_plane

  all:

  vars:

  ansible_connection: ssh

  ansible_user: root

  deploy_to_k8s: true

  need_transfer: false

  generate_etc_hosts: false

  deploy_example_services: false

  no_firewall_actions: false

  metrics_disk_request: 150Gi

  core_disk_request: 100Gi

  kuma:

  children:

  kuma_collector:

  hosts:

  kuma-collector.example.com:

  kuma_correlator:

  hosts:

  kuma-correlator.example.com:

  kuma_storage:

  hosts:

  kuma-storage-cluster1.server1.example.com

  kuma-storage-cluster1.server2.example.com

  kuma-storage-cluster1.server3.example.com

  kuma-storage-cluster1.server4.example.com

  kuma-storage-cluster1.server5.example.com

  kuma-storage-cluster1.server6.example.com

  kuma-storage-cluster1.server7.example.com

  kuma_k0s:

  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_cp2.example.com:

  ansible_port: 2222

  ansible_host: 10.0.1.11

  kuma_cp3.example.com:

  ansible_port: 2223

  ansible_host: 10.0.1.12

  kuma_control_plane_worker:

  kuma_worker:

  hosts:

  kuma-w1.example.com:

  ansible_host: 10.0.2.11

  extra_args: "--labels=kaspersky.com/kuma-core=true,kaspersky.com/kuma-ingress=true,node.longhorn.io/create-default-disk=true"

  kuma-w2.example.com:

  ansible_host: 10.0.2.12

  extra_args: "--labels=kaspersky.com/kuma-core=true,kaspersky.com/kuma-ingress=true,node.longhorn.io/create-default-disk=true"

  Пример файла инвентаря distributed.inventory.yml для отказоустойчивой установки с Ядром KUMA в кластере Raft с отдельным портом для каждого хоста с Ядром KUMA

  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: ""

  ansible_port: 2222

  kuma_core_peers:

  hosts:

  kuma-core-2.example.com:

  ip: 0.0.0.0

  ansible_port: 2223

  kuma-core-3.example.com:

  ip: 0.0.0.0

  ansible_port: 2224

  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: 1

  replica: 1

  keeper: 0

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

  ip: 0.0.0.0

  shard: 1

  replica: 2

  keeper: 0

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

  ip: 0.0.0.0

  shard: 2

  replica: 1

  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: 1

  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

ansible_user

Имя пользователя, от которого производится подключение к целевым машинам и установка компонентов.

Если пользователь root на целевых машинах заблокирован, вам нужно использовать имя пользователя, имеющего право на подключение по SSH и повышение привилегий через su или sudo.

ansible_become

Переменная, определяющая, требуется ли повышать привилегии пользователя, от имени которого осуществляется установка компонентов KUMA.

Возможные значения:

• true – вам нужно указать это значение, если для переменной ansible_user вы не указали значение root.
• false.

ansible_become_method

Способ повышения привилегий пользователя, от имени которого осуществляется установка компонентов KUMA.

Вам нужно указать значение su или sudo, если для переменной ansible_user вы не указали значение root.

ansible_ssh_private_key_file

Путь к закрытому ключу в формате /<путь>/.ssh/id_rsa. Вам нужно указать эту переменную, если вы хотите указать файл ключа, отличный от файла ключа по умолчанию ~/.ssh/id_rsa.

deploy_to_k8s

Переменная, определяющая, требуется ли разворачивать компоненты KUMA в кластере Kubernetes.

Возможные значения:

• false – это значение указано в шаблонах файла инвентаря single.inventory.yml и distributed.inventory.yml.
• true – это значение указано в шаблоне файла инвентаря k0s.inventory.yml.

Если вы не укажете эту переменную, по умолчанию будет использовано значение false.

need_transfer

Переменная, определяющая, требуется ли переносить Ядро KUMA в новый кластер Kubernetes.

Вам нужно указать эту переменную, только если для переменной deploy_to_k8s вы указали значение true.

Возможные значения:

• false – KUMA требуется установить или обновить в кластере Kubernetes.
• true – Ядро KUMA требуется перенести в новый кластер Kubernetes.

Если вы не укажете эту переменную, по умолчанию будет использовано значение false.

no_firewall_actions

Переменная, определяющая, выполняет ли установщик шаги по настройке межсетевого экрана на хостах.

Возможные значения:

• true – при запуске установщик не выполняет шаги по настройке межсетевого экрана на хостах.
• false – при запуске установщик выполняет шаги по настройке межсетевого экрана на хостах. Это значение указано во всех шаблонах файла инвентаря.

Если вы не укажете эту переменную, по умолчанию будет использовано значение false.

generate_etc_hosts

Переменная, определяющая, регистрируются ли машины в DNS-зоне вашей организации.

Установщик автоматически дополнит файлы /etc/hosts на машинах, на которые устанавливаются компоненты KUMA, IP-адресами машин из файла инвентаря. Указанные IP-адреса должны быть уникальными.

Возможные значения:

• false.
• true.

Если вы не укажете эту переменную, по умолчанию будет использовано значение false.

При использовании generate_etc_hosts: true в файле инвентаря для отказоустойчивой конфигурации нужно обязательно указать IP-адрес балансировщика в переменной ansible_host для хоста балансировщика в секции kuma_lb.

deploy_example_services

Переменная, определяющая, создаются ли предустановленные сервисы (коллектор, коррелятор, хранилище) при установке KUMA.

Вам нужно указать эту переменную, если вы хотите создать демо-сервисы независимо от файла инвентаря single/distributed/k0s.

Возможные значения:

• false – предустановленные сервисы не создаются при установке KUMA. Это значение указано во всех шаблонах файла инвентаря.
• true – предустановленные сервисы создаются при установке KUMA.

Если вы не укажете эту переменную, по умолчанию будет использовано значение false.

low_resources

Переменная, определяющая, устанавливается ли KUMA в окружениях с ограниченными вычислительными ресурсами.

Эта переменная отсутствует во всех шаблонах файла инвентаря.

Возможные значения:

• false – KUMA устанавливается для промышленной эксплуатации. В этом случае установщик проверяет требования рабочих узлов (процессор, ОЗУ и свободное дисковое пространство) в соответствии с аппаратными и программными требованиями. Если требования не выполняются, установка прерывается с сообщением об ошибке.
• true – KUMA устанавливается в окружениях с ограниченными вычислительными ресурсами. В этом случае минимальный объем директории для установки Ядра KUMA на хосте составляет 4 ГБ. Ограничения для других вычислительных ресурсов отсутствуют.

Если вы не укажете эту переменную, по умолчанию будет использовано значение false.

core_disk_request

Переменная, позволяющая определить размер тома Ядра KUMA для установки в кластере Kubernetes. Если значение переменной не задано, то для размера тома Ядра KUMA при установке будут принятые следующие значения по умолчанию:

• Если low_resources=false, размер тома по умолчанию – 100Gi.
• Если low_resources=true, размер тома по умолчанию – 4Gi.

Суффикс Gi обязателен для указания.

metrics_disk_request

Переменная, позволяющая определить размер тома сервиса Метрики для установки в кластере Kubernetes. Если значение переменной не задано, то для размера тома сервиса Метрики при установке будут приняты следующие значения по умолчанию:

• Если low_resources=false, размер тома по умолчанию – 80Gi.
• Если low_resources=true, размер тома по умолчанию – 4Gi.

Суффикс Gi обязателен для указания.

metrics_transfer_job_timeout

Переменная, позволяющая определить срок ожидания копирования метрик в минутах из тома Ядра KUMA 3.4 в новый том метрик в KUMA 4.0.

Значение по умолчанию – 120m.

Суффикс m обязателен для указания.

mtu

Переменная, позволяющая определить максимальный размер данных для передачи в одном пакете в сетевой среде без необходимости фрагментации в кластере Kubernetes.

Для решения проблемы с избыточным повторением передачи пакетов или полным пропаданием связи внутри шифрованного канала мы рекомендуем указать значение параметра mtu меньшее, чем минимальное значение mtu в существующем канале связи между рабочими узлами.

Если значение не задано, применяется автоматическое определение максимального размера данных на основании типов интерфейсов хостов.

backup_timeout

Переменная, позволяющая определить максимальное время в секундах, отведенное на создание резервной копии Ядра KUMA и отдельно на восстановление данных из резервной копии в кластере Kubernetes. Например, если вы указали значение 2700, это значит, что будет выделено 2700 секунд на создание резервной копии и 2700 секунд на восстановление из резервной копии.

Если параметр не указан в файле инвентаря в секции vars, при автоматическом создании резервной копии Ядра KUMA и автоматическом восстановлении данных из резервной копии, будет принято значение по умолчанию.

Значение по умолчанию – 1800 секунд.

Если автоматическое создание резервной копии завершилось раньше указанного значения, скрипт обновления продолжает дальнейшую работу сразу. Изменять значение параметра в большую сторону имеет смысл, если создание резервной копии Ядра KUMA вручную занимает около 30 минут или больше.

kuma_lb

FQDN балансировщика нагрузки. Вы можете установить балансировщик нагрузки nginx или сторонний TCP-балансировщик нагрузки.

Если вы устанавливаете балансировщик нагрузки nginx, вы можете указать параметр kuma_managed_lb = true, чтобы автоматически настроить балансировщик нагрузки nginx при установке KUMA, открыть на хосте балансировщика нагрузки nginx необходимые сетевые порты (6443, 8132, 9443, 7209, 7210, 7220, 7222, 7223, 7226), а также выполнить перезагрузку для применения изменений.

Если вы устанавливаете сторонний TCP-балансировщик нагрузки, вам нужно вручную настроить его до установки KUMA.

kuma_control_plane_master

Хост, выполняющий роль главного контроллера в кластере.

Группы для указания главного контроллера. Вам нужно указать хост только для одной группы.

kuma_control_plane_master_worker

Хост, совмещающий роль главного контроллера и рабочего узла в кластере. Для каждого контроллера кластера, совмещенного с рабочим узлом, в файле инвентаря должен быть указан параметр:

extra_args: "--labels=kaspersky.com/kuma-core=true,kaspersky.com/kuma-ingress=true,node.longhorn.io/create-default-disk=true"

kuma_control_plane

Хосты, выполняющие роль контроллера в кластере.

Группы для указания второстепенных контроллеров.

kuma_control_plane_worker 

Хосты, совмещающие роль контроллера и рабочего узла в кластере. Для каждого контроллера кластера, совмещенного с рабочим узлом, в файле инвентаря должен быть указан параметр:

extra_args: "--labels=kaspersky.com/kuma-core=true,kaspersky.com/kuma-ingress=true,node.longhorn.io/create-default-disk=true"

kuma_worker 

Рабочие узлы кластера. Для каждого рабочего узла в файле инвентаря должен быть указан параметр:

extra_args: "--labels=kaspersky.com/kuma-core=true,kaspersky.com/kuma-ingress=true,node.longhorn.io/create-default-disk=true"

kuma_metrics

Параметры сервиса Метрики. Вы можете указать только один хост, на котором установлено Ядро KUMA. При переносе Ядра KUMA из распределенной установки в кластер Kubernetes необходимо предварительно перенести сервис Метрики на один хост с Ядром KUMA с помощью установщика expand.sh и файла инвентаря expand.inventory.yml. При переносе Ядра KUMA в кластер Kubernetes выполняется проверка на наличие запущенного сервиса Метрики на этом хосте. Если сервис Метрики не найден, вернется ошибка и перенос будет прерван. При переносе Ядра KUMA в кластер Kubernetes данные метрик переносятся в кластер.

ipAutodetectionMethod

Если на рабочих узлах кластера одновременно используется несколько сетевых интерфейсов, переменная ipAutodetectionMethod позволяет вам задать маску названия сетевого интерфейса, который должен использоваться для взаимодействия между рабочими узлами кластера.

Например, если вы хотите использовать для связи между рабочими узлами кластера только сетевые интерфейсы с названием ethN (где N – это номер сетевого интерфейса), вы можете указать переменную следующим образом:

kuma_k0s:

vars:

ip_autodetection_method: "interface=eth.*"

В таком случае кластер будет использовать сетевой интерфейс с названием, совпадающим с маской eth.*.

Если название сетевого интерфейса на каждом рабочем узле одинаково, например, eth0, вы можете указать переменную без маски:

kuma_k0s:

vars:

ip_autodetection_method: "interface=eth0"

Подробнее см. в документации Calico Open Source.