セルフホストランナーとは(GitHub Actions)
最終更新
セルフホステッドランナーは、お客様が管理するマシン、またはプロバイダーからレンタルしたマシンで、GitHub に登録され、GitHub がホストする仮想マシンの代わりに Actions のジョブを実行します。ハードウェア、オペレーティングシステム、インストールするツールはお客様が選択できます。
仕組み
サーバー、VM、またはコンテナに GitHub ランナーアプリケーションをインストールし、トークンを使ってリポジトリ、組織、またはエンタープライズに登録します。ランナーは GitHub へ送信方向の接続を開き、作業があるかどうかをポーリングします。ジョブの runs-on ラベルがランナーのラベルと一致すると、そのジョブをローカルで実行します。
すべてのランナーには、デフォルトのラベルとして self-hosted、OS ラベル(Linux、Windows、macOS)、アーキテクチャラベル(X64、ARM64)が付与されます。特定のマシンを対象にするため、gpu や compiler-ci などのカスタムラベルを追加することもできます。
運用スタイルは 2 種類あります。
- 永続型: ランナーは起動したままで、ジョブを次々と実行します。キャッシュが高速ですが、ジョブ間で状態が引き継がれてしまいます。
- エフェメラル型: ランナーは 1 つのジョブ(
--ephemeral)だけを実行してから破棄されます。クリーンで安全性が高く、通常は自動スケーリングと組み合わせて使用します。
例
jobs:
build:
runs-on: [self-hosted, Linux, X64]
steps:
- uses: actions/checkout@v4
- run: ./gradlew build
導入が適したケース
- GPU や特定の CPU タイプなど、GitHub が提供していないハードウェアが必要な場合。
- ジョブがプライベートネットワークやオンプレミスのシステムにアクセスする必要がある場合。
- 利用量が多く、ホステッドの実行時間のコストが高くなりすぎる場合。GitHub Actions の料金をご覧ください。
- ビルドに時間がかかり、ローカルのキャッシュを温めた状態で使いたい場合。
トレードオフについてはセルフホステッドと GitHub ホステッドのランナーの比較で説明しています。マネージドプロバイダーを使えば、パッチ適用や自動スケーリングの作業を行わずに同様のメリットを得られます。compiler.dev もその一つで、runs-on を [self-hosted, Linux, compiler-ci] に変更するだけで切り替えられます。
よくある間違い
- パブリックリポジトリで永続型ランナーを使用する。フォークからのプルリクエストは、お使いのマシン上で任意のコードを実行できてしまいます。エフェメラルかつ隔離された環境でない限り、パブリックリポジトリではセルフホステッドランナーの使用を避けてください。
- ワークスペースを一度もクリーンアップしない。残ったファイルが原因で、「2 回目の実行では成功する」という原因不明の失敗が起こります。
- 自動スケーリングを行わない。固定数のプールでは、ピーク時にジョブがキューに溜まり、夜間は遊んでしまいます。
- 更新を怠る。現在のランナーバージョンから大きく遅れたランナーは、ジョブを受け取れなくなる場合があります。
- 長期間有効なシークレットをホストに保存する。クラウドへのアクセスには OIDC の利用を優先してください。あわせて GitHub Actions のセキュリティ強化もご覧ください。
関連用語
よくある質問
セルフホステッドランナーは無料ですか?
セルフホステッドランナーの料金体系は時期によって変更されているため、GitHub の最新の請求ページをご確認ください。マシン自体の費用は常にお支払いいただく必要があります。
セルフホステッドランナーは安全ですか?
安全性は隔離の度合いによって決まります。エフェメラルランナーを使用し、権限を最小限に抑えた認証情報を利用して、信頼できないフォークのコードは実行しないようにしてください。
特定のランナーにジョブを割り当てるにはどうすればよいですか?
そのランナーのラベルを runs-on にリストとして指定します。ジョブは、リストに含まれるすべてのラベルを持つランナーで実行されます。
関連記事
- セルフホストとGitHub-hostedランナーの比較:コストとリスクGitHub-hosted、セルフホスト、サードパーティ製ランナーをコスト、速度、セキュリティ、運用の手間の観点で比較します。損益分岐点の計算式と安全なエフェメラル構成も紹介します。
- ホストランナーがサーバーとの通信を失った場合の対処法GitHub Actionsでランナーがサーバーとの通信を失いましたか?多くの場合、メモリ不足またはディスクの空き容量不足が原因です。原因を特定し、YAMLで修正する方法を解説します。
- CI分とは? GitHub Actionsの料金の仕組みCI分とは、パイプラインが使用する課金対象のコンピュート時間です。GitHub Actionsでの分の数え方、切り上げと乗数、そして使用量を減らす方法を説明します。
- GitHub Actionsのキャッシュキーとは?キャッシュキーとは、GitHub Actionsで保存されたキャッシュを識別する文字列です。キーとrestore-keysの仕組みを理解し、古いキャッシュを避ける方法を学びましょう。