Custom Resources

DeckhouseRelease

Scope: Cluster
Version: v1alpha1

Определяет конфигурацию релизов Deckhouse.

• approved

  булевый

  Разрешает или запрещает ручное обновление.

  Игнорируется, если в конфигурации модуля установлен режим обновления Auto (update.mode: Auto).

  По умолчанию: false

• spec

  объект

  Обязательный параметр

  • spec.applyAfter

    строка

    Время, до которого отложено обновление, если релиз является частью canary-release.

  • spec.changelog

    объект

    Изменения включенных модулей в данном релизе.

  • spec.changelogLink

    строка

    Ссылка на страницу со всеми изменениями данного релиза.

  • spec.disruptions

    массив строк

    Потенциально опасные изменения в релизе.

  • spec.requirements

    объект

    Требования для установки релиза.

  • spec.version

    строка

    Обязательный параметр

    Версия Deckhouse.

    Пример:

    version: v1.24.20
    

Module

Scope: Cluster
Version: v1alpha1

Репрезентация модуля

• properties

  объект
  • properties.availableSources

    массив строк

    Доступные источники скачивания модуля.

  • properties.description

    строка

    Описание модуля.

  • properties.releaseChannel

    строка

    Релизный канал модуля.

  • properties.requirements

    объект

    Зависимости модуля.

  • properties.source

    строка

    Источник из которого скачен модуль (иначе пусто).

  • properties.stage

    строка

    Текущая стадия жизненного цикла модуля.

    Допустимые значения: Sandbox, Incubating, Graduated, Deprecated

  • properties.updatePolicy

    строка

    Имя политики обновления модуля.

  • properties.version

    строка

    Версия модуля.

  • properties.weight

    целочисленный

    Вес (приоритет) модуля.

ModuleConfig

Scope: Cluster
Version: v1alpha1

Определяет конфигурацию модуля Deckhouse. Название ресурса ModuleConfig должно соответствовать названию модуля (например, control-plane-manager для модуля control-plane-manager).

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: module-1
spec:
  enabled: true
  settings: {}
  version: 1

• spec

  объект

  Обязательный параметр

  • spec.enabled

    булевый

    Включить или выключить модуль.

    Пример:

    enabled: 'false'
    

  • spec.settings

    объект

    Настройки модуля.

  • spec.source

    строка

    Источник из которого будет скачен модуль.

  • spec.updatePolicy

    строка

    Политика обновления модуля.

    Пример:

    updatePolicy: test-alpha
    

  • spec.version

    число

    Версия схемы настроек модуля.

    Пример:

    version: '1'
    

ModulePullOverride

Scope: Cluster
Version: v1alpha1

Определяет конфигурацию ресурса для скачивания конкретных версий модулей Deckhouse.

• spec

  объект

  Обязательный параметр

  • spec.imageTag

    строка

    Обязательный параметр

    Тег образа контейнера модуля, который будет скачан и установлен.

  • spec.scanInterval

    строка

    Интервал сканирования для проверки изменения образа контейнера. Если образ изменился, модуль будет обновлен.

    По умолчанию: "15s"

  • spec.source

    строка

    Обязательный параметр

    Ссылка на объект ModuleSource модуля.

ModuleRelease

Scope: Cluster
Version: v1alpha1

Определяет конфигурацию релизов модулей Deckhouse.

Ресурсы ModuleRelease создает Deckhouse.

• spec

  объект

  Обязательный параметр

  • spec.applyAfter

    строка

    Время, до которого отложено обновление.

  • spec.changelog

    объект

    Список изменений модуля в данном релизе.

  • spec.moduleName

    строка

    Обязательный параметр

    Название модуля.

  • spec.requirements

    объект

    Структура содержащая требования, необходимые для применения релиза.

  • spec.version

    строка

    Обязательный параметр

    Версия модуля в данном релизе.

    Пример:

    version: v1.0.0
    

  • spec.weight

    целочисленный

    Вес (приоритет) модуля.

ModuleSource

Scope: Cluster
Version: v1alpha1

Определяет конфигурацию источника модулей Deckhouse.

apiVersion: deckhouse.io/v1alpha1
kind: ModuleSource
metadata:
  name: example
spec:
  registry:
    repo: registry.example.io/modules-source
    dockerCfg: "<base64 encoded credentials>"

• spec

  объект

  Обязательный параметр

  • spec.registry

    объект

    Обязательный параметр

    • spec.registry.ca

      строка

      Корневой сертификат (В формате PEM), которым можно проверить сертификат registry при работе по HTTPS (если registry использует самоподписанные SSL-сертификаты).

      Создание ресурса ModuleSource с указанием корневого сертификата, приведет к перезапуску containerd на всех узлах кластера.

    • spec.registry.dockerCfg

      строка

      Строка с токеном доступа к container registry в Base64. В случае использования анонимного доступа к container registry не заполняйте это поле.

    • spec.registry.repo

      строка

      Обязательный параметр

      Адрес репозитория образов контейнеров.

      Пример:

      repo: registry.example.io/deckhouse/modules
      

    • spec.registry.scheme

      строка

      Протокол для доступа к репозиторию контейнеров.

      По умолчанию: "HTTPS"

      Допустимые значения: HTTP, HTTPS

  • spec.releaseChannel

    Параметр устарел

    строка

    Желаемый канал обновлений по умолчанию для модулей данного container registry.

ModuleUpdatePolicy

Scope: Cluster

apiVersion: deckhouse.io/v1alpha2
kind: ModuleUpdatePolicy
metadata:
  name: example-update-policy
spec:
  releaseChannel: Alpha
  update:
    mode: Auto
    windows:
    - days:
      - Mon
      - Wed
      from: '13:30'
      to: '14:00'

apiVersion: deckhouse.io/v1alpha1
kind: ModuleUpdatePolicy
metadata:
  name: example-update-policy
spec:
  moduleReleaseSelector:
    labelSelector:
      matchLabels:
        source: example
        module: module-1
  releaseChannel: Alpha
  update:
    mode: Auto
    windows:
    - days:
      - Mon
      - Wed
      from: '13:30'
      to: '14:00'