GitHub Actions Importer を使った Jenkins からの移行

法的通知

GitHub Actions Importer を使った Jenkins からの移行について

以下の手順では、GitHub Actions Importer を使って Jenkins パイプラインを GitHub Actions に移行するように環境を構成する方法について説明します。

前提条件

• GitHub Actions ワークフローに変換するパイプラインとジョブを持つ Jenkins アカウントまたは Organization。

• アカウントまたは Organization の Jenkins 個人用 API トークンを作成するためのアクセス。

• Linux ベースのコンテナーを実行し、必要なツールをインストールできる環境。

  • Docker がインストールされていて実行されていること。
  • GitHub CLI がインストールされていること。

  注: GitHub Actions Importer コンテナーと CLI は、CI プラットフォームと同じサーバーにインストールする必要はありません。

制限事項

GitHub Actions Importer を使って Jenkins から GitHub Actions に移行する場合、いくつかの制限があります。 たとえば、次の構成は手動で移行する必要があります。

• 必須のビルド ツール
• スクリプトを利用したパイプライン
• シークレット
• セルフホステッド ランナー
• 不明なプラグイン

手動移行について詳しくは、「JenkinsからGitHub Actionsへの移行」を参照してください。

GitHub Actions Importer CLI 拡張機能のインストール

1. GitHub Actions Importer CLI 拡張機能のインストール

   Shell

   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 コマンドを使って、Jenkins と GitHub を操作するときに GitHub Actions Importer に必要な資格情報とオプションを設定します。

1. GitHub personal access token を作成します。 詳しくは、「Managing your personal access tokens」を参照してください。

   トークンには、workflow スコープが必要です。

   トークンは、作成後にコピーして、後で使用できるように安全な場所に保存します。

2. Jenkins API トークンを作成します。 詳しくは、Jenkins ドキュメントの「スクリプトを利用したクライアントの認証」を参照してください。

   トークンは、作成後にコピーして、後で使用できるように安全な場所に保存します。

3. ターミナルで、GitHub Actions Importer configure CLI コマンドを実行します。

   gh actions-importer configure

   configure コマンドでは、次の情報の入力が求められます。

   • "どの CI プロバイダーを構成していますか?" で、方向キーを使って Jenkins を選び、Space キーを押して選択し、Enter キーを押します。

   • "GitHub の Personal access token" で、先ほど作成した personal access token の値を入力し、Enter キーを押します。

   • "GitHub インスタンスのベース URL" で、enter the URL for your GitHub AE インスタンスの URL を入力し、Enter キーを押します。

   • "Jenkins の Personal access token" で、先ほど作成した Jenkins 個人用 API トークンの値を入力し、Enter キーを押します。

   • "Jenkins ユーザーのユーザー名" に Jenkins ユーザー名を入力し、Enter キーを押します。

   • "Jenkins インスタンスのベース URL" で、Jenkins インスタンスの URL を入力し、Enter キーを押します。

     以下に 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  

Jenkins の監査を実行する

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 でサポートされていない定義の種類です。
• 失敗したパイプラインは、変換中に致命的なエラーが発生しました。 これは、次の 3 つの理由のいずれかで発生する可能性があります。
  • パイプラインが正しく構成されず、Bamboo で有効でなかった。
  • 変換時に GitHub Actions Importer で内部エラーが発生した。
  • ネットワーク応答が失敗して、パイプラインにアクセスできなくなったが、これは多くの場合、無効な資格情報が原因である。

ビルド ステップ

"ビルド ステップ" セクションには、すべてのパイプラインで使われる個々のビルド ステップの概要と、GitHub Actions Importer によって自動的に変換された数が含まれます。

以下に、"ビルド ステップ" セクションに表示される可能性がある主な用語を示します。

