Покрокове керівництво по налаштуванню пайплайнів CI/CD в Jenkins

Jenkins - це сервер автоматизації, який зазвичай використовується для налаштування пайплайнів CI/CD. Він підходить як для невеликих проектів, так і для великомасштабних корпоративних робочих процесів, пропонуючи потужні інструменти для оптимізації та автоматизації процесу доставки програмного забезпечення. Незалежно від того, чи працюєте ви над простими завданнями, чи керуєте складними операціями, Jenkins адаптується до потреб різноманітних середовищ розробки, що робить його універсальним рішенням для безперервної інтеграції та розгортання в різних галузях.

У цьому посібнику ви дізнаєтеся, як встановити Jenkins, налаштувати його та створити базовий пайплайн CI/CD для автоматизації процесу розробки програмного забезпечення.

Що вам знадобиться

Перш ніж ми почнемо, переконайтеся, що у вас є

• Розгорнутий сервер з обраною вами ОС.
• Встановлена Java (JDK 11 або новішої версії) на сервері.
• Встановлений Git на сервері для репозиторіїв коду.
• (Необов'язково) Встановлений Docker для контейнерних додатків.
• Доступ до сервера по SSH з правами адміністратора.

Кроки з налаштування Jenkins

Ви можете налаштувати Jenkins двома способами.

Ви можете перейти на сторінку завантаження Jenkins і встановити його, вибравши відповідну версію для вашого комп'ютера.

Після завантаження файлів Дженкінса ви побачите майстер встановлення.

Далі вам потрібно вказати папку призначення для програми.

Нарешті, ви отримаєте облікові дані для входу в сервіс.

Переконайтеся, що ви запускаєте Jenkins як локальний або доменний користувач, оскільки якщо Jenkins буде запущено як LocalSystem, він отримає повний доступ до вашого комп'ютера, що зовсім не безпечно.

Щоб запустити Jenkins як локальний або доменний користувач, вам потрібно вставити ім'я користувача домену і пароль до облікового запису, з яким ви хочете запустити Jenkins, потім натиснути кнопку Перевірити облікові дані, щоб перевірити їх, а потім натиснути кнопку Далі. Після цього вам буде запропоновано:

• вибрати порт, на якому буде запущено Jenkins, а потім протестувати його.
• вибрати домашній каталог Java.
• вибрати інші служби, які ви хочете встановити разом з Jenkins.
• підтвердити встановлення.

Або, якщо ваш сервер підготовлено, ви можете встановити Jenkins, виконавши наступні кроки:

1. Додайте ключ і сховище Jenkins GPG: sudo wget -O /usr/share/keyrings/jenkins-keyring.asc \https://pkg.jenkins.io/debian/jenkins.io-2023.keyecho «deb [signed-by=/usr/share/keyrings/jenkins-keyring.asc]» \https://pkg.jenkins.io/debian binary/ | sudo tee \ /etc/apt/sources.list.d/jenkins.list > /dev/null
2. Оновлення списку пакетів: sudo apt update
3. Встановіть Jenkins:sudo apt install jenkins
4. Запуск і включення служби Jenkins: sudo systemctl start jenkins sudo systemctl enable jenkins
   

Як отримати доступ до інформаційної панелі Jenkins

Після запуску Jenkins ви можете отримати доступ до інтерфейсу користувача Jenkins для початкового налаштування:

1. Відкрийте веб-браузер і перейдіть за адресою http://<ваш-ip>:8080.
   
2. Щоб розблокувати Jenkins, отримайте пароль адміністратора, виконавши sudo cat /var/lib/jenkins/secrets/initialAdminPassword
3. Введіть пароль в інтерфейсі користувача Jenkins і дотримуйтесь вказівок майстра налаштування.
4. Встановіть запропоновані плагіни.
5. Створіть обліковий запис адміністратора і завершіть налаштування.
   

Після завершення налаштування вас буде перенаправлено на інформаційну панель Jenkins для початку налаштування конвеєра CI/CD.

Налаштування параметрів Jenkins

Після встановлення Jenkins наступним кроком буде його налаштування відповідно до особливостей вашого пайплайну CI/CD. Наведені нижче кроки допоможуть вам налаштувати облікові дані для доступу до зовнішніх сервісів і налаштувати глобальні інструменти, які Jenkins використовуватиме під час збирання та розгортання. Сюди входить додавання облікових даних для систем контролю версій, таких як GitHub, і налаштування інструментів, таких як Java, Maven і Docker, які будуть потрібні на різних етапах вашого пайплайну.

Встановлення основних плагінів

Справжня сила Дженкінса полягає в його розгалуженій екосистемі плагінів, яка дозволяє вам кастомізувати систему. Щоб розпочати роботу з конвеєром CI/CD, вам потрібно встановити кілька основних плагінів:

• Git Plugin: Це дозволяє Jenkins взаємодіяти з репозиторіями Git, дозволяючи вам клонувати, збирати та виштовхувати код.
  

Перейдіть на інформаційну панель Jenkins > Керування Jenkins > Керування плагінами > Доступні. Знайдіть Git Plugin і встановіть його.

• Плагін Pipeline : Цей плагін необхідний для визначення та виконання конвеєрів Дженкінса через файл Дженкінса, він автоматизує процеси збірки, тестування та розгортання.
  

Знайдіть Pipeline і встановіть його.

• Плагін пайплайна Docker (необов'язковий): Якщо ви плануєте інтегрувати Docker у ваш конвеєр, цей плагін дозволить вам включити команди Docker у ваш Jenkinsfile, полегшуючи збірку та керування контейнерами Docker.
  

Знайдіть Docker Pipeline і встановіть його.

• Плагін прив'язки облікових даних: Цей плагін допомагає безпечно керувати та використовувати облікові дані у вашому конвеєрі, такі як токени API або паролі.
  

Знайдіть плагін Credentials Binding Plugin і встановіть його.

Завдяки цим плагінам функціональність Jenkins значно розширюється, що дозволяє створювати більш просунуті та автоматизовані пайплайни.

Налаштування облікових даних

Щоб дозволити Jenkins безпечно взаємодіяти з GitHub, Docker Hub або іншими сторонніми системами, вам потрібно налаштувати облікові дані та керувати ними. Ось як це зробити:

1. Перейдіть до розділу «Облікові дані»:
   Перейдіть на інформаційну панель Jenkins > Керування Jenkins > Керування обліковими даними.
2. Додавання облікових даних
   Виберіть відповідний домен (зазвичай глобальний, якщо ви не впорядковуєте облікові дані за проектами).
   Натисніть (глобальний) у розділі Сховища з прив'язкою до Jenkins, а потім виберіть Додати облікові дані.
3. Оберіть тип облікових даних
   Для GitHub або GitLab виберіть Ім'я користувача з паролем або Секретний текст (для токенів API).
   Для Docker Hub виберіть Ім'я користувача з паролем. Введіть необхідні дані, такі як ім'я користувача, пароль або токен API, а також надайте змістовний ідентифікатор для легкого пошуку.
4. Зберегти облікові дані
   Після додавання облікових даних вони будуть надійно збережені в Jenkins і можуть бути використані у ваших конвеєрах.
   

Налаштування облікових даних гарантує, що Jenkins може безпечно взаємодіяти з іншими сервісами, наприклад, витягувати код зі сховища або виштовхувати образи Docker, не розкриваючи конфіденційну інформацію.

Визначення глобальних налаштувань інструменту

Щоб Jenkins міг створювати, тестувати та розгортати ваші програми, йому потрібен доступ до інструментів розробки. Налаштування цих глобальних інструментів гарантує, що Jenkins знатиме, де їх знайти у вашій системі.

1. Перехід до налаштування глобальних інструментів
   Перейдіть на інформаційну панель Jenkins > Керування Jenkins > Глобальна конфігурація інструментів.
2. Налаштуйте Git:
   У розділі Git натисніть Додати Git. Якщо Git встановлено у стандартному місці, Дженкінс має автоматично виявити його.
   Якщо ні, вкажіть шлях до виконуваного файлу Git.
3. Налаштування Maven (якщо це можливо)
   Якщо ваш проект використовує Maven для збірки, прокрутіть до Maven, натисніть Додати Maven і або дозвольте Jenkins встановити його автоматично, або вкажіть шлях до встановлення.
4. Налаштування Gradle (якщо застосовно)
   Подібно до Maven, у розділі Gradle натисніть Додати Gradle і виберіть автоматичне встановлення або вкажіть шлях до нього
   

Після налаштування цих інструментів, Jenkins зможе викликати їх під час виконання конвеєра, гарантуючи, що ваші збірки працюватимуть безперебійно незалежно від залучених технологій.

Створіть свій перший пайплайн

Коли Jenkins налаштований і готовий, наступним кроком буде створення пайплайну для автоматизації процесів збірки, тестування і розгортання. Виконайте ці кроки, щоб створити базовий пайплайн.

Початок нового проекту Jenkins

Jenkins пропонує різні типи завдань. Для пайплайнів CI/CD тип завдання «Пайплайн» зазвичай є найкращим вибором завдяки його гнучкості та сумісності з Jenkinsfiles.

1. Перехід до нового елемента
   На інформаційній панелі Jenkins натисніть «Новий елемент».
2. Виберіть тип завдання
   Введіть назву для вашого завдання (наприклад, MyFirstPipeline). Виберіть Pipeline зі списку типів завдань і натисніть OK.
3. Налаштуйте завдання
   Вас буде перенаправлено на сторінку конфігурації завдання, де ви зможете налаштувати поведінку пайплайну.
   

Тип завдання « Пайплайн» ідеально підходить для складних робочих процесів CI/CD, оскільки дозволяє визначити весь пайплайн у файлі Jenkins, що полегшує керування та контроль версій.

Створення файлу Jenkinsfile

Файл Jenkins - це текстовий файл, який визначає ваш пайплайн CI/CD у вигляді коду. Цей файл створюється за допомогою специфічної для домену мови (DSL), наданої Jenkins, і зазвичай зберігається у кореневому каталозі сховища контролю вихідного коду вашого проекту. Він описує кроки, які має виконати Jenkins для створення, тестування та розгортання вашої програми.

1. Розуміння структури Jenkinsfile:
   Базовий файл Jenkinsfile зазвичай включає такі етапи, як збірка, тестування та розгортання. Кожен етап містить кроки, які визначають дії, які буде виконувати Дженкінс.
2. Створення простого файлу Дженкінса:
   

pipeline { agent any
stages {
    stage('Clone Repository') {
        steps {
            git '<https://github.com/your-repo/your-project.git>'
        }
    }
    stage('Build') {
        steps {
            // Example build step
            sh 'make build'
        }
    }
    stage('Test') {
        steps {
            // Example test step
            sh 'make test'
        }
    }
}
}

• пайплайн: Блок верхнього рівня, що визначає весь пайплайн.
• агент: Вказує, де повинен працювати конвеєр; це означає, що він може працювати на будь-якому доступному агенті.
• етапи: Блок, що містить всі етапи конвеєра.
• етап: Визначає окремий етап конвеєра, наприклад, Clone Repository, Build або Test.
• кроки: Команди або дії, які виконує Jenkins на кожному етапі.

3. Додати файл Jenkins до вашого сховища:

Збережіть файл Jenkinsfile у кореневому каталозі сховища вашого проекту.

Визначення тригерів збірки

Тригери збірки в Jenkins визначають, коли і як буде виконуватися ваш конвеєр. Jenkins пропонує ряд варіантів тригерів, від ручних запусків до автоматизованих тригерів.

1. Перейдіть до розділу Створення тригерів: На сторінці конфігурації вашого завдання прокрутіть вниз до розділу «Створення тригерів».
2. Виберіть метод запуску:
   - Опитувати SCM: Дженкінс періодично перевірятиме ваше сховище коду на наявність змін. Встановіть частоту опитування (наприклад, *H/5 * * * ** кожні 5 хвилин).
   - Тригер хука GitHub: Для користувачів GitHub налаштуйте веб-хук для автоматичного запуску конвеєра при появі нового push або pull-запиту.
   - Періодична збірка: Заплануйте запуск конвеєра через певні проміжки часу за допомогою синтаксису, схожого на cron.
   - Ручний запуск: Тригер збирається вручну з панелі інструментів Дженкінса, коли це необхідно.
3. Налаштуйте тригер: Для веб-хуків переконайтеся, що ваш репозиторій налаштовано на надсилання POST-запитів до Jenkins, коли відбуваються зміни. Дженкінс прослухає ці запити і відповідно запустить пайплайн.
   

Запустити пайплайн-завдання

1. Запустіть конвеєр: На сторінці вашого завдання натисніть кнопку «Створити зараз», щоб вручну запустити пайплайн. Якщо ви налаштували автоматичні тригери, конвеєр запуститься автоматично, коли відбудеться вказана подія (наприклад, поштовх коду).
2. Відстежуйте процес збірки: Jenkins показуватиме прогрес на кожному етапі в реальному часі. Ви можете переглядати журнали, перевіряти стан кожного етапу і вирішувати будь-які проблеми, які можуть виникнути. Якщо конвеєр завершиться успішно, ви побачите зелену галочку для всіх етапів.
3. Перегляньте результати: Після завершення роботи конвеєра перегляньте журнали та результати збірки. Дженкінс надасть детальну інформацію про виконані кроки, будь-які помилки, що виникли, а також про загальний успіх або невдачу конвеєра.

Підключення Jenkins до системи контролю версій

Інтеграція Jenkins з системами контролю версій, такими як GitHub або GitLab, має вирішальне значення для автоматизації вашого конвеєра CI/CD. Вам потрібно налаштувати Jenkins так, щоб він автоматично запускав збірки, коли зміни потрапляють до сховища.

Посилання на репозиторії GitHub

Для початку вам потрібно підключити Jenkins до вашого репозиторію GitHub або GitLab. Це підключення дозволить Jenkins отримувати сповіщення (веб-хуки), коли у вашому репозиторії відбуваються зміни, а також безпечно автентифікуватися при доступі до вашої кодової бази.

1. Налаштуйте автентифікацію:
   - Створіть персональний токен доступу: Перейдіть на GitHub > Налаштування > Налаштування розробника > Персональні токени доступу > Створити новий токен. Виберіть необхідні діапазони, такі як repo та admin:repo_hook.
   - Додайте токен до Дженкінса: У Дженкінсі перейдіть до Керування Дженкінсом > Керування обліковими даними > (глобально) > Додати облікові дані.
   - Виберіть Секретний текст для токена, введіть токен і присвойте йому описовий ідентифікатор (наприклад, github-token).
2. Налаштуйте веб-хуки: Перейдіть до вашого репозиторію на GitHub і перейдіть до Налаштування > Вебхуки > Додати вебхук. Встановіть URL-адресу корисного навантаження на http://your-jenkins-url/github-webhook/ і виберіть application/json як тип контенту. Виберіть події, які будуть запускати вебхук, зазвичай це лише подія Push і Pull запити.
3. Налаштуйте завдання Дженкінса:
   - Посилання на ваше сховище:У конфігурації завдання Jenkins, у розділі Конвеєр, вкажіть URL-адресу вашого сховища у форматі https://github.com/your-repo/your-project.git.
   - Використовувати облікові дані: Переконайтеся, що Jenkins використовує облікові дані (персональний токен доступу), які ви додали раніше. Виберіть ці облікові дані зі спадаючого списку «Облікові дані» у розділі SCM конфігурації вашого завдання.

Після налаштування автентифікації та веб-хуків Jenkins буде підключено до вашого сховища GitHub або GitLab, що дозволить йому отримувати ваш код і автоматично запускати збірки.

Керування гілками та PR-збірками

Щоб повною мірою використовувати Jenkins, дуже важливо налаштувати його для створення гілок функцій і витягування запитів. Це налаштування допомагає виявити проблеми інтеграції на ранніх стадіях, підвищуючи загальну якість вашого коду.

• Налаштування багатоланкового пайплайну: Завдання багатоланкового пайплайну в Jenkins автоматично створює пайплайни для всіх гілок у сховищі, створюючи кожну гілку на основі власного Jenkins-файлу.
  

- Створення багатогалузевого пайплайна: На інформаційній панелі Jenkins натисніть кнопку «Новий елемент» і виберіть «Багатогалузевий пайплайн». Назвіть ваше завдання (наприклад, MyProject-Multibranch).
- Налаштуйте джерела гілок: У конфігурації завдання в розділі Джерела гілок додайте свій репозиторій GitHub і використовуйте облікові дані, які ви налаштували раніше.
- Встановіть тригери конвеєра сканування для періодичної перевірки нових гілок або оновлень, або для реагування на події веб-хука.

• Конфігурація збірки гілок: Jenkins автоматично виявить і створить всі гілки за допомогою файлу Jenkinsfile. Ви можете налаштувати обробку різних гілок.
  - Виключення та фільтри: Виключіть певні гілки зі збірки, налаштувавши стратегію властивостей у джерелах гілок. Наприклад, ви можете використовувати регулярний вираз, щоб відфільтрувати гілки з певними шаблонами назв.
  - Спеціальна конфігурація гілки: Визначте певну поведінку для гілок за допомогою директиви when у вашому Jenkins-файлі. Наприклад, ви можете вказати, що певні етапи виконуються лише для головної гілки:
  

stage('Deploy') { 
when { 
branch 'main' 
} 
steps { 
// Deployment steps here } 
}

• Збірка запитів на витягування: Дженкінс може автоматично створювати запити на витягування для тестування запропонованих змін перед тим, як об'єднати їх в основну гілку.
  - Увімкніть збірки висхідних запитів: У конфігурації завдання багатогілкового конвеєра Дженкінс буде виявляти витягнуті запити, якщо ви використовуєте підтримувані джерела, такі як GitHub або GitLab. Ці запити з'являться як окремі гілки і можуть бути побудовані аналогічно до інших гілок.
  - Налаштування звітів про стан: Дженкінс може повідомляти про стан збірки pull-запитів на GitHub або GitLab, дозволяючи вам бачити результати збірки безпосередньо в pull-запиті.
  - Переконайтеся, що ваш персональний токен доступу має необхідні дозволи (repo:status для GitHub або api для GitLab).
  

Налаштування сповіщень про збірку

Щоб тримати вашу команду в курсі статусів збірки і розгортання, важливо налаштувати сповіщення в Jenkins. Сповіщення можна надсилати електронною поштою або інтегрувати з інструментами для спільної роботи, такими як Slack або Microsoft Teams, гарантуючи, що всі будуть в курсі успіху або невдачі кожного пайплайну.

Налаштування сповіщень електронною поштою

Сповіщення електронною поштою - це простий, але ефективний спосіб тримати вашу команду в курсі результатів пайплайну. Jenkins може автоматично надсилати ці сповіщення на різних етапах проекту.

1. Встановіть плагін розширення електронної пошти:
   Перейдіть на інформаційну панель Jenkins > Керування Jenkins > Керування плагінами > Доступні, знайдіть плагін Email Extension Plugin і встановіть його, якщо він ще не встановлений.
2. Налаштуйте SMTP-сервер:
   Перейдіть до Керування Jenkins > Налаштування системи.
   Перейдіть до розділу Розширені сповіщення електронної пошти і введіть дані вашого SMTP-сервера:
   - Сервер SMTP: Адреса вашого поштового сервера (наприклад, smtp.yourdomain.com).
   -   Порт SMTP: Використовуйте 587 для TLS або 465 для SSL.
   - Аутентифікація SMTP: Позначте цю опцію, якщо ваш сервер вимагає ім'я користувача та пароль.
   - Використовувати SSL/TLS: Увімкніть цю опцію, якщо ваш SMTP-сервер вимагає SSL або TLS.
3. Налаштуйте сповіщення електронною поштою в конвеєрі: Ви можете визначити сповіщення електронною поштою безпосередньо у вашому Jenkinsfile, щоб надсилати сповіщення на основі статусу збірки:
   

groovy
Copy code
pipeline {
    agent any


    stages {
        stage('Build') {
            steps {
                sh 'make build'
            }
        }
    }


    post {
        success {
            emailext subject: "Build Success: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
                     body: "Good news! The build succeeded.",
                     to: 'team@example.com'
        }
        failure {
            emailext subject: "Build Failed: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
                     body: "Oops! The build failed. Please check the logs.",
                     to: 'team@example.com'
        }
    }
}

• пост: Цей блок визначає дії, які виконуються після завершення роботи пайплайну, наприклад, надсилання імейлів.
• успіх і невдача: Вкажіть, що робити у випадку успішного або невдалого завершення збірки. Крок надсилання електронного листа надсилає електронний лист з відповідною темою і тілом.

Налаштування інтеграції зі Slack або Teams

Для команд, які використовують інструменти для співпраці, такі як Slack або Microsoft Teams, інтеграція Jenkins з цими платформами гарантує, що сповіщення про збірку доставляються безпосередньо на канали команди, забезпечуючи оновлення в реальному часі.

Інтеграція зі Slack

1. Встановіть плагін сповіщень Slack:
   - Перейдіть на інформаційну панель Jenkins > Керування Jenkins > Керування плагінами > Доступні.
   - Знайдіть плагін Slack Notification Plugin, встановіть його та перезапустіть Jenkins, якщо це необхідно.
2. Налаштуйте інтеграцію зі Slack:
   - Перейдіть до Керування Jenkins > Налаштування системи.
   - Прокрутіть вниз до розділу Slack і введіть наступні дані:
   - Робочий простір: Введіть назву вашого робочого простору Slack.
   - Обліковий запис: Додайте токен інтеграції зі Slack (отриманий шляхом створення вхідного веб-хука або через додаток Jenkins CI для Slack).
   - Канал за замовчуванням: Вкажіть канал Slack, на який слід надсилати сповіщення за замовчуванням.
3. Додати сповіщення Slack до Jenkinsfile:
   

groovy
Copy code
pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh 'make build'
            }
        }
    }
    post {
        success {
            slackSend channel: '#build-notifications', color: 'good',
                      message: "Build Success: ${env.JOB_NAME} #${env.BUILD_NUMBER}"
        }
        failure {
            slackSend channel: '#build-notifications', color: 'danger',
                      message: "Build Failed: ${env.JOB_NAME} #${env.BUILD_NUMBER}"
        }
    }
}

