Глоссарий
Словарь для администратора.
Для кого эта страница
При работе с платформой встречаются термины Kubernetes, CAPI и специфичные для «Штурвала». На этой странице — краткие определения для быстрого ориентирования.
Установка и зеркало
| Термин | Определение |
|---|---|
| shtil | Утилита установки платформы «Штурвал». Запускает мастер установки в браузере или выполняет установку через консоль (YAML, флаги). |
| Машина shtil | Виртуальная или физическая машина, на которой запускается утилита первоначального развёртывания shtil. |
| stm (Shturval Mirror) | Утилита для работы с зеркалом образов и пакетов. Инициализация зеркала, загрузка бандла, обновление, удаление релизов. Входит в состав бандла. |
| stc | Утилита подготовки шаблонов виртуальных машин для провайдеров (vSphere, oVirt и др.). |
| Открытый контур | Сценарий установки и обновления, при котором кластер получает образы и пакеты из внешних репозиториев. Не требует локального зеркала. |
| Закрытый контур | Сценарий без доступа узлов к интернету. Требует локальное зеркало, бандл и Enterprise-лицензию. |
| Условно-закрытый контур | Вариант закрытого контура, при котором узлы кластера не имеют доступа к интернету, но хост зеркала может загружать бандлы из внешних источников. |
| Bootstrap-кластер | Временный установочный кластер, который shtil использует на этапе развёртывания постоянного кластера управления. |
| Бандл | tar-архив с образами и пакетами для конкретной версии платформы. Используется в закрытом контуре, где нет доступа к интернету. |
| Зеркало | Локальный репозиторий образов и пакетов (Nexus, Nginx). Узлы загружают дистрибутив с зеркала при установке в закрытом или условно-закрытом контуре. |
| Nexus | Система хранения артефактов (образы, пакеты). Встроена в stm или может использоваться внешний Nexus. |
| CE (Community Edition) | Community-лицензия платформы. Подходит для открытого контура. |
| Enterprise | Коммерческая редакция платформы. Требуется для закрытого контура, зеркала и DR. |
| Enterprise ML | Коммерческая редакция с возможностями для ML-сценариев. Наследует ограничения и возможности Enterprise, если в документации не указано иначе. |
| NTP (Network Time Protocol) | Протокол синхронизации времени. Синхронизация времени обязательна на всех узлах кластера. |
| SELinux | Подсистема безопасности Linux. На узлах должна быть отключена (disabled или permissive). |
| ShturvalUpdateChannel | Кастомный ресурс (API-группа update.shturval.tech). Определяет доступные версии для обновления. После обновления зеркала перезапуск ресурса ускоряет появление новой версии. |
| Step-CA | Инструмент для выпуска сертификатов (альтернатива ACME). Может использоваться для корпоративных сертификатов зеркала. |
| CRI (Container Runtime Interface) | Интерфейс Kubernetes к container runtime (containerd, cri-o). Используется при настройке узлов. |
| GPG (GnuPG) | Инструмент шифрования. Для apt-репозиториев зеркала требуется пара GPG-ключей для подписи пакетов. |
| Сервисная УЗ (учётная запись) | Учётные данные для подключения платформы к vCenter, oVirt, OpenStack, CSI. При смене пароля в инфраструктуре их нужно обновить в платформе. |
Кластеры и узлы
| Термин | Определение |
|---|---|
| Кластер управления (management cluster) | Кластер, на котором работает платформа «Штурвал». Управляет клиентскими кластерами, хранит провайдеры, права доступа, метрики. |
| Клиентский кластер (workload cluster) | Кластер Kubernetes, созданный платформой для размещения приложений. Подчиняется кластеру управления. |
| Stand-alone | Режим работы кластера управления, при котором он используется и для workloads — приложения размещаются в том же кластере, где платформа, без создания клиентских кластеров. Подходит для небольших сценариев. Отличается от обычного режима отсутствием отдельного workload-кластера. Подробнее: Режимы работы, требования открытого контура, требования закрытого контура. |
| Микрокластер | Минимальная конфигурация платформы на одном Control Plane узле (6 vCPU, 8 GiB RAM, 80 GiB диск). Подходит для тестирования, демонстраций, пилотных проектов. Установка занимает 30–60 минут. Подробнее: Быстрая установка микрокластера. |
| Control Plane (CP) | Узлы управления кластером Kubernetes. Запускают API-сервер, etcd, scheduler, controller-manager. Минимум 1, для отказоустойчивости — 3. |
| Worker | Узлы для размещения приложений (подов). На них работают kubelet, CNI, CSI. |
| Infra Worker | Специальная группа Worker-узлов для системных сервисов (мониторинг, логирование, Ingress). |
| Shturval v2 | Провайдер инфраструктуры для подготовленных bare metal или виртуальных хостов, подключаемых по SSH. Для него не используются шаблоны ВМ. |
| Гибридный кластер | Клиентский кластер, в котором основной провайдер создаёт базовые узлы, а дополнительные Worker-группы подключаются через Shturval v2, например, для физических узлов с GPU. |
| Внешний etcd | Конфигурация клиентского кластера, при которой хранилище etcd размещается отдельно от Control Plane узлов. Используется в специальных сценариях отказоустойчивости. |
Сеть и адреса
| Термин | Определение |
|---|---|
| VIP (Virtual IP) | Виртуальный IP-адрес для доступа к KubeAPI или Ingress. Не назначается постоянно одному узлу и при отказе переключается на другой узел. В платформе управляется компонентами shturval-vip и shturval-vip-provider на базе Kube-VIP. |
| FQDN (Fully Qualified Domain Name) | Полное доменное имя. Например, shturval.clustername.ip-10-11-12-13.shturval.link — FQDN веб-интерфейса при использовании VIP. |
| KubeAPI | Точка доступа к API-серверу Kubernetes. При создании кластера задаётся как VIP или FQDN и обычно доступна по TCP-порту 6443. |
| Ingress | Точка входа для HTTP/HTTPS-трафика к приложениям в кластере. Может использовать VIP, FQDN или внешний балансировщик. |
| Пул IP-адресов | Диапазон адресов, из которых платформа назначает VIP для KubeAPI и Ingress при создании кластера. Используется не для всех провайдеров инфраструктуры. |
| Внешний балансировщик | Балансировщик нагрузки вне кластера, через который можно организовать доступ к KubeAPI или Ingress вместо внутренних VIP. Для ряда провайдеров является обязательным. |
| CNI (Container Network Interface) | Интерфейс Kubernetes для подключения сетевых плагинов. В платформе сетевой подсистемой управляет сервис shturval-networking. |
| Cilium | CNI-плагин, используемый платформой для сетевой связности кластеров и сетевых политик. |
CoreHA (shturval-coreha) | Компонент для работы с динамическими бэкендами HAProxy через DNS. Используется в сценариях с внешним балансировщиком. |
Провайдеры и инфраструктура
| Термин | Определение |
|---|---|
| Провайдер инфраструктуры | Виртуализация, облако или физические хосты, где платформа создаёт или подключает узлы клиентских кластеров: VMware vSphere, oVirt, OpenStack, Shturval v2, Yandex Cloud, vCloud Director, Basis Dynamix и др. |
| Инфраструктурный провайдер CAPI | Компонент в кластере управления, реализующий контракт Cluster API для конкретной инфраструктуры, например, shturval-capvs для vSphere или shturval-capov для oVirt. |
| Экземпляр провайдера | Настроенное подключение к конкретной среде (один vCenter, один oVirt Engine и т.д.). К одному типу провайдера может быть несколько экземпляров. |
| Шаблон ВМ | Образ виртуальной машины с подготовленной ОС. Платформа клонирует его при создании узлов кластера. Готовится утилитой stc. |
| CAPI (Cluster API) | Стандарт Kubernetes для декларативного управления жизненным циклом кластеров и узлов. В платформе CAPI-ресурсы согласуются в кластере управления. |
| CAPVS | Инфраструктурный CAPI-провайдер платформы для VMware vSphere (shturval-capvs). |
| CAPOV | Инфраструктурный CAPI-провайдер платформы для oVirt и совместимых сред (shturval-capov). |
| CAPOS | Инфраструктурный CAPI-провайдер платформы для OpenStack и совместимых облаков (shturval-capos). |
| CAPY | Инфраструктурный CAPI-провайдер платформы для Yandex Cloud (shturval-capy). |
| CAPBD | Инфраструктурный CAPI-провайдер платформы для Basis Dynamix (shturval-capbd). |
| CAPVCD | Инфраструктурный CAPI-провайдер платформы для VMware vCloud Director (shturval-capvcd). |
| CAPSM | Инфраструктурный CAPI-провайдер платформы для Shturval v2 (shturval-capsm). |
| CSI (Container Storage Interface) | Интерфейс Kubernetes для подключения хранилищ. В платформе используется для интеграции хранилищ провайдеров и локального CSI-хранилища. |
| MachineDeployment | Ресурс Cluster API, описывающий группу Worker-узлов и управляющий их созданием, масштабированием и обновлением. |
| MachineHealthCheck | Ресурс Cluster API для проверки состояния машин и автоматического восстановления недоступных узлов. |
Конфигурация и сервисы
| Термин | Определение |
|---|---|
| ShturvalServiceConfig (SSC) | Описание сервиса платформы (чарт, параметры). Аналог «шаблона» сервиса. |
| ShturvalServicePatch (SSP) | Патч к сервису — переопределение параметров через customvalues. Позволяет кастомизировать сервис без изменения базового ShturvalServiceConfig (SSC). |
| ClusterProfile | Профиль кластера — набор настроек (сервисы, NCI, сетевые политики), применяемых при создании кластера. |
| NodeConfigItem (NCI) | Конфигурация, применяемая к узлам кластера (например, настройки sysctl, модули ядра). |
| ClusterConfig | Кастомный ресурс конфигурации кластера управления. Хранит параметры вроде FQDN, реестра и сетевых endpoints. |
| customvalues | Набор значений Helm-чарта, которые задаются через ShturvalServicePatch для изменения параметров сервиса платформы. |
Обновление платформы
| Термин | Определение |
|---|---|
| Shturval Updater | Модуль обновления (shturval-update), который управляет версиями платформы и Kubernetes, а также обновляет системные компоненты кластера. |
| ShturvalUpdate | Кастомный ресурс задачи обновления. Задаёт целевую версию и отображает статус процесса. |
| ShturvalUpdateSchedule | Кастомный ресурс отложенного обновления по расписанию. Описывает расписание и окно, в которое обновление может быть выполнено. |
Доступ и безопасность
| Термин | Определение |
|---|---|
| LDAP (Lightweight Directory Access Protocol) | Протокол доступа к корпоративному каталогу пользователей и групп. Используется для аутентификации и поиска пользователей. |
| OIDC (OpenID Connect) | Протокол федеративной аутентификации через внешний Identity Provider, например, Keycloak или Blitz. |
| IdP (Identity Provider) | Внешний провайдер идентификации, который подтверждает личность пользователя и передаёт платформе данные для входа. |
| Набор доступов (Permission) | Набор прав (платформенных, кластерных, роль в ArgoCD и др.), назначаемый пользователю или группе. В API представлен ресурсом Permission из группы permissions.shturval.tech. |
| Платформенные разрешения | Права на объекты платформы (создание кластеров, управление провайдерами, назначение прав и др.). |
| Кластерные разрешения | RBAC-права в Kubernetes (API-группы, ресурсы, verbs). |
| Scope | Системный ресурс, который определяет область применения набора доступов: платформа, кластер, тенант или неймспейс. |
| UserRole | Ресурс назначения прав конкретному пользователю. Ссылается на один или несколько наборов доступов и целевую область. |
| GroupRole | Ресурс назначения прав группе пользователей. Все участники группы получают права, заданные через GroupRole. |
| Tenant | Объект группировки кластеров или неймспейсов для назначения прав и управления доступом. |
Резервное копирование и DR
| Термин | Определение |
|---|---|
| Velero | Инструмент резервного копирования и восстановления Kubernetes-кластеров. Используется в платформе для бэкапов. |
| DR (Disaster Recovery) | Катастрофоустойчивость — конфигурация с резервным кластером управления для переключения при отказе основного. Доступна в Enterprise и Enterprise ML. |
Мониторинг и логирование
| Термин | Определение |
|---|---|
| Victoria Metrics | Система хранения и запроса метрик (аналог Prometheus). Используется для метрик кластеров. |
| VictoriaLogs (VLogs) | Система хранения логов. Логи собираются Vector и запрашиваются через VictoriaLogs. |
| Vector | Агент сбора и маршрутизации логов, используемый сервисом shturval-log-collector. |
| ClusterVectorPipeline | Кастомный ресурс для настройки пайплайна сбора и маршрутизации логов в кластере. |
| Grafana | Инструмент визуализации метрик. Дашборды по умолчанию поставляются с платформой. |
Глоссарии других разделов
| Раздел | Описание |
|---|---|
| Глоссарий администратора кластера | Термины по управлению кластером, хранилищу, узлам, мониторингу |
| Глоссарий разработчика | Термины по доставке приложений, GitOps, ArgoCD |
| Глоссарий по безопасности | Термины по политикам, сканированию, аудиту |