Deckhouse Kubernetes Platform на VMware Cloud Director

Введите лицензионный ключ

Ввести

Ниже сгенерированы рекомендованные настройки для установки Deckhouse Kubernetes Platform Enterprise Edition:

  • config.yml — файл первичной конфигурации кластера. Содержит параметры инсталлятора, параметры доступа облачного провайдера и начальные параметры кластера.
  • resources.yml — описание ресурсов для создания после установки (настройки узлов и Ingress-контроллера).

Обратите внимание:

  • Так выделены параметры, обязательные для самостоятельного заполнения.
  • Так выделены параметры, которые вы возможно захотите изменить.
  • Если вы запускаете инсталлятор под Windows, то убедитесь, что кодировка создаваемых YAML-файлов конфигурации UTF-8 (либо удалите примечания на русском языке).

Создайте файл config.yml.

# Общие параметры кластера.
# https://deckhouse.ru/documentation/v1/installing/configuration.html#clusterconfiguration
apiVersion: deckhouse.io/v1
kind: ClusterConfiguration
clusterType: Cloud
cloud:
  provider: VCD
  # Префикс объектов, создаваемых в облаке при установке.
  # Возможно, захотите изменить.
  prefix: cloud-demo
# Адресное пространство Pod’ов кластера.
podSubnetCIDR: 10.111.0.0/16
# Адресное пространство для service’ов кластера.
serviceSubnetCIDR: 10.222.0.0/16
kubernetesVersion: "Automatic"
clusterDomain: "cluster.local"
---
# Настройки первичной инициализации кластера Deckhouse.
# https://deckhouse.ru/documentation/v1/installing/configuration.html#initconfiguration
apiVersion: deckhouse.io/v1
kind: InitConfiguration
deckhouse:
  imagesRepo: registry.deckhouse.ru/deckhouse/ee
  # Строка с ключом для доступа к Docker registry (сгенерировано автоматически для вашего токена доступа).
  registryDockerCfg: <YOUR_ACCESS_STRING_IS_HERE>
---
# Настройки модуля deckhouse.
# https://deckhouse.ru/documentation/v1/modules/002-deckhouse/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: deckhouse
spec:
  version: 1
  enabled: true
  settings:
    bundle: Default
    releaseChannel: Stable
    logLevel: Info
---
# Глобальные настройки Deckhouse.
# https://deckhouse.ru/documentation/v1/deckhouse-configure-global.html#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: global
spec:
  version: 1
  settings:
    modules:
      # Шаблон, который будет использоваться для составления адресов системных приложений в кластере.
      # Например, Grafana для %s.example.com будет доступна на домене 'grafana.example.com'.
      # Домен НЕ ДОЛЖЕН совпадать с указанным в параметре clusterDomain ресурса ClusterConfiguration.
      # Можете изменить на свой сразу, либо следовать шагам руководства и сменить его после установки.
      publicDomainTemplate: "%s.example.com"
---
# Настройки модуля user-authn.
# https://deckhouse.ru/documentation/v1/modules/150-user-authn/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: user-authn
spec:
  version: 1
  enabled: true
  settings:
    controlPlaneConfigurator:
      dexCAMode: DoNotNeed
    # Включение доступа к API-серверу Kubernetes через Ingress.
    # https://deckhouse.ru/documentation/v1/modules/150-user-authn/configuration.html#parameters-publishapi
    publishAPI:
      enable: true
      https:
        mode: Global
        global:
          kubeconfigGeneratorMasterCA: ""
---
# Настройки модуля cni-cilium.
# https://deckhouse.ru/documentation/v1/modules/021-cni-cilium/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: cni-cilium
spec:
  enabled: true
---
# Настройки модуля metallb.
# https://deckhouse.ru/documentation/v1/modules/380-metallb/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: metallb
spec:
  version: 1
  enabled: true
  settings:
      # Настройки metaillb-пула для входящего трафика.
      # https://deckhouse.ru/documentation/v1/modules/380-metallb/configuration.html#parameters-addresspools
    addressPools:
    - addresses:
      - *!CHANGE_SUBNET_METALLB_POOL*.10/32
      name: frontend-pool
      protocol: layer2
    # Размещение спикера на frontend-узлах.
    # https://deckhouse.ru/documentation/v1/modules/380-metallb/configuration.html#parameters-speaker
    speaker:
      nodeSelector:
        node-role.deckhouse.io/frontend: ""
      tolerations:
      - effect: NoExecute
        key: dedicated.deckhouse.io
        operator: Equal
        value: frontend
