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

ClusterProjectRoleBinding

Short names: cprb

Scope: Cluster
Version: v1alpha3

ClusterProjectRoleBinding выдаёт роль субъектам во всех неймспейсах всех проектов кластера, кроме виртуальных проектов deckhouse и default.

  • spec
    объект

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

    • spec.roleRef
      объект

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

      Ссылка на выдаваемую ClusterRole.

      Допустимые префиксы: d8:project:*, d8:namespace:*, d8:project-capability:*, d8:namespace-capability:*, d8:custom:*.

      • spec.roleRef.kind
        строка

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

        Тип выдаваемой роли.

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

      • spec.roleRef.name
        строка

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

        Имя выдаваемой ClusterRole.

    • spec.subjects
      массив объектов

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

      Субъекты (пользователи, группы или ServiceAccount), которым выдаётся роль.

      • spec.subjects.apiGroup
        строка

        API-группа субъекта: rbac.authorization.k8s.io для User и Group, пустая для ServiceAccount.

      • spec.subjects.kind
        строка

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

        Тип субъекта.

        Допустимые значения: User, Group, ServiceAccount

      • spec.subjects.name
        строка

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

        Имя субъекта: для User — имя пользователя (User.spec.email), для Group — Group.spec.name, для ServiceAccount — имя ServiceAccount.

      • spec.subjects.namespace
        строка

        Неймспейс ServiceAccount.

        Если не указан, привязка относится к ServiceAccount с этим именем в каждом неймспейсе каждого проекта.

  • status
    объект
    • status.boundProjects
      целочисленный

      Количество проектов, к которым в данный момент применена привязка.

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

      Текущее состояние объекта.

      • status.conditions.lastProbeTime
        строка

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

      • status.conditions.lastTransitionTime
        строка

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

      • status.conditions.message
        строка

        Сообщение с подробностями о состоянии условия.

      • status.conditions.status
        строка

        Состояние условия: True, False или Unknown.

      • status.conditions.type
        строка

        Тип условия.

    • status.observedGeneration
      целочисленный

      Последнее поколение объекта, обработанное контроллером.

AvailableClusterResource

Short names: available

Scope: Namespaced
Version: v1alpha1

Содержит информацию о cluster-wide-ресурсах, доступных проекту, и значении, используемом по умолчанию.

Ресурс автоматически создаётся и обновляется контроллером multitenancy-manager в неймспейсе проекта для каждого зарегистрированного GrantableClusterResourceDefinition. Он удаляется при удалении соответствующего GrantableClusterResourceDefinition. Имя AvailableClusterResource совпадает с именем соответствующего GrantableClusterResourceDefinition.

Информация о доступных cluster-wide-ресурсах и значении по умолчанию содержится в поле status.

Подробнее о просмотре доступных cluster-wide-ресурсов — в разделе «Примеры использования».

Внимание. Ресурс предназначен только для чтения. Ручное создание AvailableClusterResource запрещено.

  • status
    объект

    Состояние доступности cluster-wide-ресурсов для проекта.

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

      Список доступных проекту cluster-wide-ресурсов с указанием значения, используемого по умолчанию. Каждый ресурс указан в списке один раз.

      Информация о доступном проекту cluster-wide-ресурсе.

      • status.available.default
        булевый

        Означает, что cluster-wide-ресурс используется в проекте по умолчанию.

      • status.available.fields
        объект

        Значения полей cluster-wide-ресурса, перечисленных в spec.catalogFields соответствующего GrantableClusterResourceDefinition, по именам полей.

        Значение сохраняет свой тип JSON: строка, число, логическое значение, объект или массив. Поле, значения которого в ресурсе нет или которое длиннее 512 байт, не выводится. Если status.available с полями всех ресурсов занимал бы в JSON-сериализации больше 512 КиБ, fields не будет ни у одной записи, но имена и ресурс по умолчанию по-прежнему будут перечислены.

      • status.available.name
        строка

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

        Имя доступного проекту cluster-wide-ресурса.

    • status.availableCount
      целочисленный

      Количество доступных проекту cluster-wide-ресурсов.

      Используется при выводе списка ресурсов. Имена доступных cluster-wide-ресурсов содержатся в status.available.

    • status.default
      строка

      Имя cluster-wide-ресурса, используемого в проекте по умолчанию.

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

    • status.grantedResourceKind
      строка

      Тип (kind) cluster-wide-ресурса.

    • status.observedGeneration
      целочисленный

      Поколение ресурса (generation), на основе которого контроллер сформировал текущий status.

ClusterResourceGrantPolicy

Short names: crgp

Scope: Cluster

  • v1alpha2
  • v1alpha1

Определяет политику доступа проектов к cluster-wide-ресурсам и значения, используемые по умолчанию.

Ресурс применяется к неймспейсам проектов, выбранным с помощью spec.projectSelector (по лейблам Project) и spec.namespaceSelector (по лейблам неймспейса). Для каждого типа cluster-wide-ресурсов политика позволяет настроить разрешённые и запрещённые ресурсы, а также правила их доступности и значения по умолчанию.

Тип cluster-wide-ресурсов задаётся с помощью spec.resources[].resourceName, который ссылается на соответствующий GrantableClusterResourceDefinition.

Политика создаётся администратором кластера.

Примеры настройки приведены в разделе «Примеры использования».

  • spec
    объект

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

    Параметры ClusterResourceGrantPolicy.

    • spec.namespaceSelector
      объект

      Селектор лейблов неймспейсов проектов, к которым применяется политика.

      Селектор сопоставляется с лейблами неймспейса. Если задан и spec.projectSelector, должны совпасть оба. Если селектор не задан, выбираются все неймспейсы выбранных проектов. Пустой селектор соответствует всем неймспейсам. Неймспейсы виртуальных проектов deckhouse и default не выбираются никогда.

      Значение лейбла projects.deckhouse.io/project-namespace — это имя, которое пользователь проекта даёт ProjectNamespace. Без spec.projectSelector селектор по этому лейблу выбирает и неймспейс ProjectNamespace с таким же именем в любом другом проекте.

      Дополнительный неймспейс проекта создаёт пользователь проекта. На нём есть лейблы, которые ставит модуль, и лейблы шаблона проекта, которые он наследует от основного неймспейса; лейбл, поставленный на основной неймспейс вручную, не наследуется. Политика, ограничивающая ресурсы по такому лейблу, не распространяется на новый дополнительный неймспейс.

      • spec.namespaceSelector.matchExpressions
        массив объектов

        Список выражений селектора лейблов.

        Все выражения должны выполняться одновременно.

        Выражение селектора лейблов.

        • spec.namespaceSelector.matchExpressions.key
          строка

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

          Ключ лейбла, к которому применяется выражение.

        • spec.namespaceSelector.matchExpressions.operator
          строка

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

          Оператор, определяющий отношение ключа к набору значений.

        • spec.namespaceSelector.matchExpressions.values
          массив строк

          Список значений лейбла.

          Для операторов In и NotIn список должен содержать хотя бы одно значение. Для операторов Exists и DoesNotExist список должен быть пустым.

      • spec.namespaceSelector.matchLabels
        объект

        Набор лейблов неймспейсов, к которым применяется политика.

        Все указанные лейблы должны совпадать.

    • spec.projectSelector
      объект

      Селектор лейблов проектов, к которым применяется политика.

      Селектор сопоставляется с лейблами объекта Project. Политика применяется ко всем неймспейсам выбранного проекта, в том числе к дополнительному неймспейсу, созданному позже, если выбор не сужен параметром spec.namespaceSelector. Если селектор не задан, проекты по лейблам не выбираются. Пустой селектор соответствует всем проектам, кроме виртуальных проектов deckhouse и default, неймспейсы которых не выбираются никогда.

      Если не задан ни spec.projectSelector, ни spec.namespaceSelector, политика сама по себе не применяется ни к одному проекту. Это библиотечная политика, которую ProjectTemplate подключает через spec.grantPolicies.

      • spec.projectSelector.matchExpressions
        массив объектов

        Список выражений селектора лейблов.

        Все выражения должны выполняться одновременно.

        Выражение селектора лейблов.

        • spec.projectSelector.matchExpressions.key
          строка

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

          Ключ лейбла, к которому применяется выражение.

        • spec.projectSelector.matchExpressions.operator
          строка

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

          Оператор, определяющий отношение ключа к набору значений.

        • spec.projectSelector.matchExpressions.values
          массив строк

          Список значений лейбла.

          Для операторов In и NotIn список должен содержать хотя бы одно значение. Для операторов Exists и DoesNotExist список должен быть пустым.

      • spec.projectSelector.matchLabels
        объект

        Набор лейблов проектов, к которым применяется политика.

        Все указанные лейблы должны совпадать.

    • spec.resources
      массив объектов

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

      Настройки доступа к cluster-wide-ресурсам для выбранных проектов.

      Настройки доступа к одному типу cluster-wide-ресурсов.

      • spec.resources.allowed
        массив строк

        Список имён cluster-wide-ресурсов, доступных проектам.

        Объединяется с ресурсами, выбранными с помощью allowedSelector. Пустой список не принимается: не указывайте поле или задайте availabilityDefault: None, чтобы ничего не было доступно.

      • spec.resources.allowedSelector
        объект

        Селектор лейблов cluster-wide-ресурсов, доступных проектам.

        Объединяется с ресурсами, указанными в allowed. Применяется только к cluster-wide-ресурсам, представленным объектами Kubernetes. Пустой селектор не принимается: не указывайте поле или задайте availabilityDefault, чтобы открыть или закрыть ресурс без списка.

        • spec.resources.allowedSelector.matchExpressions
          массив объектов

          Список выражений селектора лейблов.

          Все выражения должны выполняться одновременно.

          Выражение селектора лейблов.

          • spec.resources.allowedSelector.matchExpressions.key
            строка

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

            Ключ лейбла, к которому применяется выражение.

          • spec.resources.allowedSelector.matchExpressions.operator
            строка

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

            Оператор, определяющий отношение ключа к набору значений.

          • spec.resources.allowedSelector.matchExpressions.values
            массив строк

            Список значений лейбла.

            Для операторов In и NotIn список должен содержать хотя бы одно значение. Для операторов Exists и DoesNotExist список должен быть пустым.

        • spec.resources.allowedSelector.matchLabels
          объект

          Набор лейблов cluster-wide-ресурсов.

          Все указанные лейблы должны совпадать.

      • spec.resources.availabilityDefault
        строка

        Определяет доступность cluster-wide-ресурсов, не указанных явно с помощью allowed, allowedSelector, denied или deniedSelector.

        Переопределяет defaultAvailability соответствующего GrantableClusterResourceDefinition для проектов, выбранных политикой.

        Значение All предоставляет доступ ко всем таким cluster-wide-ресурсам, а None запрещает доступ к ним.

        Указывать параметр обычно не требуется. Если задан allowed или allowedSelector, а availabilityDefault не указан, доступ к остальным cluster-wide-ресурсам этого типа автоматически запрещается. Задавайте параметр явно, только чтобы изменить доступность без списка разрешённых ресурсов: All — открыть доступ ко всем ресурсам типа, None — закрыть его.

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

      • spec.resources.default
        строка

        Имя cluster-wide-ресурса, используемого в выбранных проектах по умолчанию.

        Переопределяет значение, определённое с помощью defaultFrom в соответствующем GrantableClusterResourceDefinition.

      • spec.resources.denied
        массив строк

        Список имён cluster-wide-ресурсов, недоступных проектам.

        Запрет имеет приоритет над allowed и allowedSelector.

      • spec.resources.deniedSelector
        объект

        Селектор лейблов cluster-wide-ресурсов, недоступных проектам.

        Запрет имеет приоритет над allowed и allowedSelector. Применяется только к cluster-wide-ресурсам, представленным объектами Kubernetes. Пустой селектор не принимается.

        • spec.resources.deniedSelector.matchExpressions
          массив объектов

          Список выражений селектора лейблов.

          Все выражения должны выполняться одновременно.

          Выражение селектора лейблов.

          • spec.resources.deniedSelector.matchExpressions.key
            строка

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

            Ключ лейбла, к которому применяется выражение.

          • spec.resources.deniedSelector.matchExpressions.operator
            строка

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

            Оператор, определяющий отношение ключа к набору значений.

          • spec.resources.deniedSelector.matchExpressions.values
            массив строк

            Список значений лейбла.

            Для операторов In и NotIn список должен содержать хотя бы одно значение. Для операторов Exists и DoesNotExist список должен быть пустым.

        • spec.resources.deniedSelector.matchLabels
          объект

          Набор лейблов cluster-wide-ресурсов.

          Все указанные лейблы должны совпадать.

      • spec.resources.resourceName
        строка

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

        Имя GrantableClusterResourceDefinition, для которого задаются настройки доступа.

  • status
    объект

    Состояние ClusterResourceGrantPolicy.

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

      Текущее состояние ClusterResourceGrantPolicy.

      Информация об одном из аспектов текущего состояния ресурса.

      • status.conditions.lastTransitionTime
        строка

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

        Время последнего изменения состояния условия.

      • status.conditions.message
        строка

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

        Сообщение с дополнительной информацией о состоянии условия.

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

      • status.conditions.observedGeneration
        целочисленный

        Поколение ресурса, на основе которого сформировано состояние условия.

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

      • status.conditions.reason
        строка

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

        Причина последнего изменения состояния условия.

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

        Длина: 1..1024

      • status.conditions.status
        строка

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

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

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

      • status.conditions.type
        строка

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

        Тип условия.

        Шаблон: ^([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])$

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

    • status.observedGeneration
      целочисленный

      Последнее поколение ресурса, обработанное контроллером.

