Параметры GitLab#

Parameters for creating a service#

These parameters are provided as parameters in the method CreateService.

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

Имена параметров GitLab указываются в формате snake_case.

password#

Начальный пароль пользователя root, который устанавливается при развёртывании сервиса. В дальнейшем пароль можно изменить из веб-интерфейса GitLab. Если в методе ModifyService будет указано иное значение, то оно будет проигнорировано.

Required

Editable

Datatype

Valid values

Defaults

Yes

No

String

Строка пароля. Не должна содержать символы ', ", ` и \

—

registry#

Конфигурационные параметры сервиса Container Registry. См. раздел Container registry.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

Hash

—

—

smtp#

Конфигурационные параметры для отправки исходящей почты. См. раздел Исходящая почта.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

Hash

—

—

oidc#

Конфигурационные параметры для настройки аутентификации по протоколу OIDC. См. раздел Провайдер аутентификации OIDC.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

Hash

—

—

ldap#

Конфигурационные параметры для настройки аутентификации по протоколу LDAP. См. раздел Провайдер аутентификации LDAP.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

Hash

—

—

Container registry#

Эти параметры передаются в хеше registry и описывают встроенный в GitLab сервис Container Registry.

enable_registry#

Включает или отключает сервис Container Registry. Если задано false, остальные параметры реестра не нужны и игнорируются.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

Boolean

true
false

false

storage#

По умолчанию данные реестра хранятся на диске виртуальной машины в каталоге /var/opt/gitlab. Если выбрать значение s3, то данные будут храниться в выбранном бакете объектного хранилища — для этого GitLab использует встроенный драйвер aws-s3. Параметр нельзя обновлять, так как автоматическая миграция данных между filesystem и s3 не поддерживается.

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_registry = true

No

String

filesystem
s3

filesystem

s3_user#

Пользователь объектного хранилища для доступа к бакету с Container Registry. Выбирается из списка пользователей для резервного копирования.

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_registry = true и storage = s3

Yes

String

Имя пользователя объектного хранилища

—

bucket#

Название бакета.

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_registry = true и storage = s3

Yes

String

3–63 символа: строчные латинские буквы, цифры, точки и дефисы; первый и последний символ — буква или цифра

—

Исходящая почта#

Эти параметры передаются в хеше smtp и настраивают отправку исходящей почты из GitLab.

enable_smtp#

Включает или отключает отправку почты. Если задано false, остальные параметры smtp не нужны и игнорируются, при этом отключается отправка любых исходящих сообщений из GitLab.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

Boolean

true
false

false

address#

IP-адрес или FQDN почтового сервера. Обязателен, если включён enable_smtp.

Required

Editable

Datatype

Valid values

Defaults

Да, если включён enable_smtp

Yes

String

IP-адрес или FQDN

—

port_smtp#

Порт, на котором работает почтовый сервер. Обычно это порт 25, 465 или 587.

Required

Editable

Datatype

Valid values

Defaults

Да, если включён enable_smtp

Yes

Integer

1–65535

—

username#

Имя пользователя для аутентификации на почтовом сервере. Если не указано, аутентификация не используется.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

password_smtp#

Пароль пользователя для аутентификации на почтовом сервере. Если не указан, аутентификация не используется.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

domain#

Имя почтового домена. Это значение используется в SMTP-командах, например HELO/EHLO. Некоторые почтовые сервисы проверяют существование переданного клиентом почтового домена и не принимают почту при ошибке проверки.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

authentication#

Метод аутентификации, который поддерживает почтовый сервер. В случае plain имя и пароль передаются в виде открытого текста. Если аутентификация не используется (не указаны username и password_smtp), параметр передавать не нужно.

Required

Editable

Datatype

Valid values

Defaults

Да, если указаны username и password_smtp

Yes

String

plain
login

—

tls#

Указывает, нужно ли при подключении к почтовому серверу сразу использовать шифрование TLS. Обычно серверы, которые прослушивают порт 465, требуют, чтобы подключение клиента сразу было защищено TLS. В отличие от них другие сервисы (обычно на портах 25, 587) позволяют сначала выполнить нешифрованное подключение, а затем перейти на шифрование посредством механизма STARTTLS.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

true
false

false

force_tls#

Указывает, должно ли при взаимодействии с почтовым сервером использоваться шифрование TLS. Если сервер не поддерживает TLS, то соединение сразу разрывается.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

true
false

—

starttls_auto#

Если включено, то при подключении к серверу GitLab будет пытаться установить зашифрованное соединение посредством механизма STARTTLS. Если сервер не поддерживает TLS, то взаимодействие продолжится без шифрования.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

true
false

—

tls_verify_mode#

Указывает, как осуществляется проверка TLS-сертификата сервера. В случае peer выполняется проверка валидности; чтобы её отключить (например, для самоподписанных сертификатов), нужно выбрать none.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

none
peer

—

email_from#

Адрес отправителя для всей исходящей почты.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

Valid e-mail address

—

email_reply_to#

