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

Стадия жизненного цикла модуля: General Availability

AuthorizationRule

Scope: Namespaced
Version: v1alpha1

Управляет настройками RBAC и авторизацией в пределах конкретного неймспейса.

Ресурс AuthorizationRule относится к упрощённой ролевой модели. Его права суммируются с правами гранулярной модели.

  • status
    объект

    Наблюдаемое состояние правила, поддерживается user-authz-controller.

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

      Число биндингов, созданных для правила.

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

      Условия правила. Ready=True — все биндинги правила применены; Ready=False с причиной InvalidSpec — правило нельзя отрендерить, биндинги не менялись; с причиной ApplyError — API-сервер отклонил запись (в сообщении указаны биндинг и ошибка).

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

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

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

        Подробности статуса.

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

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

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

        Причина статуса — BindingsApplied, InvalidSpec или ApplyError.

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

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

        Статус условия.

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

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

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

        Тип условия. Контроллер устанавливает Ready.

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

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

  • spec
    объект

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

    • spec.accessLevel
      строка

      Уровень доступа:

      • User — позволяет получать информацию обо всех объектах (включая доступ к журналам подов), но не позволяет заходить в контейнеры, читать секреты и выполнять port-forward;
      • PrivilegedUser — то же самое, что и User, но позволяет заходить в контейнеры, читать секреты, а также удалять поды (что обеспечивает возможность перезагрузки);
      • Editor — то же самое, что и PrivilegedUser, но предоставляет возможность создавать, изменять и удалять все объекты, которые обычно нужны для прикладных задач;
      • Admin — то же самое, что и Editor, но позволяет создавать и изменять поды, выпускать токены ServiceAccount’ов (serviceaccounts/token), управлять объектами Role, RoleBinding и AuthorizationRule и удалять служебные объекты (например, ReplicaSet, challenges и orders группы acme.cert-manager.io).

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

      Пример:

      accessLevel: PrivilegedUser
      
    • spec.allowScale
      булевый

      Разрешить/запретить масштабировать (выполнять scale) объекты Deployment и StatefulSet.

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

    • spec.portForwarding
      булевый

      Разрешить/запретить выполнять port-forward.

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

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

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

      Пользователи, группы и ServiceAccount’ы, которым выдаётся уровень доступа.

      Описание в API Kubernetes

      При использовании совместно с модулем user-authn обратите внимание на следующие нюансы:

      • Для выдачи прав конкретному пользователю в качестве имени необходимо указывать его email.
      • При указании группы убедитесь, что необходимые группы допускаются к получению от провайдера, то есть указаны в соответствующем кастомном ресурсе DexProvider.
      • spec.subjects.kind
        строка

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

        Тип ресурса.

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

        Пример:

        kind: Group
        
      • spec.subjects.name
        строка

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

        Имя ресурса.

        Пример:

        name: some-group-name
        
      • spec.subjects.namespace
        строка

        Namespace для ServiceAccount.

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

        Длина: 1..63

ClusterAuthorizationRule

Scope: Cluster

  • v1
  • v1alpha1

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

Настройки определяют, какой уровень доступа назначен пользователю и/или группе.