---
# Настройки облачного провайдера.
# https://deckhouse.io/documentation/v1/modules/030-cloud-provider-vsphere/cluster_configuration.html
apiVersion: deckhouse.io/v1
internalNetworkCIDR: 10.15.11.0/24
kind: VCDClusterConfiguration
layout: Standard
masterNodeGroup:
  instanceClass:
    etcdDiskSizeGb: 10
    # Список IP-адресов для control-plane нод.
    # Рекомендуем использовать .2, .3 .4 адреса, например: 10.15.11.2.
    mainNetworkIPAddresses:
    - !CHANGE_SUBNET*.2
    rootDiskSizeGb: 40
    sizingPolicy: *!CHANGE_SIZING_POLICY*
    storageProfile: *!CHANGE_STORAGE_PROFILE*
    # Имя образа, созданного с учетом каталога размещения образа в vCloudDirector.
    # Пример: "catatlog/ubuntu-jammy-22.04".
    template: *!CHANGE_TEMPLATE_NAME*
  replicas: 1
nodeGroups:
- instanceClass:
    mainNetworkIPAddresses:
    - !CHANGE_SUBNET*.11
    rootDiskSizeGb: 40
    sizingPolicy: *!CHANGE_SIZING_POLICY*
    storageProfile: *!CHANGE_STORAGE_PROFILE*
    # Имя образа, созданного с учетом каталога размещения образа в vCloudDirector.
    # Пример: "catatlog/ubuntu-jammy-22.04".
    template: *!CHANGE_TEMPLATE_NAME*
  name: frontend
  replicas: 1
  nodeTemplate:
    labels:
      node-role.deckhouse.io/frontend: ""
    taints:
    - effect: NoExecute
      key: dedicated.deckhouse.io
      value: frontend
# параметры доступа к API vCloud Director
provider:
  server: *!CHANGE_SERVER*
  username: *!CHANGE_USERNAME*
  password: *!CHANGE_PASSWORD*
  # Укажите true, если vCloud Directorиспользует самоподписанный сертификат,
  # иначе укажите false (или удалите строку с параметром insecure).
  insecure: *!CHANGE_INSECURE*
