Skip to main content

セルフホストランナーの追加

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

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

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

セルフホストランナーでサポートされているオペレーティングシステム、あるいはプロキシサーバーとセルフホストランナーを使う方法に関する情報については、「セルフホストランナーについて」を参照してください。

必要な環境

  • You must have access to the machine you will use as a self-hosted runner in your environment.

  • セルフホストランナーとGitHub AEの通信はHTTPS(ポート443)です。 For more information, see "About self-hosted runners."

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

単一のリポジトリにセルフホストランナーを追加できます。 セルフホストランナーをユーザのリポジトリに追加するには、リポジトリのオーナーでなければなりません。 Organizationのリポジトリの場合は、Organizationのオーナーであるか、そのリポジトリの管理アクセスを持っていなければなりません。 For information about how to add a self-hosted runner with the REST API, see "Self-hosted runners."

  1. Enterpriseで、リポジトリのメインページにアクセスしてください。

  2. リポジトリ名の下で Settings(設定)をクリックしてください。 リポジトリの設定ボタン

  3. 左のサイドバーで、Actionsをクリックしてください。

  4. 左のサイドバーで、"Actions"の下のRunners(ランナー)をクリックしてください。

  5. GitHub Insightsの "ランナー" で、[Add runner] をクリックします。

  6. 使用するセルフホストランナーマシンのオペレーティングシステムイメージとアーキテクチャを選択してください。

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

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

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

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

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

セルフホストランナーの追加に成功したことの確認

セルフホストランナーを追加するためのステップを完了すると、ランナーとそのステータスは"Self-hosted runners(セルフホストランナー)"の下にリストされます。

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

√ Connected to GitHub

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

詳しい情報については「セルフホストランナーのモニタリングとトラブルシューティング」を参照してください。

Organizationへのセルフホストランナーの追加

セルフホストランナーをOrganizationのレベルで追加し、Organization内の複数のリポジトリのジョブを処理するために使うことができます。 Organizationにセルフホストランナーを追加するには、Organizationのオーナーでなければなりません。 For information about how to add a self-hosted runner with the REST API, see "Self-hosted runners."

  1. Enterpriseで、Organizationのメインページにアクセスしてください。

  2. Organization 名の下で、クリックします Settings.

    Organizationの設定ボタン

  3. 左のサイドバーで、Actionsをクリックしてください。

  4. 左のサイドバーで、"Actions"の下のRunners(ランナー)をクリックしてください。

  5. GitHub Insightsの "Runners", click Add new, then click New runner.

  6. 使用するセルフホストランナーマシンのオペレーティングシステムイメージとアーキテクチャを選択してください。

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

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

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

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

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

セルフホストランナーの追加に成功したことの確認

セルフホストランナーを追加するためのステップを完了すると、ランナーとそのステータスは"Self-hosted runners(セルフホストランナー)"の下にリストされます。

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

√ Connected to GitHub

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

詳しい情報については「セルフホストランナーのモニタリングとトラブルシューティング」を参照してください。

ノート: セキュリティ上の理由から、デフォルトではパブリックリポジトリはランナーグループ内のランナーを使うことはできません。しかし、これはランナーグループの設定で上書きできます。 詳しい情報については、「グループを使用したセルフホストランナーへのアクセスの管理」を参照してください。

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

You can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. Organization の管理者は、そのランナーを使用できるリポジトリを制御できます。

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

セルフホストランナーをEnterpriseに追加するには、Enterpriseのオーナーでなければなりません。

  1. GitHub AEの右上で、プロフィール写真をクリックし、続いてEnterprise settings(Enterpriseの設定)をクリックしてください。 GitHub AEのプロフィール写真のドロップダウンメニュー内の"Enterprise settings"

  2. Enterpriseアカウントのサイドバーで、 Policies(ポリシー)をクリックしてください。 Enterpriseアカウントサイドバー内のポリシータブ

  3. Under " Policies", click Actions.

  4. Click the Runners tab.

  5. [Add new] をクリックし、[New runner] をクリックします。

  6. 使用するセルフホストランナーマシンのオペレーティングシステムイメージとアーキテクチャを選択してください。

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

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

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

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

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

セルフホストランナーの追加に成功したことの確認

セルフホストランナーを追加するためのステップを完了すると、ランナーとそのステータスは"Self-hosted runners(セルフホストランナー)"の下にリストされます。

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

√ Connected to GitHub

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

詳しい情報については「セルフホストランナーのモニタリングとトラブルシューティング」を参照してください。

ノート: セキュリティ上の理由から、デフォルトではパブリックリポジトリはランナーグループ内のランナーを使うことはできません。しかし、これはランナーグループの設定で上書きできます。 詳しい情報については、「グループを使用したセルフホストランナーへのアクセスの管理」を参照してください。

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

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

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

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

参考リンク