Адрес для ответов на электронную почту.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

Valid e-mail address

—

Провайдер аутентификации OIDC#

Эти параметры передаются в хеше oidc и настраивают аутентификацию по протоколу OIDC.

enable_oidc#

Включает или отключает аутентификацию по OIDC. Если задано false, остальные параметры OIDC не нужны и игнорируются.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

Boolean

true
false

false

label_oidc#

Необязательное название кнопки на странице входа.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

OpenID Connect

issuer#

URL провайдера OIDC, по которому GitLab получает конфигурацию провайдера удостоверений (IdP).

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_oidc = true

Yes

String

URL со схемой http:// или https://

—

client_auth_method#

Метод аутентификации клиента у провайдера OIDC.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

query
basic

—

uid_field#

Имя поля из user_info.raw_attributes, определяющего значение uid.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

sub

send_scope_to_token_endpoint#

Указывает, включать ли параметр scope в запрос к серверу выдачи токенов.

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_oidc = true

Yes

Boolean

true
false

true

pkce#

Включает механизм Proof Key for Code Exchange (PKCE).

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

true
false

—

client_id#

Идентификатор клиента, заданный в настройках провайдера OIDC.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

client_secret#

Секрет клиента, заданный в настройках провайдера OIDC.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

Провайдер аутентификации LDAP#

Эти параметры передаются в хеше ldap и настраивают аутентификацию по протоколу LDAP.

enable_ldap#

Включает или отключает аутентификацию по LDAP. Если задано false, остальные параметры LDAP не нужны и игнорируются.

Required

Editable

Datatype

Valid values

Defaults

Yes

Yes

Boolean

true
false

false

label_ldap#

Название кнопки на странице входа.

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_ldap = true

Yes

String

—

—

host#

IP-адрес или доменное имя LDAP-сервера.

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_ldap = true

Yes

String

—

—

port_ldap#

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

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_ldap = true

No

Integer

1–65535

—

uid#

Атрибут LDAP, который сопоставляется с именем пользователя, используемым для входа, например sAMAccountName или uid.

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_ldap = true

Yes

String

—

sub

base#

База, в которой выполняется поиск пользователей. Например: ou=people,dc=gitlab,dc=example или DC=mydomain,DC=com.

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_ldap = true

Yes

String

—

—

encryption#

Способ шифрования соединения с LDAP-сервером.

Required

Editable

Datatype

Valid values

Defaults

Да, если enable_ldap = true

Yes

String

start_tls
simple_tls
plain

—

bind_dn#

Полное Distinguished Name пользователя, от имени которого выполняется привязка (bind). Например: america\momo или CN=Gitlab,OU=Users,DC=domain,DC=com.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

password_ldap#

Пароль пользователя для привязки (bind).

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

ca_cert#

Содержимое файла CA-сертификата. Используется, если encryption = start_tls или simple_tls, а также если verify_certificates = true. Например: -----BEGIN CERTIFICATE----- <...> -----END CERTIFICATE-----.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

ssl_version#

Версия SSL/TLS для OpenSSL, если значение по умолчанию не подходит.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

TLSv1_1
TLSv1_2
TLSv1_3

—

ciphers#

Конкретные наборы шифров SSL для взаимодействия с LDAP-серверами. Например: ALL:!EXPORT:!LOW:!aNULL:!eNULL:!SSLv2.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

client_cert#

Содержимое клиентского сертификата. Используется для взаимодействия с LDAPS-серверами, если удалённый сервер выполняет проверку клиентского сертификата. Например: -----BEGIN CERTIFICATE----- <...> -----END CERTIFICATE-----.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

client_key#

Содержимое ключа для клиентского сертификата. Используется для взаимодействия с LDAPS-серверами, если удалённый сервер выполняет проверку клиентского сертификата (см. параметр client_cert).

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

verify_certificates#

Включает проверку SSL-сертификата, если выбран способ шифрования start_tls или simple_tls.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

true
false

—

timeout#

Тайм-аут LDAP-запросов в секундах. Значение 0 означает отсутствие тайм-аута.

Required

Editable

Datatype

Valid values

Defaults

No

No

Integer

0–60

10

active_directory#

Указывает, является ли LDAP-сервер сервером Active Directory. Если нет, специфичные для AD запросы игнорируются. Для LDAP-сервера без Active Directory задайте значение false.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

true
false

—

allow_username_or_email_login#

Если true, GitLab игнорирует всё, что указано после первого символа @ в имени пользователя LDAP.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

true
false

—

user_filter#

Фильтр пользователей LDAP в формате RFC 4515, например (memberOf=CN=GitLab_Users,CN=Groups,DC=example,DC=com).

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—

lowercase_usernames#

Если включено, GitLab приводит имя пользователя к нижнему регистру.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

Boolean

true
false

—

retry_empty_result_with_codes#

Коды ответа LDAP-запроса, при получении которых операция повторяется, если результат пуст.

Required

Editable

Datatype

Valid values

Defaults

No

Yes

String

—

—