organization: *!CHANGE_ORG*
virtualApplicationName: *!CHANGE_VAPP*
virtualDataCenter: *!CHANGE__DC*
# Internal network name.
mainNetwork: *!CHANGE_MAIN_NETWORK*
# Публичная часть SSH-ключа для доступа к узлам облака.
# Этот ключ будет добавлен пользователю на созданных узлах (имя пользователя зависит от используемого образа).
sshPublicKey: *!CHANGE_SSH_KEY*
# Общие параметры кластера. # https://deckhouse.ru/documentation/v1/installing/configuration.html#clusterconfiguration apiVersion: deckhouse.io/v1 kind: ClusterConfiguration clusterType: Cloud cloud: provider: VCD # Префикс объектов, создаваемых в облаке при установке. # Возможно, захотите изменить. prefix: cloud-demo # Адресное пространство Pod’ов кластера. podSubnetCIDR: 10.111.0.0/16 # Адресное пространство для service’ов кластера. serviceSubnetCIDR: 10.222.0.0/16 kubernetesVersion: "Automatic" clusterDomain: "cluster.local" --- # Настройки первичной инициализации кластера Deckhouse. # https://deckhouse.ru/documentation/v1/installing/configuration.html#initconfiguration apiVersion: deckhouse.io/v1 kind: InitConfiguration deckhouse: imagesRepo: registry.deckhouse.ru/deckhouse/ee # Строка с ключом для доступа к Docker registry (сгенерировано автоматически для вашего токена доступа). registryDockerCfg: <YOUR_ACCESS_STRING_IS_HERE> --- # Настройки модуля deckhouse. # https://deckhouse.ru/documentation/v1/modules/002-deckhouse/configuration.html apiVersion: deckhouse.io/v1alpha1 kind: ModuleConfig metadata: name: deckhouse spec: version: 1 enabled: true settings: bundle: Default releaseChannel: Stable logLevel: Info --- # Глобальные настройки Deckhouse. # https://deckhouse.ru/documentation/v1/deckhouse-configure-global.html#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B apiVersion: deckhouse.io/v1alpha1 kind: ModuleConfig metadata: name: global spec: version: 1 settings: modules: # Шаблон, который будет использоваться для составления адресов системных приложений в кластере. # Например, Grafana для %s.example.com будет доступна на домене 'grafana.example.com'. # Домен НЕ ДОЛЖЕН совпадать с указанным в параметре clusterDomain ресурса ClusterConfiguration. # Можете изменить на свой сразу, либо следовать шагам руководства и сменить его после установки. publicDomainTemplate: "%s.example.com" --- # Настройки модуля user-authn. # https://deckhouse.ru/documentation/v1/modules/150-user-authn/configuration.html apiVersion: deckhouse.io/v1alpha1 kind: ModuleConfig metadata: name: user-authn spec: version: 1 enabled: true settings: controlPlaneConfigurator: dexCAMode: DoNotNeed # Включение доступа к API-серверу Kubernetes через Ingress. # https://deckhouse.ru/documentation/v1/modules/150-user-authn/configuration.html#parameters-publishapi publishAPI: enable: true https: mode: Global global: kubeconfigGeneratorMasterCA: "" --- # Настройки модуля cni-cilium. # https://deckhouse.ru/documentation/v1/modules/021-cni-cilium/configuration.html apiVersion: deckhouse.io/v1alpha1 kind: ModuleConfig metadata: name: cni-cilium spec: enabled: true --- # Настройки модуля metallb. # https://deckhouse.ru/documentation/v1/modules/380-metallb/configuration.html apiVersion: deckhouse.io/v1alpha1 kind: ModuleConfig metadata: name: metallb spec: version: 1 enabled: true settings: # Настройки metaillb-пула для входящего трафика. # https://deckhouse.ru/documentation/v1/modules/380-metallb/configuration.html#parameters-addresspools addressPools: - addresses: - *!CHANGE_SUBNET_METALLB_POOL*.10/32 name: frontend-pool protocol: layer2 # Размещение спикера на frontend-узлах. # https://deckhouse.ru/documentation/v1/modules/380-metallb/configuration.html#parameters-speaker speaker: nodeSelector: node-role.deckhouse.io/frontend: "" tolerations: - effect: NoExecute key: dedicated.deckhouse.io operator: Equal value: frontend --- # Настройки облачного провайдера. # https://deckhouse.io/documentation/v1/modules/030-cloud-provider-vsphere/cluster_configuration.html apiVersion: deckhouse.io/v1 internalNetworkCIDR: 10.15.11.0/24 kind: VCDClusterConfiguration layout: Standard masterNodeGroup: instanceClass: etcdDiskSizeGb: 10 # Список IP-адресов для control-plane нод. # Рекомендуем использовать .2, .3 .4 адреса, например: 10.15.11.2. mainNetworkIPAddresses: - !CHANGE_SUBNET*.2 rootDiskSizeGb: 40 sizingPolicy: *!CHANGE_SIZING_POLICY* storageProfile: *!CHANGE_STORAGE_PROFILE* # Имя образа, созданного с учетом каталога размещения образа в vCloudDirector. # Пример: "catatlog/ubuntu-jammy-22.04". template: *!CHANGE_TEMPLATE_NAME* replicas: 1 nodeGroups: - instanceClass: mainNetworkIPAddresses: - !CHANGE_SUBNET*.11 rootDiskSizeGb: 40 sizingPolicy: *!CHANGE_SIZING_POLICY* storageProfile: *!CHANGE_STORAGE_PROFILE* # Имя образа, созданного с учетом каталога размещения образа в vCloudDirector. # Пример: "catatlog/ubuntu-jammy-22.04". template: *!CHANGE_TEMPLATE_NAME* name: frontend replicas: 1 nodeTemplate: labels: node-role.deckhouse.io/frontend: "" taints: - effect: NoExecute key: dedicated.deckhouse.io value: frontend # параметры доступа к API vCloud Director provider: server: *!CHANGE_SERVER* username: *!CHANGE_USERNAME* password: *!CHANGE_PASSWORD* # Укажите true, если vCloud Directorиспользует самоподписанный сертификат, # иначе укажите false (или удалите строку с параметром insecure). insecure: *!CHANGE_INSECURE* organization: *!CHANGE_ORG* virtualApplicationName: *!CHANGE_VAPP* virtualDataCenter: *!CHANGE__DC* # Internal network name. mainNetwork: *!CHANGE_MAIN_NETWORK* # Публичная часть SSH-ключа для доступа к узлам облака. # Этот ключ будет добавлен пользователю на созданных узлах (имя пользователя зависит от используемого образа). sshPublicKey: *!CHANGE_SSH_KEY*

Создайте файл resources.yml.

# Секция, описывающая параметры инстанс-класса для узлов c компонентами, обеспечивающими рабочую нагрузку.
# https://deckhouse.ru/documentation/v1/modules/030-cloud-provider-vcd/cr.html
apiVersion: deckhouse.io/v1
kind: VCDInstanceClass
metadata:
  name: worker