Устаревший ресурс. Поддержка ресурса может быть исключена в следующих версиях.

Определяет политику доступа проектов к cluster-wide-ресурсам и значения, используемые по умолчанию.

Ресурс применяется к неймспейсам проектов, лейблы которых соответствуют spec.projectSelector. Политика, записанная через multitenancy.deckhouse.io/v1alpha2, может также выбирать проекты по лейблам Project; в этой версии такой селектор виден как JSON в аннотации multitenancy.deckhouse.io/v1alpha2-project-selector. Для каждого типа cluster-wide-ресурсов политика позволяет настроить разрешённые и запрещённые ресурсы, а также правила их доступности и значения по умолчанию.

Тип cluster-wide-ресурсов задаётся с помощью spec.resources[].resourceName, который ссылается на соответствующий GrantableClusterResourceDefinition.

Политика создаётся администратором кластера.

Примеры настройки приведены в разделе «Примеры использования».

  • spec
    объект

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

    Параметры ClusterResourceGrantPolicy.

    • spec.projectSelector
      объект

      Селектор лейблов неймспейсов проектов, к которым применяется политика.

      Селектор сопоставляется с лейблами неймспейса — так же, как spec.namespaceSelector в версии multitenancy.deckhouse.io/v1alpha2, которую и следует использовать.

      Если селектор не задан и нет аннотации multitenancy.deckhouse.io/v1alpha2-project-selector, политика не применяется ни к одному проекту. Пустой селектор соответствует всем неймспейсам проектов, кроме неймспейсов виртуальных проектов deckhouse и default.

      В аннотации хранится spec.projectSelector версии v1alpha2, который сопоставляется с лейблами Project. Сохраняйте аннотацию, когда меняете политику через эту версию.

      • spec.projectSelector.matchExpressions
        массив объектов

        Список выражений селектора лейблов.

        Все выражения должны выполняться одновременно.

        Выражение селектора лейблов.

        • spec.projectSelector.matchExpressions.key
          строка

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

          Ключ лейбла, к которому применяется выражение.

        • spec.projectSelector.matchExpressions.operator
          строка

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

          Оператор, определяющий отношение ключа к набору значений.

        • spec.projectSelector.matchExpressions.values
          массив строк

          Список значений лейбла.

          Для операторов In и NotIn список должен содержать хотя бы одно значение. Для операторов Exists и DoesNotExist список должен быть пустым.

      • spec.projectSelector.matchLabels
        объект

        Набор лейблов неймспейсов, к которым применяется политика.

        Все указанные лейблы должны совпадать.

    • spec.resources
      массив объектов

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

      Настройки доступа к cluster-wide-ресурсам для выбранных проектов.

      Настройки доступа к одному типу cluster-wide-ресурсов.

      • spec.resources.allowed
        массив строк

        Список имён cluster-wide-ресурсов, доступных проектам.

        Объединяется с ресурсами, выбранными с помощью allowedSelector. Пустой список не принимается: не указывайте поле или задайте availabilityDefault: None, чтобы ничего не было доступно.

      • spec.resources.allowedSelector
        объект

        Селектор лейблов cluster-wide-ресурсов, доступных проектам.

        Объединяется с ресурсами, указанными в allowed. Применяется только к cluster-wide-ресурсам, представленным объектами Kubernetes. Пустой селектор не принимается: не указывайте поле или задайте availabilityDefault, чтобы открыть или закрыть ресурс без списка.

        • spec.resources.allowedSelector.matchExpressions
          массив объектов

          Список выражений селектора лейблов.

          Все выражения должны выполняться одновременно.

          Выражение селектора лейблов.

          • spec.resources.allowedSelector.matchExpressions.key
            строка

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

            Ключ лейбла, к которому применяется выражение.

          • spec.resources.allowedSelector.matchExpressions.operator
            строка

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

            Оператор, определяющий отношение ключа к набору значений.

          • spec.resources.allowedSelector.matchExpressions.values
            массив строк

            Список значений лейбла.

            Для операторов In и NotIn список должен содержать хотя бы одно значение. Для операторов Exists и DoesNotExist список должен быть пустым.

        • spec.resources.allowedSelector.matchLabels
          объект

          Набор лейблов cluster-wide-ресурсов.

          Все указанные лейблы должны совпадать.

      • spec.resources.availabilityDefault
        строка

        Определяет доступность cluster-wide-ресурсов, не указанных явно с помощью allowed, allowedSelector, denied или deniedSelector.

        Переопределяет defaultAvailability соответствующего GrantableClusterResourceDefinition для проектов, выбранных политикой.

        Значение All предоставляет доступ ко всем таким cluster-wide-ресурсам, а None запрещает доступ к ним.

        Указывать параметр обычно не требуется. Если задан allowed или allowedSelector, а availabilityDefault не указан, доступ к остальным cluster-wide-ресурсам этого типа автоматически запрещается. Задавайте параметр явно, только чтобы изменить доступность без списка разрешённых ресурсов: All — открыть доступ ко всем ресурсам типа, None — закрыть его.

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

      • spec.resources.default
        строка

        Имя cluster-wide-ресурса, используемого в выбранных проектах по умолчанию.

        Переопределяет значение, определённое с помощью defaultFrom в соответствующем GrantableClusterResourceDefinition.

      • spec.resources.denied
        массив строк

        Список имён cluster-wide-ресурсов, недоступных проектам.

        Запрет имеет приоритет над allowed и allowedSelector.

      • spec.resources.deniedSelector
        объект

        Селектор лейблов cluster-wide-ресурсов, недоступных проектам.

        Запрет имеет приоритет над allowed и allowedSelector. Применяется только к cluster-wide-ресурсам, представленным объектами Kubernetes. Пустой селектор не принимается.

        • spec.resources.deniedSelector.matchExpressions
          массив объектов

          Список выражений селектора лейблов.

          Все выражения должны выполняться одновременно.

          Выражение селектора лейблов.

          • spec.resources.deniedSelector.matchExpressions.key
            строка

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

            Ключ лейбла, к которому применяется выражение.

          • spec.resources.deniedSelector.matchExpressions.operator
            строка

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

            Оператор, определяющий отношение ключа к набору значений.

          • spec.resources.deniedSelector.matchExpressions.values
            массив строк

            Список значений лейбла.

            Для операторов In и NotIn список должен содержать хотя бы одно значение. Для операторов Exists и DoesNotExist список должен быть пустым.

        • spec.resources.deniedSelector.matchLabels
          объект

          Набор лейблов cluster-wide-ресурсов.

          Все указанные лейблы должны совпадать.

      • spec.resources.resourceName
        строка

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

        Имя GrantableClusterResourceDefinition, для которого задаются настройки доступа.

  • status
    объект

    Состояние ClusterResourceGrantPolicy.

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

      Текущее состояние ClusterResourceGrantPolicy.

      Информация об одном из аспектов текущего состояния ресурса.

      • status.conditions.lastTransitionTime
        строка

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

        Время последнего изменения состояния условия.

      • status.conditions.message
        строка

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

        Сообщение с дополнительной информацией о состоянии условия.

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

      • status.conditions.observedGeneration
        целочисленный

        Поколение ресурса, на основе которого сформировано состояние условия.

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

      • status.conditions.reason
        строка

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

        Причина последнего изменения состояния условия.

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

        Длина: 1..1024

      • status.conditions.status
        строка

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

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

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

      • status.conditions.type
        строка

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

        Тип условия.

        Шаблон: ^([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])$

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

    • status.observedGeneration
      целочисленный

      Последнее поколение ресурса, обработанное контроллером.

GrantableClusterResourceDefinition

Short names: gcrd

