Как развернуть сервер GitLab с помощью Docker

GitLab — это ведущая платформа для размещения репозиториев Git, конвейеров непрерывной интеграции и рабочих процессов DevOps. Он доступен как предложение SaaS на GitLab.com или как самоуправляемый дистрибутив для частного использования на вашем собственном оборудовании.

GitLab — это сложная система, состоящая из сети отдельных компонентов и зависимостей. Установка пакетов GitLab непосредственно в вашу операционную систему добавит на вашу машину новые весомые сервисы, включая PostgreSQL, Redis, Gitaly и основное веб-приложение GitLab на основе Rails.

Развертывание GitLab в качестве контейнера Docker — это один из способов избежать загрязнения вашей среды всеми этими компонентами. Все, что связано с GitLab, будет жить внутри контейнера отдельно от файловой системы вашего хоста.

В этом руководстве мы будем использовать Docker для развертывания готового экземпляра GitLab, который вы можете использовать для размещения исходного кода и совместной работы над проектами. Прежде чем продолжить, следует учесть, что Docker не устраняет основные требования GitLab к оборудованию: вам потребуется не менее 4 ГБ свободной оперативной памяти и около 10 ГБ неиспользуемого хранилища.

Официальный образ Docker

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

Образ является монолитным по своей природе, объединяя все компоненты GitLab, поэтому они работают в одном контейнере. Это упрощает настройку, но затрудняет масштабирование установки в будущем. Это идет вразрез с передовыми методами контейнеризации, поскольку в контейнере выполняется несколько отдельных компонентов.

Это означает, что стоковое изображение может быть не идеальным для загруженных установок. В качестве альтернативы вы можете использовать диаграмму Helm GitLab для развертывания в кластере Kubernetes. Это запускает каждую службу как отдельный контейнерный модуль, поэтому вы можете масштабировать компоненты по отдельности.

Развертывание GitLab с помощью Docker

Установите Docker и настройте DNS-запись A для вашего доменного имени GitLab, прежде чем продолжить. Вы должны указать запись DNS на IP-адрес вашего хоста Docker. Мы будем использовать gitlab.example.com в качестве домена в оставшейся части этого руководства.

Вы можете запустить GitLab, выполнив следующую команду:

docker run -d -p 22:22 -p 80:80 -p 443:443 
    --name gitlab 
    --hostname gitlab.example.com 
    --restart unless-stopped 
    --shm-size 256m 
    -v gitlab_config:/etc/gitlab 
    -v gitlab_logs:/var/log/gitlab 
    -v gitlab_data:/var/opt/gitlab 
    gitlab/gitlab-ce:14.7.0-ce.0

Docker загрузит образ GitLab Community Edition (CE) и запустит новый контейнер, используя его. Лучше всего закрепить конкретную версию GitLab, выбрав соответствующий тег изображения, в данном случае 14.7.0-ce.0. Вот объяснение флагов, используемых в команде:

• -d — отсоединить терминал от контейнера, чтобы он работал в фоновом режиме.
• -p — привязать порты 22, 80 и 443 в контейнере к соответствующим портам на вашем хосте; это позволяет GitLab получать Git и веб-трафик по SSH и HTTP/S, когда он направлен на ваш хост.
• --name: присвойте контейнеру понятное имя, чтобы вы могли удобно ссылаться на него при выполнении команд Docker CLI в будущем.
• --hostname — укажите имя хоста контейнера; это должно соответствовать домену, который вы используете для доступа к GitLab.
• --restart — назначьте контейнеру политику перезапуска, чтобы он автоматически перезапускался при завершении работы из-за сбоя или перезагрузки хоста.
• --shm-size – это объясняется в следующем разделе.
• -v — настройте тома Docker для постоянного хранения файлов конфигурации GitLab, журналов и сгенерированных пользовательских данных вне контейнера. Это очень важно, чтобы не потерять данные при остановке контейнера!

Подождите несколько минут, пока первая настройка GitLab не завершится. В конце концов вы сможете посетить gitlab.example.com, чтобы увидеть страницу входа. Войдите как root; пароль учетной записи генерируется автоматически, и его можно получить, выполнив следующую команду:

docker exec -it <gitlab-container-name> grep 'Password:' /etc/gitlab/initial_root_password

Замените именем, которое вы указали при создании контейнера. В приведенном выше примере это был gitlab.

Исследование проблем развертывания

Выполнение сценариев установки занимает много времени. Это нормально. В GitLab нужно настроить множество компонентов, прежде чем сервис сможет начать функционировать. Вы можете отслеживать прогресс, просматривая логи контейнера:

docker logs gitlab --follow

