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

前提条件

セルフホステッド ランナーを追加する前に、その仕組みと動作について理解しておく必要があります。 「セルフホステッド ランナー」を参照してください。

さらに、次の要件を満たす必要があります。

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

リポジトリへのセルフホステッド ランナーの追加

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

カスタム組織の役割の詳細については、「 カスタム組織ロールの権限」を参照してください。

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

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

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

   

3. 左側のサイドバーで、 [Actions] をクリックしてから [Runners] をクリックします。

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

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

   

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

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

   メモ

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

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

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

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

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

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

√ Connected to GitHub

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

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

Organizationへのセルフホステッド ランナーの追加

セルフホステッド ランナーをOrganizationのレベルで追加し、Organization内の複数のリポジトリのジョブを処理するために使うことができます。 組織にセルフホスト ランナーを追加するには、組織のオーナーであるか、"Manage organization runners and runner groups" 権限を持っている必要があります。 REST API を使ってセルフホステッド ランナーを追加する方法については、「セルフホステッド ランナーの REST API エンドポイント」を参照してください。

カスタム組織の役割の詳細については、「 カスタム組織ロールの権限」を参照してください。

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

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

   

3. 左側のサイドバーで、 [Actions] をクリックしてから [Runners] をクリックします。

4. ［新しいランナー］をクリックし、［新しいセルフホステッド ランナー］をクリックします。

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

   

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

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

   メモ

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

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

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

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

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

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

√ Connected to GitHub

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

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

セルフホステッド ランナーを Enterprise に追加する

エンタープライズにセルフホステッドランナーを追加できます。追加したランナーは複数の組織に割り当てることができます。 Organization オーナーは、どのリポジトリがそのランナーを使用できるかを制御できます。

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

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

1. 企業ページに移動してください。 たとえば、GitHub.com の [Enterprise] ページから。

2. ページの上部にある [ポリシーの] をクリックします。

3. [ Policies] で、[Actions] をクリックします。

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

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

   

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

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

   メモ

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

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

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

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

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

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

√ Connected to GitHub

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

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

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

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

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

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

次のステップ

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