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

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

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

ClusterPeer

Короткие имена: cpeer

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

Пиринг с другим кластером.
  • spec
    объект
    • spec.capabilities
      массив строк
      Имена объектов PeeringCapability, доступных модулям другого кластера.
      • spec.capabilities.Элемент массива
        строка

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

    • spec.invite
      объект
      Параметры для типа Invite.
      • spec.invite.expectedClusterUUID
        строка
        UUID кластера, которому разрешено подключиться.

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

      • spec.invite.tokenTTL
        строка
        Срок действия строки подключения.
    • spec.join
      объект
      Параметры для типа Join.
      • spec.join.connectionString
        строка

        Строка подключения, выпущенная другим кластером.

        Без права на подресурс clusterpeers/sensitive API возвращает вместо значения <omitted>.

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

      • spec.join.expectedClusterUUID
        строка
        UUID кластера, выпустившего строку подключения.

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

    • spec.type
      строка

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

      Роль кластера в пиринге: Invite или Join.

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

  • status
    объект
    • status.access
      объект
      • status.access.audiences
        массив объектов
        • status.access.audiences.audience
          строка
        • status.access.audiences.capability
          строка
      • status.access.caBundle
        строка
      • status.access.endpoint
        строка
    • status.conditions
      массив объектов

      Состояние пиринга.

      • Ready — работает ли пиринг; при False — причина сбоя.
      • ClientCertEnforced — отклоняет ли вход peering-gateway запрос без клиентского сертификата: ClientCertRequired — отклоняет; ClientCertNotRequired — пропускает; EntranceUnreachable — самопроверка не смогла это определить: вход не ответил или ответил, не обслуживая запрос.
      • ServerCertOurs — предъявляет ли вход peering-gateway сертификат, выпущенный пиринговым CA этого кластера на его хост: PeeringRootCert — предъявляет; ForeignCert — нет или выпущенный пиринговым CA сертификат входа просрочен либо ещё не действует, и пиры не смогут подключиться; EntranceUnreachable — рукопожатие не принесло сертификата.
      • TokenExchangeReady — сделал ли user-authn готовым TokenExchangeProvider пира, через который Dex этого кластера меняет токены потребителей пира: ProviderReady — сделал; ProviderPending — провайдер только что создан или изменён, и user-authn его ещё не применил; ProviderDeleting — провайдер удаляется и будет создан заново, когда удалится; PrefixConflict, InvalidSpec, DiscoveryFailed, ApplyError — причина, которую провайдеру дал user-authn, как есть и с его сообщением (ProviderNotReady — если причину или статус провайдера не прочитать); ProviderRejected — API-сервер отказал в чтении или записи провайдера или ключи пира — не JWK Set; ForeignProvider — имя провайдера занято объектом, который записал не модуль; AwaitingIssuer — пир ещё не опубликовал издателя своих токенов ServiceAccount.

      ClientCertEnforced и ServerCertOurs на Ready не влияют; TokenExchangeReady — тоже, кроме ProviderRejected и ForeignProvider: с ними проход завершается сбоем и Ready=False.

      • status.conditions.lastTransitionTime
        строка
      • status.conditions.message
        строка
      • status.conditions.observedGeneration
        целое число

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

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

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

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

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

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

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

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

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

    • status.grants
      массив объектов
      Доступ модулей другого кластера по возможностям.
      • status.grants.capability
        строка
        Имя возможности.
      • status.grants.namespaces
        массив строк
        Неймспейсы, в которых действует доступ.
    • status.invite
      объект
      Выпущенная строка подключения.
      • status.invite.connectionString
        строка

        Строка подключения.

        Без права на подресурс clusterpeers/sensitive API возвращает вместо значения <omitted>.

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

      • status.invite.expiresAt
        строка
        Время истечения строки подключения.
      • status.invite.tokenHash
        строка
        Хеш строки подключения.

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

      • status.invite.tokenID
        строка
        Идентификатор строки подключения.

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

      • status.invite.used
        булевый
        Использована ли строка подключения.
    • status.observedGeneration
      целое число
    • status.offer
      объект
      Данные, которые получает другой кластер.
      • status.offer.capabilities
        массив объектов
        Возможности пиринга.
        • status.offer.capabilities.name
          строка
          Имя возможности.
        • status.offer.capabilities.scope
          массив строк
          Область действия возможности: project или cluster.
        • status.offer.capabilities.version
          строка
          Версия возможности.
      • status.offer.issuer
        объект
        Издатель токенов ServiceAccount.
        • status.offer.issuer.jwks
          строка
          Открытые ключи издателя в формате JWKS.
        • status.offer.issuer.url
          строка
          URL издателя.
      • status.offer.peeringVersion
        строка
        Версия модуля peering.

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

      • status.offer.projects
        массив объектов
        Проекты, доступные для сопряжения.
        • status.offer.projects.name
          строка
          Имя проекта.
        • status.offer.projects.namespaces
          массив строк
          Неймспейсы проекта.
    • status.pairedProjectsCount
      целое число
      Число сопряжённых проектов.
    • status.peer
      объект
      Данные, полученные от другого кластера.
      • status.peer.alias
        строка

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

      • status.peer.capabilities
        массив объектов
        Возможности пиринга.
        • status.peer.capabilities.name
          строка
          Имя возможности.

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

        • status.peer.capabilities.scope
          массив строк
          Область действия возможности: project или cluster.
          • status.peer.capabilities.scope.Элемент массива
            строка

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

        • status.peer.capabilities.version
          строка
          Версия возможности.

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

      • status.peer.clusterUUID
        строка

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

      • status.peer.endpoint
        строка

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

      • status.peer.issuer
        объект
        Издатель токенов ServiceAccount.
        • status.peer.issuer.jwks
          строка
          Открытые ключи издателя в формате JWKS.

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

        • status.peer.issuer.url
          строка
          URL издателя.

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

      • status.peer.lastSyncTime
        строка
      • status.peer.peeringVersion
        строка
        Версия модуля peering.

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

      • status.peer.projects
        массив объектов
        Проекты, доступные для сопряжения.
        • status.peer.projects.name
          строка
          Имя проекта.

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

        • status.peer.projects.namespaces
          массив строк
          Неймспейсы проекта.
          • status.peer.projects.namespaces.Элемент массива
            строка

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

    • status.phase
      строка

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

