Основные плагины Jenkins: руководство по выбору и настройке

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

Это руководство охватывает распространенные категории плагинов, практические примеры и привычки обслуживания, которые предотвращают превращение установок Jenkins с большим количеством плагинов в трудно обновляемые.

Понимание экосистемы плагинов Jenkins

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

Интеграция инструментов сборки: Плагины для интеграции с инструментами сборки, такими как Maven, Gradle, Ant и т.д.
Интеграция систем управления исходным кодом (SCM): Плагины для подключения к Git, Subversion, Mercurial и другим SCM-системам.
Фреймворки тестирования: Плагины для запуска и отчетности по различным типам тестов (модульные, интеграционные, безопасности и т.д.).
Инструменты развертывания и релизов: Плагины для развертывания приложений в различных средах (например, Docker, Kubernetes, облачные платформы).
Уведомления и отчетность: Плагины для отправки уведомлений о статусе сборки (email, Slack и т.д.) и создания отчетов.
Расширения Pipeline: Плагины, добавляющие функции в Jenkins Pipeline, такие как визуализация Pipeline as Code (Jenkinsfile) и общие библиотеки.
Безопасность и контроль доступа: Плагины для повышения безопасности Jenkins и управления правами пользователей.
Мониторинг и производительность: Плагины для мониторинга самого Jenkins.

Установка и управление плагинами

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

Доступ к менеджеру плагинов

Перейдите на панель управления Jenkins.
Нажмите Управление Jenkins в левом меню.
Выберите Управление плагинами.

Установка плагинов

На странице Управление плагинами вы найдете несколько вкладок:

Обновления: Список доступных обновлений для установленных плагинов.
Доступные: Показывает все плагины, доступные для установки из центра обновлений Jenkins.
Установленные: Отображает плагины, установленные в данный момент на вашем экземпляре Jenkins.
Дополнительно: Предоставляет опции для настройки центра обновлений, управления установкой плагинов и загрузки файлов плагинов.

Чтобы установить новый плагин:

Перейдите на вкладку Доступные.
Найдите нужный плагин по имени или ключевому слову.
Установите флажок рядом с плагином(ами), которые вы хотите установить.
Нажмите кнопку Установить без перезапуска или Загрузить сейчас и установить после перезапуска внизу страницы.

Совет: Для большинства плагинов достаточно Установить без перезапуска, и Jenkins автоматически загрузит и установит их в фоновом режиме. Если плагин требует перезапуска Jenkins для вступления в силу, используйте второй вариант.

Обновление и удаление плагинов

Обновление: На вкладке Обновления выберите плагины, которые хотите обновить, и нажмите Обновить выбранные пакеты. Или нажмите Обновить все.
Удаление: На вкладке Установленные установите флажок рядом с плагином, который хотите удалить, и нажмите Удалить.

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

Основные плагины для типичных сценариев CI/CD

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

1. Pipeline as Code и управление рабочими процессами

Jenkins Pipeline — это мощный плагин, который позволяет определить ваш CI/CD конвейер как код, обычно в файле Jenkinsfile. Это способствует контролю версий, повторному использованию и лучшей видимости ваших конвейеров.

Pipeline: Это основной плагин, который включает задачи Pipeline. Обычно он устанавливается по умолчанию в современных установках Jenkins.
Pipeline: Declarative Pipeline: Улучшает синтаксис Jenkinsfile более структурированным, основанным на правилах синтаксисом. Настоятельно рекомендуется для новых конвейеров.
Pipeline: Script Security: Управляет скриптами Groovy, используемыми в задачах Pipeline, позволяя одобрять или отклонять скрипты по соображениям безопасности.
Pipeline Utility Steps: Предоставляет полезные шаги для ваших скриптов Pipeline, такие как readJSON, writeJSON, zip, unzip и fileExists.

Пример конфигурации (Jenkinsfile - Declarative):

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building...' // Пример шага
                // Добавьте сюда команды сборки (например, mvn clean install)
            }
        }
        stage('Test') {
            steps {
                echo 'Testing...' // Пример шага
                // Добавьте сюда команды тестирования (например, mvn test)
            }
        }
        stage('Deploy') {
            steps {
                echo 'Deploying...' // Пример шага
                // Добавьте сюда команды развертывания
            }
        }
    }
    post {
        always {
            echo 'Pipeline finished.'
        }
        success {
            echo 'Pipeline succeeded!'
        }
        failure {
            echo 'Pipeline failed.'
        }
    }
}

2. Интеграция систем управления исходным кодом (SCM)

Чтобы запускать сборки и получать код, Jenkins должен интегрироваться с вашей SCM-системой.

Git Plugin: Необходим для интеграции с репозиториями Git. Поддерживает опрос SCM Git, получение кода и многое другое.
Subversion Plugin: Для команд, все еще использующих Subversion.

Пример конфигурации (Git в Pipeline):

stage('Checkout') {
    steps {
        git branch: 'main', url: 'https://github.com/your-username/your-repo.git'
    }
}

3. Инструменты сборки и среды

Эти плагины помогают Jenkins управлять и выполнять сборки для различных технологий.

Maven Integration plugin: Для проектов, использующих Maven. Позволяет настраивать версии Maven и цели.
Gradle Plugin: Для проектов, использующих Gradle.
NodeJS Plugin: Позволяет легко устанавливать и переключаться между различными версиями Node.js на ваших агентах Jenkins.

Пример конфигурации (NodeJS Plugin в Pipeline):