Scope: Cluster
Version: v1alpha1

Регистрирует тип cluster-wide-ресурсов для управления доступом к нему из проектов.

GrantableClusterResourceDefinition определяет cluster-wide-ресурс, для которого можно настраивать доступ с помощью ClusterResourceGrantPolicy, а также базовые правила его доступности и использования значения по умолчанию.

Ресурс может регистрировать как объекты Kubernetes, например StorageClass или ClusterRole, так и значения, которые не представлены отдельными объектами Kubernetes.

Места использования cluster-wide-ресурса в других ресурсах Kubernetes регистрируются отдельно с помощью GrantableClusterResourceReference.

GrantableClusterResourceDefinition создаётся DP или разработчиком модуля. Для управления доступом к дополнительным типам cluster-wide-ресурсов можно создавать собственные определения.

Подробнее — в разделе «Примеры использования».

  • spec
    объект

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

    Параметры GrantableClusterResourceDefinition.

    • spec.catalogFields
      массив объектов

      Поля cluster-wide-ресурсов, которые показываются проектам в AvailableClusterResource.

      Для каждого доступного ресурса контроллер считывает из него значение каждого указанного поля и записывает его в status.available[].fields AvailableClusterResource под заданным именем.

      Правила:

      • Применяется только для определений с grantedResource, и этот ресурс должен быть cluster-scoped. Для значений, которые не представлены объектами Kubernetes, параметр указывать нельзя.
      • Можно указать не более 10 полей.
      • Поле, значения которого в ресурсе нет, не выводится.
      • Значение длиннее 512 байт в JSON-сериализации не выводится.
      • Если status.available одного AvailableClusterResource с полями всех ресурсов занимал бы в JSON-сериализации больше 512 КиБ, поля в нём не выводятся вовсе.

      Пути проверяются при создании и изменении объекта, некорректный элемент отклоняется. Результат проверки сохранённого объекта показывает условие CatalogFieldsValid. О значениях, пропущенных из-за размера, сообщают предупреждающие события CatalogFieldsSkipped на GrantableClusterResourceDefinition.

      Внимание. Значения видны всем пользователям каждого проекта, которому доступен ресурс. Указывайте только несекретные данные.

      Поле cluster-wide-ресурса, которое показывается проектам.

      • spec.catalogFields.name
        строка

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

        Имя поля в status.available[].fields AvailableClusterResource в формате lowerCamelCase (например, reclaimPolicy).

        Шаблон: ^[a-z][a-zA-Z0-9]*$

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

      • spec.catalogFields.path
        строка

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

        Путь к значению в cluster-wide-ресурсе, например $.provisioner.

        Должен быть singular query JSONPath по RFC 9535 длиной не более 256 символов, выбирающий ровно одно значение: только имена полей и индексы массивов, без wildcard (*), рекурсивного спуска (..), срезов и фильтров.

        Пути, которые читают metadata.managedFields, аннотацию kubectl.kubernetes.io/last-applied-configuration или содержащее их родительское поле (например, $.metadata), указывать нельзя: в этих полях хранится копия всего ресурса.

        Длина: 1..256

    • spec.defaultAvailability
      строка

      Базовая доступность cluster-wide-ресурсов для проектов.

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

      • All — ресурсы доступны по умолчанию;
      • None — ресурсы недоступны по умолчанию.

      Значение применяется, если доступность не определена с помощью ClusterResourceGrantPolicy.

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

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

    • spec.defaultFrom
      объект

      Настройки определения cluster-wide-ресурса, используемого по умолчанию.

      Ресурс определяется по заданной аннотации со значением true (регистр не важен; false помечает ресурс, который не является используемым по умолчанию, как в соглашении Kubernetes для storageclass.kubernetes.io/is-default-class) и используется как значение по умолчанию, если оно не задано с помощью ClusterResourceGrantPolicy. Если true стоит на нескольких ресурсах, значения по умолчанию нет.

      • spec.defaultFrom.annotationKey
        строка

        Ключ аннотации, которой отмечается cluster-wide-ресурс, используемый по умолчанию; учитывается только значение true.

    • spec.enforcement
      строка

      Способ проверки доступности cluster-wide-ресурса.

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

      • Managed — проверка выполняется вебхуками multitenancy-manager;
      • External — проверка выполняется внешним механизмом, например вебхуком модуля.

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

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

    • spec.excluded
      массив объектов

      Фильтры исключённых cluster-wide-ресурсов, которые всегда недоступны проектам независимо от настроек ClusterResourceGrantPolicy.

      Ресурс считается исключённым, если соответствует хотя бы одному из указанных фильтров.

      Фильтр cluster-wide-ресурсов по именам и лейблам.

      • spec.excluded.matchExpressions
        массив объектов

        Список выражений селектора лейблов cluster-wide-ресурсов.

        Все выражения должны выполняться одновременно.

        Выражение селектора лейблов.

        • spec.excluded.matchExpressions.key
          строка

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

          Ключ лейбла, к которому применяется выражение.

        • spec.excluded.matchExpressions.operator
          строка

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

          Оператор, определяющий отношение ключа к набору значений.

        • spec.excluded.matchExpressions.values
          массив строк

          Список значений лейбла.

          Для операторов In и NotIn список должен содержать хотя бы одно значение. Для операторов Exists и DoesNotExist список должен быть пустым.

      • spec.excluded.matchLabels
        объект

        Набор лейблов cluster-wide-ресурсов.

        Все указанные лейблы должны совпадать.

      • spec.excluded.names
        массив строк

        Список имён cluster-wide-ресурсов.

    • spec.grantedResource
      объект

      Cluster-wide-ресурс Kubernetes, для которого настраивается доступ.

      Должен быть cluster-scoped-ресурсом: namespaced-ресурс (например, Secret) отклоняется при создании и изменении объекта, а определение, сохранённое с ним, не обрабатывается, что показывает условие GrantedResourceValid. Ресурс, который ещё не обслуживается (его CRD не установлена), принимается и проверяется, когда начинает обслуживаться.

      Если параметр не задан, управление доступом применяется к значениям, которые не представлены отдельными объектами Kubernetes.

      • spec.grantedResource.apiGroup
        строка

        API-группа cluster-wide-ресурса.

        Для основной API-группы укажите пустую строку ("").

      • spec.grantedResource.kind
        строка

        Тип (kind) cluster-wide-ресурса (например, StorageClass).

    • spec.reserved
      массив объектов

      Фильтры зарезервированных cluster-wide-ресурсов, которые по умолчанию недоступны проектам.

      Зарезервированный ресурс становится доступен проекту, только если применимая к проекту ClusterResourceGrantPolicy указывает его в allowed или выбирает через allowedSelector. availabilityDefault: All в политике и defaultAvailability не делают его доступным. Фильтры excluded и параметры denied и deniedSelector политики имеют приоритет над allowed и allowedSelector.

      Ресурс считается зарезервированным, если соответствует хотя бы одному из указанных фильтров.

      Фильтр cluster-wide-ресурсов по именам и лейблам.

      • spec.reserved.matchExpressions
        массив объектов

        Список выражений селектора лейблов cluster-wide-ресурсов.

        Все выражения должны выполняться одновременно.

        Выражение селектора лейблов.

        • spec.reserved.matchExpressions.key
          строка

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

          Ключ лейбла, к которому применяется выражение.

        • spec.reserved.matchExpressions.operator
          строка

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

          Оператор, определяющий отношение ключа к набору значений.

        • spec.reserved.matchExpressions.values
          массив строк

          Список значений лейбла.

          Для операторов In и NotIn список должен содержать хотя бы одно значение. Для операторов Exists и DoesNotExist список должен быть пустым.

      • spec.reserved.matchLabels
        объект

        Набор лейблов cluster-wide-ресурсов.

        Все указанные лейблы должны совпадать.

      • spec.reserved.names
        массив строк

        Список имён cluster-wide-ресурсов.

  • status
    объект

    Состояние GrantableClusterResourceDefinition.

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

      Текущее состояние GrantableClusterResourceDefinition.

      • GrantedResourceValid — может ли быть обработан spec.grantedResource. True с причиной ClusterScoped для cluster-scoped-ресурса или ValueBacked для определения без grantedResource. False с причиной Namespaced для namespaced-ресурса: определение не обрабатывается, ни один проект не получает его AvailableClusterResource, а вебхуки грантов пропускают ссылки на него: их значения не проверяются. Unknown с причиной KindNotServed, пока ресурс не обслуживается (например, его CRD ещё не установлена), или MappingFailed, если определить его область видимости не удалось.
      • CatalogFieldsValid — проходят ли spec.catalogFields проверки, выполняемые при создании и изменении объекта: пути — корректные singular query, не читающие metadata.managedFields и аннотацию kubectl.kubernetes.io/last-applied-configuration, а у определения указан grantedResource (причины Valid, InvalidCatalogFields; в сообщении перечислены все проблемы). У определения без catalogFields условие равно True. False означает, что объект сохранён в обход этих проверок; некорректные элементы в AvailableClusterResource не выводятся.

      Информация об одном из аспектов текущего состояния ресурса.

      • status.conditions.lastTransitionTime
        строка

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

        Время последнего изменения состояния условия.

      • status.conditions.message
        строка

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

        Сообщение с дополнительной информацией о состоянии условия.

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

      • status.conditions.observedGeneration
        целочисленный

        Поколение ресурса, на основе которого сформировано состояние условия.

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

      • status.conditions.reason
        строка

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

        Причина последнего изменения состояния условия.

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

        Длина: 1..1024

      • status.conditions.status
        строка

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

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

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

      • status.conditions.type
        строка

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

        Тип условия.

        Шаблон: ^([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])$

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

    • status.observedGeneration
      целочисленный

      Последнее поколение ресурса, обработанное контроллером.

    • status.referenceCount
      целочисленный

      Количество ресурсов GrantableClusterResourceReference, связанных с этим определением.

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

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

      Информация о ресурсе GrantableClusterResourceReference, связанном с этим определением.

      • status.references.name
        строка

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

        Имя ресурса GrantableClusterResourceReference.

      • status.references.resources
        массив строк

        Типы ресурсов Kubernetes, содержащих зарегистрированные ссылки на cluster-wide-ресурс.

GrantableClusterResourceReference

Short names: gcrr

Scope: Cluster
Version: v1alpha1

Регистрирует места использования cluster-wide-ресурса в других ресурсах Kubernetes.

GrantableClusterResourceReference определяет ресурсы Kubernetes и поля, содержащие ссылки на cluster-wide-ресурс, зарегистрированный с помощью GrantableClusterResourceDefinition. Для таких полей можно настроить проверку доступности указанного cluster-wide-ресурса и автоматическую подстановку значения по умолчанию.