spec:
  rootDiskSizeGb: 50
  sizingPolicy: *!CHANGE_SIZING_POLICY*
  storageProfile: *!CHANGE_STORAGE_PROFILE*
  # Имя образа, созданного с без учета каталога размещения образа в vCloudDirector.
  # Пример: "ubuntu-jammy-22.04".
  template: *!CHANGE_TEMPLATE_NAME*
---
# Секция, описывающая параметры группы узлов c компонентами, обеспечивающими рабочую нагрузку.
# https://deckhouse.ru/documentation/v1/modules/040-node-manager/cr.html#nodegroup
apiVersion: deckhouse.io/v1
kind: NodeGroup
metadata:
  name: worker
spec:
  cloudInstances:
    classReference:
      kind: VCDInstanceClass
      name: worker
    maxPerZone: 2
    maxSurgePerZone: 0
    maxUnavailablePerZone: 0
    minPerZone: 1
  nodeType: CloudEphemeral
---
# Секция, описывающая параметры NGINX Ingress controller.
# https://deckhouse.ru/documentation/v1/modules/402-ingress-nginx/cr.html
apiVersion: deckhouse.io/v1
kind: IngressNginxController
metadata:
  name: nginx
spec:
  ingressClass: nginx
  # Способ поступления трафика из внешнего мира.
  inlet: HostPort
  hostPort:
    httpPort: 80
    httpsPort: 443
    realIPHeader: X-Forwarded-For
  nodeSelector:
    node-role.kubernetes.io/control-plane: ""
  tolerations:
  - operator: Exists
---
# Настройки RBAC и авторизации.
# https://deckhouse.ru/documentation/v1/modules/140-user-authz/cr.html#clusterauthorizationrule
apiVersion: deckhouse.io/v1
kind: ClusterAuthorizationRule
metadata:
  name: admin
spec:
  subjects:
  - kind: User
    name: admin@deckhouse.io
  accessLevel: SuperAdmin
  portForwarding: true
---
# Данные статического пользователя.
# https://deckhouse.ru/documentation/v1/modules/150-user-authn/cr.html#user
apiVersion: deckhouse.io/v1
kind: User
metadata:
  name: admin
spec:
  # E-mail пользователя.
  email: admin@deckhouse.io
  # Это хэш пароля <GENERATED_PASSWORD>, сгенерированного при загрузке страницы "Быстрого Старта".
  # Сгенерируйте свой или используйте этот, но только для тестирования
  # echo "<GENERATED_PASSWORD>" | htpasswd -BinC 10 "" | cut -d: -f2 | base64 -w0
  # Возможно, захотите изменить.
  password: <GENERATED_PASSWORD_HASH>
# Секция, описывающая параметры инстанс-класса для узлов c компонентами, обеспечивающими рабочую нагрузку. # https://deckhouse.ru/documentation/v1/modules/030-cloud-provider-vcd/cr.html apiVersion: deckhouse.io/v1 kind: VCDInstanceClass metadata: name: worker spec: rootDiskSizeGb: 50 sizingPolicy: *!CHANGE_SIZING_POLICY* storageProfile: *!CHANGE_STORAGE_PROFILE* # Имя образа, созданного с без учета каталога размещения образа в vCloudDirector. # Пример: "ubuntu-jammy-22.04". template: *!CHANGE_TEMPLATE_NAME* --- # Секция, описывающая параметры группы узлов c компонентами, обеспечивающими рабочую нагрузку. # https://deckhouse.ru/documentation/v1/modules/040-node-manager/cr.html#nodegroup apiVersion: deckhouse.io/v1 kind: NodeGroup metadata: name: worker spec: cloudInstances: classReference: kind: VCDInstanceClass name: worker maxPerZone: 2 maxSurgePerZone: 0 maxUnavailablePerZone: 0 minPerZone: 1 nodeType: CloudEphemeral --- # Секция, описывающая параметры NGINX Ingress controller. # https://deckhouse.ru/documentation/v1/modules/402-ingress-nginx/cr.html apiVersion: deckhouse.io/v1 kind: IngressNginxController metadata: name: nginx spec: ingressClass: nginx # Способ поступления трафика из внешнего мира. inlet: HostPort hostPort: httpPort: 80 httpsPort: 443 realIPHeader: X-Forwarded-For nodeSelector: node-role.kubernetes.io/control-plane: "" tolerations: - operator: Exists --- # Настройки RBAC и авторизации. # https://deckhouse.ru/documentation/v1/modules/140-user-authz/cr.html#clusterauthorizationrule apiVersion: deckhouse.io/v1 kind: ClusterAuthorizationRule metadata: name: admin spec: subjects: - kind: User name: admin@deckhouse.io accessLevel: SuperAdmin portForwarding: true --- # Данные статического пользователя. # https://deckhouse.ru/documentation/v1/modules/150-user-authn/cr.html#user apiVersion: deckhouse.io/v1 kind: User metadata: name: admin spec: # E-mail пользователя. email: admin@deckhouse.io # Это хэш пароля <GENERATED_PASSWORD>, сгенерированного при загрузке страницы "Быстрого Старта". # Сгенерируйте свой или используйте этот, но только для тестирования # echo "<GENERATED_PASSWORD>" | htpasswd -BinC 10 "" | cut -d: -f2 | base64 -w0 # Возможно, захотите изменить. password: <GENERATED_PASSWORD_HASH>