Ресурс ClusterAuthorizationRule относится к упрощённой ролевой модели. Его права суммируются с правами гранулярной модели.

  • status
    объект

    Наблюдаемое состояние правила, поддерживается user-authz-controller.

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

      Число биндингов, созданных для правила.

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

      Условия правила. Ready=True — все биндинги правила применены; Ready=False с причиной InvalidSpec — правило нельзя отрендерить, биндинги не менялись; с причиной ApplyError — API-сервер отклонил запись (в сообщении указаны биндинг и ошибка).

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

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

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

        Подробности статуса.

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

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

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

        Причина статуса — BindingsApplied, InvalidSpec или ApplyError.

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

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

        Статус условия.

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

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

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

        Тип условия. Контроллер устанавливает Ready.

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

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

  • spec
    объект

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

    • spec.accessLevel
      строка

      Уровень доступа:

      • User — позволяет получать информацию обо всех объектах (включая доступ к журналам подов), но не позволяет заходить в контейнеры, читать секреты и выполнять port-forward;
      • PrivilegedUser — то же самое, что и User, но позволяет заходить в контейнеры, читать секреты, а также удалять поды (что обеспечивает возможность перезагрузки);
      • Editor — то же самое, что и PrivilegedUser, но предоставляет возможность создавать, изменять и удалять все объекты, которые обычно нужны для прикладных задач;
      • Admin — то же самое, что и Editor, но позволяет создавать и изменять поды, выпускать токены ServiceAccount’ов (serviceaccounts/token), управлять объектами Role, RoleBinding и AuthorizationRule и удалять служебные объекты (например, ReplicaSet, challenges и orders группы acme.cert-manager.io);
      • ClusterEditor — то же самое, что и Editor, но позволяет управлять ограниченным набором cluster-wide-объектов для прикладных задач (DaemonSet, StorageClass, CustomResourceDefinition, GatewayClass и объекты, которые модули добавляют на этот уровень, например KeepalivedInstance). Роль для работы оператора кластера;
      • ClusterAdmin — то же самое, что и ClusterEditor + Admin, но позволяет управлять служебными cluster-wide-объектами (неймспейсы, квоты, NetworkPolicy, подресурсы узлов для proxy, ClusterAuthorizationRule, ClusterRole и ClusterRoleBinding). Роль для работы администратора кластера.

        Внимание. ClusterAdmin может создавать объекты ClusterAuthorizationRule с уровнем не выше ClusterAdmin и объекты ClusterRoleBinding только на роли, права которых у него уже есть.

      • SuperAdmin — разрешены любые действия с любыми объектами, при этом ограничения namespaceSelector и limitNamespaces (см. ниже) продолжат работать.

      Допустимые значения: User, PrivilegedUser, Editor, Admin, ClusterEditor, ClusterAdmin, SuperAdmin

      Пример:

      accessLevel: PrivilegedUser
      
    • spec.additionalRoles
      массив объектов

      Дополнительные роли, которые необходимо выдать для заданных subjects.

      Вместо него используйте параметр accessLevel: этот параметр — для исключительных случаев.

      Пример:

      additionalRoles:
      - apiGroup: rbac.authorization.k8s.io
        kind: ClusterRole
        name: cluster-admin
      
      • spec.additionalRoles.apiGroup
        строка

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

        API-группа роли. Поддерживается только rbac.authorization.k8s.io.

        Пример:

        apiGroup: rbac.authorization.k8s.io
        
      • spec.additionalRoles.kind
        строка

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

        Kind роли.

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

        Пример:

        kind: ClusterRole
        
      • spec.additionalRoles.name
        строка

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

        Название роли.

        Пример:

        name: cluster-admin
        
    • spec.allowAccessToSystemNamespaces
      Параметр устарел
      булевый

      Доступно в редакциях: BE, SE, SE+, Ultimate/EE, Certified Core/CSE Lite (1.73), Certified Pro/CSE Pro (1.73)

      Разрешить пользователю доступ в системные неймспейсы (kube-*, d8-*, default).

      Требует параметра enableMultiTenancy. Пока он выключен, правило с этим полем отклоняется, а правило, в котором поле уже задано, применяется без ограничений по неймспейсам — во всех неймспейсах кластера.

      Ограничения правила по неймспейсам применяет вебхук авторизации, поэтому они не действуют на субъекты, которые вебхук не проверяет: компоненты control plane, kubelet и ServiceAccount’ы неймспейса kube-system и неймспейсов, имена которых начинаются с d8-. Для них уровень доступа правила действует во всех неймспейсах.

      Параметр устарел, используйте вместо него параметр namespaceSelector.

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

    • spec.allowScale
      булевый

      Разрешить/запретить масштабировать (выполнять scale) объекты Deployment и StatefulSet.

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

    • spec.limitNamespaces
      Параметр устарел
      массив строк

      Доступно в редакциях: BE, SE, SE+, Ultimate/EE, Certified Core/CSE Lite (1.73), Certified Pro/CSE Pro (1.73)

      Список разрешённых неймспейсов в формате регулярных выражений.

      Каждый шаблон должен совпадать с именем неймспейса целиком: team не подходит для team-2. Шаблон, который не является корректным регулярным выражением RE2, отклоняется при записи правила. Если проверка его не распознала, шаблон игнорируется, правило открывает меньше неймспейсов и срабатывает алерт D8UserAuthzWebhookRulesQuarantined.

      Политика:

      • Если список указан, разрешаем доступ только по нему.
      • Если список не указан, считаем, что разрешено всё, кроме системных неймспейсов (см. поле allowAccessToSystemNamespaces).

      Требует параметра enableMultiTenancy. Пока он выключен, правило с этим полем отклоняется, а правило, в котором поле уже задано, применяется без ограничений по неймспейсам — во всех неймспейсах кластера.

      Ограничения правила по неймспейсам применяет вебхук авторизации, поэтому они не действуют на субъекты, которые вебхук не проверяет: компоненты control plane, kubelet и ServiceAccount’ы неймспейса kube-system и неймспейсов, имена которых начинаются с d8-. Для них уровень доступа правила действует во всех неймспейсах.

      Параметр устарел, используйте вместо него параметр namespaceSelector.

      Пример:

      limitNamespaces: production-.*
      
      • Элемент массива
        строка
    • spec.namespaceSelector
      объект

      Доступно в редакциях: BE, SE, SE+, Ultimate/EE, Certified Core/CSE Lite (1.73), Certified Pro/CSE Pro (1.73)

      Определяет доступные неймспейсы на основе значений, указанных в параметре namespaceSelector.labelSelector.

      Если параметр namespaceSelector указан, значения параметров limitNamespaces и allowAccessToSystemNamespaces игнорируются. Таким образом, будут доступны либо все неймспейсы с лейблами, подпадающими под указанные в параметре namespaceSelector.labelSelector условия (включая системные неймспейсы), либо все неймспейсы (включая системные), если указан параметр namespaceSelector.matchAny.

      Если параметр namespaceSelector не указан, набор доступных неймспейсов определяется значением параметров limitNamespaces и allowAccessToSystemNamespaces. Если не указан ни один из параметров namespaceSelector, limitNamespaces и allowAccessToSystemNamespaces, будут доступны все неймспейсы, за исключением системных (kube-*, d8-*, default).

      Требует параметра enableMultiTenancy. Пока он выключен, правило с этим полем отклоняется, а правило, в котором поле уже задано, применяется без ограничений по неймспейсам — во всех неймспейсах кластера.

      Ограничения правила по неймспейсам применяет вебхук авторизации, поэтому они не действуют на субъекты, которые вебхук не проверяет: компоненты control plane, kubelet и ServiceAccount’ы неймспейса kube-system и неймспейсов, имена которых начинаются с d8-. Для них уровень доступа правила действует во всех неймспейсах.

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

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

        Не может использоваться совместно с параметром matchAny.

        Если указаны одновременно matchExpressions и matchLabels, учитываются оба фильтра (AND). Если указано несколько условий matchExpressions, должны выполняться все.

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

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

          Пример:

          matchExpressions:
          - key: tier
            operator: In
            values:
            - production
            - staging
          - key: tier
            operator: NotIn
            values:
            - production
          
          • spec.namespaceSelector.labelSelector.matchExpressions.key
            строка

            Имя лейбла.

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

            Оператор сравнения.

            Допустимые значения: In, NotIn, Exists, DoesNotExist

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

            Значение лейбла.

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

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

              Длина: 1..63

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

          Набор лейблов, которые должны быть у неймспейса.

          Пример:

          matchLabels:
            foo: bar
            baz: who
          
      • spec.namespaceSelector.matchAny
        булевый

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

        Не может использоваться совместно с параметром labelSelector.

        Так как с помощью параметра labelSelector можно предоставить доступ только к определённому перечню неймспейсов, параметр matchAny необходим в случаях, когда нужно предоставить доступ ко всем неймспейсам.

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

    • spec.portForwarding
      булевый

      Разрешить/запретить выполнять port-forward.

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

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

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

      Пользователи, группы и ServiceAccount’ы, которым выдаётся уровень доступа.

      Описание в API Kubernetes

      При использовании совместно с модулем user-authn обратите внимание на следующие нюансы:

      • Для выдачи прав конкретному пользователю в качестве имени необходимо указывать его email.
      • При указании группы убедитесь, что необходимые группы допускаются к получению от провайдера, то есть указаны в соответствующем кастомном ресурсе DexProvider.
      • spec.subjects.kind
        строка

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

        Тип ресурса.

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

        Пример:

        kind: Group
        
      • spec.subjects.name
        строка

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

        Имя ресурса.

        Пример:

        name: some-group-name
        
      • spec.subjects.namespace
        строка

        Неймспейс ServiceAccount. Ограничения правила по неймспейсам не действуют на ServiceAccount’ы неймспейса kube-system и неймспейсов, имена которых начинаются с d8-: их вебхук авторизации не проверяет.

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

        Длина: 1..63

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

