Автозагрузка приложения при помощи Gitlab

2860

CI/CD — это такая штука, которая часто причиняет боль. А эта статья — это такая штука, которая эту боль поможет снять ~~без регистрации и смс.~~

По сути, это набор готовых решений, который подойдет для небольших компаний. И если вы обычно не используете некоторые технологии из-за их сложности или громоздкости, этот текст — для вас.

Что такое CI/CD ?

CI/CD — это концепция непрерывной интеграции и доставки. Она реализуется как конвейер, облегчая слияние только что закомиченного кода в основную кодовую базу.

Это основа наших тестирований. Она позволяет запускать различные типы тестов на каждом этапе (выполнение интеграционного аспекта) и завершать их запуском с развертыванием закомиченного кода в фактический продукт, который видят конечные пользователи (выполнение доставки).

CI/CD необходима для разработки программного обеспечения по Agile-методологии, которая рекомендует использовать автоматическое тестирование для быстрой наладки рабочего ПО. Автоматическое тестирование дает заинтересованным лицам доступ к вновь созданным функциям и обеспечивает быструю обратную связь.

Сервисы в помощь

Локальные:

Gitlab CI,
TeamCity,
Bamboo,
GoCD Jenkins,
Circle CI.

Облачные:

BitBucket Pipelines,
Heroku CI,
Travis,
Codeship,
Buddy CI,
AWS CodeBuild.

Мы в работе используем Gitlab. У него есть 2000 минут в месяц для использования процесса непрерывной интеграции кода и возможность создавать гибкую структуру проектов, групп и подгрупп для разграничения доступа команд к разным проектам. Эти два преимущества сыграли решающую роль при выборе для нас.

Что нужно для настройки автоматического деплоя приложения в Gitlab? Всего лишь один файл, в котором будет записана конфигурация (скрипт загрузки) — она именуется pipeline. Pipeline — это целый набор разных команд, которые можно выполнить для вашего проекта в рамках одной итерации. Перед стартом работы ознакомьтесь с Gitlab pipeline на официальном сайте компании.

Далее я приведу 2 реальных примера из собственной практики. Они работают на наших проектах — и позволят загружать приложения различной сложности и структуры на сервер вам.

Gitlab pipeline для Angular приложения

Описание pipeline для приложения на Angular

До начала работы важно добавить публичный ключ в аккаунт. Это можно сделать в разделе SSH Keys:

После добавьте переменные окружения, которые нужны в самом проекте. Для этого зайдите в раздел настроек в самом проекте.

Найдите раздел Environment variables.

И добавьте переменные:

Нам нужны:

SSH_HOST_DO – ip-адрес сервера

SSH_PRIVATE_KEY – приватный ключ сервера

SSH_USERNAME_DO – логин (имя) пользователя

И давайте посмотрим на сам pipeline!

Первая секция — переменные, которые я буду использовать локально в этом сценарии:

  DEVSERVER_FOLDER: 'xxx.yyyy.com/'
  DEMOSERVER_FOLDER: 'xxx.yyyy.com/'
  APP_FOLDER: 'xxx.yyyy.com/'
  OWN_HOST: '154.231.218.89'

Так как в моем приложении используется сразу 3 сервера (тестовый, демо-версия и продкашн), мне нужно выполнять загрузку приложения на всех них. В переменных я указываю имя директории поддомена, где располагается приложение.

Переменная OWN_HOST хранит ip-адрес сервера для подключения по SSH.

Далее скрипт выполняет настройку SSH-клиента и добавляет хост в известные, чтобы он мог с ним работать:

  - ssh-keyscan $OWN_HOST >> ~/.ssh/known_hosts
  - chmod 644 ~/.ssh/known_hosts

Это сделано специально для повышения защиты. Если же по каким-либо причинам вы не можете работать так или машины не совершают соединение, можно отключить проверку хоста. Для этого впишите вот эту команду вместо двух команд выше:

'[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config'

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

stages:
  - dev
  - demo
  - master

Разберем детально загрузку тестовой версии:

