Skip to main content

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

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

注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。

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

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

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

警告: セルフホストランナーは、プライベートリポジトリでのみ利用することをおすすめします。 これは、ワークフロー内でコードを実行する pull request を作成することで、パブリック リポジトリのフォークによって、セルフホステッド ランナー マシン上で危険なコードが実行される可能性があるからです。

詳細については、セルフホステッド ランナーに関する記述をご覧ください。

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

前提条件

  • GitHub Actions は、GitHub Enterprise Server に対して有効にする必要があります。 サイト管理者は、インスタンスの GitHub Actions を有効にして構成できます。 詳細については、「GitHub Enterprise Server の GitHub Actions の概要」を参照してください。

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

  • セルフホステッド ランナーと GitHub Enterprise Server の接続は、HTTP (ポート 80) または HTTPS (ポート 443) を経由します。 HTTPS 経由で確実に接続するには、your GitHub Enterprise Server instance に対して TLS を構成します。 詳細については、「TLS の構成」を参照してください。 詳細については、「セルフホステッド ランナーについて」を参照してください。

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

単一のリポジトリにセルフホストランナーを追加できます。 セルフホストランナーをユーザのリポジトリに追加するには、リポジトリのオーナーでなければなりません。 Organizationのリポジトリの場合は、Organizationのオーナーであるか、そのリポジトリの管理アクセスを持っていなければなりません。 REST API を使用してセルフホスト ランナーを追加する方法については、「セルフホスト ランナー」を参照してください。

  1. your GitHub Enterprise Server instance で、リポジトリのメイン ページへ移動します。 1. リポジトリ名の下の [ 設定] をクリックします。 リポジトリの設定ボタン 1. 左側のサイドバーで、 [アクション] をクリックします。

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

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

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

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

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

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

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

    • セルフホストランナーアプリケーションのダウンロードと展開。
    • config スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
    • セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。 ### セルフホストランナーの追加に成功したことの確認

セルフホステッド ランナーを追加する手順を完了すると、ランナーとその状態が の下に表示されます。

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

√ Connected to GitHub

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

詳細については、「セルフホスト ランナーの監視とトラブルシューティング」を参照してください。

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

セルフホストランナーをOrganizationのレベルで追加し、Organization内の複数のリポジトリのジョブを処理するために使うことができます。 Organizationにセルフホストランナーを追加するには、Organizationのオーナーでなければなりません。 REST API を使用してセルフホスト ランナーを追加する方法については、「セルフホスト ランナー」を参照してください。

  1. your GitHub Enterprise Server instance で、Organization のメイン ページへ移動します。 1. Organization 名の下で、 [設定] をクリックします。 Organization の設定ボタン 1. 左側のサイドバーで、 [アクション] をクリックします。

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

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

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

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

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

    • セルフホストランナーアプリケーションのダウンロードと展開。
    • config スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
    • セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。 ### セルフホストランナーの追加に成功したことの確認

セルフホステッド ランナーを追加する手順を完了すると、ランナーとその状態が の下に表示されます。

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

√ Connected to GitHub

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

詳細については、「セルフホスト ランナーの監視とトラブルシューティング」を参照してください。

注: セキュリティ上の理由により、既定で、パブリック リポジトリでは、ランナー グループ内でランナーを使用することができませんが、ランナー グループの設定でこれをオーバーライドすることができます。 詳細については、「グループを使用してセルフホストランナーへのアクセスを管理する」を参照してください。

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

セルフホスト ランナーを Enterprise に追加できます。この場合、複数の組織に割り当てることができます。 Organization の管理者は、そのランナーを使用できるリポジトリを制御できます。

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

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

  1. GitHub Enterprise Server の右上で、ご自分のプロファイル写真をクリックしてから、 [Enterprise 設定] をクリックします。 GitHub Enterprise Server のプロファイル写真のドロップダウン メニューの [自分の Enterprise] 1. Enterprise サイドバーで、 [ポリシー] をクリックします。 [Enterprise アカウント] サイドバーの [ポリシー] タブ 1. [ ポリシー] で、 [アクション] をクリックします。 1. [Runners](ランナー) タブをクリックします。 1。 [新しいランナー] をクリックします。 1. 使用するセルフホスト ランナー マシンのオペレーティング システム イメージとアーキテクチャを選択します。

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

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

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

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

    • セルフホストランナーアプリケーションのダウンロードと展開。
    • config スクリプトを実行してセルフホスト ランナー アプリケーションを設定し、GitHub Actions に登録します。 config スクリプトには、登録先の URL と、リクエストを認証してもらうための自動的に生成された時間制限付きのトークンが必要です。
    • セルフホストランナーアプリケーションを実行して、マシンをGitHub Actionsに接続します。

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

セルフホステッド ランナーを追加する手順を完了すると、ランナーとその状態が の下に表示されます。

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

√ Connected to GitHub

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

詳細については、「セルフホスト ランナーの監視とトラブルシューティング」を参照してください。

注: セキュリティ上の理由により、既定で、パブリック リポジトリでは、ランナー グループ内でランナーを使用することができませんが、ランナー グループの設定でこれをオーバーライドすることができます。 詳細については、「グループを使用してセルフホストランナーへのアクセスを管理する」を参照してください。

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

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

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

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

参考資料