pipeline {
    agent any
    tools {
        nodejs 'NodeJS 18.x' // Имя, настроенное в Global Tool Configuration
    }
    stages {
        stage('Install Dependencies') {
            steps {
                sh 'npm install'
            }
        }
        stage('Build Frontend') {
            steps {
                sh 'npm run build'
            }
        }
    }
}

Чтобы настроить такие инструменты, как NodeJS или Maven:

Перейдите в Управление Jenkins -> Глобальная конфигурация инструментов.
Найдите соответствующий инструмент (например, NodeJS).
Нажмите Добавить NodeJS и настройте метод установки (например, Установить автоматически) и версию.
Дайте ему описательное имя (например, NodeJS 18.x), которое вы будете использовать в своем Jenkinsfile.

4. Тестирование и отчетность

Визуализация результатов тестов имеет решающее значение для понимания качества кода и выявления регрессий.

JUnit Plugin: Анализирует и отображает результаты тестов из формата JUnit XML. Большинство фреймворков тестирования могут генерировать этот формат.
Cobertura Plugin / JaCoCo Plugin: Для отчетов о покрытии кода (в зависимости от вашего инструмента сборки Java).

Пример конфигурации (JUnit в Pipeline):

stage('Test') {
    steps {
        // Предполагается, что ваши тесты создают результаты в target/surefire-reports/
        junit 'target/surefire-reports/**/*.xml'
    }
}

Чтобы это работало:

Убедитесь, что ваш инструмент сборки (например, плагин Maven Surefire) настроен на вывод отчетов JUnit XML.
Добавьте шаг junit в ваш конвейер после выполнения тестов.

5. Уведомления и связь

Информирование вашей команды о статусе сборки жизненно важно.

Email Extension Plugin: Предоставляет гибкие возможности уведомлений по электронной почте.
Slack Notification Plugin: Интегрирует сборки Jenkins с каналами Slack.
Microsoft Teams Notification Plugin: Аналогичная интеграция для Microsoft Teams.

Пример конфигурации (Slack Notification в Pipeline):

Сначала настройте интеграцию Slack в Управление Jenkins -> Настроить систему. Вам понадобится токен интеграции приложения Slack.

post {
    success {
        slackSend channel: '#ci-cd', message: 'Сборка #${env.BUILD_NUMBER} выполнена успешно! - ${env.JOB_NAME}'
    }
    failure {
        slackSend channel: '#ci-cd', color: 'danger', message: 'Сборка #${env.BUILD_NUMBER} не удалась! Проверьте логи: ${env.BUILD_URL}'
    }
}

6. Управление артефактами и архивирование

Сохранение результатов сборки (артефактов) для последующего использования или проверки.

Archive the Artifacts: Встроенный шаг Jenkins для архивирования файлов, созданных в результате сборки.

Пример конфигурации (Архивирование артефактов в Pipeline):

stage('Archive Artifacts') {
    steps {
        archiveArtifacts artifacts: 'target/*.jar', fingerprint: true
    }
}

Этот шаг архивирует все файлы .jar, найденные в каталоге target, и включает снятие отпечатков, что помогает отслеживать использование артефактов в разных сборках и задачах.

7. Безопасность и управление учетными данными

Безопасное управление конфиденциальной информацией, такой как пароли, ключи API и закрытые ключи SSH, имеет первостепенное значение.

Credentials Plugin: Стандартный плагин для управления учетными данными. Он предоставляет различные типы учетных данных (имя пользователя/пароль, ключи SSH, токены и т.д.).
Credentials Binding Plugin: Позволяет привязывать учетные данные к переменным среды или файлам в ваших шагах сборки, гарантируя, что конфиденциальные данные не будут раскрыты в логах.

Пример конфигурации (Использование учетных данных в Pipeline):

Добавление учетных данных: Перейдите в Управление Jenkins -> Управление учетными данными. В разделе Хранилища, ограниченные Jenkins, нажмите на домен (global). Нажмите Добавить учетные данные. Выберите тип (например, 'Имя пользователя с паролем'), заполните данные и укажите ID (например, my-docker-registry-creds).

Использование в Pipeline:

stage('Push to Docker Registry') {
    steps {
        withCredentials([usernamePassword(credentialsId: 'my-docker-registry-creds', usernameVariable: 'DOCKER_USER', passwordVariable: 'DOCKER_PASS')]) {
            sh 'printf "%s" "$DOCKER_PASS" | docker login -u "$DOCKER_USER" --password-stdin'
            sh 'docker push my-registry/my-image:latest'
        }
    }
}

Лучшие практики управления плагинами

Будьте минималистичны: Устанавливайте только те плагины, которые вам действительно нужны. Каждый плагин добавляет накладные расходы.
Регулярно пересматривайте: Периодически проверяйте установленные плагины. Удалите те, которые больше не используются или являются избыточными.
Обновляйте своевременно: Держите плагины обновленными, чтобы получать исправления ошибок, патчи безопасности и новые функции. Однако, если возможно, тестируйте обновления на промежуточном экземпляре Jenkins.
Проверяйте совместимость: Перед установкой нового плагина проверьте его документацию на совместимость с вашей версией Jenkins и другими критическими плагинами.
Понимайте зависимости: Некоторые плагины зависят от других. Менеджер плагинов обычно обрабатывает это, но знайте о возможных конфликтах.
Безопасность прежде всего: Будьте осторожны при установке плагинов из ненадежных источников. Используйте только плагины из официального центра обновлений Jenkins или из надежных источников.

Ключевой вывод

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