自己ホストランナーの追加

リポジトリ、Organization、Enterpriseに自己ホストランナーを追加できます。

Organization または Enterprise 管理者の場合は、Organization または Enterprise レベルで自己ホストランナーを追加することをお勧めします。 このアプローチにより、Organization または Enterprise 内の複数のリポジトリでランナーを使用できるようになり、ランナーを1か所で管理することもできます。

自己ホスト ランナーでサポートされているオペレーティング システム、またはプロキシ サーバーで自己ホスト ランナーを使う方法については、「自己ホスト ランナーの概要」をご覧ください。

自己ホスト ランナーの数をスケーリングするように自動化を設定できます。 詳しくは、「セルフホステッド ランナーによる自動スケーリング」を参照してください。

Just-In-Time ランナーの登録を使って、登録がクリーンアップされる前に 1 つのジョブを実行するエフェメラル ランナーを登録できます。 詳しくは、「GitHub Actions のセキュリティ強化」を参照してください。

前提条件

• 環境内でセルフホステッド ランナーとして使用するマシンにアクセスできる必要があります。

リポジトリへの自己ホストランナーの追加

単一のリポジトリに自己ホストランナーを追加できます。 自己ホストランナーをユーザのリポジトリに追加するには、リポジトリのオーナーでなければなりません。 組織リポジトリの場合、組織の所有者、リポジトリへの管理者アクセス権の所有、「組織ランナーとランナー グループを管理する」アクセス許可を持っている必要があります。

カスタム組織の役割の詳細については、「カスタム組織の役割の情報」を参照してください。

REST API を使って自己ホスト ランナーを追加する方法については、「セルフホステッド ランナーの REST API エンドポイント」をご覧ください。

1. GitHub で、リポジトリのメイン ページに移動します。

2. リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

   

3. 左のサイドバーで [アクション] をクリックしてから、 [ランナー] をクリックします。

4. [新規フホスト ランナー] をクリックします。

5. 使用する自己ホスト ランナー マシンのオペレーティング システム イメージとアーキテクチャを選択します。

   

6. ランナーアプリケーションをダウンロードして、使用する自己ホストランナーのマシンにインストールする方法が表示されます。

   自己ホストランナーのマシンでシェルを開き、表示順に従ってシェルコマンドを実行してください。

   注: Windows で、自己ホスト ランナー アプリケーションをサービスとしてインストールする場合は、シェルを管理者権限でオープンしなければなりません。 また、C:\actions-runner を自己ホスト ランナー アプリケーション用のディレクトリとして使用し、Windows のシステム アカウントでランナー ディレクトリにアクセスできるようにすることをお勧めします。

   この指示に従えば、以下のタスクが完了します。

   • 自己ホストランナーアプリケーションのダウンロードと展開。
   • config スクリプトを実行して自己ホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
     • Windows では、config スクリプトから自己ホスト ランナーをサービスとしてインストールするかどうかも尋ねられます。 LinuxとmacOSでは、ランナーの追加を終えた後にサービスをインストールできます。 詳しくは、「自己ホストランナーアプリケーションをサービスとして設定する」を参照してください。
   • 自己ホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。

自己ホストランナーの追加に成功したことの確認

自己ホスト ランナーを追加する手順を完了すると、ランナーとその状態が の下に表示されます。

ジョブをランナーが受け付けるためには、自己ホストランナーアプリケーションが動作していなければなりません。 ランナー アプリケーションが GitHub Enterprise Cloud に接続されており、ジョブの受信準備ができたら、以下のメッセージがコンピューターのターミナルに表示されます。

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

詳しくは、「自己ホストランナーのモニタリングとトラブルシューティング」を参照してください。

Organizationへの自己ホストランナーの追加

自己ホストランナーをOrganizationのレベルで追加し、Organization内の複数のリポジトリのジョブを処理するために使うことができます。 セルフ ホスト ランナーを組織に追加するには、組織の所有者であるか、「組織ランナーとランナー グループを管理する」アクセス許可を持っている必要があります。 REST API を使って自己ホスト ランナーを追加する方法については、「セルフホステッド ランナーの REST API エンドポイント」をご覧ください。

カスタム組織の役割の詳細については、「カスタム組織の役割の情報」を参照してください。

1. GitHub で、organization のメイン ページに移動します。

