Связаться с намиПодключиться

Интеграция с Yandex Tracker

Статья создана
Обновлена 29 октября 2024 г.

В задачах Tracker можно автоматически добавлять ссылки на мерж-реквесты из GitLab, указывая ключ нужной задачи в названии или описании нового мерж-реквеста. Ссылки будут размещаться в разделе Связи с внешними приложениями.

Дополнительно можно включить автоматическое создание комментариев в задаче с информацией о мерж-реквестах. Автоматическое комментирование доступно только для Managed Service for GitLab.

Чтобы настроить интеграцию с GitLab в Tracker:

  1. Подключите Yandex Tracker.
  2. Создайте инстанс GitLab.
  3. (Опционально) Создайте проект GitLab.
  4. Создайте хук для интеграции.
  5. Протестируйте хук.
  6. Проверьте результат.

Если созданные ресурсы вам больше не нужны, удалите их.

Перед началом работы

Зарегистрируйтесь в Yandex Cloud и создайте платежный аккаунт:

  1. Перейдите в консоль управления, затем войдите в Yandex Cloud или зарегистрируйтесь.
  2. На странице Yandex Cloud Billing убедитесь, что у вас подключен платежный аккаунт, и он находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его и привяжите к нему облако.

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

Подробнее об облаках и каталогах.

Подключите Yandex Tracker

Подключите Tracker к вашей организации Yandex Cloud.

Создайте инстанс GitLab

Создайте инстанс Managed Service for GitLab или виртуальную машину с образом GitLab.

Создайте инстанс Managed Service for GitLab согласно инструкции.

Запустите GitLab на ВМ с публичным IP-адресом.

  1. На странице каталога в консоли управления нажмите кнопку Создать ресурс и выберите Виртуальная машина.
  2. В поле Имя введите имя ВМ: ci-tutorial-gitlab.
  3. Выберите зону доступности, в которой будет находиться ВМ.
  4. В блоке Образ загрузочного диска перейдите на вкладку Marketplace и нажмите кнопку Показать все продукты Marketplace. В открывшемся окне выберите образ GitLab и нажмите кнопку Использовать.
  5. В блоке Вычислительные ресурсы укажите следующую конфигурацию:
    • vCPU — 4.
    • Гарантированная доля vCPU — 100%.
    • RAM — 8 ГБ.
  6. В блоке Сетевые настройки:

    • Выберите, к какой подсети подключить ВМ. Если нужной сети или подсети нет, создайте их с помощью кнопок Создать сеть и Создать подсеть.

      Важно

      Технические ограничения Yandex Cloud временно не позволяют выбрать подсеть с диапазоном адресов 192.168.0.0/24.

    • В поле Публичный адрес выберите Автоматически.

  7. В блоке Доступ укажите данные для доступа на ВМ:

    • В поле Логин введите имя пользователя.

      Внимание

      Не используйте логин root или другие имена, зарезервированные операционной системой. Для выполнения операций, требующих прав суперпользователя, используйте команду sudo.

    • В поле SSH-ключ вставьте содержимое файла открытого ключа. Пару ключей для подключения по SSH необходимо создать самостоятельно, см. раздел о подключении к ВМ по SSH.

  8. Нажмите кнопку Создать ВМ.

Создание ВМ может занять несколько минут. Когда ВМ перейдет в статус RUNNING и запустится GitLab, настройте его.

(Опционально) Создайте проект GitLab

Чтобы настроить интеграцию для отдельного проекта GitLab, создайте его.

  1. Авторизуйтесь в веб-интерфейсе инстанса Managed Service for GitLab.

  2. Нажмите кнопку Create a project.

  3. Нажмите кнопку Create blank project.

  4. Заполните поля:

    • Project name — укажите имя проекта.
    • Project URL — выберите пользователя-администратора в поле рядом с FQDN инстанса Managed Service for GitLab.

    Остальные поля оставьте без изменений.

  5. Нажмите кнопку Create project.

  1. На странице сервиса Yandex Compute Cloud выберите созданную ВМ и скопируйте ее публичный IP-адрес.

  2. Подключитесь к ВМ по протоколу SSH.

  3. Получите пароль администратора GitLab с помощью команды ВМ:

    sudo cat /etc/gitlab/initial_root_password

  4. Скопируйте пароль из строки Password (исключая пробелы) в буфер обмена или отдельный файл.

  5. Откройте в браузере ссылку http://<публичный_IP-адрес_ВМ>. Откроется веб-интерфейс GitLab.

  6. Войдите в систему с учетной записью администратора:

    • Username or email — root.
    • Password — пароль, скопированный ранее.

    Если вы не можете войти, сбросьте пароль учетной записи администратора.

  7. Смените пароль учетной записи администратора.

  8. Повторно войдите в систему с учетной записью администратора, используя новый пароль.

  9. Выберите Create a project.

  10. Укажите имя проекта.

  11. Нажмите кнопку Create project.