dev_deploy:
  stage: dev
  script:
    - rm ./package-lock.json
    - npm install
    - ./node_modules/@angular/cli/bin/ng build --configuration=dev
    - ssh $SSH_USERNAME_DO@$SSH_HOST_DO "cd / && cd home/USER/public_html/ && rm -rf $DEVSERVER_FOLDER*"
    - scp -r dist/adson/. $SSH_USERNAME_DO@$SSH_HOST_DO:/home/USER/public_html/$DEVSERVER_FOLDER
    - scp .htaccess $SSH_USERNAME_DO@$SSH_HOST_DO:/home/USER/public_html/$DEVSERVER_FOLDER
  only:
    - dev

Параметр stage указывает, какой секции принадлежит наша задача. После объявления слова script мы записываем набор действий (операций), которые будут производиться.

На словах логика загрузки такова:

Приложение нужно сбилдить и скопировать на сервер, предварительно удалив старую версию

А если пошагово, то…

1 — Выполняем билд приложения:

- rm ./package-lock.json
- npm install
- ./node_modules/@angular/cli/bin/ng build --configuration=dev

2 — Подключаемся по SSH к хосту и удаляем старое приложение:

 - ssh $SSH_USERNAME_DO@$SSH_HOST_DO "cd / && cd home/USER/public_html/ && rm -rf $DEVSERVER_FOLDER*"

3 — Выполняем загрузку новой версии:

 - ssh $SSH_USERNAME_DO@$SSH_HOST_DO "cd / && cd home/USER/public_html/ && rm -rf $DEVSERVER_FOLDER*"

4 — Загружаем файл htacces:

     - scp .htaccess $SSH_USERNAME_DO@$SSH_HOST_DO:/home/USER/public_html/$DEVSERVER_FOLDER

5 — ОБЯЗАТЕЛЬНО указываем, в какой ветке работает эта задача:

   only:
    - dev

Задачи в других ветках работают по такому же принципу.

Gitlab pipeline для PHP приложения (непопулярные фреймворки)

Процесс подготовки среды не отличается от описанного выше: нужно тоже добавить ключ в аккаунт и создать переменные окружения в самом проекте. Повторно рассматривать это не будем.

А вот как выглядит сценарий:

Описание Gitlab pipeline для PHP приложения

Вся магия загрузки заключается здесь:

- ssh $SSH_USERNAME_DO@$SSH_HOST_DO "cd / && cd home/dev/public_html/$DEVSERVER_FOLDER && git reset --hard HEAD && git checkout dev && git pull origin dev && composer update --no-dev -q && composer dump-autoload -o && find /home/dev/public_html/$DEVSERVER_FOLDER -type f -print0 | xargs -0 chmod 644 && find /home/dev/public_html/$DEVSERVER_FOLDER -type d -print0 | xargs -0 chmod 755 && chown -R dev:dev /home/dev/public_html/$DEVSERVER_FOLDER && exit"

Давайте разберем эту часть более детально и распишем скрипт на команды по порядку.

 - ssh $SSH_USERNAME_DO@$SSH_HOST_DO – подключаемся по SSH
cd / - переходим к корень
cd home/dev/public_html/$DEVSERVER_FOLDER – переходим в директорию с приложением
git reset --hard HEAD – выполняем сброс на последний коммит (это страховка от неумелых коллег, которые захотят однажды редактировать файлы по FTP)
git checkout dev – переключаемся в нужную ветку
git pull origin dev – скачиваем с репозитория новые изменения
composer update --no-dev –q – обновляем зависимости проекта
composer dump-autoload –o – выполняем оптимизацию автозагрузчика
find /home/dev/public_html/$DEVSERVER_FOLDER -type f -print0 | xargs -0 chmod 644 – выставляем права на файлы
find /home/dev/public_html/$DEVSERVER_FOLDER -type d -print0 | xargs -0 chmod 755 – выставляем права на директории
chown -R dev:dev /home/dev/public_html/$DEVSERVER_FOLDER – выставляем владельца директории приложения (если загрузка ведется от имени другого пользователя)

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

Надеемся, что эти два примера помогут вам настроить автоматический деплой приложения быстро и красиво! Ставьте ♥, делитесь с коллегами — и читайте другие статьи по разработке в нашем блоге.