Стадия жизненного цикла модуля: Экспериментальная версия

У модуля есть требования для установки

Перед включением модуля необходимо разрешить использование экспериментальных модулей в ModuleConfig deckhouse. Для этого установите параметр allowExperimentalModules в true.

Deckhouse Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.

HelmClusterAddonChart

Область: Cluster
Версия: v1alpha1

HelmClusterAddonChart представляет собой Helm-чарт, обнаруженный в HelmClusterAddonRepository. Эти ресурсы создаются автоматически во время синхронизации репозитория и защищены от изменений.
  • apiVersion
    строка
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    строка
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    объект
  • status
    объект
    • status.conditions
      массив объектов
      Условия отражают последние наблюдения за состоянием репозитория.
      • status.conditions.lastTransitionTime
        строка
        lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
      • status.conditions.message
        строка
        message is a human readable message indicating details about the transition. This may be an empty string.

        Максимальная длина: 32768

      • status.conditions.observedGeneration
        целое число
        observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

        Допустимые значения: 0 <= X

      • status.conditions.reason
        строка
        reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

        Длина: 1..1024

        Шаблон: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        строка
        status of the condition, one of True, False, Unknown.

        Допустимые значения: True, False, Unknown

      • status.conditions.type
        строка
        type of condition in CamelCase or in foo.example.com/CamelCase.

        Максимальная длина: 316

        Шаблон: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.iconURL
      строка
      URL-адрес иконки Helm-чарта. Применимо только для чартов из Helm-репозиториев.
    • status.observedGeneration
      целое число
      Поколение ресурса, обработанное контроллером последним.
    • status.versions
      массив объектов
      Список всех версий Helm-чарта, изученных контроллером. Версия пригодна к использованию, если у неё нет unavailableReason; для OCI-репозитория у пригодной версии также заполнен media type слоя, который её содержит.
      • status.versions.mediaType
        строка
        OCI media type слоя, содержащего эту версию чарта. Заполняется только для версии oci://-репозитория и только когда слой поддерживается: пустое значение там означает, что версию нельзя задеплоить. Для версии с ociRef остаётся пустым — слой такого артефакта проверяется в момент раскатки и здесь не записывается.
      • status.versions.ociRef
        строка
        OCI-ссылка, по которой опубликована эта версия, записанная из индекса репозитория. Заполняется только для версии helm-репозитория, чья запись в индексе указывает на OCI-репозиторий вместо архива чарта: такая версия раскатывается через внутренний OCIRepository, хотя её репозиторий — helm. Хост и путь сохраняются в написании индекса, тег всегда указан явно.
      • status.versions.unavailableMessage
        строка
        Человекочитаемые подробности к unavailableReason.
      • status.versions.unavailableReason
        строка
        Причина, по которой версию нельзя задеплоить. Отсутствие поля означает, что версия пригодна.

        Допустимые значения: RemovedFromRepository, UnsupportedMediaType, ResolvePending, InvalidChartReference

      • status.versions.version
        строка
        Версия Helm-чарта.

        Минимальная длина: 1

HelmClusterAddonRepository

Область: Cluster
Версия: v1alpha1

HelmClusterAddonRepository представляет собой Helm- или OCI-совместимый репозиторий, содержащий Helm-чарты, на которые могут ссылаться ресурсы HelmClusterAddon.
  • apiVersion
    строка
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    строка
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    объект
  • spec
    объект
    • spec.auth
      объект
      Учётные данные для аутентификации в репозитории.
      • spec.auth.password
        строка

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

        Пароль для аутентификации в репозитории.

        Минимальная длина: 1

      • spec.auth.username
        строка

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

        Имя пользователя для аутентификации в репозитории.

        Минимальная длина: 1

    • spec.caCertificate
      строка
      CA-сертификат в формате PEM для проверки TLS.
    • spec.insecureSkipVerify
      булевый
      Выключить проверку TLS-сертификата.
    • spec.url
      строка

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

      URL Helm-репозитория.

      Поддерживаются протоколы http(s):// и oci://.

  • status
    объект
    • status.conditions
      массив объектов

      Условия отражают последние наблюдения за состоянием репозитория.

      Ready сообщает, пригоден ли репозиторий: вспомогательные ресурсы на месте, внутренний объект источника исправен, и репозиторий ответил на чтение каталога на текущей спецификации. Транзиентная ошибка чтения не переводит Ready в False.

      Synced сообщает, актуален ли каталог чартов.

      Reconciling и Stalled следуют соглашению kstatus: они присутствуют, только когда применимы. Reconciling означает, что работа выполняется или запланирован повтор; Stalled — что репозиторий не восстановится без вмешательства. Пока выполняется синхронизация, Reconciling имеет причину Synchronization, либо ForceReconcile, если проход был запрошен аннотацией принудительной реконсиляции.

      • status.conditions.lastTransitionTime
        строка
        lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
      • status.conditions.message
        строка
        message is a human readable message indicating details about the transition. This may be an empty string.

        Максимальная длина: 32768

      • status.conditions.observedGeneration
        целое число
        observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

        Допустимые значения: 0 <= X

      • status.conditions.reason
        строка
        reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

        Длина: 1..1024

        Шаблон: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        строка
        status of the condition, one of True, False, Unknown.

        Допустимые значения: True, False, Unknown

      • status.conditions.type
        строка
        type of condition in CamelCase or in foo.example.com/CamelCase.

        Максимальная длина: 316

        Шаблон: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.consecutiveFetchFailures
      целое число
      Число подряд идущих неудачных обращений к репозиторию. Определяет задержку повтора и обнуляется при первом успехе.
    • status.lastForceReconcileTime
      строка
      Время обработки последнего запроса принудительной реконсиляции. Фиксирует, что запрос был обработан, а не что он завершился успешно — результат отражают Ready и Synced.
    • status.lastSuccessfulSyncTime
      строка
      Время последнего успешного приведения каталога чартов в актуальное состояние.
    • status.nextSyncTime
      строка
      Запланированное время следующей попытки синхронизации.
    • status.observedGeneration
      целое число
      Поколение ресурса, обработанное контроллером последним.

