Skip to main content
ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

Getting started with self-hosted runners for your enterprise

You can configure a runner machine for your enterprise so your developers can start automating workflows with GitHub Actions.

Enterprise owners can configure policies for GitHub Actions and add self-hosted runners to the enterprise.

About self-hosted runners for GitHub Actions

GitHub Actions allows members of your enterprise 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. You can host your own runner machine to execute jobs, and 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 Cloud using the GitHub Actions self-hosted runner application. All runners can run Linux, Windows, or macOS. 詳しい情報については「セルフホストランナーについて」を参照してください。

Alternatively, you can use runner machines that GitHub hosts. GitHub-hosted runners are outside the scope of this guide. 詳しい情報については「GitHubホストランナーについて」を参照してください。

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 and reusable workflows 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
  5. Optionally, build custom tooling to automatically scale your self-hosted runners

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

After you finish the guide, members of your enterprise will be able to run workflow jobs from GitHub Actions on a self-hosted runner machine.

必要な環境

1. Configure policies for GitHub Actions

First, enable GitHub Actions for all organizations, and configure a policy to restrict the actions and reusable workflows that can run within your enterprise on GitHub Enterprise Cloud. Optionally, organization owners can further restrict these policies for each organization.

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

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

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

  4. Under " Policies", click Actions.

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

    Screenshot of "Enable for all organizations" policy for GitHub Actions

  6. Select Allow enterprise, and select non-enterprise, actions and reusable workflows and Allow actions created by GitHub to allow local actions and reusable workflows, and actions created by GitHub.

    Screenshot of "Allow select actions" and "Allow actions created by GitHub" for GitHub Actions

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

You can configure additional policies to restrict the actions available to enterprise members. 詳しい情報については「EnterpriseでのGitHub Actionsのポリシーの施行」を参照してください。

2. Deploy the self-hosted runner for your enterprise

Next, add a self-hosted runner to your enterprise. GitHub Enterprise Cloud 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 your enterprise.

Adding the self-hosted runner

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

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

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

  4. Under " Policies", click Actions.

  5. Runners(ランナー)タブをクリックしてください。

  6. Click New runner.

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

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

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

    ノート: 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 "Runners".

ジョブをランナーが受け付けるためには、セルフホストランナーアプリケーションが動作していなければなりません。 When the runner application is connected to GitHub Enterprise Cloud 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 Cloud adds all new runners to a group. Runners can be in one group at a time. By default, GitHub Enterprise Cloud adds new runners to the "Default" group.

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

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

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

  4. Under " Policies", click Actions.

  5. Click the Runner groups tab.

  6. Click New runner group.

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

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

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

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

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

    Warning:

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

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

  12. Click Create group to create the group and apply the policy.

  13. Click the "Runners" tab.

  14. In the list of runners, click the runner that you deployed in the previous section.

  15. [Edit] をクリックします。

  16. Click Runner groups .

  17. In the list of runner groups, click the name of the group that you previously created.

  18. Click Save to move the runner to the group.

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.

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

5. Automatically scale your self-hosted runners

Optionally, you can build custom tooling to automatically scale the self-hosted runners for your enterprise. For example, your tooling can respond to webhook events from GitHub.com to automatically scale a cluster of runner machines. For more information, see "Autoscaling with self-hosted runners."

次のステップ

  • 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."

  • If you use GitHub Enterprise Server or GitHub AE, you can manually sync repositories on GitHub.com containing actions to your enterprise on GitHub Enterprise Server or GitHub AE. Alternatively, you can allow members of your enterprise to automatically access actions from GitHub.com by 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. The software that powers runner machines for GitHub Actions is open source. For more information, see the actions/runner and actions/virtual-environments repositories.

参考リンク