Предварительная версия. Функциональность может измениться, но основные возможности сохранятся. Совместимость с будущими версиями может потребовать ручных действий по миграции.

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

CodeInstance

Scope: Cluster
Version: v1

CodeInstance is the Schema for the codeinstances API.
  • apiVersion
    строка
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    строка
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    объект
  • spec
    объект
    CodeInstanceSpec defines the desired state of the CodeInstance.
    • spec.appConfig
      объект
      AppConfig параметры, которые можно использовать для изменения общих настроек компонентов Rails

      По умолчанию: {}

      • spec.appConfig.contentSecurityPolicy
        объект
        настройка параметров contentSecurityPolicy

        По умолчанию: {}

        • spec.appConfig.contentSecurityPolicy.directives
          объект
          словарь директив для contentSecurityPolicy

          По умолчанию: {}

          • spec.appConfig.contentSecurityPolicy.directives.child_src
            строка
          • spec.appConfig.contentSecurityPolicy.directives.connect_src
            строка
          • spec.appConfig.contentSecurityPolicy.directives.default_src
            строка
          • spec.appConfig.contentSecurityPolicy.directives.font_src
            строка
          • spec.appConfig.contentSecurityPolicy.directives.frame_ancestors
            строка
          • spec.appConfig.contentSecurityPolicy.directives.frame_src
            строка
          • spec.appConfig.contentSecurityPolicy.directives.img_src
            строка
          • spec.appConfig.contentSecurityPolicy.directives.media_src
            строка
          • spec.appConfig.contentSecurityPolicy.directives.object_src
            строка
          • spec.appConfig.contentSecurityPolicy.directives.script_src
            строка
          • spec.appConfig.contentSecurityPolicy.directives.style_src
            строка
        • spec.appConfig.contentSecurityPolicy.enabled
          булевый
          включение contentSecurityPolicy

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

        • spec.appConfig.contentSecurityPolicy.reportOnly
          булевый
          использование contentSecurityPolicy в режиме reportOnly

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

      • spec.appConfig.cronJobs
        объект
        Список задач выполняемыемых периодически для самовосстановления, выполнения синхронизации и т.д.

        По умолчанию: {}

        • spec.appConfig.cronJobs.additionalProperties
          объект
          • spec.appConfig.cronJobs.additionalProperties.cron
            строка

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

            Schedule for job
          • spec.appConfig.cronJobs.additionalProperties.jobClass
            строка
            Warning!: For advanced usage only. Overrides class for job execution
      • spec.appConfig.customHtmlHeaderTags
        строка
        дополнительные пользовательские HTML header теги для интерфейса

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

      • spec.appConfig.defaultColorMode
        строка
        тема интерфейса по умолчанию

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

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

      • spec.appConfig.ldap
        объект
        раздел с настройками интеграции LDAP
        • spec.appConfig.ldap.preventSignin
          булевый
          Отключить авторизацию в UI через LDAP для пользователей

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

        • spec.appConfig.ldap.servers
          объект

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

          конфигурация LDAP-серверов

          По умолчанию: {}

          • spec.appConfig.ldap.servers.additionalProperties
            объект

            По умолчанию: {}

            • spec.appConfig.ldap.servers.additionalProperties.activeDirectory
              булевый
              настройка, указывающая что LDAP сервер является Active Directory LDAP сервером

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

            • spec.appConfig.ldap.servers.additionalProperties.allowUsernameOrEmailLogin
              булевый
              Если включено, Gitlab игнорирует все после первого @ в LDAP логине отправленном пользователем для авторизации

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

            • spec.appConfig.ldap.servers.additionalProperties.attributes
              объект
              Настройки для маппинга LDAP атрибутов

              По умолчанию: {}

              • spec.appConfig.ldap.servers.additionalProperties.attributes.email
                массив строк
                LDAP атрибут для эл. почты пользователя

                По умолчанию: [ "mail", "email", "userPrincipalName" ]

              • spec.appConfig.ldap.servers.additionalProperties.attributes.firstName
                строка
                LDAP атрибут для имени пользователя

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

              • spec.appConfig.ldap.servers.additionalProperties.attributes.lastName
                строка
                LDAP атрибут для фамилии пользователя

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

              • spec.appConfig.ldap.servers.additionalProperties.attributes.name
                строка
                LDAP атрибут для отображемого имени

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

              • spec.appConfig.ldap.servers.additionalProperties.attributes.username
                массив строк
                @username c которым будет связан аккаунт Code. Если параметр содержит эл. почту то логином в Code будет часть строки до @

                По умолчанию: [ "uid", "userid", "sAMAccountName" ]

            • spec.appConfig.ldap.servers.additionalProperties.base
              строка

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

              Базовый DN, от которого производится поиск пользователей

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

            • spec.appConfig.ldap.servers.additionalProperties.bindDn
              строка
              Полный DN пользователя, которым вы подключаетесь для синхронизации

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

            • spec.appConfig.ldap.servers.additionalProperties.blockAutoCreatedUsers
              булевый
              Настройка для блокировки пользователей до рассмотрения администратором

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

            • spec.appConfig.ldap.servers.additionalProperties.encryption
              строка

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

              Метод шифрования для подключения

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

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

            • spec.appConfig.ldap.servers.additionalProperties.groupSync
              объект
              настройка синхронизации групп и членства пользователей в группах

              По умолчанию: {}

              • spec.appConfig.ldap.servers.additionalProperties.groupSync.base
                строка

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

                базовый DN, от которого производится поиск групп

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

              • spec.appConfig.ldap.servers.additionalProperties.groupSync.createGroups
                булевый
                создавать группы автоматически

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

              • spec.appConfig.ldap.servers.additionalProperties.groupSync.filter
                строка
                фильтр LDAP групп в формате RFC 4515

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

              • spec.appConfig.ldap.servers.additionalProperties.groupSync.nameMask
                строка
                Регулярное выражение для извлечения имен групп из DN

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

              • spec.appConfig.ldap.servers.additionalProperties.groupSync.owner
                строка
                Владелец групп, синхронизированных с LDAP. По умолчанию root

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

              • spec.appConfig.ldap.servers.additionalProperties.groupSync.prefix
                объект
                Опциональная секция для настройки вложенной групповой иерархии

                По умолчанию: {}

                • spec.appConfig.ldap.servers.additionalProperties.groupSync.prefix.attribute
                  строка

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

                  Имя аттрибута, содержащего информацию о родительской группе

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

                • spec.appConfig.ldap.servers.additionalProperties.groupSync.prefix.default
                  строка

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

                  Имя родительской группы по умолчанию (при ненахождении аттрибута prefix.attribute)

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

                • spec.appConfig.ldap.servers.additionalProperties.groupSync.prefix.nameMask
                  строка
                  Регулярное выражение для извлечения имени родительской группы из CN
              • spec.appConfig.ldap.servers.additionalProperties.groupSync.roleMapping
                массив объектов
                Cписок словарей маппинга ролей, извлеченных из имен LDAP-групп на роли Gitlab

                По умолчанию: []

                • spec.appConfig.ldap.servers.additionalProperties.groupSync.roleMapping.byName
                  строка
                  регулярное выражение для извлечения имени роли из группы LDAP

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

                • spec.appConfig.ldap.servers.additionalProperties.groupSync.roleMapping.gitlabRole
                  строка
                  имя роли в Gitlab

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

                  Допустимые значения: Guest, Planner, Reporter, Developer, Maintainer, Owner

              • spec.appConfig.ldap.servers.additionalProperties.groupSync.scope
                число
                Скоуп поиска групп (0 — Base, 1 — SingleLevel, 2 — WholeSubtree)

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

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

              • spec.appConfig.ldap.servers.additionalProperties.groupSync.topLevelGroup
                строка
                Имя родительской группы, куда проводить синхронизацию LDAP групп. При отстутствии группы синхронизация будет происходить в корневую группу

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

            • spec.appConfig.ldap.servers.additionalProperties.host
              строка

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

              FQDN-адрес LDAP сервера

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

            • spec.appConfig.ldap.servers.additionalProperties.label
              строка

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

              Человеко-читаемое имя для LDAP сервера

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

            • spec.appConfig.ldap.servers.additionalProperties.lowercaseUsernames
              булевый
              Если задано, то Gitlab перевод логин пользователя в нижний регистр

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

            • spec.appConfig.ldap.servers.additionalProperties.password
              строка
              Пароль пользователя для синхронизации

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

            • spec.appConfig.ldap.servers.additionalProperties.port
              число

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

              Порт для подключения к LDAP серверу

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

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

            • spec.appConfig.ldap.servers.additionalProperties.syncName
              булевый
              синхронизировать имя пользователя Gitlab с LDAP

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

            • spec.appConfig.ldap.servers.additionalProperties.timeout
              число
              Определяет таймаут выполнения LDAP запросов в секундах

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

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

            • spec.appConfig.ldap.servers.additionalProperties.uid
              строка

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

              LDAP аттрибут, который определяет используемый пользователем логин для авторизации

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

            • spec.appConfig.ldap.servers.additionalProperties.userFilter
              строка
              Фильтр LDAP пользователей в формате RFC 4515

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

            • spec.appConfig.ldap.servers.additionalProperties.verifyCertificates
              булевый
              Включает проверку SSL сертификата, если метод шифрования start_tls или simple_tls

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

      • spec.appConfig.omniauth
        объект
        конфигурация OmniAuth
        • spec.appConfig.omniauth.allowBypassTwoFactor
          массив строк
          разрешить обход двухфакторной аутентификации

          По умолчанию: []

        • spec.appConfig.omniauth.allowSingleSignOn
          массив строк
          разрешить единый вход (SSO)

          По умолчанию: []

        • spec.appConfig.omniauth.autoLinkLdapUser
          булевый
          автоматически связывать пользователей LDAP

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

        • spec.appConfig.omniauth.autoLinkSamlUser
          булевый
          автоматически связывать пользователей SAML

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

        • spec.appConfig.omniauth.autoLinkUser
          массив строк
          автоматически связывать пользователя

          По умолчанию: []

        • spec.appConfig.omniauth.autoSignInWithProvider
          строка
          автоматический вход через провайдера
        • spec.appConfig.omniauth.blockAutoCreatedUsers
          булевый
          блокировать автоматически созданных пользователей

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

        • spec.appConfig.omniauth.enabled
          булевый
          включение OmniAuth

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

        • spec.appConfig.omniauth.externalProviders
          массив строк
          внешние провайдеры

          По умолчанию: []

        • spec.appConfig.omniauth.providers
          массив объектов
          нативно поддерживаемые OmniAuth провайдеры

          По умолчанию: []

          • spec.appConfig.omniauth.providers.args
            объект
            • spec.appConfig.omniauth.providers.args.client_options
              объект
          • spec.appConfig.omniauth.providers.icon
            строка
          • spec.appConfig.omniauth.providers.label
            строка
          • spec.appConfig.omniauth.providers.name
            строка

            Допустимые значения: alicloud, atlassioan_oauth2, auth0, cognito, azute_activedirectory_v2, bitbucket, oauth2_generic, github, gitlab, google_oauth2, jwt, kerberos, openid_connect, salesforce, saml, shibboleth

          • spec.appConfig.omniauth.providers.uid
            строка
            This fields is only for operator itself. Do not edit or set it

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

        • spec.appConfig.omniauth.syncProfileAttributes
          массив строк
          атрибуты профиля, подлежащие синхронизации

          По умолчанию: [ "name", "email" ]

        • spec.appConfig.omniauth.syncProfileFromProvider
          массив строк
          синхронизировать профиль с провайдера

          По умолчанию: []

      • spec.appConfig.rackAttack
        объект
        настройка rackAttack
        • spec.appConfig.rackAttack.gitlabBasicAuth
          объект
          ограничитель скорости, используемый GitLab для настройки блокировки и ограничения попыток аутентификации пользователей
          • spec.appConfig.rackAttack.gitlabBasicAuth.banTime
            целочисленный

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

          • spec.appConfig.rackAttack.gitlabBasicAuth.findTime
            целочисленный

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

          • spec.appConfig.rackAttack.gitlabBasicAuth.ipWhitelist
            массив строк
            список IP-адресов, не подпадающих под правила rackAttack
          • spec.appConfig.rackAttack.gitlabBasicAuth.maxRetry
            целочисленный

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

      • spec.appConfig.signInEnabled
        булевый
        Настройка стандартного входа. Стандартный вход можно отключить, чтобы принудительно авторизовываться через LDAP

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

      • spec.appConfig.signUpEnabled
        булевый
        Разрешить пользователю создавать учетные записи. Это также позволяет обычным пользователям регистрировать учетные записи самостоятельно.

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

      • spec.appConfig.usernameChangingEnabled
        булевый
        разрешить изменение имен пользователей для существующих учетных записей

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

    • spec.backup
      объект
      Настройки бэкапов

      По умолчанию: {}

      • spec.backup.backupBeforeUpdate
        булевый
        Автоматическое создание бэкапов перед обновлением модуля

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

      • spec.backup.backupStorageGb
        целочисленный
        Ожидаемый общий размер резервных копий (архив tar) для настройки базового хранилища

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

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

      • spec.backup.cronSchedule
        строка
        Если указано значение то включается создание бэкапов по cron расписанию
      • spec.backup.enabled
        булевый
        Включение возможности работы с бэкапами

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

      • spec.backup.nodeSelector
        объект
        Kubernetes selector для выбора ноды кластера, где будет запускаться процесс бекапа
      • spec.backup.persistentVolumeClaim
        объект
        Настройки для персистентного ресурса Kubernetes

        По умолчанию: {}

        • spec.backup.persistentVolumeClaim.enabled
          булевый
          <REPLACE_ME>

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

        • spec.backup.persistentVolumeClaim.storageClass
          строка
          Persistent Volume Storage Class. Если задано значение -, то storageClassName: "", что отключает динамического провайдера
      • spec.backup.s3
        объект
        Настройки для подключения к S3 хранилищу
        • spec.backup.s3.bucketName
          строка
          имя бакета в объектном хранилище для хранения бекапов

          По умолчанию: d8-code-backups

        • spec.backup.s3.external
          объект
          Настройки для внешнего S3-хранилища
          • spec.backup.s3.external.accessKey
            строка

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

            Ключ доступа к бакетам
          • spec.backup.s3.external.endpoint
            строка
            Переменная endpoint задаёт пользовательский endpoint совместимого с S3 хранилища, который будет использоваться для выполнения запросов Если схема (http:// или https://) явно не указана, по умолчанию будет использоваться https://. Например, если указано s3.example.com, система автоматически интерпретирует это как https://s3.example.com

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

          • spec.backup.s3.external.provider
            строка

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

            Облачный провайдер S3 хранилища. Используйте Generic для хранилища в локальном контуре

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

          • spec.backup.s3.external.region
            строка
            Регион для размещения бакетов

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

          • spec.backup.s3.external.secretKey
            строка

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

            Секретный ключ доступа к бакетам
        • spec.backup.s3.mode
          строка
          Тип хранилища: внешнее / внутреннее

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

        • spec.backup.s3.tmpBucketName
          строка
          имя временной директории, где будут храниться бекапы перед сохранением в объектное хранилище

          По умолчанию: d8-code-tmp

      • spec.backup.skipComponents
        массив строк
        Список компонентов, не подлежащих бекапированию

        По умолчанию: []

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

          Допустимые значения: Db, Repositories, Uploads, Builds, Artifacts, Pages, Lfs, TerraformState, Registry, Packages, CiSecureFiles, ExternalDiffs

      • spec.backup.tolerations
        массив объектов
        Kubernetes tolerations для запуска пода, отвечающего за бекапирование(toolbox), на конкретной ноде

        По умолчанию: []

        • spec.backup.tolerations.effect
          строка
        • spec.backup.tolerations.key
          строка
        • spec.backup.tolerations.operator
          строка
        • spec.backup.tolerations.tolerationSeconds
          целочисленный
        • spec.backup.tolerations.value
          строка
    • spec.features
      объект
      другие необязательные компоненты, которые включаются по требованию. Вся конфигурация ниже относится к компонентам

      По умолчанию: {}

      • spec.features.mail
        объект
        Настройки всех видов электронной почты

        По умолчанию: {}

        • spec.features.mail.incomingEmail
          объект
          Настройки для получения входящих эл. писем

          По умолчанию: { "address": "", "enabled": false, "host": "", "password": "", "user": "" }

          • spec.features.mail.incomingEmail.address
            строка

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

            Шаблон адреса электронной почты ресурса/проекта, на который дается ответ (например: code-incoming+%{key}@gmail.com). Обратите внимание, что суффикс +%{key} должен быть включен полностью в адрес электронной почты и не должен быть заменен другим значением.

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

          • spec.features.mail.incomingEmail.enabled
            булевый

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

            Включить получение входящих эл. писем для модуля

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

          • spec.features.mail.incomingEmail.host
            строка

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

            Адресс удаленного почтового сервера

            По умолчанию: imap.gmail.com

          • spec.features.mail.incomingEmail.password
            строка

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

            Пароль для IMAP авторизации

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

          • spec.features.mail.incomingEmail.port
            целочисленный
            Порт удаленного почтового сервера

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

          • spec.features.mail.incomingEmail.serviceDeskEmail
            объект
            Настройки для получения службой поддержки проекта(-ов) входящих эл. писем

            По умолчанию: { "address": "", "enabled": false, "host": "", "password": "", "user": "" }

            • spec.features.mail.incomingEmail.serviceDeskEmail.address
              строка

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

              Шаблон адреса электронной почты ресурса/проекта, на который дается ответ (например: project_contact+%{key}@gmail.com). Обратите внимание, что суффикс +%{key} должен быть включен полностью в адрес электронной почты и не должен быть заменен другим значением.

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

            • spec.features.mail.incomingEmail.serviceDeskEmail.enabled
              булевый

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

              Включить получение службой поддержки проекта(-ов) входящих эл. писем. Применимо, когда включено и настроено получение входящих эл. писем для модуля

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

            • spec.features.mail.incomingEmail.serviceDeskEmail.host
              строка

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

              Адресс удаленного почтового сервера

              По умолчанию: imap.gmail.com

            • spec.features.mail.incomingEmail.serviceDeskEmail.password
              строка

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

              Пароль для IMAP авторизации

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

            • spec.features.mail.incomingEmail.serviceDeskEmail.port
              целочисленный
              Порт удаленного почтового сервера

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

            • spec.features.mail.incomingEmail.serviceDeskEmail.ssl
              булевый
              Использовать SSL (если опция включена на IMAP сервере)

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

            • spec.features.mail.incomingEmail.serviceDeskEmail.startTls
              булевый
              Использовать STARTTLS (если опция включена на IMAP сервере)

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

            • spec.features.mail.incomingEmail.serviceDeskEmail.user
              строка

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

              Имя пользователя для IMAP авторизации

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

          • spec.features.mail.incomingEmail.ssl
            булевый
            Использовать SSL (если опция включена на IMAP сервере)

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

          • spec.features.mail.incomingEmail.startTls
            булевый
            Использовать STARTTLS (если опция включена на IMAP сервере)

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

          • spec.features.mail.incomingEmail.user
            строка

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

            Имя пользователя для IMAP авторизации

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

        • spec.features.mail.outgoingEmail
          объект
          Настройки для исходящих эл. писем

          По умолчанию: { "displayName": "Deckhouse Code", "from": "no-reply@deckhouse.io", "replyTo": "no-reply@deckhouse.io" }

          • spec.features.mail.outgoingEmail.displayName
            строка

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

            Имя отправителя, отображаемое в эл. письме

            По умолчанию: Deckhouse Code

          • spec.features.mail.outgoingEmail.from
            строка

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

            Почта отправителя, отображаемое в эл. письме

            По умолчанию: deckhouse.code@example.com

          • spec.features.mail.outgoingEmail.replyTo
            строка

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

            Почта, отображаемая в Reply-To в эл. письме

            По умолчанию: noreply@example.com

          • spec.features.mail.outgoingEmail.smtp
            объект
            Настройки SMTP для модуля

            По умолчанию: {}

            • spec.features.mail.outgoingEmail.smtp.address
              строка
              Адресс удаленного почтового сервера

              По умолчанию: smtp.mailgun.org

            • spec.features.mail.outgoingEmail.smtp.authentication
              строка
              Тип SMTP авторизации (Plain, Login, CramMd5 или None для подключения без авторизации)

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

            • spec.features.mail.outgoingEmail.smtp.domain
              строка
              Опционально: HELO домен для SMTP

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

            • spec.features.mail.outgoingEmail.smtp.enabled
              булевый
              Включить исходящие сообщения

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

            • spec.features.mail.outgoingEmail.smtp.opensslVerifyMode
              строка
              Режим проверки TLS (None, Peer, ClientOnce или FailIfNoPeerCert)

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

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

            • spec.features.mail.outgoingEmail.smtp.password
              строка
              Пароль для SMTP авторизации

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

            • spec.features.mail.outgoingEmail.smtp.port
              целочисленный
              Порт подключения к удаленного серверу

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

            • spec.features.mail.outgoingEmail.smtp.starttlsAuto
              булевый
              Использовать STARTTLS (если опция включена на почтовом сервере)

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

            • spec.features.mail.outgoingEmail.smtp.tls
              булевый
              Включение SMTP/TLS (SMTPS: SMTP over direct TLS connection)

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

            • spec.features.mail.outgoingEmail.smtp.username
              строка
              Имя пользователя для SMTP авторизации

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

          • spec.features.mail.outgoingEmail.subjectSuffix
            строка
            Приставка к теме всех исходящих писем от модуля

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

      • spec.features.pages
        объект
        настройка компонента Pages

        По умолчанию: {}

        • spec.features.pages.enabled
          булевый
          включение компонента Pages

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

        • spec.features.pages.ingress
          объект
          раздел с настройками входящих сетевых соединений для компонента

          По умолчанию: {}

          • spec.features.pages.ingress.annotations
            объект
            Словарь дополнительных аннотаций для сервиса компонента
          • spec.features.pages.ingress.hostname
            строка
            переопределенное доменное имя pages сервиса

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

          • spec.features.pages.ingress.https
            объект
            настройки https для входящих соединений компонента
            • spec.features.pages.ingress.https.certManager
              объект
              Параметры certmanager
              • spec.features.pages.ingress.https.certManager.clusterIssuerName
                строка
                имя кластерного issuer для SSL-сертификатов

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

            • spec.features.pages.ingress.https.customCertificate
              объект
              Параметры режима custom certificate
              • spec.features.pages.ingress.https.customCertificate.secretName
                строка
                имя секрета, где хранится пользовательский сертификат
            • spec.features.pages.ingress.https.mode
              строка
              способ хранения/выдачи сертификата. Может быть custom/certManager/global

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

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

        • spec.features.pages.s3
          объект
          Настройки для подключения к S3 хранилищу
          • spec.features.pages.s3.bucketName
            строка
            имя S3-бакета для Pages

            По умолчанию: d8-code-pages

          • spec.features.pages.s3.external
            объект
            Настройки для внешнего S3-хранилища
            • spec.features.pages.s3.external.accessKey
              строка

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

              Ключ доступа к бакетам
            • spec.features.pages.s3.external.endpoint
              строка
              Переменная endpoint задаёт пользовательский endpoint совместимого с S3 хранилища, который будет использоваться для выполнения запросов Если схема (http:// или https://) явно не указана, по умолчанию будет использоваться https://. Например, если указано s3.example.com, система автоматически интерпретирует это как https://s3.example.com

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

            • spec.features.pages.s3.external.provider
              строка

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

              Облачный провайдер S3 хранилища. Используйте Generic для хранилища в локальном контуре

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

            • spec.features.pages.s3.external.region
              строка
              Регион для размещения бакетов

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

            • spec.features.pages.s3.external.secretKey
              строка

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

              Секретный ключ доступа к бакетам
            • spec.features.pages.s3.external.storageOptions
              объект
              Настройки серверного шифрования S3

              По умолчанию: {}

              • spec.features.pages.s3.external.storageOptions.serverSideEncryption
                строка
                Метод шифрования S3 бакета (AES256 или AwsKms)

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

              • spec.features.pages.s3.external.storageOptions.serverSideEncryptionKmsKeyId
                строка
                Amazon Resource Name. Необходим только когда serverSideEncryption имеет значение AwsKms.
          • spec.features.pages.s3.mode
            строка
            Тип хранилища: внешнее / внутреннее

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

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

      • spec.features.registry
        объект
        Настройка компонента registry

        По умолчанию: {}

        • spec.features.registry.enabled
          булевый
          Включение компонента registry

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

        • spec.features.registry.garbageCollector
          объект
          Раздел для настройки garbage collector
          • spec.features.registry.garbageCollector.blobs
            объект
            Подраздел blobs настраивает blobs worker.
            • spec.features.registry.garbageCollector.blobs.enabled
              булевый
              Если установлено значение true, garbage collector blobs включен..

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

            • spec.features.registry.garbageCollector.blobs.interval
              строка
              Интервал между запусками garbage collector для blobs.

              По умолчанию: 5s

          • spec.features.registry.garbageCollector.enabled
            булевый
            Включение garbage collector

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

          • spec.features.registry.garbageCollector.manifests
            объект
            Подраздел manifests настраивает garbase collector для manifests.
            • spec.features.registry.garbageCollector.manifests.enabled
              булевый
              Если установлено значение true, garbage collector для manifests включен.

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

            • spec.features.registry.garbageCollector.manifests.interval
              строка
              Интервал между запусками garbage collector для manifests.

              По умолчанию: 5s

        • spec.features.registry.ingress
          объект
          раздел с настройками входящих сетевых соединений для компонента

          По умолчанию: {}

          • spec.features.registry.ingress.annotations
            объект
            Словарь дополнительных аннотаций для сервиса компонента
          • spec.features.registry.ingress.hostname
            строка
            переопределенное доменное имя registry сервиса

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

          • spec.features.registry.ingress.https
            объект
            настройки https для входящих соединений компонента
            • spec.features.registry.ingress.https.certManager
              объект
              Параметры certmanager
              • spec.features.registry.ingress.https.certManager.clusterIssuerName
                строка
                имя кластерного issuer для SSL-сертификатов

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

            • spec.features.registry.ingress.https.customCertificate
              объект
              Параметры режима custom certificate
              • spec.features.registry.ingress.https.customCertificate.secretName
                строка
                имя секрета, где хранится пользовательский сертификат
            • spec.features.registry.ingress.https.mode
              строка
              способ хранения/выдачи сертификата. Может быть custom/certManager

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

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

        • spec.features.registry.maintenance
          объект
          раздел с настройками обслуживания Registry

          По умолчанию: {}

          • spec.features.registry.maintenance.readOnly
            объект
            режим только для чтения

            По умолчанию: {}

            • spec.features.registry.maintenance.readOnly.enabled
              булевый
              перевести ли Registry в режим только для чтения во время обслуживания

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

          • spec.features.registry.maintenance.uploadPurging
            объект
            раздел описывает функцию обслуживания, удаляющую артефакты загрузки изображений из хранилища (данные изображений не удаляются)

            По умолчанию: {}

            • spec.features.registry.maintenance.uploadPurging.age
              строка
              возраст артефактов для удаления, измеряется в часах

              По умолчанию: 168h

              Шаблон: ^(\d+)h$

            • spec.features.registry.maintenance.uploadPurging.dryrun
              булевый
              использовать ли в тестовом/проверочном режиме

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

            • spec.features.registry.maintenance.uploadPurging.enabled
              булевый
              включить ли функцию uploadPurging. Выключено в режиме readOnly

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

            • spec.features.registry.maintenance.uploadPurging.interval
              строка
              интервал запуска

              По умолчанию: 24h

              Шаблон: ^(\d+)h$

        • spec.features.registry.postgres
          объект
          Defines connection to postgres database
          • spec.features.registry.postgres.external
            объект
            Defines external Postgres settings.
            • spec.features.registry.postgres.external.database
              строка

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

              name of the metadata database, minumum 3 symbols

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

            • spec.features.registry.postgres.external.host
              строка
              FQDN address of database server
            • spec.features.registry.postgres.external.password
              строка
              password for metadata database
            • spec.features.registry.postgres.external.port
              целочисленный
              port of the database server
            • spec.features.registry.postgres.external.serverCA
              строка
              CA certificate for postgres server
            • spec.features.registry.postgres.external.sslMode
              строка
              SSL mode priority for database connection

              Допустимые значения: allow, prefer, require, verify-ca, verify-full

            • spec.features.registry.postgres.external.username
              строка
              username for metadata database
          • spec.features.registry.postgres.mode
            строка
            whether to use external database or internal one

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

        • spec.features.registry.s3
          объект
          Настройки для подключения к S3 хранилищу

          По умолчанию: {}

          • spec.features.registry.s3.bucketName
            строка
            имя S3-бакета для Registry

            По умолчанию: d8-code-registry

          • spec.features.registry.s3.external
            объект
            Настройки для внешнего S3-хранилища
            • spec.features.registry.s3.external.accessKey
              строка

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

              Ключ доступа к бакетам
            • spec.features.registry.s3.external.endpoint
              строка
              Переменная endpoint задаёт пользовательский endpoint совместимого с S3 хранилища, который будет использоваться для выполнения запросов Если схема (http:// или https://) явно не указана, по умолчанию будет использоваться https://. Например, если указано s3.example.com, система автоматически интерпретирует это как https://s3.example.com

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

            • spec.features.registry.s3.external.provider
              строка

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

              Облачный провайдер S3 хранилища. Используйте Generic для хранилища в локальном контуре

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

            • spec.features.registry.s3.external.region
              строка
              Регион для размещения бакетов

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

            • spec.features.registry.s3.external.secretKey
              строка

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

              Секретный ключ доступа к бакетам
          • spec.features.registry.s3.mode
            строка
            Тип хранилища: внешнее / внутреннее

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

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

    • spec.gitData
      объект
      все, что связано с вашими данными Git
      • spec.gitData.replicas
        целочисленный
        Число Gitaly нод, когда ‘highAvailability: true’

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

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

      • spec.gitData.resources
        объект
        секция определяет размер ресурсов, обслуживающих данные Git (gitaly)
      • spec.gitData.storageClass
        строка
        Kubernetes storageClass, использумый для хранения данных Git (для PVC подов gitaly)
      • spec.gitData.storagePerReplicaGb
        целочисленный
        размер всех данных Git. Необходим для расчета размера томов для каждой реплики

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

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

    • spec.network
      объект
      Раздел для настройки параметров сети

      По умолчанию: {}

      • spec.network.certificates
        объект
        Раздел для настройки и управления TLS сертификатами

        По умолчанию: {}

        • spec.network.certificates.customCAs
          массив объектов
          Список k8s Secret и ConfigMap для импорта CA сертификатов

          По умолчанию: []

          • spec.network.certificates.customCAs.configMap
            строка
          • spec.network.certificates.customCAs.keys
            массив строк
          • spec.network.certificates.customCAs.secret
            строка
      • spec.network.gitSsh
        объект
        Сетевые настройки компонента shell (для поддержки git по SSH)
        • spec.network.gitSsh.hostname
          строка
          Укажите имя хоста, по которому будет доступен компонент shell. Оставьте пустым, чтобы использовать имя, идентичное webservice-у. При этом убедитесь, что оба сервиса доступны по одному и тому же ip-адресу

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

        • spec.network.gitSsh.service
          объект
          конфигурация сервиса для доступа к компоненту shell
          • spec.network.gitSsh.service.annotations
            объект
            Словарь дополнительных аннотаций для компонента shell
          • spec.network.gitSsh.service.nodePort
            целочисленный
            номер порта, который будет использоваться для доступа к компоненту shell при указании типа сервиса nodePort

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

          • spec.network.gitSsh.service.type
            строка
            Способ публикации SSH сервиса

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

      • spec.network.ingressClass
        строка
        Ingress для использования в модуле. Если не указан то используется класс из Deckhouse по умолчанию

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

      • spec.network.ownLoadBalancer
        объект
        Параметры для конфигурации haproxy

        По умолчанию: {}

        • spec.network.ownLoadBalancer.annotations
          объект
          Список аннотаций для сервиса haproxy
        • spec.network.ownLoadBalancer.enabled
          булевый
          Разворачивает дополнительный LoadBalancer для веб-сервиса и shell-сервиса. Обратитесь к сетевой документации для получения дополнительной информации

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

        • spec.network.ownLoadBalancer.httpBackends
          массив строк
          Список имен IngressNginxControllers куда будет направлен HTTP(S) траффик. По умолчанию направляет в k8s service по имени ingress класса.

          По умолчанию: []

      • spec.network.web
        объект
        Сетевые настройки веб-сервиса (UI)
        • spec.network.web.annotations
          объект
          Словарь дополнительных аннотаций для веб-сервиса
        • spec.network.web.hostname
          строка
          Укажите имя хоста, по которому будет доступен компонент shell. Если задано пустое значние, то по умолчанию будет использоваться шаблон домена кластера Внимание! Убедитесь, что https mode и TLS-сертификат валидны для указанного имени

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

        • spec.network.web.https
          объект
          Тип используемого сертификата. При использовании этого параметра полностью переопределяются глобальные настройки global.modules.https.
          • spec.network.web.https.certManager
            объект
            Настройки для certmanager.
            • spec.network.web.https.certManager.clusterIssuerName
              строка
              Тип ClusterIssuer’а, используемого для заказа SSL-сертификата (в данный момент доступны letsencrypt, letsencrypt-staging, selfsigned, но возможно определить свои).

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

          • spec.network.web.https.customCertificate
            объект
            Настройки для использования пользовательского сертификата.
            • spec.network.web.https.customCertificate.secretName
              строка

              Имя Secret’а в пространстве имен d8-code, который будет использоваться для веб-интерфейса Code.

              Secret должен быть в формате kubernetes.io/tls.

          • spec.network.web.https.mode
            строка

            Режим работы HTTPS:

            • CertManager — доступ по HTTPS с заказом сертификата согласно ClusterIssuer’у, заданному в параметре certManager.clusterIssuerName.
            • CustomCertificate — доступ по HTTPS с использованием сертификата из пространства имен d8-code.

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

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

    • spec.placement
      объект
      Настройки, относящиеся к размещеню компонентов CR

      По умолчанию: {}

      • spec.placement.dedicated
        булевый
        Использовать выделенные ноды с лейблом ’node-role.deckhouse.io/code='

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

    • spec.scaling
      объект
      scaling-related configurations

      По умолчанию: {}

      • spec.scaling.highAvailability
        булевый
        режим High Availability (HA)

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

      • spec.scaling.targetUserCount
        целочисленный
        Предполагаемое число пользователей модуля

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

        Допустимые значения: 10, 100, 300, 500, 1000

    • spec.storages
      объект

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

      все, что связано с хранилищами, используемыми Code. В настоящее время поддерживаются только внешние хранилища
      • spec.storages.postgres
        объект

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

        Настройки для подключения к базе Postgres
        • spec.storages.postgres.external
          объект
          настройки для подключения к внешней базе Postgres
          • spec.storages.postgres.external.database
            строка

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

            name of the main database
          • spec.storages.postgres.external.host
            строка

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

            IP или доменное имя сервера Postgres

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

          • spec.storages.postgres.external.password
            строка
            Пароль пользователя
          • spec.storages.postgres.external.port
            целочисленный
            Порт подключения к Postgres

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

          • spec.storages.postgres.external.praefectDatabase
            строка
            Имя базы данных на сервере Postgres для Praefect

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

          • spec.storages.postgres.external.praefectPassword
            строка
            Пароль пользователя Postgres для Praefect
          • spec.storages.postgres.external.praefectUsername
            строка
            Имя пользователя Postgres для Praefect

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

          • spec.storages.postgres.external.serverCA
            строка
            CA сертификат сервера Postgres
          • spec.storages.postgres.external.sslMode
            строка
            SSL mode priority for database connection

            Допустимые значения: allow, prefer, require, verify-ca, verify-full

          • spec.storages.postgres.external.username
            строка

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

            Имя пользователя

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

        • spec.storages.postgres.mode
          строка
          Тип базы: встроенная или внешняя

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

      • spec.storages.redis
        объект

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

        Настройки для подключения к Redis
        • spec.storages.redis.external
          объект
          Настройки для подключения к внешнему Redis
          • spec.storages.redis.external.auth
            объект

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

            Аутентификация для подключения к Redis
            • spec.storages.redis.external.auth.enabled
              булевый

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

              Аутентификация для подключения к Redis

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

            • spec.storages.redis.external.auth.password
              строка
              пароль для Redis, если аутентификация включена
            • spec.storages.redis.external.auth.username
              строка
              пользователь Redis, если аутентификация включена
          • spec.storages.redis.external.host
            строка
            Доменное имя или IP адрес Redis сервера. Не нужен, если используется Sentinel

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

          • spec.storages.redis.external.masterName
            строка
            Имя мастера для Sentinel кластера Redis
          • spec.storages.redis.external.port
            целочисленный
            Адрес порта Redis сервера

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

          • spec.storages.redis.external.scheme
            строка
            Тип подключения к Redis серверу

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

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

          • spec.storages.redis.external.sentinels
            массив объектов
            Список Sentinel серверов для подключения к Redis
            • spec.storages.redis.external.sentinels.host
              строка
            • spec.storages.redis.external.sentinels.port
              целочисленный
          • spec.storages.redis.external.serverCA
            строка
            CA-сертификат для подключения к Redis серверу
        • spec.storages.redis.mode
          строка

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

          Тип используемого Redis. Внешний или встроенный

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

      • spec.storages.s3
        объект

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

        Настройки для подключения к S3 хранилищу
        • spec.storages.s3.bucketNames
          объект
          словарь (ключ-значение), указывающий имена для всех необходимых бакетов

          По умолчанию: {}

          • spec.storages.s3.bucketNames.artifacts
            строка
            имя бакета для хранения артефактов

            По умолчанию: d8-code-artifacts

          • spec.storages.s3.bucketNames.ciSecureFiles
            строка
            имя бакета для хранения секретов пайплайна

            По умолчанию: d8-code-ci-secure-files

          • spec.storages.s3.bucketNames.dependencyProxy
            строка
            имя бакета для хранения артефактов dependency proxy

            По умолчанию: d8-code-dependency-proxy

          • spec.storages.s3.bucketNames.externalDiffs
            строка
            имя бакета для хранения MergeRequest diffs

            По умолчанию: d8-code-mr-diffs

          • spec.storages.s3.bucketNames.lfs
            строка
            имя бакета для хранения данных git-lfs

            По умолчанию: d8-code-git-lfs

          • spec.storages.s3.bucketNames.packages
            строка
            имя бакета для хранения пакетов

            По умолчанию: d8-code-packages

          • spec.storages.s3.bucketNames.terraformState
            строка
            имя бакета для хранения стейта terraform

            По умолчанию: d8-code-terraform-state

          • spec.storages.s3.bucketNames.uploads
            строка
            имя бакета для хранения загрузок

            По умолчанию: d8-code-uploads

        • spec.storages.s3.external
          объект
          Настройки для внешнего S3-хранилища
          • spec.storages.s3.external.accessKey
            строка

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

            Ключ доступа к бакетам
          • spec.storages.s3.external.endpoint
            строка
            Переменная endpoint задаёт пользовательский endpoint совместимого с S3 хранилища, который будет использоваться для выполнения запросов Если схема (http:// или https://) явно не указана, по умолчанию будет использоваться https://. Например, если указано s3.example.com, система автоматически интерпретирует это как https://s3.example.com

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

          • spec.storages.s3.external.provider
            строка

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

            Облачный провайдер S3 хранилища. Используйте Generic для хранилища в локальном контуре

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

          • spec.storages.s3.external.proxyDownload
            булевый
            Включить прокси для всех загрузок через Code вместо прямых загрузок с S3 бакетов

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

          • spec.storages.s3.external.region
            строка
            Регион для размещения бакетов

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

          • spec.storages.s3.external.secretKey
            строка

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

            Секретный ключ доступа к бакетам
          • spec.storages.s3.external.storageOptions
            объект
            Настройки серверного шифрования S3
            • spec.storages.s3.external.storageOptions.serverSideEncryption
              строка
              Метод шифрования S3 бакета (AES256 или AwsKms)

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

            • spec.storages.s3.external.storageOptions.serverSideEncryptionKmsKeyId
              строка
              Amazon Resource Name. Необходим только когда serverSideEncryption имеет значение AwsKms.
        • spec.storages.s3.mode
          строка
          Тип хранилища: внешнее / внутреннее

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

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