Установка

Системные требования

Чтобы начать пользоваться Deckhouse Commander, необходим кластер на базе Deckhouse Kubernetes Platform. Если у вас еще нет кластера, обратитесь к инструкции по установке.

Мы рекомендуем создать отказоустойчивый управляющий кластер, в котором будут следующие наборы узлов (NodeGroup):

Расчет узлов в группе commander основан на минимальных требованиях компонентов Deckhouse Commander:

• PostgreSQL в режиме HighAvailability в двух репликах требует 1 ядро и 1Гб памяти на 2 отдельных узлах (если используете operator-postgres)
• Сервер API в режиме HighAvailability в двух репликах требует 1 ядро и 1Гб памяти на 2 отдельных узлах
• Служебные компоненты для рендеринга конфигурации и подключения к прикладными кластерам, требуют 0.5 ядра и 128 Мб памяти на кластер
• Менеджер кластеров и сервер dhctl совместно требуют ресурсы в зависимости от количества обслуживаемых кластеров и одновременно обслуживаемых версий DKP
• До 2 ядер на узле могут быть заняты служебными компонентами DKP (например: runtime-audit-engine, istio, cilium, log-shipper), дополнительно учтен запас памяти.

Системные требования к группе узлов commander а так же к конфигурации самих узлов (ядра ЦП и объем оперативной памяти) варьируются в зависимости от количества кластеров, которые будут обслуживаться в Deckhouse Commander:

Подготовка СУБД

Deckhouse Commander работает с СУБД PostgreSQL. Для корректной работы Deckhouse Commander необходимы расширения plpgsql и pgcrypto.

Вариант 1: выделенная СУБД

Это рекомендуемый способ использования Deckhouse Commander в производственных средах. Для использования Deckhouse Commander необходимо подготовить параметры подключения к БД.

Вариант 2: модуль operator-postgres

Это не рекомендуемый способ для использования в производственных средах. Однако использование operator-postgres удобно для более быстрого знакомства с Deckhouse Commander или для сред, где нет высоких требований к доступности и поддержке.

Модуль Deckhouse Commander важно включить после того, как в кластере появились CRD из модуля operator-postgres.

Модуль operator-postgres использует оператор PostgreSQL. Вы можете использовать собственную инсталляцию postgres-operator версии не ниже v1.10.0.

Шаг 1: включение operator-postgres

Сначала нужно включить модуль оператора postgres и дождаться его включения

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: operator-postgres
spec:
  enabled: true

Шаг 2: завершение установки

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

kubectl -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller queue main

И проверьте наличие необходимых CRD в кластере:

kubectl get crd | grep postgresqls.acid.zalan.do

Включение Deckhouse Commander

Если используете свою инсталляцию СУБД PostgreSQL

Чтобы включить Deckhouse Commander, создайте ModuleConfig:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: commander
spec:
  enabled: true
  version: 1
  settings:
    postgres:
      mode: External
      external:
        host: "..."     # Обязательное поле
        port: "..."     # Обязательное поле
        user: "..."     # Обязательное поле
        password: "..." # Обязательное поле
        db: "..."       # Обязательное поле

Если используете модуль operator-postgres

Достаточно включить модуль commander, в режимом подключения к СУБД Internal. Deckhouse Commander самостоятельно настроит БД в операторе PostgreSQL.

Обратите внимание, для БД будет использоваться класс хранилища (StorageClass) по умолчанию. Для Deckhouse Commander класс хранилища можно задать явно:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: commander
spec:
  enabled: true
  version: 1
  settings:
    postgres:
      mode: Internal
      internal:
        storageClass: my-storage-class   # необязательное поле

Назначение временных администраторов для настройки прав доступа

Это может потребоваться в следующих ситуациях:

• Deckhouse Commander был запущен с включенной поддержкой прав доступа доступа до того, как кто-либо вошел в ее интерфейс, в результате в системе нет ни одного пользователя или группы с какими-либо разрешениями.
• В процессе настройки прав доступа права администратора были утеряны и должны быть восстановлены.

Создайте ConfigMap commander-admins в неймспейсе d8-commander, указав пользователей и группы, которым требуется временный административный доступ:

apiVersion: v1
kind: ConfigMap
metadata:
  name: commander-admins
  namespace: d8-commander
data:
  users: |
    john.doe@example.com
    jane.doe@example.com
  groups: |
    Enterprise Admins
    Administrators

Пользователи и участники групп получат максимальные права в интерфейсе Deckhouse Commander.

Внимание! После завершения настройки необходимых ролей и назначений, ConfigMap commander-admins необходимо удалить. После удаления временный доступ будет отозван, и в силу вступит только вручную выданные полномочия.