Предварительная версия. Функциональность может измениться, но основные возможности сохранятся. Совместимость с будущими версиями может потребовать ручных действий по миграции.
Deckhouse Kubernetes Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.
CodeInstance
Scope: Cluster
Version: v1
-
строкаapiVersionAPIVersion 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
-
строкаkindKind 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
-
объектspecCodeInstanceSpec defines the desired state of the CodeInstance.
-
объектspec.appConfigAppConfig параметры, которые можно использовать для изменения общих настроек компонентов 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.jobClassWarning!: 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.emailLDAP атрибут для эл. почты пользователя
По умолчанию:
[ "mail", "email", "userPrincipalName" ] -
строкаspec.appConfig.ldap.servers.additionalProperties.attributes.firstNameLDAP атрибут для имени пользователя
По умолчанию:
givenName -
строкаspec.appConfig.ldap.servers.additionalProperties.attributes.lastNameLDAP атрибут для фамилии пользователя
По умолчанию:
sn -
строкаspec.appConfig.ldap.servers.additionalProperties.attributes.nameLDAP атрибут для отображемого имени
По умолчанию:
cn -
массив строкspec.appConfig.ldap.servers.additionalProperties.attributes.username
@usernamec которым будет связан аккаунт 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.roleMappingCписок словарей маппинга ролей, извлеченных из имен 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.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 для запуска бекапирования
По умолчанию:
0 0 1 * * -
булевыйspec.backup.enabledвключение бекапирования
По умолчанию:
false -
объектspec.backup.nodeSelectorkubernetes selector для выбора ноды кластера, где будет запускаться процесс бекапа
-
объектspec.backup.persistentVolumeClaimНастройки для персистентного ресурса Kubernetes
По умолчанию:
{}-
булевыйspec.backup.persistentVolumeClaim.enabled<REPLACE_ME>
По умолчанию:
false -
строкаspec.backup.persistentVolumeClaim.storageClassPersistent 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.tolerationskubernetes 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.serverSideEncryptionKmsKeyIdAmazon 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.postgresDefines connection to postgres database
-
объектspec.features.registry.postgres.externalDefines external Postgres settings.
-
строкаspec.features.registry.postgres.external.database
Обязательный параметр
name of the metadata database, minumum 3 symbolsМинимальная длина:
3 -
строкаspec.features.registry.postgres.external.hostFQDN address of database server
-
строкаspec.features.registry.postgres.external.passwordpassword for metadata database
-
целочисленныйspec.features.registry.postgres.external.portport of the database server
-
строкаspec.features.registry.postgres.external.serverCACA certificate for postgres server
-
строкаspec.features.registry.postgres.external.sslModeSSL mode priority for database connection
Допустимые значения:
allow,prefer,require,verify-ca,verify-full -
строкаspec.features.registry.postgres.external.usernameusername for metadata database
-
-
строкаspec.features.registry.postgres.modewhether 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.storageClassKubernetes 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.ingressClassIngress для использования в модуле. Если не указан то используется класс из 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.scalingscaling-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.serverCACA сертификат сервера Postgres
-
строкаspec.storages.postgres.external.sslModeSSL 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.serverCACA-сертификат для подключения к 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.serverSideEncryptionKmsKeyIdAmazon Resource Name. Необходим только когда
serverSideEncryptionимеет значениеAwsKms.
-
-
-
строкаspec.storages.s3.modeТип хранилища: внешнее / внутреннее
По умолчанию:
ExternalДопустимые значения:
Internal,External
-
-
-