• 既知のビルド ステップは、同等のアクションに自動的に変換されたステップです。
• 不明なビルド ステップは、同等のアクションに自動的に変換されなかったステップです。
• 未サポートのビルド ステップは、次のいずれかのステップです。
  • GitHub Actions で基本的にサポートされていない。
  • GitHub Actions と互換性のない方法で構成されている。
• アクションは、変換されたワークフローで使われたアクションのリストです。 これは、次の場合に重要である可能性があります。
  • GitHub Enterprise Server を使う場合、インスタンスに同期するアクションのリストを収集する。
  • 使われるアクションの組織レベルの許可リストを定義する。 このアクション リストは、セキュリティ チームまたはコンプライアンス チームの確認を必要とする可能性があるアクションの包括的なリストです。

手動タスク

"手動タスク" セクションには、GitHub Actions Importer で自動的に完了できず、手動で完了する必要があるタスクの概要が含まれます。

以下に、"手動タスク" セクションに表示される可能性がある主な用語を示します。

• シークレットは、変換されたパイプラインで使われるリポジトリまたは組織レベルのシークレットです。 これらのパイプラインが正常に機能するためには、これらのシークレットを GitHub Actions で手動で作成する必要があります。 詳しくは、「暗号化されたシークレット」を参照してください。
• セルフホステッド ランナーとは、変換されたパイプラインで参照されるランナーのラベルのうち、GitHub ホステッド ランナーではないものを指します。 これらのパイプラインを適切に機能させるには、これらのランナーを手動で定義する必要があります。

ファイル

監査レポートの最後のセクションには、監査中にディスクに書き込まれたすべてのファイルのマニフェストが表示されます。

各パイプライン ファイルには、次のようなさまざまなファイルが監査に含まれます。

• GitHub で定義された元のパイプライン。
• パイプラインの変換に使われたネットワーク応答のすべて。
• 変換されたワークフロー ファイル。
• 失敗したパイプライン変換のトラブルシューティングに使用できるスタック トレース。

さらに、workflow_usage.csv ファイルには、正常に変換された各パイプラインで使われるすべてのアクション、シークレット、ランナーのコンマ区切りのリストが含まれます。 これは、どのワークフローがどのアクション、シークレット、ランナーを使うかを判断するのに役立ち、セキュリティ レビューを実行するのに役立ちます。

潜在的なビルド ランナーの使用状況を予測する

forecast コマンドを使って、Jenkins サーバーで完了したパイプライン実行のメトリックを計算することで、潜在的な GitHub Actions の使用状況を予測できます。

forecast コマンドを実行するための前提条件

Jenkins インスタンスに対して forecast コマンドを実行するためには、Jenkins サーバーに paginated-builds プラグインをインストールする必要があります。 このプラグインを使用すると、GitHub Actions Importer を使って、多数のビルドを持つジョブの履歴ビルド データを効率的に取得できます。 Jenkins にはページ分割されたビルド データを取得するメソッドがないため、このプラグインを使うことで、大量の履歴データをフェッチするときに発生する可能性がある Jenkins サーバーからのタイムアウトを防ぐことができます。 paginated-builds プラグインはオープンソースで、REST API エンドポイントを公開して、ビルド データを一度にすべてフェッチするのではなく、ページ単位でフェッチします。

paginated-builds プラグインをインストールするには、以下を実行します。

1. Jenkins インスタンスで、https://<your-jenkins-instance>/pluginManager/available に移動します。
2. paginated-builds プラグインを検索します。
3. 左側のチェック ボックスをオンにし、 [再起動せずにインストール] を選びます。

forecast コマンドの実行

潜在的な GitHub Actions の予測を実行するには、ターミナルで次のコマンドを実行します。 既定では、GitHub Actions Importer による予測レポートに過去 7 日間が含まれます。

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

予測レポートの検査

予測の結果は、指定した出力ディレクトリ内の forecast_report.md ファイルに含まれます。

以下に、予測レポートに表示される可能性がある主な用語を示します。