Лучший способ действий, если веб-интерфейс GitLab недоступен, — просто подождать немного дольше и позволить процедуре настройки завершиться. Если что-то пошло не так, вы видите 500 ошибок в своем браузере, а журналы контейнера не показывают новую активность, иногда может помочь перезапуск контейнера с помощью docker restart gitlab.

Одно распространенное сообщение об ошибке, которое вы можете увидеть в журналах, выглядит примерно так:

writing value to /dev/shm/gitlab/... failed with unmapped file

Это происходит из-за того, что службы, связанные с GitLab, записывают значительные объемы данных во временную файловую систему /dev/shm. Docker по умолчанию выделяет контейнерам пространство /dev/shm размером 64 МБ. Этого редко бывает достаточно для поддержания сбора метрик GitLab через Prometheus, который отвечает за большую часть операций записи в файловую систему.

Емкость /dev/shm можно увеличить с помощью флага --shm-size при создании контейнера с помощью docker run. Это показано в приведенном выше примере развертывания, где выделено 256 МБ — минимум, рекомендованный GitLab. Для очень активных установок может потребоваться использование большего размера.

Еще одна проблема связана с лог-файлами GitLab: они быстро становятся объемными, что может привести к ошибкам обнаружено переполнение буфера при запуске Docker. Этого можно избежать, периодически удаляя старые файлы в каталоге /var/log/gitlab из вашего контейнера GitLab:

docker exec -it gitlab rm /var/log/gitlab/*

Файлы журнала, которые Docker собирает из выходных потоков контейнера и сохраняет на вашем хосте, также быстро увеличиваются до больших размеров. Драйвер хранилища журнала Docker json-file по умолчанию не подходит для использования с рабочим экземпляром GitLab. Файлы JSON, которые он создает, тяжелые, многословные, никогда не сжимаются и не вращаются. Переключитесь на другой драйвер хранилища, например local или journald, чтобы обеспечить регулярную ротацию журналов.

Настройка GitLab

Вы можете предоставить фрагменты файла конфигурации GitLab при создании контейнера, установив переменную среды GITLAB_OMNIBUS_CONFIG. Это должна быть допустимая строка Ruby, которая будет добавлена к файлу /etc/gitlab/gitlab.rb внутри контейнера:

docker run -e GITLAB_OMNIBUS_CONFIG="gitlab_rails['allowed_hosts'] = ['gitlab.example.com]; nginx['redirect_http_to_https'] = true;"

Вы также можете редактировать /etc/gitlab/gitlab.rb внутри контейнера после его запуска. Когда вы закончите вносить изменения, вы должны перезапустить контейнер, чтобы применить их:

docker restart gitlab

Образ GitLab Docker автоматически запускает скрипт перенастройки Omnibus при каждом запуске. Это берет текущую конфигурацию из вашего gitlab.rb и применяет ее к вашей установке. GitLab может быть недоступен в течение нескольких секунд после перезапуска контейнера, пока этот процесс завершается.

Применение обновлений GitLab

Обновления GitLab легко применить, остановив ваш контейнер и запустив новый с той же конфигурацией.

Извлеките новый образ, соответствующий выбранному вами выпуску GitLab:

docker pull gitlab/gitlab-ce:14.7.1-ce.0

Удалите существующий контейнер:

docker rm gitlab

Наконец, запустите новый контейнер, повторив исходные флаги, но изменив ссылку на изображение:

docker run -d -p 22:22 -p 80:80 -p 443:443 
    --name gitlab 
    ...
    gitlab/gitlab-ce:14.7.1-ce.0

Ваши данные останутся нетронутыми, так как тома из старого контейнера будут присоединены к новому.

Вы можете избежать повторения флагов docker run, инкапсулировав свою конфигурацию в файл docker-compose.yml:

version: "3"
services:
  gitlab:
    image: gitlab/gitlab-ce:14.7.0-ce-0
    hostname: gitlab.example.com
    ports:
      - 22:22
      - 80:80
      - 443:443
    volumes:
      gitlab_config:/etc/gitlab
      gitlab_logs:/var/log/gitlab
      gitlab_data:/var/opt/gitlab
    restart: unless-stopped
volumes:
  gitlab_config:
  gitlab_logs:
  gitlab_data:

docker exec -t gitlab gitlab-backup create

gitlab_rails['backup_upload_connection'] = {
    "provider" => "AWS",
    "region" => "eu-west-1",
    "aws_access_key_id" => "access_key",
    "aws_secret_access_key" => "secret_key",
    # "endpoint" => "https://..."
}

0 * * * * docker exec -t gitlab gitlab-backup create