Інтеграція з Microsoft Teams

1. Створіть вхідний веб-хук у Microsoft Teams:
   - У Microsoft Teams перейдіть до каналу, на який ви хочете отримувати сповіщення.
   - Перейдіть до Додаткові параметри (⋯) > Коннектори > Вхідний веб-хук. Назвіть веб-хук і скопіюйте надану URL-адресу.
2. Інсталюйте плагін сповіщень Microsoft Teams:
   - Перейдіть на інформаційну панель Jenkins > Керування Jenkins > Керування плагінами > Доступні.
   - Знайдіть плагін Office 365 Connector Plugin, встановіть його та перезапустіть Jenkins, якщо потрібно.
3. Налаштуйте інтеграцію з командами:
   - Перейдіть на сторінку конфігурації завдання в Jenkins.
   - Перейдіть до розділу Коннектор Office 365 і вставте URL-адресу веб-хука з Teams.
4. Додайте сповіщення Teams до файлу Jenkins:
   

groovy
Copy code
pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh 'make build'
            }
        }
    }
    post {
        success {
            office365ConnectorSend message: "Build Success: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
                                   webhookUrl: 'YOUR_WEBHOOK_URL'
        }
        failure {
            office365ConnectorSend message: "Build Failed: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
                                   webhookUrl: 'YOUR_WEBHOOK_URL'
        }
    }
}

Це налаштування гарантує, що ваша команда отримуватиме сповіщення в реальному часі в Slack або Microsoft Teams, тримаючи всіх в курсі стану проекту.