Для установки Deckhouse Kubernetes Platform используется Docker-образ, в который необходимо передать конфигурационные файлы и SSH-ключи доступа на master-узел (далее подразумевается что используется SSH-ключ ~/.ssh/id_rsa).

Запустите установщик на персональном компьютере.

Linux / macOS Windows

 echo <LICENSE_TOKEN> | docker login -u license-token --password-stdin registry.deckhouse.ru
docker run --pull=always -it -v "$PWD/config.yml:/config.yml" -v "$HOME/.ssh/:/tmp/.ssh/" \
  -v "$PWD/resources.yml:/resources.yml" -v "$PWD/dhctl-tmp:/tmp/dhctl" registry.deckhouse.ru/deckhouse/ee/install:stable bash
echo <LICENSE_TOKEN> | docker login -u license-token --password-stdin registry.deckhouse.ru docker run --pull=always -it -v "$PWD/config.yml:/config.yml" -v "$HOME/.ssh/:/tmp/.ssh/" \ -v "$PWD/resources.yml:/resources.yml" -v "$PWD/dhctl-tmp:/tmp/dhctl" registry.deckhouse.ru/deckhouse/ee/install:stable bash

Авторизуйтесь на персональном компьютере в container image registry, введя лицензионный ключ на запрос пароля:

docker login -u license-token registry.deckhouse.ru
docker login -u license-token registry.deckhouse.ru

Запустите контейнер с установщиком:

docker run --pull=always -it -v "%cd%\config.yml:/config.yml" -v "%userprofile%\.ssh\:/tmp/.ssh/" -v "%cd%\resources.yml:/resources.yml" -v "%cd%\dhctl-tmp:/tmp/dhctl"  registry.deckhouse.ru/deckhouse/ee/install:stable bash -c "chmod 400 /tmp/.ssh/id_rsa; bash"
docker run --pull=always -it -v "%cd%\config.yml:/config.yml" -v "%userprofile%\.ssh\:/tmp/.ssh/" -v "%cd%\resources.yml:/resources.yml" -v "%cd%\dhctl-tmp:/tmp/dhctl" registry.deckhouse.ru/deckhouse/ee/install:stable bash -c "chmod 400 /tmp/.ssh/id_rsa; bash"

Внутри контейнера выполните команду:

dhctl bootstrap --ssh-user=ubuntu --ssh-agent-private-keys=/tmp/.ssh/id_rsa --config=/config.yml --resources=/resources.yml
dhctl bootstrap --ssh-user=ubuntu --ssh-agent-private-keys=/tmp/.ssh/id_rsa --config=/config.yml --resources=/resources.yml

В параметре --ssh-user укажите имя пользователя по умолчанию для выбранного образа виртуальной машины. Для предложенного в руководстве образа это ubuntu.

Если установка была прервана...

Если установка была прервана (не хватило квот, ошибки сети и т.п.), вы можете ее перезапустить. Установка корректно продолжится, никакие дублирующие ресурсы в облаке созданы не будут.

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

dhctl bootstrap-phase abort --ssh-user=ubuntu --ssh-agent-private-keys=/tmp/.ssh/id_rsa --config=/config.yml

Процесс установки может занять от 5 до 30 минут, в зависимости от качества соединения.

По окончании установки инсталлятор выведет IP-адрес master-узла (он вам потребуется далее). Пример вывода:

...
┌ 🎈 ~ Common: Kubernetes Master Node addresses for SSH
│ cloud-demo-master-0 | ssh ubuntu@1.2.3.4
└ 🎈 ~ Common: Kubernetes Master Node addresses for SSH (0.00 seconds)

Почти все готово для полноценной работы Deckhouse Kubernetes Platform!