• ジョブ数は、完了したジョブの合計数です。
• パイプライン数は、使われた一意のパイプラインの数です。
• 実行時間は、ランナーがジョブに費やした時間を表します。 このメトリックを使うと、GitHub ホステッド ランナーのコストを計画するのに役立ちます。
  • このメトリックは、GitHub Actions に費やすと予想する時間と相関しています。 これは、この時間 (分) に使われるハードウェアによって異なります。 GitHub Actions 料金計算ツールを使って、コストを見積もることができます。
• キュー時間メトリックは、ランナーが実行できるようになるのを待機するためにジョブが費やした時間を表します。
• 同時実行ジョブ メトリックは、特定の時点で実行されるジョブの量を表します。 このメトリックを使って、構成する必要があるランナーの数を定義できます。

さらに、これらのメトリックを、Jenkins のランナーの各キューに対して定義します。 これはホステッド ランナーとセルフホステッド ランナー、またはハイ スペック マシンとロー スペック マシンが混在している場合に特に有用で、異なるタイプのランナーに固有のメトリックを確認できます。

Jenkins パイプラインの dry-run 移行を実行する

dry-run コマンドを使って、Jenkins パイプラインを同等の GitHub Actions ワークフローに変換できます。

dry-run コマンドの実行

dry-run コマンドを使って、Jenkins パイプラインを同等の GitHub Actions ワークフローに変換できます。 dry-run を実行すると、指定したディレクトリに出力ファイルが作成されますが、パイプラインを移行するための pull request は開かれません。

Jenkins パイプラインを GitHub Actions に移行するドライ ランを実行するには、ターミナルで次のコマンドを実行し、my-jenkins-project を Jenkins ジョブの URL に置き換えます。

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

変換されたワークフローの検査

指定した出力ディレクトリで、ドライ ランのログと変換されたワークフロー ファイルを表示できます。

不明なビルド ステップや部分的に成功したパイプラインなど、GitHub Actions Importer で自動的に変換できなかったものがある場合は、カスタム トランスフォーマーを作成して変換プロセスをさらにカスタマイズできます。 詳しくは、「カスタム トランスフォーマーを使って GitHub Actions Importer を拡張する」を参照してください。

Jenkins パイプラインの運用移行を実行する

migrate コマンドを使って、Jenkins パイプラインを変換し、同等の GitHub Actions ワークフローで pull request を開くことができます。

migrate コマンドの実行

Jenkins パイプラインを GitHub Actions に移行するには、ターミナルで次のコマンドを実行し、target-url 値を GitHub AE リポジトリの URL に置き換え、my-jenkins-project を Jenkins ジョブの URL に置き換えます。

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

コマンドの出力には、変換されたワークフローをリポジトリに追加する pull request への 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'

pull request の検査

migrate コマンドが正常に実行された場合、出力には、変換されたワークフローをリポジトリに追加する新しい pull request へのリンクが含まれます。

pull request の重要な要素には、次のようなものがあります。

• pull request の説明の「手動ステップ」というセクションには、パイプラインの GitHub Actions への移行を終了する前に手動で完了する必要があるステップが列挙されています。 たとえば、このセクションでは、ワークフローで使われるシークレットを作成するように指示する場合があります。
• 変換されたワークフロー ファイル。 pull request の [変更されたファイル] タブを選んで、GitHub AE リポジトリに追加されるワークフロー ファイルを表示します。

pull request の検査が終了したら、それをマージして、ワークフローを GitHub AE リポジトリに追加できます。

リファレンス

このセクションには、環境変数、省略可能な引数、および GitHub Actions Importer を使って Jenkins から移行するときにサポートされる構文に関する参照情報が記載されています。

環境変数の使用

GitHub Actions Importer では、認証構成に環境変数が使われます。 これらの変数は、configure コマンドを使って構成プロセスに従うことで設定します。 詳しくは、GitHub Actions Importer の資格情報の構成に関するセクションを参照してください。

GitHub Actions Importer では、次の環境変数を使って Jenkins インスタンスに接続されます。