2. 組織名の下で、 [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

   

3. 左のサイドバーで [アクション] をクリックしてから、 [ランナー] をクリックします。

4. [新しいランナー] をクリックし、 [新しい自己ホスト ランナー] をクリックします。 1. 使用する自己ホスト ランナー マシンのオペレーティング システム イメージとアーキテクチャを選択します。

   

5. ランナーアプリケーションをダウンロードして、使用する自己ホストランナーのマシンにインストールする方法が表示されます。

   自己ホストランナーのマシンでシェルを開き、表示順に従ってシェルコマンドを実行してください。

   注: Windows で、自己ホスト ランナー アプリケーションをサービスとしてインストールする場合は、シェルを管理者権限でオープンしなければなりません。 また、C:\actions-runner を自己ホスト ランナー アプリケーション用のディレクトリとして使用し、Windows のシステム アカウントでランナー ディレクトリにアクセスできるようにすることをお勧めします。

   この指示に従えば、以下のタスクが完了します。

   • 自己ホストランナーアプリケーションのダウンロードと展開。
   • config スクリプトを実行して自己ホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
     • Windows では、config スクリプトから自己ホスト ランナーをサービスとしてインストールするかどうかも尋ねられます。 LinuxとmacOSでは、ランナーの追加を終えた後にサービスをインストールできます。 詳しくは、「自己ホストランナーアプリケーションをサービスとして設定する」を参照してください。
   • 自己ホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。

自己ホストランナーの追加に成功したことの確認

自己ホスト ランナーを追加する手順を完了すると、ランナーとその状態が の下に表示されます。

ジョブをランナーが受け付けるためには、自己ホストランナーアプリケーションが動作していなければなりません。 ランナー アプリケーションが GitHub Enterprise Cloud に接続されており、ジョブの受信準備ができたら、以下のメッセージがコンピューターのターミナルに表示されます。

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

詳しくは、「自己ホストランナーのモニタリングとトラブルシューティング」を参照してください。

自己ホストランナーを Enterprise に追加する

自己ホスト ランナーを Enterprise に追加できます。この場合、複数の組織に割り当てることができます。 組織のオーナーは、どのリポジトリがそれを使用できるかをコントロールできます。

新しいランナーが既定のグループに割り当てられます。 ランナーを登録した後、ランナーのグループを変更できます。 詳しくは、「グループを使用してセルフホストランナーへのアクセスを管理する」を参照してください。

自己ホスト ランナーを Enterprise に追加するには、Enterprise のオーナーである必要があります。 REST API を使用して自己ホスト ランナーを追加する方法については、GitHub Actions REST API の Enterprise エンドポイントを参照してください。

1. GitHub の右上の自分のプロフィール写真をクリックし、[自分の Enterprise] をクリックします。

2. Enterpriseのリストで、表示したいEnterpriseをクリックしてください。

3. ページの左側にある Enterprise アカウントのサイドバーで、 [ポリシー] をクリックします。

4. 「 ポリシー」で、[アクション] をクリックします。

5. [Runners](ランナー) タブをクリックします。

6. [新しいランナー] をクリックし、 [新しいセルフホステッド ランナー] をクリックします。 1. 使用する自己ホスト ランナー マシンのオペレーティング システム イメージとアーキテクチャを選択します。

   

7. ランナーアプリケーションをダウンロードして、使用する自己ホストランナーのマシンにインストールする方法が表示されます。

   自己ホストランナーのマシンでシェルを開き、表示順に従ってシェルコマンドを実行してください。

   注: Windows で、自己ホスト ランナー アプリケーションをサービスとしてインストールする場合は、シェルを管理者権限でオープンしなければなりません。 また、C:\actions-runner を自己ホスト ランナー アプリケーション用のディレクトリとして使用し、Windows のシステム アカウントでランナー ディレクトリにアクセスできるようにすることをお勧めします。

   この指示に従えば、以下のタスクが完了します。

   • 自己ホストランナーアプリケーションのダウンロードと展開。
   • config スクリプトを実行して自己ホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
     • Windows では、config スクリプトから自己ホスト ランナーをサービスとしてインストールするかどうかも尋ねられます。 LinuxとmacOSでは、ランナーの追加を終えた後にサービスをインストールできます。 詳しくは、「自己ホストランナーアプリケーションをサービスとして設定する」を参照してください。
   • 自己ホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。

自己ホストランナーの追加に成功したことの確認

自己ホスト ランナーを追加する手順を完了すると、ランナーとその状態が の下に表示されます。

ジョブをランナーが受け付けるためには、自己ホストランナーアプリケーションが動作していなければなりません。 ランナー アプリケーションが GitHub Enterprise Cloud に接続されており、ジョブの受信準備ができたら、以下のメッセージがコンピューターのターミナルに表示されます。

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

詳しくは、「自己ホストランナーのモニタリングとトラブルシューティング」を参照してください。

Enterprise ランナーをリポジトリで利用可能にする

デフォルトでは、Enterprise の「デフォルト」の自己ホストランナーグループのランナーは、Enterprise 内のすべての Organization で使用できますが、各 Organization のすべてのリポジトリで使用できるわけではありません。

Enterprise レベルの自己ホストランナーグループを Organization リポジトリで使用できるようにするには、ランナーグループの Organization の継承設定を変更して、Organization 内のリポジトリでランナーを使用できるようにする必要がある場合があります。

ランナー グループのアクセス設定を変更する方法について詳しくは、「グループを使用してセルフホストランナーへのアクセスを管理する」をご覧ください。

参考資料

• 「企業向けセルフホスト ランナーの概要」