Cluster-wide-ресурс для управления настройками RBAC и авторизацией.

Ресурс ClusterAuthorizationRule относится к упрощённой ролевой модели. Его права суммируются с правами гранулярной модели.

  • status
    объект

    Наблюдаемое состояние правила, поддерживается user-authz-controller.

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

      Число биндингов, созданных для правила.

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

      Условия правила. Ready=True — все биндинги правила применены; Ready=False с причиной InvalidSpec — правило нельзя отрендерить, биндинги не менялись; с причиной ApplyError — API-сервер отклонил запись (в сообщении указаны биндинг и ошибка).

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

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

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

        Подробности статуса.

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

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

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

        Причина статуса — BindingsApplied, InvalidSpec или ApplyError.

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

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

        Статус условия.

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

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

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

        Тип условия. Контроллер устанавливает Ready.

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

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

  • spec
    объект

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

    • spec.accessLevel
      строка

      Уровень доступа:

      • User — позволяет получать информацию обо всех объектах (включая доступ к журналам подов), но не позволяет заходить в контейнеры, читать секреты и выполнять port-forward;
      • PrivilegedUser — то же самое, что и User, но позволяет заходить в контейнеры, читать секреты, а также удалять поды (что обеспечивает возможность перезагрузки);
      • Editor — то же самое, что и PrivilegedUser, но предоставляет возможность создавать, изменять и удалять все объекты, которые обычно нужны для прикладных задач;
      • Admin — то же самое, что и Editor, но позволяет создавать и изменять поды, выпускать токены ServiceAccount’ов (serviceaccounts/token), управлять объектами Role, RoleBinding и AuthorizationRule и удалять служебные объекты (например, ReplicaSet, challenges и orders группы acme.cert-manager.io);
      • ClusterEditor — то же самое, что и Editor, но позволяет управлять ограниченным набором cluster-wide-объектов для прикладных задач (DaemonSet, StorageClass, CustomResourceDefinition, GatewayClass и объекты, которые модули добавляют на этот уровень, например KeepalivedInstance). Роль для работы оператора кластера;
      • ClusterAdmin — то же самое, что и ClusterEditor + Admin, но позволяет управлять служебными cluster-wide-объектами (неймспейсы, квоты, NetworkPolicy, подресурсы узлов для proxy, ClusterAuthorizationRule, ClusterRole и ClusterRoleBinding). Роль для работы администратора кластера.

        Внимание. ClusterAdmin может создавать объекты ClusterAuthorizationRule с уровнем не выше ClusterAdmin и объекты ClusterRoleBinding только на роли, права которых у него уже есть.

      • SuperAdmin — разрешены любые действия с любыми объектами, при этом ограничения limitNamespaces (см. ниже) продолжат работать.

      Допустимые значения: User, PrivilegedUser, Editor, Admin, ClusterEditor, ClusterAdmin, SuperAdmin

      Пример:

      accessLevel: PrivilegedUser
      
    • spec.additionalRoles
      массив объектов

      Дополнительные роли, которые необходимо выдать для заданных subjects.

      Вместо него используйте параметр accessLevel: этот параметр — для исключительных случаев.

      Пример:

      additionalRoles:
      - apiGroup: rbac.authorization.k8s.io
        kind: ClusterRole
        name: cluster-admin
      
      • spec.additionalRoles.apiGroup
        строка

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

        API-группа роли. Поддерживается только rbac.authorization.k8s.io.

        Пример:

        apiGroup: rbac.authorization.k8s.io
        
      • spec.additionalRoles.kind
        строка

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

        Kind роли.

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

        Пример:

        kind: ClusterRole
        
      • spec.additionalRoles.name
        строка

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

        Название роли.

        Пример:

        name: cluster-admin
        
    • spec.allowAccessToSystemNamespaces
      Параметр устарел
      булевый

      Доступно в редакциях: BE, SE, SE+, Ultimate/EE, Certified Core/CSE Lite (1.73), Certified Pro/CSE Pro (1.73)

      Разрешить пользователю доступ в системные неймспейсы (kube-*, d8-*, default).

      Требует параметра enableMultiTenancy. Пока он выключен, правило с этим полем отклоняется, а правило, в котором поле уже задано, применяется без ограничений по неймспейсам — во всех неймспейсах кластера.

      Ограничения правила по неймспейсам применяет вебхук авторизации, поэтому они не действуют на субъекты, которые вебхук не проверяет: компоненты control plane, kubelet и ServiceAccount’ы неймспейса kube-system и неймспейсов, имена которых начинаются с d8-. Для них уровень доступа правила действует во всех неймспейсах.

      Параметр устарел, используйте вместо него параметр namespaceSelector (версия v1 ресурса).

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

    • spec.allowScale
      булевый

      Разрешить/запретить масштабировать (выполнять scale) объекты Deployment и StatefulSet.

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

    • spec.limitNamespaces
      Параметр устарел
      массив строк

      Доступно в редакциях: BE, SE, SE+, Ultimate/EE, Certified Core/CSE Lite (1.73), Certified Pro/CSE Pro (1.73)

      Список разрешённых неймспейсов в формате регулярных выражений.

      Каждый шаблон должен совпадать с именем неймспейса целиком: team не подходит для team-2. Шаблон, который не является корректным регулярным выражением RE2, отклоняется при записи правила. Если проверка его не распознала, шаблон игнорируется, правило открывает меньше неймспейсов и срабатывает алерт D8UserAuthzWebhookRulesQuarantined.

      Политика:

      • Если список указан, разрешаем доступ только по нему.
      • Если список не указан, считаем, что разрешено всё, кроме системных неймспейсов (см. поле allowAccessToSystemNamespaces).

      Требует параметра enableMultiTenancy. Пока он выключен, правило с этим полем отклоняется, а правило, в котором поле уже задано, применяется без ограничений по неймспейсам — во всех неймспейсах кластера.

      Ограничения правила по неймспейсам применяет вебхук авторизации, поэтому они не действуют на субъекты, которые вебхук не проверяет: компоненты control plane, kubelet и ServiceAccount’ы неймспейса kube-system и неймспейсов, имена которых начинаются с d8-. Для них уровень доступа правила действует во всех неймспейсах.

      Параметр устарел, используйте вместо него параметр namespaceSelector (версия v1 ресурса).

      Пример:

      limitNamespaces: production-.*
      
      • Элемент массива
        строка
    • spec.portForwarding
      булевый

      Разрешить/запретить выполнять port-forward.

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

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

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

      Пользователи, группы и ServiceAccount’ы, которым выдаётся уровень доступа.

      Описание в API Kubernetes

      При использовании совместно с модулем user-authn обратите внимание на следующие нюансы:

      • Для выдачи прав конкретному пользователю в качестве имени необходимо указывать его email.
      • При указании группы убедитесь, что необходимые группы допускаются к получению от провайдера, то есть указаны в соответствующем кастомном ресурсе DexProvider.
      • spec.subjects.kind
        строка

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

        Тип ресурса.

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

        Пример:

        kind: Group
        
      • spec.subjects.name
        строка

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

        Имя ресурса.

        Пример:

        name: some-group-name
        
      • spec.subjects.namespace
        строка

        Неймспейс ServiceAccount. Ограничения правила по неймспейсам не действуют на ServiceAccount’ы неймспейса kube-system и неймспейсов, имена которых начинаются с d8-: их вебхук авторизации не проверяет.

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

        Длина: 1..63