Provision
—— XP

Практика: первый конвейер проверок

практика~40 минут+525 XP

В репозитории ~/infra лежат описания Compose и конфигурации nginx, а скоро появятся и скрипты. Ошибку в них сейчас находишь только на стенде — когда что-то не поднялось. Сейчас ты напишешь конвейер, который находит это за минуту после push, и посмотришь на него в своём GitLab.

Проверки возьмём три простые: синтаксис YAML, итоговое описание Compose и скрипты. Файл будем собирать кусками, по одной задаче.

Шаг 1. Ветка

Конвейер — такое же изменение, как остальные, и в main он попадёт через merge request.

ubuntu@stand:~$
cd ~/infra
git switch -c ci/checks

Шаг 2. Стадии

Открой новый файл .gitlab-ci.yml в корне репозитория. Пока стадия одна — проверки.

nano ~/infra/.gitlab-ci.yml
stages:
  - check

Шаг 3. Проверка YAML

Первая задача ловит ошибки отступов — самую частую поломку YAML. yamllint ставится через pip в образе с Python, --quiet убирает простыню установки. Флаг -d relaxed у yamllint включает мягкие правила: длинные строки — не ошибка.

дописать в .gitlab-ci.yml
yaml-lint:
  stage: check
  image: python:3.12-slim
  script:
    - pip install --quiet yamllint
    - yamllint -d relaxed stand/

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

ubuntu@stand:~$
git add .gitlab-ci.yml
ubuntu@stand:~$
git commit -m "ci: проверка yaml"
ubuntu@stand:~$
git push -u gitlab ci/checks

Флаг -u у push связывает новую ветку с сервером, как в практике 05. Открой ссылку merge_requests/new из вывода и создай merge request, как в практике 05. На вкладке Overview появится плашка Pipeline #… running — конвейер уже запустился сам, на push ветки. Через минуту она станет зелёной: passed.

Шаг 4. Проверка Compose

Вторая задача собирает итоговое описание Compose — как docker compose config в разделе 08. Проверяем описание сервера — основной файл плюс серверный, как на стенде в серверном режиме. Каждый флаг -f добавляет файл описания, как в практике про окружения.

дописать в .gitlab-ci.yml
compose-config:
  stage: check
  image: docker:29-cli
  script:
    - docker compose -f stand/compose.yaml -f stand/compose.prod.yaml config > compose.txt

Закоммить с сообщением ci: проверка compose и отправь: git commit -am, затем git push. Флаг -a у commit сам добавляет изменённые файлы. На этот раз плашка красная. Открой упавшую задачу compose-config — ошибку ищут в конце журнала, над строкой Job failed:

конец журнала
error while interpolating services.app.image: required variable APP_IMAGE is missing a value: задай образ в .env
ERROR: Job failed: exit code 1

Файла .env в репозитории нет — и не должно быть, — а APP_IMAGE в серверном файле обязательна формой :?. Подставим учебные значения прямо в задачу, блоком variables под image. Заодно и две другие переменные: без них Compose подставил бы пустые строки и предупредил The "APP_NAME" variable is not set. Это не секреты, база с таким паролем нигде не поднимется.

в задачу compose-config, под image
  variables:
    APP_IMAGE: app:check
    APP_NAME: check
    POSTGRES_PASSWORD: only-for-check

Итоговое описание мы сохраняем в compose.txt. Чтобы файл не пропал вместе с контейнером задачи, объявим его артефактом — допиши в конец той же задачи:

дописать в задачу compose-config
  artifacts:
    paths:
      - compose.txt
    expire_in: 1 week

Закоммить и отправь — теперь обе задачи зелёные.

Шаг 5. Проверка скриптов

Третья задача — shellcheck, который ищет в скриптах ошибки вроде переменных без кавычек. Скриптов в репозитории пока нет, поэтому заведём первый — короткую проверку стенда снаружи. Каталог scripts понадобится и дальше: в практике про выкат туда ляжет скрипт выката.

ubuntu@stand:~$
mkdir -p ~/infra/scripts
nano ~/infra/scripts/check-stand.sh
#!/bin/bash
# Проверка стенда через прокси, как его видит пользователь
set -euo pipefail
URL=https://stand.provision.internal:8443/api/whoami
curl -fsS --cacert ~/devops-lab/tls/ca.crt "$URL"

Скрипт повторяет проверку из миссии раздела 08: -f превращает ответ с ошибкой в ненулевой код возврата. Сделай его исполняемым и запусти — ожидается ответ приложения.

ubuntu@stand:~$
chmod +x ~/infra/scripts/check-stand.sh
ubuntu@stand:~$
~/infra/scripts/check-stand.sh

Теперь задача, которая проверяет все скрипты каталога. У shellcheck есть готовый маленький образ.

