Getting started with self-hosted runners for your enterprise

About self-hosted runners for GitHub Actions

GitHub Actions allows people who use GitHub Enterprise Serverインスタンス to improve productivity by automating every phase of the software development workflow. For more information, see "About GitHub Actions for enterprises."

With GitHub Actions, developers can write and combine individual tasks called actions to create custom workflows. To enable GitHub Actions for GitHub Enterprise Serverインスタンス, you must host at least one machine to execute jobs. This machine is called a self-hosted runner. Self-hosted runners can be physical, virtual, in a container, on-premises, or in a cloud. Your runner machine connects to GitHub Enterprise Server using the GitHub Actions self-hosted runner application. Self-hosted runners can run Linux, Windows, or macOS. 詳しい情� �については「セルフホストランナーについて」を参照してく� さい。

This guide shows you how to apply a centralized management approach to self-hosted runners for GitHub Actions in your enterprise. In the guide, you'll complete the following tasks.

1. Configure a limited policy to restrict the actions that can run within your enterprise
2. Deploy a self-hosted runner for your enterprise
3. Create a group to manage access to the runners available to your enterprise
4. Optionally, further restrict the repositories that can use the runner

You'll also find additional information about how to monitor and secure your self-hosted runners, how to access actions from GitHub.com, and how to customize the software on your runner machines.

After you finish the guide, users of GitHub Enterprise Serverインスタンス will be able to run workflow jobs from GitHub Actions on a self-hosted runner machine.

必要な環境

• GitHub Actions must be enabled for GitHub Enterprise Server. A site administrator can enable and configure GitHub Actions for your instance. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

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

• The connection between self-hosted runners and GitHub Enterprise Server is over HTTP (port 80) or HTTPS (port 443). To ensure connectivity over HTTPS, configure TLS for GitHub Enterprise Serverインスタンス. For more information, see "Configuring TLS." For more information, see "About self-hosted runners."

• Your enterprise must own at least one organization. For more information, see "About organizations" and "Creating a new organization from scratch."

1. Configure policies for GitHub Actions

First, enable GitHub Actions for all organizations, and configure a policy to restrict the actions that can run on GitHub Enterprise Serverインスタンス. Optionally, organization owners can further restrict these policies for each organization.

1. GitHub Enterprise Serverの右上で、プロフィール写真をクリックし、続いてEnterprise settings（Enterpriseの設定）をクリックしてく� さい。

2. Enterpriseアカウントのサイドバーで、 Policies（ポリシー）をクリックしてく� さい。

3. Under " Policies", click Actions.

4. Under "Policies", select Enable for all organizations.

   

5. Select Allow select actions and Allow actions created by GitHub to allow local actions, and actions created by GitHub.

   

6. [Save] をクリックします。

You can configure additional policies to restrict the actions available to users of GitHub Enterprise Serverインスタンス. 詳しい情� �については「EnterpriseでのGitHub Actionsのポリシーの施行」を参照してく� さい。

2. Deploy the self-hosted runner for your enterprise

Next, add a self-hosted runner to your enterprise. GitHub Enterprise Server will guide you through installation of the necessary software on the runner machine. After you deploy the runner, you can verify connectivity between the runner machine and GitHub Enterprise Serverインスタンス.

Adding the self-hosted runner

To add a self-hosted runner to an enterprise, you must be an enterprise owner.

1. GitHub Enterprise Serverの右上で、プロフィール写真をクリックし、続いてEnterprise settings（Enterpriseの設定）をクリックしてく� さい。

2. Enterpriseアカウントのサイドバーで、 Policies（ポリシー）をクリックしてく� さい。

3. Under " Policies", click Actions.

4. Self-hosted runners（セルフホストランナー）タブをクリックしてく� さい。

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

6. Select the operating system image and architecture of your self-hosted runner machine.

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

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

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

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

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

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

After completing the steps to add a self-hosted runner, the runner and its status are now listed under "Self-hosted runners".

ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 When the runner application is connected to GitHub Enterprise Server and ready to receive jobs, you will see the following message on the machine's terminal.

√ Connected to GitHub

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

3. Manage access to the self-hosted runner using a group

You can create a runner group to manage access to the runner that you added to your enterprise. You'll use the group to choose which organizations can execute jobs from GitHub Actions on the runner.

GitHub Enterprise Server adds all new runners to a group. Runners can be in one group at a time. By default, GitHub Enterprise Server adds new runners to the "Default" group.

1. GitHub Enterprise Serverの右上で、プロフィール写真をクリックし、続いてEnterprise settings（Enterpriseの設定）をクリックしてく� さい。

2. Enterpriseアカウントのサイドバーで、 Policies（ポリシー）をクリックしてく� さい。

3. Under " Policies", click Actions.

4. Self-hosted runners（セルフホストランナー）タブをクリックしてく� さい。

5. Use the Add new drop-down, and select New group.

6. Under "Group name", type a name for your runner group.

7. To choose a policy for organization access, under "Organization access", select the Organization access drop-down, and click Selected organizations.

8. To the right of the drop-down with the organization access policy, click .

9. Select the organizations you'd like to grant access to the runner group.

10. Optionally, to allow public repositories in the selected organizations to use runners in the group, select Allow public repositories.

    Warning:

    セルフホストランナーは、プライベートリポジトリでのみ利用することをおすすめします。 これは、ワークフロー中でコードを実行するPull Requestを作成することによって、リポジトリのフォークが危険なコードをセルフホストランナーマシン上で実行できる可能性があるためです。

    詳しい情� �については「セルフホストランナーについて」を参照してく� さい。

11. Click Save group to create the group and apply the policy.

12. To the right of "Default", click the number of runners in the group to show the runners.

13. Select the runner that you deployed.

14. To the right of "Runner groups", select the Move to group dropdown, and click the group that you previously created.

You've now deployed a self-hosted runner that can run jobs from GitHub Actions within the organizations that you specified.

4. Further restrict access to the self-hosted runner

Optionally, organization owners can further restrict the access policy of the runner group that you created. For example, an organization owner could allow only certain repositories in the organization to use the runner group.

詳しい情� �については、「グループを使用したセルフホストランナーへのアクセスの管理」を参照してく� さい。

次のステップ

• You can monitor self-hosted runners and troubleshoot common issues. 詳しい情� �については「セルフホストランナーのモニタリングとトラブルシューティング」を参照してく� さい。

• GitHub recommends that you review security considerations for self-hosted runner machines. For more information, see "Security hardening for GitHub Actions."

• You can manually sync repositories on GitHub.com containing actions to your enterprise on GitHub Enterprise Server. Alternatively, you can allow members of your enterprise to automatically access actions from GitHub.com by using GitHub Connect. 詳しい情� �については、以下を参照してく� さい。

  • "Manually syncing actions from GitHub.com"
  • "Enabling automatic access to GitHub.com actions using GitHub Connect"

• You can customize the software available on your self-hosted runner machines, or configure your runners to run software similar to GitHub-hosted runners available for customers using GitHub.com. The software that powers runner machines for GitHub Actions is open source. For more information, see the actions/runner and actions/virtual-environments repositories.

参考リンク

• "Configuring the self-hosted runner application as a service"
• "Using self-hosted runners in a workflow"