Один GrantableClusterResourceDefinition может быть связан с несколькими GrantableClusterResourceReference, если cluster-wide-ресурс используется в разных ресурсах или полях.

GrantableClusterResourceReference создаётся разработчиком модуля при добавлении ссылки на зарегистрированный cluster-wide-ресурс.

Подробнее о регистрации ссылок на cluster-wide-ресурсы — в разделе «Примеры использования».

  • spec
    объект

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

    Параметры GrantableClusterResourceReference.

    • spec.fieldPaths
      массив объектов

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

      Список полей ресурсов Kubernetes, содержащих ссылки на cluster-wide-ресурс.

      Для каждого поля можно ограничить применимость определёнными ресурсами, API-группами и версиями, задать условие проверки и настроить подстановку значения по умолчанию.

      Требуется указать хотя бы один элемент. Значения resources, apiGroups и apiVersions элемента должны входить в соответствующие списки spec.rule (* в spec.rule допускает любое значение). Каждое сочетание API-группы, версии и ресурса, которому соответствует spec.rule, должно покрываться хотя бы одним элементом, иначе запросы для него не проверялись бы вовсе. Для этого либо задайте элементы для каждого такого сочетания, либо добавьте элемент без resources, apiGroups и apiVersions, который будет применяться в остальных случаях. Объект, нарушающий любое из этих правил, отклоняется.

      Настройки поля, содержащего ссылку на cluster-wide-ресурс.

      Если запросу соответствуют несколько элементов, применяется наиболее специфичный: resources имеет приоритет над apiGroups, а apiGroups — над apiVersions. Значение * в resources, apiGroups или apiVersions не ограничивает элемент и не делает его более специфичным. Элементы, условие match которых для объекта не выполняется, пропускаются. Из одинаково ограниченных элементов элемент с match имеет приоритет над элементом без него. Если несколько элементов одинаково специфичны, применяется первый из них в списке. Элемент без ограничений и без match используется в остальных случаях.

      Поэтому несколько элементов с одним path могут обрабатывать разные объекты одного ресурса. Например, элемент с match по $.spec['dataSource','dataSourceRef'].kind и defaulting: None обрабатывает PersistentVolumeClaim, которые восстанавливают или клонируют том, а элемент без match с defaulting: Coerce — все остальные PersistentVolumeClaim.

      • spec.fieldPaths.apiGroups
        массив строк

        API-группы, для которых применяются настройки поля.

        Если параметр не задан, настройки применяются ко всем API-группам, соответствующим spec.rule.

      • spec.fieldPaths.apiVersions
        массив строк

        Версии API, для которых применяются настройки поля.

        Если параметр не задан, настройки применяются ко всем версиям API, соответствующим spec.rule.

      • spec.fieldPaths.defaulting
        строка

        Режим подстановки значения по умолчанию.

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

        • None — значение не подставляется, выполняется только проверка доступности указанного cluster-wide-ресурса;
        • FillEmpty — значение по умолчанию подставляется при создании объекта, если поле не заполнено;
        • Coerce — значение по умолчанию подставляется при создании объекта, если поле не заполнено или указанный cluster-wide-ресурс недоступен проекту.

        Режимы FillEmpty и Coerce требуют, чтобы path указывал на одно поле, поэтому принимается только простой путь по именам полей, например $.spec.storageClassName или $.metadata.annotations['cert-manager.io/cluster-issuer']. Путь с подстановочным знаком, индексом массива или фильтром с этими режимами отклоняется и может использоваться только с None.

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

        Допустимые значения: None, FillEmpty, Coerce

      • spec.fieldPaths.match
        объект

        Условие применения настроек поля.

        Если условие не выполняется, элемент пропускается: применяется следующий по специфичности элемент, а если его нет, проверка доступности и подстановка значения для этого поля не выполняются.

        Без equals и in условие выполняется, когда fieldPath указывает на строковое значение.

        • spec.fieldPaths.match.equals
          строка

          Значение, которому должно соответствовать поле, указанное в fieldPath.

        • spec.fieldPaths.match.fieldPath
          строка

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

          JSONPath к полю, значение которого проверяется условием.

          Должен быть корректным JSONPath по RFC 9535 длиной не более 256 символов; объект с путём, который не разбирается, отклоняется.

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

        • spec.fieldPaths.match.in
          массив строк

          Список допустимых значений поля, указанного в fieldPath.

      • spec.fieldPaths.message
        строка

        Текст, который добавляется к отказу, если поле объекта ссылается на cluster-wide-ресурс, недоступный проекту.

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

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

      • spec.fieldPaths.path
        строка

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

        JSONPath к строковому полю, содержащему имя cluster-wide-ресурса.

        Путь может указывать в том числе на аннотацию, например $.metadata.annotations['cert-manager.io/cluster-issuer'].

        Должен быть корректным JSONPath по RFC 9535 длиной не более 256 символов; объект с путём, который не разбирается, отклоняется при любом значении defaulting. Имя поля, которое не является простым идентификатором (содержит -, . или / либо начинается с цифры), записывается в скобках, например $.spec['foo-bar'].

        При проверке доступности JSONPath вычисляется полностью, включая подстановочные знаки, индексы массивов и фильтры. При подстановке значения по умолчанию — нет: с defaulting: FillEmpty или defaulting: Coerce принимается только простой путь по именам полей.

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

      • spec.fieldPaths.resources
        массив строк

        Имена ресурсов Kubernetes во множественном числе, например pods или cronjobs, для которых применяются настройки поля.

        Если параметр не задан, настройки применяются ко всем ресурсам, соответствующим spec.rule. Значение * действует так же, как отсутствие параметра: не ограничивает элемент и не делает его более специфичным.

        • Элемент массива
          строка
    • spec.grantableClusterResourceName
      строка

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

      Имя ресурса GrantableClusterResourceDefinition, регистрирующего cluster-wide-ресурс, на который ссылаются поля.

    • spec.rule
      объект

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

      Правило выбора ресурсов Kubernetes, к которым применяется GrantableClusterResourceReference.

      • spec.rule.apiGroups
        массив строк

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

        API-группы ресурсов Kubernetes. Core-группа задаётся пустой строкой.

        * не принимается: admission webhook регистрируется только на перечисленные группы, и подстановочный знак молча не перехватывал бы ничего.

      • spec.rule.apiVersions
        массив строк

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

        Версии API ресурсов Kubernetes.

        Используйте *, чтобы выбрать все версии.

      • spec.rule.resources
        массив строк

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

        Имена ресурсов Kubernetes во множественном числе (например, ingresses).

  • status
    объект

    Состояние GrantableClusterResourceReference

    • status.bound
      булевый

      Означает, что GrantableClusterResourceDefinition, указанный в spec.grantableClusterResourceName, существует.

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

      Текущее состояние GrantableClusterResourceReference.

      • Bound — существует ли GrantableClusterResourceDefinition, указанный в spec.grantableClusterResourceName (причины Resolved, UnknownResource).
      • FieldPathsValid — проходят ли spec.fieldPaths проверки, выполняемые при создании и изменении объекта: пути корректны, пути с подстановкой значения по умолчанию указывают на одно поле, ограничения элементов входят в spec.rule, и каждое сочетание, которому соответствует spec.rule, покрыто (причины Valid, InvalidFieldPaths; в сообщении перечислены все проблемы). False означает, что объект сохранён в обход этих проверок; некорректные пути при проверке доступности пропускаются.

      Информация об одном из аспектов текущего состояния ресурса.

      • status.conditions.lastTransitionTime
        строка

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

        Время последнего изменения состояния условия.

      • status.conditions.message
        строка

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

        Сообщение с дополнительной информацией о состоянии условия.

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

      • status.conditions.observedGeneration
        целочисленный

        Поколение ресурса, на основе которого сформировано состояние условия.

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

      • status.conditions.reason
        строка

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

        Причина последнего изменения состояния условия.

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

        Длина: 1..1024

      • status.conditions.status
        строка

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

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

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

      • status.conditions.type
        строка

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

        Тип условия.

        Шаблон: ^([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])$

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

    • status.observedGeneration
      целочисленный

      Последнее поколение ресурса, обработанное контроллером.

ProjectNamespace

Short names: pns

Scope: Namespaced
Version: v1alpha3

Описывает дополнительный неймспейс проекта.

Доступен в коммерческих редакциях Deckhouse Platform. В Deckhouse Platform Open создать ProjectNamespace нельзя, а контроллер не создаёт и не обслуживает его неймспейс.

Ресурс должен создаваться в основном неймспейсе проекта (неймспейс, имя которого совпадает с именем проекта). Контроллер создаёт неймспейс <project>-<spec.name>, ставит на него лейблы принадлежности проекту и добавляет его в Project.status.namespaces с типом Additional. Удаление ProjectNamespace удаляет этот неймспейс.

  • spec
    объект

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

    • spec.name
      строка

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

      Суффикс итогового неймспейса.

      Создаётся неймспейс <project>-<name>, где <project> — основной неймспейс, в котором создан этот объект.

      Итоговое имя неймспейса <project>-<name> должно быть не длиннее 63 символов.

      Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

      Длина: 1..61

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

      Текущее состояние объекта.

      • status.conditions.lastProbeTime
        строка

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

      • status.conditions.lastTransitionTime
        строка

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

      • status.conditions.message
        строка

        Сообщение с подробностями о состоянии условия.

      • status.conditions.status
        строка

        Состояние условия: True, False или Unknown.

      • status.conditions.type
        строка

        Тип условия.

    • status.namespace
      строка

      Неймспейс, который контроллер создал для этого ProjectNamespace.

    • status.observedGeneration
      целочисленный

      Последнее поколение объекта, обработанное контроллером.

ProjectQuotaStatus

Short names: pqs

Scope: Cluster
Version: v1alpha1

Лимиты и потребление квоты проекта, просуммированное по всем неймспейсам проекта.

Объект доступен только для чтения. Контроллер создаёт его по полю Project.spec.quota, поддерживает в актуальном состоянии и удаляет, когда поле очищено или проект удалён. Квоту проекта задайте в поле Project.spec.quota. Имя объекта — имя проекта.

