Deckhouse Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.
Стадия жизненного цикла модуля: Preview
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[].fieldsAvailableClusterResource под заданным именем.Правила:
- Применяется только для определений с
grantedResource, и этот ресурс должен быть cluster-scoped. Для значений, которые не представлены объектами Kubernetes, параметр указывать нельзя. - Можно указать не более 10 полей.
- Поле, значения которого в ресурсе нет, не выводится.
- Значение длиннее 512 байт в JSON-сериализации не выводится.
- Если
status.availableодного AvailableClusterResource с полями всех ресурсов занимал бы в JSON-сериализации больше 512 КиБ, поля в нём не выводятся вовсе.
Пути проверяются при создании и изменении объекта, некорректный элемент отклоняется. Результат проверки сохранённого объекта показывает условие
CatalogFieldsValid. О значениях, пропущенных из-за размера, сообщают предупреждающие событияCatalogFieldsSkippedна GrantableClusterResourceDefinition.Внимание. Значения видны всем пользователям каждого проекта, которому доступен ресурс. Указывайте только несекретные данные.
Поле cluster-wide-ресурса, которое показывается проектам.
- строкаspec.catalogFields.name
Обязательный параметр
Имя поля в
status.available[].fieldsAvailableClusterResource в формате 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(ConfigMapquota-ledger-suspendприостановил проверку суммы),WebhookMissing(вебхука счётчика квот нет или егоcaBundleне совпадает с CA сертификата счётчика),WebhookMisconfigured(вебхук изменён так, что записиd8-project-quotaне доходят до счётчика),WebhookNotCalled(какой-то API-сервер допускает объекты, не вызывая этот вебхук),KeyNotServed(какой-то ключ ничего не считает: API-сервер ещё не обслуживает ресурс ключаcount/или модуль, который обслуживает ресурсы ключа, выключен) илиKeyRollout(ResourceQuotad8-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через ProjectRoleBindingd8-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для проекта, которое выдаёт capabilitymanage_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>, а ProjectRoleBindingd8-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и который после изменения шаблон создаёт иначе, например NetworkPolicyisolatedпосле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— в каждом неймспейсе проекта создаётся NetworkPolicyisolated. Она разрешает входящий трафик только из неймспейсов проекта, от 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, в них передаются администраторы и квота проекта в том виде, в каком их содержит Projectdeckhouse.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
Готовность шаблона к использованию. Указывает на то, что шаблон успешно прошёл проверку.