Создайте хук для интеграции

Чтобы привязывать мерж-реквесты из GitLab к задачам в Tracker, создайте хук:

  1. Если у вас еще нет OAuth-токена для работы с Tracker API, получите его.
  2. Проверьте наличие доступа к API с помощью запроса информации о текущем пользователе.
  3. Откройте инстанс GitLab и перейдите к настройкам хука:
    • Для включения интеграции на весь инстанс GitLab (требуются права администратора GitLab):
      1. В панели слева нажмите на раскрывающийся список Your work и выберите пункт Admin Area.
      2. Перейдите в раздел System Hooks.
    • Для включения интеграции на отдельный проект:
      1. Перейдите в необходимый проект.
      2. В панели слева нажмите кнопку Settings и выберите пункт Webhooks.
  4. Укажите параметры хука:

    • URL — https://api.tracker.yandex.net/v2/system/gitlab/receive?comments=true&<тип_организации>=<идентификатор_организации>.

      Где:

      • comments=true — включает автоматическое создание комментариев в задаче со ссылкой и информацией о мерж-реквестах. Отключите, если комментирование не нужно. Параметр доступен только для Managed Service for GitLab.

      • <тип_организации> — может принимать следующие значения:

        • x_cloud_org_id — если тип вашей организации Yandex Cloud Organization.
        • x_org_id — если тип вашей организации или Яндекс 360 для бизнеса, или одновременно Яндекс 360 для бизнеса и Yandex Cloud Organization.

      • <идентификатор_организации> — идентификатор организации на странице организаций Tracker.

    • Secret token — OAuth-токен робота, от имени которого будут добавляться связи, в формате OAuth <содержимое_токена>.
      Например: OAuth y1_AQAD-qJScAAAEKEQbBNnChvfBIqR_yEQl_HMO0********.

    • В блоке Trigger выключите все опции, кроме Merge request events.

    • В блоке SSL verification включите опцию Enable SSL verification.

  5. Нажмите кнопку Add system hook (Add webhook для отдельного проекта).

На странице появится блок System Hooks (Project Hooks для отдельного проекта), в котором отобразится созданный хук и его параметры.

Протестируйте хук

  1. В блоке System Hooks (Project Hooks для отдельного проекта) нажмите кнопку Test.
  2. В раскрывающемся списке выберите пункт Merge request events.

Тестовый запрос должен вернуть ответ Hook executed successfully: HTTP 204. Если тестовый запрос возвращает ошибку, значит параметры хука указаны неверно.

Проверьте результат

  1. Создайте задачу в Tracker.

  2. Создайте мерж-реквест в GitLab и укажите в его названии или описании ключ задачи.

  3. Убедитесь, что в задаче Tracker в разделе Связи с внешними приложениями появилась ссылка на мерж-реквест из GitLab.

    Если вы использовали Managed Service for GitLab и включили автоматическое комментирование при создании хука, то в задаче появится комментарий со ссылкой на мерж-реквест и информацией о нем.

Удалите созданные ресурсы

Удалите ресурсы, которые вы больше не будете использовать, чтобы за них не списывалась плата:

  1. Удалите инстанс Managed Service for GitLab или созданную ВМ с образом GitLab.
  2. Если вы зарезервировали публичный статический IP-адрес для ВМ, освободите и удалите его.
Предыдущая
Создание тестовых виртуальных машин через GitLab CI
Следующая
Вызов нагрузочного тестирования из GitLab CI