Миграция с Jenkins с помощью импортера GitHub Actions

Узнайте, как использовать GitHub Actions Importer для автоматизации миграции конвейеров Jenkins в GitHub Actions.

В этой статье

О миграции с Jenkins с помощью импортера GitHub Actions

Приведенные ниже инструкции помогут вам настроить среду для использования GitHub Actions Importer для переноса конвейеров Jenkins в GitHub Actions.

Необходимые компоненты

  • Учетная запись или организация Jenkins с конвейерами и заданиями, которые необходимо преобразовать в рабочие процессы GitHub Actions.
  • Доступ к созданию личного маркера API Jenkins для вашей учетной записи или организации.

Ограничения

При миграции из Jenkins в GitHub Actions с GitHub Actions Importerсуществуют некоторые ограничения. Например, необходимо вручную перенести следующие конструкции:

  • Обязательные средства сборки
  • Скриптовые конвейеры
  • Секреты
  • Локальные средства выполнения тестов
  • Неизвестные подключаемые модули

Дополнительные сведения о миграции вручную см. в разделе Переход с Jenkins на GitHub Actions.

Установка расширения CLI GitHub Actions Importer

  1. Установите расширение CLI GitHub Actions Importer :

    Bash
    gh extension install github/gh-actions-importer

  2. Убедитесь, что расширение установлено:

    $ gh actions-importer -h
Options:
  -?, -h, --help  Show help and usage information

Commands:
  update     Update to the latest version of GitHub Actions Importer.
  version    Display the version of GitHub Actions Importer.
  configure  Start an interactive prompt to configure credentials used to authenticate with your CI server(s).
  audit      Plan your CI/CD migration by analyzing your current CI/CD footprint.
  forecast   Forecast GitHub Actions usage from historical pipeline utilization.
  dry-run    Convert a pipeline to a GitHub Actions workflow and output its yaml file.
  migrate    Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes.

Настройка учетных данных