HelmClusterAddon

Область: Cluster
Версия: v1alpha1

HelmClusterAddon представляет собой единичный экземпляр установки Helm-чарта в масштабе всего кластера, который может включать в себя определения пользовательских ресурсов (CRD) и требует прав cluster-admin для развертывания. В каждый момент времени может быть установлен только один экземпляр конкретного чарта.
  • apiVersion
    строка
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    строка
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    объект
  • spec
    объект
    • spec.chart
      объект

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

      • spec.chart.helmClusterAddonChart
        строка

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

        Имя Helm-чарта для установки из указанного репозитория (например, «ingress-nginx» или «redis»).

        Минимальная длина: 1

      • spec.chart.helmClusterAddonRepository
        строка

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

        Имя ресурса HelmClusterAddonRepository, содержащего параметры подключения и учётные данные для доступа к репозиторию, в котором расположен чарт.

        Длина: 3..63

      • spec.chart.version
        строка

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

        Версия Helm-чарта для HelmClusterAddon.
    • spec.maintenance
      строка

      Стратегия согласования ресурса.

      При значении NoResourceReconciliation контроллер прекращает обновление управляемых ресурсов, что позволяет выполнять ручное вмешательство или обслуживание без перезаписи изменений оператором. При пустом значении ("") используется стандартное согласование.

      Допустимые значения: ‘’, NoResourceReconciliation

    • spec.namespace
      строка
      Пространство имён для развёртывания релиза аддона.

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

      Длина: 3..63

    • spec.values
      Пользовательские значения для релиза HelmClusterAddon.
  • status
    объект
    • status.conditions
      массив объектов

      Условия отражают последние наблюдения за состоянием ресурса.

      Reconciling присутствует, только когда применимо, следуя соглашению kstatus. Пока выполняется реконсиляция, запрошенная аннотацией принудительной реконсиляции, это условие имеет причину ForceReconcile.

      • status.conditions.lastTransitionTime
        строка
        lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
      • status.conditions.message
        строка
        message is a human readable message indicating details about the transition. This may be an empty string.

        Максимальная длина: 32768

      • status.conditions.observedGeneration
        целое число
        observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

        Допустимые значения: 0 <= X

      • status.conditions.reason
        строка
        reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

        Длина: 1..1024

        Шаблон: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        строка
        status of the condition, one of True, False, Unknown.

        Допустимые значения: True, False, Unknown

      • status.conditions.type
        строка
        type of condition in CamelCase or in foo.example.com/CamelCase.

        Максимальная длина: 316

        Шаблон: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.lastAppliedChart
      объект
      Последний применённый чарт, инициировавший установку или обновление аддона.
      • status.lastAppliedChart.helmClusterAddonChart
        строка
        Имя Helm-чарта.
      • status.lastAppliedChart.helmClusterAddonRepository
        строка
        Имя ресурса HelmClusterAddonRepository.
      • status.lastAppliedChart.version
        строка
        Версия Helm-чарта.
    • status.lastAppliedValues
      Последние применённые значения, инициировавшие установку или обновление аддона.
    • status.lastForceReconcileTime
      строка
      Время обработки последнего запроса принудительной реконсиляции. Фиксирует, что запрос был обработан, а не что он завершился успешно — результат отражает Ready.
    • status.observedGeneration
      целое число
      Поколение ресурса, обработанное контроллером последним.