Назначение каждого параметра описано на странице «Обзор». Здесь для каждого типа установки указано место, в котором записываются параметры, общие параметры OmniAuth и способ применения изменений. Записи провайдеров и серверов приведены на страницах OpenID Connect, SAML и LDAP.

Где хранится конфигурация

Пакет для ОС Linux. Параметры задаются ключами файла /etc/gitlab/gitlab.rb.

Omnibus Docker. Контейнер читает те же ключи gitlab.rb. Они попадают в него из переменной окружения GITLAB_OMNIBUS_CONFIG, которая вычисляется при каждом запуске, и из файла /etc/gitlab/gitlab.rb на томе конфигурации, который читается после переменной. Ключ, записанный в файле, переопределяет тот же ключ в переменной. Переменная задаётся при создании контейнера:

docker run -d --name code \
  --shm-size 256m \
  -p 80:80 -p 443:443 -p 22:22 \
  -e GITLAB_OMNIBUS_CONFIG="external_url 'https://<HOSTNAME>'; gitlab_rails['omniauth_enabled'] = true; gitlab_rails['omniauth_allow_single_sign_on'] = ['openid_connect']; gitlab_rails['omniauth_auto_link_ldap_user'] = true" \
  -v /srv/code/config:/etc/gitlab \
  -v /srv/code/logs:/var/log/gitlab \
  -v /srv/code/data:/var/opt/gitlab \
  <REGISTRY>/<FLAVOR>:<VERSION>

Переменная фиксируется при создании контейнера, поэтому её изменение означает удаление контейнера и создание нового с теми же томами. Записи провайдеров и LDAP-серверов занимают несколько строк, а том конфигурации сохраняет их при замене контейнера. С томами из быстрого старта файл /etc/gitlab/gitlab.rb внутри контейнера — это /srv/code/config/gitlab.rb на хосте, и редактируется он на хосте:

sudo vi /srv/code/config/gitlab.rb

Helm-чарт. Параметры задаются значениями чарта в файле values.yaml релиза.

Модуль Deckhouse Platform. Параметры задаются в ресурсе CodeInstance, описанном на страницах «Настройка OmniAuth и LDAP» и Custom Resources в документации модуля.

Общие параметры OmniAuth

Параметры и их действие описаны в разделе «Общие параметры OmniAuth».

  • Пакет для ОС Linux
  • Omnibus Docker
  • Helm-чарт
  • Модуль Deckhouse Platform

У каждого общего параметра OmniAuth собственный ключ в gitlab.rb:

ПараметрКлюч в gitlab.rb
enabledgitlab_rails['omniauth_enabled']
providersgitlab_rails['omniauth_providers']
allow_single_sign_ongitlab_rails['omniauth_allow_single_sign_on']
block_auto_created_usersgitlab_rails['omniauth_block_auto_created_users']
auto_link_ldap_usergitlab_rails['omniauth_auto_link_ldap_user']
auto_link_usergitlab_rails['omniauth_auto_link_user']
auto_sign_in_with_providergitlab_rails['omniauth_auto_sign_in_with_provider']
external_providersgitlab_rails['omniauth_external_providers']
allow_bypass_two_factorgitlab_rails['omniauth_allow_bypass_two_factor']
sync_profile_from_providergitlab_rails['omniauth_sync_profile_from_provider']
sync_profile_attributesgitlab_rails['omniauth_sync_profile_attributes']
gitlab_rails['omniauth_enabled'] = true
gitlab_rails['omniauth_allow_single_sign_on'] = ['openid_connect']
gitlab_rails['omniauth_block_auto_created_users'] = true
gitlab_rails['omniauth_auto_link_ldap_user'] = true
gitlab_rails['omniauth_sync_profile_attributes'] = ['email']
Ключи и их значения те же, что во вкладке «Пакет для ОС Linux». Однострочный ключ помещается в GITLAB_OMNIBUS_CONFIG и отделяется от следующего символом ;, как в команде docker run выше; ключ, значение которого занимает несколько строк, записывается в файл /srv/code/config/gitlab.rb.

Общие параметры — это значения в секции global.appConfig.omniauth:

global:
  appConfig:
    omniauth:
      enabled: true
      allowSingleSignOn: ['openid_connect']
      blockAutoCreatedUsers: true
      autoLinkLdapUser: true
      syncProfileAttributes: ['email']

Общие параметры задаются в секции spec.appConfig.omniauth, а провайдеры перечисляются в её параметре providers:

enabled: true
allowSingleSignOn: ['openid_connect']
blockAutoCreatedUsers: true
autoLinkLdapUser: true
syncProfileAttributes: ['email']

Применение конфигурации

  • Пакет для ОС Linux
  • Omnibus Docker
  • Helm-чарт
  • Модуль Deckhouse Platform

Каждое изменение файла /etc/gitlab/gitlab.rb вступает в силу после выполнения команды:

sudo gitlab-ctl reconfigure

Примените изменённый файл в работающем контейнере:

docker exec code gitlab-ctl reconfigure

Перезапуск контейнера тоже применяет конфигурацию; так вступает в силу изменённая переменная GITLAB_OMNIBUS_CONFIG пересозданного контейнера:

docker restart code

Примените изменённый файл values.yaml к релизу:

helm upgrade code deckhouse-code \
  -n code \
  -f values.yaml
Изменённый ресурс CodeInstance применяет оператор.