CICD
Содержание
Практика по CI/CD
Тема 0
Тема:
Организация доступа на GNU/Linux хост посредством протокола ssh. Установка gitlab-runner на GNU/Linux хост.
Отчёт:
В отчёт необходимо включить результат последовательного выполнения шагов 0.* и вывод по достигнутым результатам. Каждой теме и каждому шагу в отчёте необходимо дать осмысленное название.
Шаг 0.1
Посредством утилиты:
ssh-keygen
создайте ключевую пару (открытую и закрытую части криптографического ключа).
Обычно результатом создания ключевой пары являются файлы:
id_ed25519 id_ed25519.pub
или:
id_rsa id_rsa.pub
(в зависимости от типа шифрования, настроенного операционной системе, на которой создаётся ключевая пара).
Файл с суффиксом:
.pub
содержит открытую часть ключа. Второй файл, соответственно, содержит закрытую часть ключа.
Закрытую часть сохраните у себя и ни кому не передавайте (это ваш будущий ключ от удалённого GNU/Linux хоста).
Содержимое открытой части ключа добавьте к содержимому файла:
authorized_keys
, который обычно находится в каталоге:
.ssh
внутри домашнего каталога пользователя, под которым вы планируете подключаться на GNU/Linux хост по протоколу ssh.
Да, верно: открытую часть ключа следует доставить на удалённый GNU/Linux хост и положить в выше упомянутый файл в выше упомянутом каталоге того пользователя удалённого GNU/Linux хоста, под которым планируется подключение.
Шаг 0.2
Для процедуры доставки открытой части ключа можно воспользоваться утилитой:
ssh-copy-id
(если это позволяют настройки безопасности удалённого GNU/Linux хоста) либо в ручном режиме переместить содержимое открытого ключа в необходимый файл на удалённом хосте, предварительно подключившись на удалённый GNU/Linux хост по протоколу ssh по логину и паролю.
При корректной настройке удалённого GNU/Linux хоста к нему можно будет подключаться, используя закрытую часть ключа, командой, общий вид которой следующий:
ssh -i </путь/до/закрытой_части_ключа> <пользователь>@<хост_или_ip_адрес> -p <порт>
Если порт ssh сервера, к которому производится подключение, стандартный (22), то ключ -p с номером порта в команде можно опустить.
Пример команды:
ssh -i ~/.ssh/id_ed25519 user@10.207.123.123 -p 22
При выполнении такой команды подразумевается, что содержимое файла:
id_ed25519.pub
находится в файле:
/home/user/.ssh/authorized_keys
на GNU/Linux хосте с ip-адресом:
10.207.123.123
а ssh сервер работает на этом же хосте на стандартном порту
22
(как уже говорилось выше, ключ -p 22 в команде можно опустить, если порт сервера стандартный -- 22-й).
Шаг 0.3
Предыдущие два шага демонстрируют процесс настройки БЕЗОПАСНОГО доступа на уалённый сервер.
Безопасным доступом в этом контексте является доступ с аутентификацией по ключам, а не по паролю (пароль может быть подобран извне специализированным программным обеспечением).
Следовательно, категорически не рекомендуется оставлять доступ по паролю на удалённый сервер!
Когда доступ на удалённый сервер (GNU/Linux хост) получен, на нём необходимо установить и настроить средство выполнения для gitlab.
Это программное обеспечение называется:
gitlab-runner
В некоторых GNU/Linux дистрибутивов gitlab-runner может входить в состав репозитория программного обеспечения.
Далее будет рассмотрена процедура установки средства выполнения "gitlab-runner" универсальным способом.
Шаг 0.4
1. Подключитесь к серверу по протоколу ssh;
2. Перейдите в режим суперпользователя;
3. Загрузите бинарную версию средства выполнения "gitlab-runner" для сервера архитектуры x86_64 (она же amd64) командой:
curl -L --output /usr/local/bin/gitlab-runner https://wiki.nntc.nnov.ru/download/gitlab-runner-linux-amd64
4. Сделайте загруженный файл исполняемым:
chmod +x /usr/local/bin/gitlab-runner
5. Добавьте пользователя, от имени которого будет работать средство выполнения
useradd --comment 'GitLab Runner' --create-home gitlab-runner --shell /bin/bash
6. Установите и запустите средство выполнения как сервис
gitlab-runner install --user=gitlab-runner --working-directory=/home/gitlab-runner gitlab-runner start
Готовые бинарные сборки средства выполнения "gitlab-runner" существуют также под архитектуры 386, arm и arm64.
Для снижения нагрузки на интернет-канал лабораторий колледжа в команде (п.3) установки используется локальная ссылка.
Более подробную информацию по установке средства выполнения можно получить [ https://docs.gitlab.com/runner/install/ здесь ]
Тема 1
Тема:
Создание проекта в https://gitlab.nntc.nnov.ru, настройка gitlab-runner, создание простейшего файла .gitlab-ci.yml
Отчёт:
В отчёт необходимо включить результат последовательного выполнения шагов 1.* и вывод по достигнутым результатам. Название gitlab-проекта обязательно должно включать фамилию обучающегося. Отчёт должен содержать ссылку на существующий git-репозиторий, соответствующий репозиторию, описанному в отчёте. Каждой теме и каждому шагу в отчёте необходимо дать осмысленное название.
Шаг 1.1
Войдите в свой аккаунт на https://gitlab.nntc.nnov.ru и создайте новый git-репозиторий.
Далее в пределах этого практикума ваш репозиторий будет иметь шаблонное название
<up_petrov_ii>
Шаг 1.2
Перейдите на страницу созданного репозитория.
Найдите раздел "Средства выполнения" в меню "Настройки - CI/CD"
Создайте средство выполнения, заполнив форму следующим образом:
Теги:
test
Остальные параметры оставьте по умолчанию, затем нажмите кнопку:
Создать средство выполнения
На следующей странице ознакомьтесь с пошаговой инструкцией по запуску средства выполнения gitlab-runner (пройдите по предлагаемым ссылкам инструкции чтобы ознакомиться наиболее полно!), скопируйте команды, которые в последующем понадобятся для запуска средства выполнения на GNU/Linux хосте, затем нажмите на кнопку:
Просмотр средств выполнения
В результате в списке средств выполнения появится ваше средство выполнения, которое будет иметь номер и уникальное название. Например:
#20 (LDBWhOpr)
Шаг 1.3
Рядом с созданным на предыдущем шаге средством выполнения будет показан треугольный значок с восклицательным знаком. Это означает, что gitlab не не подключился к средству выполнения на GNU/Linux хосте. Теперь необходимо это настроить.
Используйте скопированные ранее команды чтобы зарегистрировать средство выполнения на GNU/Linux хосте. Для этого:
1. Войдите на GNU/Linux хост по протоколу ssh;
2. Выполните команду для регистрации средства выполнения;
3. Перейдите на страницу "Средства выполнения" проекта;
4. Убедитесь что треугольный значок с восклицательным знаком пропал и на его месте появился зелёный кружок, символизирующий успешное подключение gitlab к средству выполнения (к gitlab-runner-у).
Если после всех выполненных действий рядом со средством выполнения по прежнему показан треугольный значок с восклицательным знаком, значит необходимо заново пройти все шаги темы 1 до достижения правильного результата.
Шаг 1.4
Склонируйте ваш репозиторий себе на компьютер и создайте внутри файл
.gitlab-ci.yml
со следующим содержимым
stages:
- test
hello_job:
stage: test
tags:
- test
script:
- echo "Hello from GitLab CI"
- uname -a
- echo "Hello from GitLab CI" > /tmp/test
- uname -a >> /tmp/test
Сделайте коммит (git commit) и синхронизируйте изменения с репозиторием (git push).
Затем перейдите в средство выполнения ("Сборка" - "Средства выполнения") в меню вашего репозитория в gitlab и посмотрите статус задания.
Опишите результат в отчёт.
Затем войдите по протоколу ssh на GNU/Linux хост, на котором работает средство выполнения и просмотрите содержимое файла:
/tmp/test
Опишите результат исследования файла на GNU/Linux хосте.
Шаг 1.5
Сделайте полный вывод о проделанной работе по теме 1.
Свяжите работу средства выполнения с содержимым файла:
.gitlab-ci.yml
Шаг 1.6
Ответьте на вопросы и разместите вопросы и ответы на них в отчёте.
Список вопросов:
1. Сколько команд будет выполнено средством выполнения? 2. Какие именно это команды? 3. Какие команды формируют содержимое файла test в каталоге /tmp GNU/Linux хоста? 4. Как связано название стадии (stage) и названия тегов, указываемых при конфигурировании средства выполнения? 5. На что влияют названия тегов, указываемых при конфигурирования средства выполнения?
