Параметры GitLab#

Параметры создания сервиса#

Эти параметры указываются в качестве parameters в методе CreateService.

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

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

password#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да

Нет

String

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

—

registry#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да

Есть

Hash

—

—

smtp#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да

Есть

Hash

—

—

oidc#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да

Есть

Hash

—

—

ldap#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да

Есть

Hash

—

—

Container registry#

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

enable_registry#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да

Есть

Boolean

true
false

false

storage#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да, если enable_registry = true

Нет

String

filesystem
s3

filesystem

s3_user#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

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

Есть

String

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

—

bucket#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

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

Есть

String

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

—

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

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

enable_smtp#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да

Есть

Boolean

true
false

false

address#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

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

Есть

String

IP-адрес или FQDN

—

port_smtp#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

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

Есть

Integer

1–65535

—

username#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

password_smtp#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

domain#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

authentication#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

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

Есть

String

plain
login

—

tls#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

Boolean

true
false

false

force_tls#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

Boolean

true
false

—

starttls_auto#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

Boolean

true
false

—

tls_verify_mode#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

none
peer

—

email_from#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

Корректный адрес электронной почты

—

email_reply_to#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

Корректный адрес электронной почты

—

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

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

enable_oidc#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да

Есть

Boolean

true
false

false

label_oidc#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

OpenID Connect

issuer#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да, если enable_oidc = true

Есть

String

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

—

client_auth_method#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

query
basic

—

uid_field#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

sub

send_scope_to_token_endpoint#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да, если enable_oidc = true

Есть

Boolean

true
false

true

pkce#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

Boolean

true
false

—

client_id#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

client_secret#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

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

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

enable_ldap#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да

Есть

Boolean

true
false

false

label_ldap#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да, если enable_ldap = true

Есть

String

—

—

host#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да, если enable_ldap = true

Есть

String

—

—

port_ldap#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да, если enable_ldap = true

Нет

Integer

1–65535

—

uid#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да, если enable_ldap = true

Есть

String

—

sub

base#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да, если enable_ldap = true

Есть

String

—

—

encryption#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Да, если enable_ldap = true

Есть

String

start_tls
simple_tls
plain

—

bind_dn#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

password_ldap#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

ca_cert#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

ssl_version#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

TLSv1_1
TLSv1_2
TLSv1_3

—

ciphers#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

client_cert#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

client_key#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

verify_certificates#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

Boolean

true
false

—

timeout#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Нет

Integer

0–60

10

active_directory#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

Boolean

true
false

—

allow_username_or_email_login#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

Boolean

true
false

—

user_filter#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—

lowercase_usernames#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

Boolean

true
false

—

retry_empty_result_with_codes#

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

Необходимо

Возможность редактирования

Тип данных

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

По умолчанию

Нет

Есть

String

—

—