• GITHUB_ACCESS_TOKEN: 変換されたワークフローで pull request を作成するために使われる personal access token (repo と workflow スコープが必要)。

• GITHUB_INSTANCE_URL: ターゲット GitHub インスタンスへの URL (例: https://github.com)。

• JENKINS_ACCESS_TOKEN: Jenkins リソースの表示に使われる Jenkins API トークン。

  注: このトークンには、移行または監査するすべてのジョブへのアクセスが必要です。 フォルダーまたはジョブが親からアクセス制御リストを継承しない場合は、明示的なアクセス許可または完全な管理者特権を付与する必要があります。

• JENKINS_USERNAME: Jenkins API トークンを作成したユーザー アカウントのユーザー名。

• JENKINS_INSTANCE_URL: Jenkins インスタンスの URL。

• JENKINSFILE_ACCESS_TOKEN (省略可能) ビルド リポジトリに格納されている Jenkinsfile の内容を取得するために使われる API トークン。 これには、repo スコープが必要です。 これを指定しないと、代わりに GITHUB_ACCESS_TOKEN が使われます。

これらの環境変数は、実行時に GitHub Actions Importer によって読み込まれる .env.local ファイルに指定できます。

省略可能な引数の使用

GitHub Actions Importer サブコマンドと一緒に使って、移行をカスタマイズできる省略可能な引数があります。

--source-file-path

--source-file-path 引数は、forecast、dry-run、または migration サブコマンドと一緒に使うことができます。

既定では、GitHub Actions Importer はパイプラインの内容をソース管理からフェッチします。 --source-file-path 引数を指定して、指定したソース ファイル パスを代わりに使うように GitHub Actions Importer に指示します。 このオプションは、Jenkinsfile パイプラインとマルチブランチ パイプラインに使うことができます。

forecast サブコマンドの実行時に複数のソース ファイルを指定する場合は、ファイル パス値でパターン マッチングを使うことができます。 たとえば、gh forecast --source-file-path ./tmp/previous_forecast/jobs/*.json は、./tmp/previous_forecast/jobs/*.json ファイル パスに一致するすべてのソース ファイルを GitHub Actions Importer に提供します。

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 に指示します。

dry-run または migrate サブコマンドで --config-file-path オプションを使うと、GitHub Actions Importer はリポジトリ スラッグを --source-url オプションで表されるジョブと照合して、パイプラインを選びます。 指定したソース ファイルをプルするために config-file-path が使われます。

Audit の例

この例では、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 パイプラインでサポートされている構文

Jenkins	GitHub のアクション	Status
docker テンプレート	jobs.<job_id>.container	サポートされています
build	jobs	部分的にサポートされています。
ビルド環境	env	部分的にサポートされています。
ビルド トリガー	on	部分的にサポートされています。
全般	runners	部分的にサポートされています。

Jenkinsfile パイプラインでサポートされている構文

Jenkins	GitHub のアクション	Status
docker	jobs.<job_id>.container	サポートされています
ステージ	jobs.<job_id>	サポートされています
エージェント	runners	部分的にサポートされています。
環境	env	部分的にサポートされています。
stages	jobs	部分的にサポートされています。
steps	jobs.<job_id>.steps	部分的にサポートされています。
トリガー	on	部分的にサポートされています。
when	jobs.<job_id>.if	部分的にサポートされています。
inputs	inputs	サポートされていない
マトリックス	jobs.<job_id>.strategy.matrix	サポートされていない
options	jobs.<job_id>.strategy	サポートされていない
parameters	inputs	サポートされていない

環境変数の構文

GitHub Actions Importer では、次の表のマッピングを使って、既定の Jenkins 環境変数を GitHub Actions の最も近い同等の変数に変換します。

Jenkins	GitHub のアクション
${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 }}

法的通知

MIT ライセンスのもとで https://github.com/github/gh-actions-importer/ から一部を引用しています。

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.