Контроллер ставит ResourceQuota d8-project-quota с лимитами spec.hard в каждый неймспейс проекта, в том числе созданный позже, поэтому потребление каждого неймспейса считается его собственным ResourceQuota, и ни один неймспейс в одиночку не может использовать больше, чем весь проект. В статусе видна сумма потребления по неймспейсам.

  • spec
    объект

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

    • spec.hard
      объект

      Лимиты проекта, которые контроллер копирует из Project.spec.quota, в формате ResourceQuota.spec.hard, например requests.cpu: "100".

      Допустимы ключи, которые ResourceQuota считает в неймспейсе: cpu, memory, requests.*, limits.*, pods, services, services.loadbalancers, services.nodeports, persistentvolumeclaims, configmaps, secrets, replicationcontrollers, ephemeral-storage, ключи классов хранилищ и классов устройств, запросы расширенных ресурсов и count/<RESOURCE>[.<GROUP>] для namespaced-ресурса, который обслуживает API-сервер. projectNamespaces — псевдоним count/projectnamespaces.deckhouse.io, число объектов ProjectNamespace проекта.

      Если включён модуль virtualization, виртуальные машины проекта ограничиваются по спецификации ключами virtualmachines.virtualization.deckhouse.io/cores, virtualmachines.virtualization.deckhouse.io/cpu, virtualmachines.virtualization.deckhouse.io/memory, virtualmachines.virtualization.deckhouse.io/gpus и <GPU_CLASS>.gpuclass.virtualization.deckhouse.io/gpus; эти ключи не считает ни один ResourceQuota, поэтому в d8-project-quota они не попадают. Сервисы типа LoadBalancer ограничиваются по классу, пулу и адресам ключами <CLASS>.loadbalancerclass.network.deckhouse.io/services, <CLASS>.loadbalancerclass.network.deckhouse.io/addresses, <POOL>.loadbalancerpool.network.deckhouse.io/addresses и loadbalancers.network.deckhouse.io/addresses, которые туда тоже не попадают.

      Ключи resourcequotas, count/resourcequotas, счётчик cluster-wide-ресурса и ресурс с опечаткой отклоняются. Ключ count/ группы, которую API-сервер ещё не обслуживает, принимается с предупреждением и ничего не считает, пока не включён модуль, который эту группу предоставляет.

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

      Состояние квоты:

      • Если Enforced установлен в True, то квота применяется во всех неймспейсах проекта. Если Enforced установлен в False, то в reason указывается причина, по которой это произошло: ControlPlaneNotManaged (control plane ведёт не Deckhouse Platform, поэтому сумма не ограничивается), Suspended (ConfigMap quota-ledger-suspend приостановил проверку суммы), WebhookMissing (вебхука счётчика квот нет или его caBundle не совпадает с CA сертификата счётчика), WebhookMisconfigured (вебхук изменён так, что записи d8-project-quota не доходят до счётчика), WebhookNotCalled (какой-то API-сервер допускает объекты, не вызывая этот вебхук), KeyNotServed (какой-то ключ ничего не считает: API-сервер ещё не обслуживает ресурс ключа count/ или модуль, который обслуживает ресурсы ключа, выключен) или KeyRollout (ResourceQuota d8-project-quota какого-то неймспейса ещё не создан или не рассчитан со всеми лимитами).
      • Если Exceeded установлен в True, то потребление проекта выше квоты по какому-то ключу. Причина в reason показывает, как возникло превышение: HardLowered (лимит задан ниже потребления — изменением или при создании квоты) или Overshoot (потребление выросло за лимит).
      • status.conditions.lastTransitionTime
        строка

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

      • status.conditions.message
        строка

        Сообщение с подробностями состояния условия.

      • status.conditions.observedGeneration
        целочисленный

        Поколение объекта, для которого выставлено условие.

      • status.conditions.reason
        строка

        Причина состояния условия.

      • status.conditions.status
        строка

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

        Состояние условия: True, False или Unknown.

      • status.conditions.type
        строка

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

        Тип условия.

    • status.hard
      объект

      Лимиты, которые применяет контроллер, — spec.hard с раскрытым псевдонимом.

    • status.namespaceCount
      целочисленный

      Число неймспейсов проекта.

    • status.observedGeneration
      целочисленный

      Последнее поколение объекта, обработанное контроллером.

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

      Неймспейсы, ближе всего подошедшие к лимиту, не больше 50. Потребление каждого неймспейса — в его ResourceQuota d8-project-quota.

      • status.topNamespaces.name
        строка

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

        Имя неймспейса.

      • status.topNamespaces.used
        объект

        Потребление неймспейса.

    • status.used
      объект

      Потребление проекта, просуммированное по всем его неймспейсам.

ProjectRoleBinding

Short names: prb

Scope: Namespaced
Version: v1alpha3

ProjectRoleBinding выдаёт роль субъектам во всех неймспейсах одного проекта.

Создавайте его в основном неймспейсе проекта (неймспейсе, имя которого совпадает с именем проекта).

  • spec
    объект

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

    • spec.roleRef
      объект

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

      Ссылка на выдаваемую ClusterRole.

      Допустимые префиксы: d8:project:*, d8:namespace:*, d8:project-capability:*, d8:namespace-capability:*, d8:custom:*.

      • spec.roleRef.kind
        строка

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

        Тип выдаваемой роли.

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

      • spec.roleRef.name
        строка

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

        Имя выдаваемой ClusterRole.

    • spec.subjects
      массив объектов

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

      Субъекты (пользователи, группы или ServiceAccount), которым выдаётся роль.

      • spec.subjects.apiGroup
        строка

        API-группа субъекта: rbac.authorization.k8s.io для User и Group, пустая для ServiceAccount.

      • spec.subjects.kind
        строка

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

        Тип субъекта.

        Допустимые значения: User, Group, ServiceAccount

      • spec.subjects.name
        строка

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

        Имя субъекта: для User — имя пользователя (User.spec.email), для Group — Group.spec.name, для ServiceAccount — имя ServiceAccount.

      • spec.subjects.namespace
        строка

        Неймспейс ServiceAccount.

        Если не указан, привязка относится к ServiceAccount с этим именем в каждом неймспейсе проекта.

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

      Текущее состояние объекта.

      • status.conditions.lastProbeTime
        строка

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

      • status.conditions.lastTransitionTime
        строка

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

      • status.conditions.message
        строка

        Сообщение с подробностями о состоянии условия.

      • status.conditions.status
        строка

        Состояние условия: True, False или Unknown.

      • status.conditions.type
        строка

        Тип условия.

    • status.observedGeneration
      целочисленный

      Последнее поколение объекта, обработанное контроллером.

Project

Scope: Cluster

  • v1alpha3
  • v1alpha2
  • v1alpha1

Описывает проект — изолированное окружение для приложений.

