Руководство прикладного разработчика#

Системные требования#

На рабочей машине разработчика должны быть установлены следующие пакеты:

  • make

  • git

  • openssl

  • brew (только для MacOS)

  • git-core (только для Ubuntu)

  • Gitlab Development Kit (GDK)

Для Windows убедитесь, что установлена WSL версии 2, выполнив следующую команду в cmd или PowerShell:

> wsl -l -v

Пример результата:

  NAME            STATE           VERSION
* Ubuntu-20.04    Running         2

Подключение и конфигурирование#

Полный путь директории GDK должен состоять не более чем из 60 символов. Проверить это можно следующей командой:

pwd | wc -c

После успешного клонирования необходимо запустить команду инициализации, которая установит все необходимые зависимости, в том числе asdf (менеджер управления версиями) и gem gitlab-development-kit:

make bootstrap

Миграция на текущую версию#

Миграция не предусмотрена в текущем релизе.

Быстрый старт#

Перед установкой Gitlab необходимо прописать переменную окружения FOSS_ONLY=1:

export FOSS_ONLY=1
echo -e "\nexport FOSS_ONLY=1" >> ~/.bash_profile

В примере выше замените ~/.bash_profile в следующих случаях:

  • при использовании MacOS: замените на ~/.zshrc;

  • при использовании Ubuntu: замените на ~/.bashrc.

Приложение устанавливается из любого репозитория, который содержит fork нужной версии с доработками для платформы:

gdk install gitlab_repo=git@10.27.0.4:RELS/gitlab-pv.git

После успешной установки приложения, оно должно быть доступно по адресу http://127.0.0.1:3000.

Использование программного компонента#

  • Диагностика gdk:

    gdk doctor

  • Запуск, остановка, перезапуск и проверка статуса сервисов:

    gdk start/stop/restart/status <service>

  • Мониторинг логов:

    gdk tail <service>

    Можно также перечислить в качестве параметров отдельные логи по имени субдиректории в log/.

  • Запуск "тонкого" сервера для отладки в консоли.

    gdk thin

    После выхода из него нужно выполнить команду gdk start, чтобы запустилась стандартная Puma.

  • Вывод всех команд и логина/пароля для входа по умолчанию:

    gdk help

Часто встречающиеся проблемы и пути их устранения#

В текущей версии продукта типовые проблемы не выявлены