дописать в .gitlab-ci.yml
shellcheck:
  stage: check
  image: koalaman/shellcheck-alpine:stable
  script:
    - shellcheck scripts/*.sh

Шаг 6. Отправить третью задачу

Скрипт и задачу — одним коммитом.

ubuntu@stand:~$
git add .gitlab-ci.yml scripts
ubuntu@stand:~$
git commit -m "ci: проверка скриптов"
ubuntu@stand:~$
git push

Если shellcheck покраснел на твоём скрипте, это не поломка конвейера, а его первая находка. В журнале у каждого замечания есть код вида SC2086 и номер строки — поправь скрипт и отправь ещё один коммит.

Шаг 7. Граф конвейера

Нажми на номер конвейера в плашке. Откроется граф: одна колонка check с тремя задачами. Пока они крутятся, у них синий значок, по окончании — зелёная галочка или красный крестик.

Задачи одной стадии могли бы идти одновременно, но наш раннер по умолчанию берёт одну задачу за раз, поэтому они выполнятся по очереди. Число одновременных задач задаёт строка concurrent в config.toml раннера; на стенде хватит и одной.

Если задача висит серой с подписью pending, раннер её не взял: проверь, что он онлайн, — Settings → CI/CD → Runners.

Шаг 8. Скачать артефакт

Открой задачу compose-config. Справа на странице задачи блок Job artifacts с кнопками Download и Browse. Нажми Browse и открой compose.txt.

Внутри — итоговое описание стека: все сервисы, подставленные переменные, полные пути томов. Это ровно то, что поднял бы Compose. Теперь его можно посмотреть, не заходя на стенд, — для каждого коммита.

Шаг 9. Запретить слияние красного

Проверки бесполезны, если красный MR всё равно можно влить. Включим запрет.

В проекте: Settings → Merge requests → раздел Merge checks → галочка Pipelines must succeed → Save changes. Теперь кнопка Merge работает только при зелёном конвейере.

Шаг 10. Сломать намеренно

Проверка, которую не пробовали сломать, обычно не проверяет ничего. Испортим ключ в описании Compose. Флаг -i у sed правит файл на месте.

ubuntu@stand:~$
sed -i 's/^services:/servises:/' stand/compose.yaml
ubuntu@stand:~$
git commit -am "проверка: сломанный compose"
git push

Флаг -a у commit сам добавляет изменённые файлы, -m задаёт сообщение. Через минуту в MR плашка станет красной: Pipeline failed, а кнопка Merge — недоступной.

Шаг 11. Прочитать красную задачу

Открой упавшую задачу compose-config. Ошибку ищут в конце журнала, над строкой Job failed.

конец журнала
docker compose … config > compose.txt
validating /builds/devops/infra/stand/compose.yaml:  additional properties 'servises' not allowed
Cleaning up project directory and file based variables
ERROR: Job failed: exit code 1

Строка с $ — команда, на которой всё остановилось. Под ней — её собственная ошибка: Compose не знает ключа servises. Последняя строка — итог: ненулевой код возврата. Число у тебя может быть другим, важно, что это не 0. Заметь: yaml-lint при этом зелёный — синтаксис YAML правильный, ошибка в смысле. Поэтому проверок несколько.

Шаг 12. Отменить поломку и влить

Отменим последний коммит новым коммитом — git revert из раздела 06. Флаг --no-edit берёт сообщение по умолчанию.

ubuntu@stand:~$
git revert --no-edit HEAD
ubuntu@stand:~$
[ci/checks 5d2e8a1] Revert "проверка: сломанный compose"
 1 file changed, 1 insertion(+), 1 deletion(-)
ubuntu@stand:~$
git push

Конвейер снова зелёный, кнопка Merge ожила. Нажми Merge. После слияния конвейер запустится ещё раз — уже на main. Забери результат к себе:

ubuntu@stand:~$
git switch main
git pull

Шаг 13. Сдать

Выполни команду сдачи: она покажет задачи из .gitlab-ci.yml в gitlab/main и последние коммиты.

Практика 04+525 XP

Собрать первый настоящий конвейер в своём GitLab, читать его граф и журналы, пользоваться артефактами и запретить слияние красного merge request.

  • Стадии объявлены
  • Три проверки на месте
  • Артефакт объявлен
  • Поломка отменена коммитом
  • Конвейер влит через merge request
Команда сдачи — выполни на своей машине
команда
cd ~/infra; git fetch -q gitlab; git show gitlab/main:.gitlab-ci.yml | grep -E '^[a-z-]+:|artifacts:'; git log --oneline -6 gitlab/main

Нашёл ошибку или непонятное место? Наведи на абзац — слева появится «+», нажми и напиши, что не так. Замечание увидит автор курса.Нашёл ошибку или непонятное место? Нажми «+» справа от заголовка раздела и напиши, что не так. Замечание увидит автор курса.