Проект состоит из основного неймспейса с именем проекта, дополнительных неймспейсов (ProjectNamespace), если они есть, а также настроек, политик и объектов, которые описывает его шаблон ProjectTemplate. См. Создание проекта.

  • spec
    объект
    • spec.administrators
      массив объектов

      Пользователи и группы, получающие административный доступ к проекту.

      Контроллер выдаёт им роль d8:project:admin через ProjectRoleBinding d8-administrators. Для User имя — это имя пользователя (User.spec.email), для Group — Group.spec.name.

      Нельзя задавать вместе с parameters.administrators.

      • spec.administrators.kind
        строка

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

        Тип субъекта.

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

      • spec.administrators.name
        строка

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

        Имя субъекта. Для User — имя пользователя (User.spec.email). Для Group — Group.spec.name (имя в токене), а не metadata.name. Имя не может содержать управляющие символы и переводы строк и не может начинаться с system:multitenancy-manager:, префикса пользователей, от имени которых действует контроллер. Обновление, которое оставляет такое имя прежним, принимается с предупреждением.

        Шаблон: ^[^\x00-\x1f\x7f]+$

    • spec.description
      строка

      Произвольное описание назначения проекта.

      Укажите пустую строку, если описание не требуется.

    • spec.grants
      объект

      Cluster-wide-ресурсы, доступные неймспейсам проекта, в дополнение к тем, что даёт его шаблон.

      Контроллер превращает их в управляемые объекты ClusterResourceGrantPolicy с именами project-<PROJECT_NAME>-*, владелец которых — проект. Для изменения поля нужно право на создание объектов ClusterResourceGrantPolicy. deckhouse.io/v1alpha2 не может описать это поле, поэтому запись проекта с грантами через эту версию, в том числе запись его статуса, отклоняется.

      • spec.grants.grantPolicies
        массив строк

        Ссылки на библиотечные объекты ClusterResourceGrantPolicy (созданные без projectSelector и namespaceSelector).

        Для каждой ссылки контроллер создаёт и поддерживает отдельную управляемую политику project-<PROJECT_NAME>-<POLICY_NAME>, копирует в неё ресурсы библиотечной политики и привязывает их к каждому неймспейсу проекта.

      • spec.grants.resources
        массив объектов

        Правила доступа к cluster-wide-ресурсам для неймспейсов проекта в формате resources шаблона ProjectTemplate.

        Контроллер превращает их в ClusterResourceGrantPolicy project-<PROJECT_NAME>-inline, которая применяется к каждому неймспейсу проекта.

        Настройки доступа к одному типу cluster-wide-ресурсов.

        • spec.grants.resources.allowed
          массив строк

          Список имён cluster-wide-ресурсов, доступных проекту.

          Объединяется с ресурсами, выбранными с помощью allowedSelector.

        • spec.grants.resources.allowedSelector
          объект

          Селектор лейблов cluster-wide-ресурсов, доступных проекту.

          Объединяется с ресурсами из allowed. Применяется только к cluster-wide-ресурсам, которые представлены объектами Kubernetes.

          • spec.grants.resources.allowedSelector.matchExpressions
            массив объектов

            Список выражений селектора лейблов.

            Должны выполняться все выражения.

            • spec.grants.resources.allowedSelector.matchExpressions.key
              строка

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

              Ключ лейбла, к которому применяется выражение.

            • spec.grants.resources.allowedSelector.matchExpressions.operator
              строка

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

              Оператор, задающий отношение между ключом и набором значений.

            • spec.grants.resources.allowedSelector.matchExpressions.values
              массив строк

              Список значений лейбла.

          • spec.grants.resources.allowedSelector.matchLabels
            объект

            Набор лейблов cluster-wide-ресурсов.

            Должны совпадать все указанные лейблы.

        • spec.grants.resources.availabilityDefault
          строка

          Доступность cluster-wide-ресурсов этого типа, которые не указаны в allowed, allowedSelector, denied и deniedSelector.

          Переопределяет defaultAvailability в GrantableClusterResourceDefinition. Если задан allowed или allowedSelector, а это поле не задано, остальные ресурсы этого типа проекту недоступны.

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

        • spec.grants.resources.default
          строка

          Имя cluster-wide-ресурса, который проект использует по умолчанию.

          Переопределяет значение, определённое с помощью defaultFrom в GrantableClusterResourceDefinition.

        • spec.grants.resources.denied
          массив строк

          Список имён cluster-wide-ресурсов, недоступных проекту.

          Запрещающие правила имеют приоритет над allowed и allowedSelector.

        • spec.grants.resources.deniedSelector
          объект

          Селектор лейблов cluster-wide-ресурсов, недоступных проекту.

          Запрещающие правила имеют приоритет над allowed и allowedSelector.

          • spec.grants.resources.deniedSelector.matchExpressions
            массив объектов

            Список выражений селектора лейблов.

            Должны выполняться все выражения.

            • spec.grants.resources.deniedSelector.matchExpressions.key
              строка

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

              Ключ лейбла, к которому применяется выражение.

            • spec.grants.resources.deniedSelector.matchExpressions.operator
              строка

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

              Оператор, задающий отношение между ключом и набором значений.

            • spec.grants.resources.deniedSelector.matchExpressions.values
              массив строк

              Список значений лейбла.

          • spec.grants.resources.deniedSelector.matchLabels
            объект

            Набор лейблов cluster-wide-ресурсов.

            Должны совпадать все указанные лейблы.

        • spec.grants.resources.resourceName
          строка

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

          Имя GrantableClusterResourceDefinition, который регистрирует тип cluster-wide-ресурсов.

    • spec.parameters
      объект

      Значения параметров, которые шаблон объявляет в parametersSchema.

      Структурированные поля шаблона получают их через {fromParam: <NAME>}. manifests и resourcesTemplate получают их в {{ .parameters }}, дополненными значениями по умолчанию из parametersSchema. Значения проверяются по parametersSchema.openAPIV3Schema шаблона при создании и изменении проекта.

    • spec.projectTemplateName
      строка

      Имя ProjectTemplate, по которому создаётся проект.

      Шаблон simple создаёт только неймспейс проекта.

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

    • spec.quota
      объект

      Квота ресурсов на весь проект.

      Контроллер ставит ResourceQuota d8-project-quota в каждый неймспейс проекта, суммирует потребление по ним и показывает лимиты и потребление в объекте ProjectQuotaStatus проекта, доступном только для чтения. Очистка поля удаляет этот ProjectQuotaStatus.

      Для изменения поля нужно право update на projects/quota в группе deckhouse.io для проекта, которое выдаёт capability manage_quotas модуля multitenancy-manager.

      Ключи и значения соответствуют формату ResourceQuota.spec.hard, например requests.cpu: "100". Для memory и storage нужна явная единица измерения (например requests.memory: 2Gi); числа без единицы измерения интерпретируются как байты, поэтому вебхук отклоняет такое число, кроме 0. Обновление, которое оставляет такое значение прежним, принимается с предупреждением, как и создание через deckhouse.io/v1alpha2, в котором такое значение приходит из parameters.resourceQuota.

      Нельзя задавать вместе с parameters.resourceQuota.

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

      Текущее состояние проекта.

      Типы условий описаны в разделе «Статус и диагностика проекта».

      • status.conditions.lastProbeTime
        строка

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

      • status.conditions.lastTransitionTime
        строка

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

      • status.conditions.message
        строка

        Сообщение с подробностями о состоянии условия.

      • status.conditions.status
        строка

        Состояние условия: True, False или Unknown.

      • status.conditions.type
        строка

        Тип условия.

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

      Объекты manifests, которые обновление релиза проекта забирает себе.

      В каждой записи объект и ревизия релиза, которую это обновление должно развернуть. Объект остаётся в кластере, и пока запись есть, manifestObjects его не перечисляет. Запись удаляется, когда обновление развернуло объект. Если обновление его не развернуло, объект возвращается под управление manifests. На него возвращаются лейблы projects.deckhouse.io/project и projects.deckhouse.io/source: manifests, с него снимаются лейблы heritage, app.kubernetes.io/managed-by и projects.deckhouse.io/project-template, и manifestObjects снова его перечисляет.

      Пока обновление забрало бы ещё и объект, который не принадлежит manifests и есть без лейбла app.kubernetes.io/managed-by: Helm и аннотации meta.helm.sh/release-name этого релиза, ни один объект не передаётся. Обновление тогда не запускается, а условие ResourcesUpgraded называет этот объект.

      • status.handingOver.apiVersion
        строка

        Версия API объекта.

      • status.handingOver.kind
        строка

        Тип объекта.

      • status.handingOver.name
        строка

        Имя объекта.

      • status.handingOver.namespace
        строка

        Неймспейс объекта.

      • status.handingOver.revision
        целочисленный

        Ревизия релиза, которую обновление должно развернуть.

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

      Объекты, которые релиз проекта перестал содержать и которые остались на месте вместо удаления.

      Это объекты Helm-текста resourcesTemplate после перехода проекта на структурированные поля, квота, сохранённая на время передачи, после того как .spec.quota перестало её покрывать, и объекты релиза структурированных полей, которые рендерят manifests. Релиз ими больше не управляет. На них стоит лейбл projects.deckhouse.io/kept-from-helm-template: "true", и пока он стоит, менять и удалять их может только тот, кто может сделать то же во всём кластере.

      Объект исчезает из списка, когда его удаляют, снимают с него этот лейбл, релиз снова его рендерит или его забирают manifests. Когда проект удаляют, объекты уровня кластера, на которых ещё стоит этот лейбл, удаляются вместе с ним.

      • status.keptObjects.apiVersion
        строка

        Версия API объекта.

      • status.keptObjects.kind
        строка

        Тип объекта.

      • status.keptObjects.name
        строка

        Имя объекта.

      • status.keptObjects.namespace
        строка

        Неймспейс объекта, пустой для объекта уровня кластера.

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

      Объекты, которые контроллер применил из manifests шаблона проекта от имени пользователя system:multitenancy-manager:project:<PROJECT_NAME>. На них стоят лейбл projects.deckhouse.io/project с именем проекта и лейбл projects.deckhouse.io/source: manifests. Объект, который шаблон больше не создаёт, удаляется и исчезает из списка. Объект, с которого к этому времени сняли один из этих лейблов или неймспейс которого больше не принадлежит проекту, исчезает из списка и остаётся на месте.

      • status.manifestObjects.apiVersion
        строка

        Версия API объекта.

      • status.manifestObjects.kind
        строка

        Тип объекта.

      • status.manifestObjects.name
        строка

        Имя объекта.

      • status.manifestObjects.namespace
        строка

        Неймспейс объекта.

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

      Неймспейсы, принадлежащие проекту.

      • status.namespaces.kind
        строка

        Тип неймспейса (Main или Additional).

      • status.namespaces.name
        строка

        Имя неймспейса.

    • status.observedGeneration
      целочисленный

      Последнее поколение проекта, обработанное контроллером.

    • status.resources
      объект

      Список отрендеренных и пропущенных ресурсов.

    • status.state
      строка

      Состояние проекта: Deployed или Error. Подробности приведены в условиях и их сообщениях.

    • status.templateGeneration
      целочисленный

      Поколение шаблона, по которому проект был отрендерен последним.

    • status.usage
      объект

      Текущее использование квоты проекта.

Описывает проект — изолированное окружение для приложений.

Проект состоит из основного неймспейса с именем проекта, дополнительных неймспейсов (ProjectNamespace), если они есть, а также настроек, политик и объектов, которые описывает его шаблон ProjectTemplate. См. Создание проекта.

  • spec
    объект
    • spec.description
      строка

      Произвольное описание назначения проекта. Укажите пустую строку, если описание не требуется.

    • spec.parameters
      объект

      Значения параметров, которые шаблон объявляет в parametersSchema.

      Структурированные поля шаблона получают их через {fromParam: <NAME>}. manifests и resourcesTemplate получают их в {{ .parameters }}, дополненными значениями по умолчанию из parametersSchema. Значения проверяются по parametersSchema.openAPIV3Schema шаблона при создании и изменении проекта.

    • spec.projectTemplateName
      строка

      Имя ProjectTemplate, по которому создаётся проект.

      Шаблон simple создаёт только неймспейс проекта.

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

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

      Текущее состояние проекта.

      Типы условий описаны в разделе «Статус и диагностика проекта».

      • status.conditions.lastProbeTime
        строка

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

      • status.conditions.lastTransitionTime
        строка

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

      • status.conditions.message
        строка

        Сообщение с подробностями о состоянии условия.

      • status.conditions.status
        строка

        Состояние условия: True, False или Unknown.

      • status.conditions.type
        строка

        Тип условия.

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

      Объекты manifests, которые обновление релиза проекта забирает себе.

      В каждой записи объект и ревизия релиза, которую это обновление должно развернуть. Объект остаётся в кластере, и пока запись есть, manifestObjects его не перечисляет. Запись удаляется, когда обновление развернуло объект. Если обновление его не развернуло, объект возвращается под управление manifests. На него возвращаются лейблы projects.deckhouse.io/project и projects.deckhouse.io/source: manifests, с него снимаются лейблы heritage, app.kubernetes.io/managed-by и projects.deckhouse.io/project-template, и manifestObjects снова его перечисляет.

      Пока обновление забрало бы ещё и объект, который не принадлежит manifests и есть без лейбла app.kubernetes.io/managed-by: Helm и аннотации meta.helm.sh/release-name этого релиза, ни один объект не передаётся. Обновление тогда не запускается, а условие ResourcesUpgraded называет этот объект.

      • status.handingOver.apiVersion
        строка

        Версия API объекта.

      • status.handingOver.kind
        строка

        Тип объекта.

      • status.handingOver.name
        строка

        Имя объекта.

      • status.handingOver.namespace
        строка

        Неймспейс объекта.

      • status.handingOver.revision
        целочисленный

        Ревизия релиза, которую обновление должно развернуть.

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

      Объекты, которые релиз проекта перестал содержать и которые остались на месте вместо удаления.

      Это объекты Helm-текста resourcesTemplate после перехода проекта на структурированные поля, квота, сохранённая на время передачи, после того как .spec.quota перестало её покрывать, и объекты релиза структурированных полей, которые рендерят manifests. Релиз ими больше не управляет. На них стоит лейбл projects.deckhouse.io/kept-from-helm-template: "true", и пока он стоит, менять и удалять их может только тот, кто может сделать то же во всём кластере.

      Объект исчезает из списка, когда его удаляют, снимают с него этот лейбл, релиз снова его рендерит или его забирают manifests. Когда проект удаляют, объекты уровня кластера, на которых ещё стоит этот лейбл, удаляются вместе с ним.

      • status.keptObjects.apiVersion
        строка

        Версия API объекта.

      • status.keptObjects.kind
        строка

        Тип объекта.

      • status.keptObjects.name
        строка

        Имя объекта.

      • status.keptObjects.namespace
        строка

        Неймспейс объекта, пустой для объекта уровня кластера.

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

      Объекты, которые контроллер применил из manifests шаблона проекта от имени пользователя system:multitenancy-manager:project:<PROJECT_NAME>. На них стоят лейбл projects.deckhouse.io/project с именем проекта и лейбл projects.deckhouse.io/source: manifests. Объект, который шаблон больше не создаёт, удаляется и исчезает из списка. Объект, с которого к этому времени сняли один из этих лейблов или неймспейс которого больше не принадлежит проекту, исчезает из списка и остаётся на месте.

      • status.manifestObjects.apiVersion
        строка

        Версия API объекта.

      • status.manifestObjects.kind
        строка

        Тип объекта.

      • status.manifestObjects.name
        строка

        Имя объекта.

      • status.manifestObjects.namespace
        строка

        Неймспейс объекта.

    • status.namespaces
      массив строк

      Неймспейсы проекта.

    • status.observedGeneration
      целочисленный

      Последнее поколение проекта, обработанное контроллером.

    • status.resources
      объект

      Список отрендеренных и пропущенных ресурсов.

    • status.state
      строка

      Состояние проекта: Deployed или Error. Подробности приведены в условиях и их сообщениях.

    • status.templateGeneration
      целочисленный

      Поколение шаблона, по которому проект был отрендерен последним.