PeeringCapability

Короткие имена: peercap

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

Возможность модуля Deckhouse Platform в пиринге.
  • spec
    объект
    • spec.consumers
      массив объектов
      ServiceAccount контроллеров модуля.
      • spec.consumers.kind
        строка

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

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

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

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

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

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

    • spec.rules
      массив объектов
      Правила доступа к ресурсам.
      • spec.rules.apiGroups
        массив строк
        • spec.rules.apiGroups.Элемент массива
          строка

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

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

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

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

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

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

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

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

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

    • spec.version
      строка

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

      Версия возможности.

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

  • status
    объект
    Статус проверки возможности пиринга.
    • status.conditions
      массив объектов
      • status.conditions.lastTransitionTime
        строка
      • status.conditions.message
        строка
      • status.conditions.observedGeneration
        целое число

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

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

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

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

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

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

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

    • status.observedGeneration
      целое число

ProjectPeer

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

Сопряжение проекта с одноимённым проектом в другом кластере.
  • status
    объект
    • status.capabilities
      массив объектов
      Возможности пиринга в проекте.
      • status.capabilities.name
        строка
        Имя возможности.
      • status.capabilities.scope
        массив строк
        Область действия возможности: project или cluster.
      • status.capabilities.version
        строка
        Версия возможности.
    • status.clusterUUID
      строка
      UUID другого кластера.
    • status.message
      строка
      Подробности состояния.
    • status.reason
      строка
      Причина состояния.
    • status.remoteNamespaces
      массив строк
      Неймспейсы проекта в другом кластере.
    • status.state
      строка
      Состояние сопряжения.

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