Команда configure CLI используется для задания необходимых учетных данных и параметров для GitHub Actions Importer при работе с Jenkins и GitHub.

  1. Создайте GitHub personal access token (classic). Дополнительные сведения см. в разделе Управление личными маркерами доступа.

    У маркера workflow должна быть область.

    После создания маркера скопируйте его и сохраните его в безопасном расположении для последующего использования.

  2. Создайте токен API Jenkins. Дополнительные сведения см. в документации Jenkins по проверке подлинности сценариев .

    После создания маркера скопируйте его и сохраните его в безопасном расположении для последующего использования.

  3. В терминале выполните команду CLI GitHub Actions Importer configure :

    gh actions-importer configure

    В командной строке появится следующая configure информация:

    • Для вопроса «Каких провайдеров CI вы настраиваете?» используйте стрелки, чтобы выбрать Jenkins, нажмите Space чтобы выбрать его, затем нажмите Enter.
    • Для «Personal access token for GitHub введите значение personal access token (classic), которое вы создали ранее, и нажмите Enter.
    • Для «Базового URL GitHub экземпляра» нажмите Enter чтобы принять значение по умолчанию (https://github.com).
    • В поле "Personal access token для Jenkins" введите значение для созданного ранее токена API Jenkins и нажмите клавишу ВВОД.
    • В поле "Имя пользователя Jenkins" введите имя пользователя Jenkins и нажмите клавишу ВВОД.
    • В поле "Базовый URL-адрес экземпляра Jenkins" введите URL-адрес экземпляра Jenkins и нажмите клавишу ВВОД.

    Ниже показан пример configure команды:

    $ gh actions-importer configure
✔ Which CI providers are you configuring?: Jenkins
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Personal access token for Jenkins: ***************
✔ Username of Jenkins user: admin
✔ Base url of the Jenkins instance: https://localhost
Environment variables successfully updated.

  4. В терминале выполните команду GitHub Actions Importer update CLI для подключения к GitHub Packages Container registry и убедитесь, что образ контейнера обновлен до последней версии:

    gh actions-importer update

    Выходные данные команды должны выглядеть следующим образом:

    Updating ghcr.io/actions-importer/cli:latest...
ghcr.io/actions-importer/cli:latest up-to-date

Выполнение аудита Дженкинса

С помощью audit команды можно получить высокоуровневое представление всех конвейеров на сервере Jenkins.

Команда audit выполняет следующие действия.

  1. Извлекает все проекты, определенные на сервере Jenkins.
  2. Преобразует каждый конвейер в эквивалентный рабочий процесс GitHub Actions .
  3. Создает отчет, в котором приводится сводка о том, как полная и сложная миграция возможна с помощью GitHub Actions Importer.

Выполнение команды аудита

Чтобы выполнить аудит сервера Jenkins, выполните следующую команду в терминале:

gh actions-importer audit jenkins --output-dir tmp/audit

Проверка результатов аудита

Файлы в указанном выходном каталоге содержат результаты аудита. audit_summary.md Ознакомьтесь с файлом с сводкой результатов аудита.

Сводка аудита содержит следующие разделы.

Pipelines

Раздел "Конвейеры" содержит высокоуровневую статистику относительно скорости преобразования, выполняемой GitHub Actions Importer.

Ниже перечислены некоторые ключевые термины, которые могут отображаться в разделе "Конвейеры":

  • Успешные конвейеры имели 100 % конструкций конвейера и отдельные элементы, преобразованные автоматически в их эквивалент GitHub Actions.
  • Частично успешные конвейеры были преобразованы все конструкции конвейера, однако существовали некоторые отдельные элементы, которые не были автоматически преобразованы в их эквивалент GitHub Actions.
  • Неподдерживаемые конвейеры — это типы определений, которые не поддерживаются GitHub Actions Importer.
  • Неудачные конвейеры столкнулись с неустранимой ошибкой при преобразовании. Это может произойти по одной из трех причин:
    • Конвейер изначально был неправильно настроен и недопустим.
    • При преобразовании данных GitHub Actions Importer возникла внутренняя ошибка.
    • Произошел неудачный сетевой ответ, который привел к недоступности конвейера, что часто связано с недопустимыми учетными данными.

Этапы сборки

В разделе "Шаги сборки" содержится обзор отдельных шагов сборки, используемых во всех конвейерах, и количество автоматически преобразованных GitHub Actions Importer.

Ниже приведены некоторые ключевые термины, которые могут отображаться в разделе "Шаги сборки".

  • Известный **** шаг сборки — это шаг, который был автоматически преобразован в эквивалентное действие.
  • ** Неизвестный **шаг сборки — это шаг, который не был автоматически преобразован в эквивалентное действие.
  • Неподдерживаемый **** шаг сборки — это шаг, который является следующим:
    • В основном не поддерживается GitHub Actions.
    • Настроено таким образом, что несовместимо с данными GitHub Actions.
  • Действие **** — это список действий, которые использовались в преобразованных рабочих процессах. Это может быть важно для:
    • Если вы используете GitHub Enterprise Server, собирайте список действий для синхронизации с экземпляром.
    • Определение списка разрешений на уровне организации используемых действий. Этот список действий — это полный список действий, которые могут потребоваться для проверки вашей группы безопасности или соответствия требованиям.

Задачи вручную

В разделе "Задачи вручную" содержится обзор задач, которые GitHub Actions Importer не могут выполняться автоматически, и что необходимо выполнить вручную.

Ниже перечислены некоторые ключевые термины, которые могут отображаться в разделе "Задачи вручную".

  • Секрет — это репозиторий или секрет уровня организации, используемый в преобразованных конвейерах. Эти секреты необходимо создать вручную в GitHub Actions для правильной работы этих конвейеров. Дополнительные сведения см. в разделе Использование секретов в GitHub Actions.
  • Локальное средство выполнения ссылается на метку бегуна, на который ссылается преобразованный конвейер, который не является GitHub, размещенным в runner. Необходимо вручную определить эти средства выполнения для правильной работы этих конвейеров.

Файлы

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

Каждый файл конвейера содержит различные файлы, включенные в аудит, в том числе:

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

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

Прогнозирование потенциального использования средства выполнения сборки

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

Предварительные требования для выполнения команды прогноза

Чтобы выполнить forecast команду в экземпляре Jenkins, необходимо установить paginated-builds подключаемый модуль на сервере Jenkins. Этот подключаемый модуль позволяет GitHub Actions Importer эффективно извлекать исторические данные сборки для заданий с большим количеством сборок. Так как Jenkins не предоставляет метод для получения данных сборки с разбивкой на страницы, использование этого подключаемого модуля предотвращает время ожидания с сервера Jenkins, которое может возникать при получении большого количества исторических данных. Плагин paginated-builds — это open source, и он открывает REST API конечную точку для загрузки данных сборки в страницы, а не все сразу.

Чтобы установить подключаемый paginated-builds модуль, выполните следующие действия.

  1. В экземпляре Jenkins перейдите в https://<your-jenkins-instance>/pluginManager/availableраздел .
  2. Найдите подключаемый paginated-builds модуль.
  3. Установите флажок слева и нажмите кнопку "Установить без перезагрузки".

Выполнение команды прогноза

Чтобы выполнить прогноз потенциальных данных GitHub Actions, выполните следующую команду в терминале. По умолчанию GitHub Actions Importer включает предыдущие семь дней в отчете прогноза.

gh actions-importer forecast jenkins --output-dir tmp/forecast

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

Файл forecast_report.md в указанном выходном каталоге содержит результаты прогноза.

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

  • Число заданий — общее количество завершенных заданий.
  • Число конвейеров — это количество уникальных используемых конвейеров .
  •         **Время** выполнения описывает время выполнения, затраченное на задание. Эту метрику можно использовать для планирования стоимости GitHubразмещенных средств выполнения.
    • Эта метрика сопоставляется с тем, сколько следует потратить в GitHub Actions. Это зависит от оборудования, используемого в эти минуты. Вы можете использовать калькулятор цен GitHub Actions для оценки затрат.
  •         **Метрики времени** очереди описывают время, затраченное на выполнение задания, ожидающего доступности средства выполнения.

  •         **Метрики параллельных заданий** описывают количество заданий, выполняемых в любое время. Эту метрику можно использовать для определения количества модулей выполнения, которые необходимо настроить.

Кроме того, эти метрики определяются для каждой очереди runners в Jenkins. Это особенно полезно, если имеется сочетание размещенных или локальных runners, или компьютеров с высокой или низкой спецификацией, поэтому вы можете видеть метрики, относящиеся к различным типам runners.

Выполнение миграции конвейера Jenkins с использованием сухого запуска

С помощью dry-run команды можно преобразовать конвейер Jenkins в эквивалентный рабочий процесс GitHub Actions .

Выполнение команды dry-run

С помощью dry-run команды можно преобразовать конвейер Jenkins в эквивалентный рабочий процесс GitHub Actions . Сухой запуск создает выходные файлы в указанном каталоге, но не открывает запрос на вытягивание для переноса конвейера.

Чтобы выполнить сухой запуск переноса конвейеров Jenkins в GitHub Actions, выполните следующую команду в терминале, заменив my-jenkins-project URL-адрес задания Jenkins.

gh actions-importer dry-run jenkins --source-url my-jenkins-project --output-dir tmp/dry-run

Проверка преобразованных рабочих процессов

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

Выполнение рабочей миграции конвейера Jenkins

Вы можете использовать migrate команду для преобразования конвейера Jenkins и открытия запроса на вытягивание с эквивалентным рабочим процессом GitHub Actions.

Выполнение команды миграции

Чтобы перенести конвейер Jenkins в GitHub Actions, выполните следующую команду в терминале, заменив target-url значение URL-адресом репозитория GitHub и my-jenkins-project URL-адрес для задания Jenkins.

gh actions-importer migrate jenkins --target-url https://github.com/:owner/:repo --output-dir tmp/migrate --source-url my-jenkins-project

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

$ gh actions-importer migrate jenkins --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --source-url http://localhost:8080/job/monas_dev_work/job/monas_freestyle
[2022-08-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20220916-014033.log'
[2022-08-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'

Проверка запроса на вытягивание

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

Ниже приведены некоторые важные элементы запроса на вытягивание:

  • В описании запроса на вытягивание раздел с именем "Вручную", в котором перечислены шаги, которые необходимо выполнить вручную, прежде чем завершить перенос конвейеров на GitHub Actions. Например, в этом разделе может быть описано создание секретов, используемых в рабочих процессах.
  • Преобразованный файл рабочих процессов. Выберите вкладку "**Измененные файлы" в запросе **на вытягивание, чтобы просмотреть файл рабочего процесса, который будет добавлен в репозиторий GitHub .

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

Справочные материалы

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

Использование переменных среды

GitHub Actions Importer использует следующие переменные среды для подключения к экземпляру Jenkins:

  •         `GITHUB_ACCESS_TOKEN`: personal access token (classic) используется для создания запросов на вытягивание с преобразованным рабочим процессом (требуется `repo` и `workflow` области).

  •         `GITHUB_INSTANCE_URL`: URL-адрес целевого экземпляра GitHub (например, `https://github.com`).

  •         `JENKINS_ACCESS_TOKEN`: маркер API Jenkins, используемый для просмотра ресурсов Jenkins.

    Примечание.

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

  •         `JENKINS_USERNAME`: имя пользователя учетной записи пользователя, создавшего маркер API Jenkins.

  •         `JENKINS_INSTANCE_URL`: URL-адрес экземпляра Jenkins.

  •         `JENKINSFILE_ACCESS_TOKEN` (Необязательно) Маркер API, используемый для получения содержимого хранимого `Jenkinsfile` в репозитории сборки. Для этого требуется `repo` область. Если это не указано, `GITHUB_ACCESS_TOKEN` вместо него будет использоваться.

Эти переменные среды можно указать в .env.local файле, загруженном GitHub Actions Importer при запуске.

Использование необязательных аргументов

Существуют необязательные аргументы, которые можно использовать с подкомандами GitHub Actions Importer для настройки миграции.

--source-file-path

Аргумент можно использовать --source-file-path с forecast``dry-runподкомандами или migration подкомандами.

По умолчанию GitHub Actions Importer извлекает содержимое конвейера из системы управления версиями. Аргумент --source-file-path указывает GitHub Actions Importer использовать указанный путь к исходному файлу. Этот параметр можно использовать для конвейеров Jenkinsfile и multibranch.

Если вы хотите предоставить несколько исходных файлов при запуске forecast подкоманда, можно использовать сопоставление шаблонов в значении пути к файлу. Например, gh forecast --source-file-path ./tmp/previous_forecast/jobs/*.json предоставляет GitHub Actions Importer любым исходным файлам, соответствующим пути к файлу ./tmp/previous_forecast/jobs/*.json .

Пример конвейера Jenkinsfile

В этом примере GitHub Actions Importer использует указанный Jenkinsfile в качестве исходного файла для выполнения сухого запуска.

gh actions-importer dry-run jenkins --output-dir path/to/output/ --source-file-path path/to/Jenkinsfile --source-url :url_to_jenkins_job

--config-file-path

Аргумент можно использовать --config-file-path с audit``dry-runподкомандами и migrate подкомандами.

По умолчанию GitHub Actions Importer извлекает содержимое конвейера из системы управления версиями. Аргумент --config-file-path указывает GitHub Actions Importer использовать указанные исходные файлы.

При использовании --config-file-path параметра с dry-run``migrate подкомандами GitHub Actions Importer соответствует заданию, представленному --source-url параметром выбора конвейера. Он используется config-file-path для извлечения указанного исходного файла.

Пример аудита

В этом примере GitHub Actions Importer использует указанный файл конфигурации YAML для выполнения аудита.

gh actions-importer audit jenkins --output-dir path/to/output/ --config-file-path path/to/jenkins/config.yml

Для аудита экземпляра Jenkins с помощью файла конфигурации файл конфигурации должен быть в следующем формате, и каждое repository_slug значение должно быть уникальным:

source_files:
  - repository_slug: pipeline-name
    path: path/to/Jenkinsfile
  - repository_slug: multi-branch-pipeline-name
    branches:
      - branch: main
        path: path/to/Jenkinsfile
      - branch: node
        path: path/to/Jenkinsfile

Поддерживаемый синтаксис для конвейеров Jenkins

В следующих таблицах показан тип свойств GitHub Actions Importer в настоящее время можно преобразовать. Дополнительные сведения о том, как синтаксис конвейера Jenkins соответствует GitHub Actions, см. в разделе Переход с Jenkins на GitHub Actions.

Сведения о поддерживаемых подключаемых модулях Jenkins см. в репозиторииgithub/gh-actions-importer.

Поддерживаемый синтаксис для конвейеров Freestyle

JenkinsGitHub ActionsСостояние
Шаблон dockerjobs.<job_id>.containerПоддерживается
сборкаjobsЧастично поддерживается
Среда сборкиenvЧастично поддерживается
Триггеры сборкиonЧастично поддерживается
ОбщийrunnersЧастично поддерживается

Поддерживаемый синтаксис для конвейеров Jenkinsfile

JenkinsGitHub ActionsСостояние
dockerjobs.<job_id>.containerПоддерживается
постановкаjobs.<job_id>Поддерживается
агентrunnersЧастично поддерживается
environmentenvЧастично поддерживается
ЭтапахjobsЧастично поддерживается
stepsjobs.<job_id>.stepsЧастично поддерживается
триггерыonЧастично поддерживается
Если...jobs.<job_id>.ifЧастично поддерживается
входные данныеinputsНе поддерживается
матрицыjobs.<job_id>.strategy.matrixНе поддерживается
optionsjobs.<job_id>.strategyНе поддерживается
parametersinputsНе поддерживается

Синтаксис переменных среды

GitHub Actions Importer использует сопоставление в таблице ниже для преобразования переменных среды Jenkins по умолчанию в ближайший эквивалент в GitHub Actions.

JenkinsGitHub Actions
${BUILD_ID}${{ github.run_id }}
${BUILD_NUMBER}${{ github.run_id }}
${BUILD_TAG}${{ github.workflow }}-${{ github.run_id }}
${BUILD_URL}${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
${JENKINS_URL}${{ github.server_url }}
${JOB_NAME}${{ github.workflow }}
${WORKSPACE}${{ github.workspace }}

Части были адаптированы в соответствии с https://github.com/github/gh-actions-importer/ лицензией MIT:

MIT License

Copyright (c) 2022 GitHub

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.