Устаревший ресурс. Поддержка ресурса может быть исключена в следующих версиях.

ProjectTemplate

Scope: Cluster

  • v1alpha2
  • v1alpha1

Описывает шаблон проекта как набор структурированных декларативных полей.

На этот ресурс ссылается кастомный ресурс Project. Поля resources и grantPolicies превращаются в объекты ClusterResourceGrantPolicy, которые применяются к проектам этого шаблона. Остальные поля превращаются в объекты в неймспейсах проектов.

Объекты, которые не описывает ни одно структурированное поле, создаются из manifests. Вместо полей, которые рендерят объекты, шаблон, созданный через deckhouse.io/v1alpha1, может содержать Helm-шаблон в resourcesTemplate. Такая форма устарела, и ни один шаблон не может получить новое resourcesTemplate.

Имя virtual зарезервировано за шаблоном виртуальных проектов default и deckhouse: создать ProjectTemplate с этим именем нельзя.

  • spec
    объект
    • spec.allowedGIDs

      Диапазон идентификаторов групп, допустимых в контейнерах проекта.

      Литеральный объект {min, max} или ссылка на параметр {fromParam: "<name>"}.

    • spec.allowedUIDs

      Диапазон идентификаторов пользователей, допустимых в контейнерах проекта.

      Литеральный объект {min, max} или ссылка на параметр {fromParam: "<name>"}.

    • spec.description
      строка

      Произвольное описание назначения шаблона.

      Укажите пустую строку, если описание не требуется.

    • spec.features
      объект

      Опциональные возможности проекта.

      • spec.features.monitoring

        Включить расширенный мониторинг для проекта.

        Литеральное булево значение или ссылка на параметр {fromParam: "<name>"}.

      • spec.features.vulnerabilityScanning

        Включить периодическое сканирование уязвимостей (Trivy) для проекта.

        Литеральное булево значение или ссылка на параметр {fromParam: "<name>"}.

    • spec.grantPolicies
      массив строк

      Ссылки на библиотечные объекты ClusterResourceGrantPolicy (созданные без projectSelector и namespaceSelector).

      Для каждой ссылки контроллер создаёт и поддерживает отдельную управляемую политику, копирует в неё ресурсы библиотечной политики и привязывает их к неймспейсам, созданным по этому шаблону.

    • spec.logShipping
      объект

      Перенаправление логов проекта в кластерное хранилище логов.

      • spec.logShipping.clusterDestinationRef

        Имя ClusterLogDestination для отправки логов.

        Литеральная строка или ссылка на параметр {fromParam: "<name>"}.

    • spec.manifests
      строка

      Шаблон в формате go template с функциями helm, который создаёт объекты в неймспейсах проекта рядом с объектами из структурированных полей.

      Шаблон получает имя проекта в {{ .projectName }}, имя шаблона в {{ .projectTemplateName }} и параметры проекта, дополненные значениями по умолчанию из parametersSchema, в {{ .parameters }}, то есть те же значения, что и resourcesTemplate. Проект, параметры которого превращаются в объекты или ключи отрендеренных манифестов, а не в значения, отклоняется, поэтому заключайте в кавычки каждую подстановку.

      Контроллер применяет объекты через server-side apply от имени пользователя system:multitenancy-manager:project:<PROJECT_NAME>, а ProjectRoleBinding d8-manifests проекта выдаёт этому пользователю роль d8:project:admin. Поэтому объект получает только то, что эта роль разрешает в неймспейсах проекта, а не права контроллера. AuthorizationRule с уровнем доступа Admin отклоняется, когда манифесты создают его или повышают до этого уровня уже существующий, хотя роль это разрешает. Администраторы проекта задаются в .spec.administrators объекта Project. Объекты применяются, когда эта привязка в состоянии Ready, а условие ManifestsApplied проекта показывает, применены ли объекты, и называет объекты, которые отклонил API-сервер, с кодом каждого отказа, например 403.

      Объект без metadata.namespace создаётся в основном неймспейсе проекта, а неймспейс, который указывает объект, должен принадлежать проекту или создаваться ProjectNamespace из тех же manifests. Объекты такого неймспейса применяются, когда он появится, а до этого условие ManifestsApplied называет неймспейсы, которых они ждут. Подробнее в разделе «Дополнительные неймспейсы в manifests». Объекты уровня кластера, объекты в неймспейсах вне проекта и объекты с лейблом heritage: multitenancy-manager или heritage: deckhouse отклоняются. На объекты ставятся лейбл projects.deckhouse.io/project с именем проекта и лейбл projects.deckhouse.io/source: manifests, а .status.manifestObjects проекта перечисляет их. Объект, который шаблон больше не создаёт, удаляется.

      Объект, который перевод проекта с Helm-текста оставил на месте и перечислил в .status.keptObjects, переходит под управление manifests, когда шаблон создаёт объект того же типа с тем же неймспейсом и именем. После этого объект содержит то, что создаёт manifests, а поле, которое задал Helm-текст и не задаёт manifests, удаляется, в том числе аннотации Helm. Через тот же список объект переходит из релиза структурированных полей в manifests. Если структурированные поля перестают создавать объект, который manifests создают с тем же типом, неймспейсом и именем, контроллер оставляет его на месте с лейблом projects.deckhouse.io/kept-from-helm-template: "true" и записывает в .status.keptObjects, а manifests забирают его в том же изменении. Если manifests не могут его применить, объект остаётся в списке. Подробнее в разделе «Перенос объекта релиза в manifests». Любой другой уже существующий объект, который создали не manifests, меняется, только если на нём есть оба лейбла, а иначе его называет условие ManifestsApplied. Объект, который создали manifests и который после изменения шаблон создаёт иначе, например NetworkPolicy isolated после networkPolicy.mode: Isolated, в том же изменении переходит к объектам, которые проект создаёт по шаблону. Он получает то, что создаёт шаблон, а поле, которое задали только manifests, удаляется.

      Как и объекты из структурированных полей, эти объекты меняются только через шаблон. Политика d8-multitenancy-manager-manifests-objects не даёт создать, изменить или удалить объект с лейблом projects.deckhouse.io/source: manifests никому, в том числе администраторам проекта и кластера. Это могут только пользователь, от имени которого применяются manifests проекта, контроллер, ServiceAccount неймспейсов d8-* и компоненты кластера. Перезапустить rollout рабочей нагрузки может любой, кому разрешено её изменять, если единственное изменение — аннотация kubectl.kubernetes.io/restartedAt у шаблона пода. metadata.resourceVersion, metadata.generation и metadata.managedFields не сравниваются, потому что их записывает API-сервер. Через некоторое время контроллер применяет объекты снова и возвращает поля, которые задаёт шаблон, если их изменило что-то ещё. Шаблон проекта могут прочитать и пользователи без доступа к его проектам, в том числе пользователи с уровнем доступа User, поэтому не помещайте в manifests секретные значения.

      Поле нельзя задать вместе с resourcesTemplate. В deckhouse.io/v1alpha1 для него нет места, поэтому запись шаблона с этим полем через deckhouse.io/v1alpha1 отклоняется. Подробнее в разделе «Описание других объектов в manifests».

    • spec.namespaceMetadata
      объект

      Дополнительные лейблы и аннотации для неймспейсов проекта.

      • spec.namespaceMetadata.annotations

        Литеральная карта аннотаций или ссылка на параметр {fromParam: "<name>"}.

        Аннотации ставятся только на основной неймспейс проекта.

      • spec.namespaceMetadata.labels

        Литеральная карта лейблов или ссылка на параметр {fromParam: "<name>"}.

        Лейблы ставятся на все неймспейсы проекта, включая дополнительные, и перечисляются в аннотации projects.deckhouse.io/template-labels каждого из них.

        Лейблы, которыми управляет модуль (heritage, app.kubernetes.io/managed-by, projects.deckhouse.io/*, multitenancy.deckhouse.io/*, лейблы профиля безопасности, мониторинга и сканирования), и лейбл kubernetes.io/metadata.name в этом поле задать нельзя. Шаблон, который задаёт такой лейбл здесь, отклоняется, как и Project, параметры которого передают такой лейбл в это поле. Шаблон или Project, в котором такой лейбл уже есть, можно изменять, пока лейбл остаётся прежним. Лейбл не применяется, и ответ API предупреждает об этом.

        Лейблы отслеживания GitOps (app.kubernetes.io/instance, argocd.argoproj.io/*, kustomize.toolkit.fluxcd.io/*, helm.toolkit.fluxcd.io/*, kapp.k14s.io/*) ставятся только на основной неймспейс. Собственный ключ отслеживания наследуется, как любой другой лейбл.

        Когда неймспейс становится проектом автоматически, его собственные лейблы не копируются в Project и в это поле не попадают. Лейбл, заданный в spec.parameters.namespace.labels ресурса Project, попадает в это поле через встроенные шаблоны и наследуется.

    • spec.networkPolicy
      объект

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

      • spec.networkPolicy.mode

        Режим сетевой изоляции неймспейсов проекта.

        • Isolated — в каждом неймспейсе проекта создаётся NetworkPolicy isolated. Она разрешает входящий трафик только из неймспейсов проекта, от Prometheus, контроллера ingress-nginx и агента service-with-healthchecks, а исходящий — только в неймспейсы проекта и к DNS в kube-system.
        • NotRestricted — NetworkPolicy не создаётся.

        Если поле не задано, NetworkPolicy тоже не создаётся.

        Литеральная строка (Isolated/NotRestricted) или ссылка на параметр {fromParam: "<name>"}. Литерал вне двух значений вебхук отклоняет.

    • spec.nodeSelector

      Селектор узлов для подов основного неймспейса проекта. Литеральная карта лейблов или ссылка на параметр {fromParam: "<name>"}.

      Задаётся аннотацией scheduler.alpha.kubernetes.io/node-selector основного неймспейса и объединяется с селектором узлов каждого пода в нём. Под с конфликтующим селектором отклоняется. Дополнительные неймспейсы проекта его не получают.

    • spec.parametersSchema
      объект

      Схема OpenAPI v3 для параметров проекта.

      Булев параметр requiredRequests, объявленный здесь, читается по имени: если для проекта он равен true, поды во всех неймспейсах проекта должны задавать запросы CPU и памяти (OperationPolicy в режиме Deny).

      • spec.parametersSchema.openAPIV3Schema
        объект

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

        Спецификация OpenAPI, по которой проверяются параметры проекта при его создании и изменении.

    • spec.podSecurityStandard

      Профиль Pod Security Standard, применяемый к неймспейсам проекта.

      • Privileged — политика без ограничений.
      • Baseline — минимально ограничивающая политика, которая предотвращает известные способы повышения привилегий.
      • Restricted — строго ограничивающая политика, которая следует современным практикам защиты подов.

      Литеральная строка (Privileged/Baseline/Restricted) или ссылка на параметр {fromParam: "<name>"}, указывающая на свойство parametersSchema. Литерал вне трёх значений и ссылку на необъявленный параметр или параметр другого типа вебхук отклоняет.

    • spec.resources
      массив объектов

      Правила доступа к cluster-wide-ресурсам для проектов шаблона.

      Контроллер превращает их в ClusterResourceGrantPolicy template-<TEMPLATE_NAME>-inline, которая применяется к неймспейсам проектов этого шаблона.

      Настройки доступа к одному типу cluster-wide-ресурсов.

      • spec.resources.allowed
        массив строк

        Список имён cluster-wide-ресурсов, доступных проектам.

        Объединяется с ресурсами, выбранными с помощью allowedSelector.

      • spec.resources.allowedSelector
        объект

        Селектор лейблов cluster-wide-ресурсов, доступных проектам.

        Объединяется с ресурсами из allowed. Применяется только к cluster-wide-ресурсам, которые представлены объектами Kubernetes.

        • spec.resources.allowedSelector.matchExpressions
          массив объектов

          Список выражений селектора лейблов.

          Должны выполняться все выражения.

          • spec.resources.allowedSelector.matchExpressions.key
            строка

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

            Ключ лейбла, к которому применяется выражение.

          • spec.resources.allowedSelector.matchExpressions.operator
            строка

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

            Оператор, задающий отношение между ключом и набором значений.

          • spec.resources.allowedSelector.matchExpressions.values
            массив строк

            Список значений лейбла.

        • spec.resources.allowedSelector.matchLabels
          объект

          Набор лейблов cluster-wide-ресурсов.

          Должны совпадать все указанные лейблы.

      • spec.resources.availabilityDefault
        строка

        Доступность cluster-wide-ресурсов этого типа, которые не указаны в allowed, allowedSelector, denied и deniedSelector.

        Переопределяет defaultAvailability в GrantableClusterResourceDefinition. Если задан allowed или allowedSelector, а это поле не задано, остальные ресурсы этого типа проектам недоступны.

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

      • spec.resources.default
        строка

        Имя cluster-wide-ресурса, который проекты используют по умолчанию.

        Переопределяет значение, определённое с помощью defaultFrom в GrantableClusterResourceDefinition.

      • spec.resources.denied
        массив строк

        Список имён cluster-wide-ресурсов, недоступных проектам.

        Запрещающие правила имеют приоритет над allowed и allowedSelector.

      • spec.resources.deniedSelector
        объект

        Селектор лейблов cluster-wide-ресурсов, недоступных проектам.

        Запрещающие правила имеют приоритет над allowed и allowedSelector.

        • spec.resources.deniedSelector.matchExpressions
          массив объектов

          Список выражений селектора лейблов.

          Должны выполняться все выражения.

          • spec.resources.deniedSelector.matchExpressions.key
            строка

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

            Ключ лейбла, к которому применяется выражение.

          • spec.resources.deniedSelector.matchExpressions.operator
            строка

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

            Оператор, задающий отношение между ключом и набором значений.

          • spec.resources.deniedSelector.matchExpressions.values
            массив строк

            Список значений лейбла.

        • spec.resources.deniedSelector.matchLabels
          объект

          Набор лейблов cluster-wide-ресурсов.

          Должны совпадать все указанные лейблы.

      • spec.resources.resourceName
        строка

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

        Имя GrantableClusterResourceDefinition, который регистрирует тип cluster-wide-ресурсов.

    • spec.resourcesTemplate
      строка

      Шаблон в формате go template с функциями helm, который рендерит объекты проекта.

      Поле устарело и сохраняется для шаблонов, созданных через deckhouse.io/v1alpha1. Описывайте новые шаблоны структурированными полями и manifests. Ни один шаблон не может получить новое resourcesTemplate ни через одну из версий: создание шаблона с непустым полем и изменение, которое задаёт поле шаблону без него, отклоняются, а создание через deckhouse.io/v1alpha1 отклоняется целиком. Шаблон, у которого поле есть, сохраняет его, и его можно менять через любую из двух версий, пока deckhouse.io/v1alpha1 может описать весь шаблон. Поэтому шаблон с Helm-текстом нельзя создать заново, например из резервной копии или из Git: сначала переведите его на структурированные поля и manifests. Поле уйдёт из deckhouse.io/v1alpha2 вместе с deckhouse.io/v1alpha1 в одном из следующих релизов. Подробнее в разделе «Перевод шаблона с Helm-текста».

      Если поле не пустое, шаблон рендерится из него. Его нельзя задать вместе с полями, которые рендерят объекты в неймспейсы проекта (podSecurityStandard, networkPolicy, namespaceMetadata, manifests и остальные), а resources и grantPolicies действуют в обоих случаях. Шаблон, который используют проекты, сохраняет непустое resourcesTemplate, пока изменение не задаст такие поля или manifests вместо него.

      После такого изменения, как и после перевода проекта на структурированный шаблон, объекты AuthorizationRule и ResourceQuota из Helm-текста, которые заменяют .spec.administrators и .spec.quota проекта, удаляются, когда эти поля заработают, а AuthorizationRule, в котором больше нет никого из .spec.administrators, удаляется сразу. Каждый другой объект Helm-текста, который новые поля не создают с тем же типом и именем, остаётся на месте и перечисляется в .status.keptObjects проекта, пока manifests не создаст объект того же типа с тем же неймспейсом и именем и не возьмёт его под управление. В .status.keptObjects также попадает объект релиза структурированных полей, который рендерят manifests, когда релиз перестаёт его содержать, и остаётся там, пока manifests не заберут его. Подробнее в разделах «Переход проекта с Helm-текста» и «Перенос объекта релиза в manifests».

      Шаблон получает имя проекта в {{ .projectName }}, имя шаблона в {{ .projectTemplateName }} и параметры проекта, дополненные значениями по умолчанию из parametersSchema, в {{ .parameters }}. Если parametersSchema объявляет параметры administrators и resourceQuota, в них передаются администраторы и квота проекта в том виде, в каком их содержит Project deckhouse.io/v1alpha2. Проект, параметры которого превращаются в объекты или ключи отрендеренных манифестов, а не в значения, отклоняется, поэтому заключайте в кавычки каждую подстановку.

      Объект без metadata.namespace или в неймспейсе вне проекта создаётся в основном неймспейсе проекта. Лейблы, которые шаблон ставит на основной неймспейс, кроме лейблов модуля и лейблов отслеживания GitOps, перечисляются в его аннотации projects.deckhouse.io/template-labels и ставятся также на дополнительные неймспейсы.

    • spec.runtimeAudit
      объект

      Правила аудита обращений к ядру; действуют только при заданных allowedUIDs/allowedGIDs.

      • spec.runtimeAudit.enabled

        Литеральное булево значение или ссылка на параметр {fromParam: "<name>"}.

    • spec.title
      строка

      Краткое человекочитаемое имя шаблона.

    • spec.tolerations

      Tolerations по умолчанию для подов основного неймспейса проекта.

      Литеральный список tolerations или ссылка на параметр {fromParam: "<name>"}. Задаются аннотацией scheduler.alpha.kubernetes.io/defaultTolerations основного неймспейса. Дополнительные неймспейсы проекта их не получают.

  • status
    объект
    • status.message
      строка

      Сообщение, указывающее на причину появления текущего статуса.

    • status.ready
      булевый

      Готовность шаблона к использованию. Указывает на то, что шаблон успешно прошёл проверку.

Устаревший ресурс. Поддержка ресурса может быть исключена в следующих версиях.

Описывает шаблон проекта.

На этот ресурс ссылается кастомный ресурс Project.

Версия устарела. Шаблон создаётся через deckhouse.io/v1alpha2, а создание через deckhouse.io/v1alpha1 отклоняется. Шаблоны, созданные через deckhouse.io/v1alpha1 раньше, читаются, меняются и удаляются через эту версию, как и прежде.

  • spec
    объект
    • spec.description
      строка

      Произвольное описание назначения шаблона. Укажите пустую строку, если описание не требуется.

    • spec.parametersSchema
      объект

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

      Схема параметров проекта.

      Поддерживается только openAPIV3Schema.

      • spec.parametersSchema.openAPIV3Schema
        объект

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

        Спецификация OpenAPI для параметров.

        Используется для проверки правильности параметров, передаваемых при создании нового проекта.

    • spec.resourcesTemplate
      строка

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

      Шаблон, определяющий ресурсы в формате go template, создаваемые при настройке нового проекта.

      Шаблоны полностью совместимы со всеми функциями helm.

      Подробнее — в разделе «Перевод шаблона с Helm-текста».

      В шаблонах доступны следующие параметры:

      • {{ .projectName }} — имя Project, для которого рендерится шаблон.
      • {{ .projectTemplateName }} — имя ProjectTemplate.
      • {{ .parameters }} — словарь пользовательских значений, описанных в параметре .spec.parametersSchema и определённых в параметре .spec.parameters.

      .metadata.namespace объекта указывать необязательно: объект без него создаётся в основном неймспейсе проекта.

  • status
    объект
    • status.message
      строка

      Сообщение, указывающее на причину появления текущего статуса.

    • status.ready
      булевый

      Готовность шаблона к использованию. Указывает на то, что шаблон успешно прошёл проверку.