GitHub API に対する認証を行う

法的通知

概要

GitHub App または personal access token (classic) を使うことで、GitHub API に対して Actions Runner Controller (ARC) の認証を行うことができます。

Note

Enterprise レベルでランナーの GitHub App を使って認証を行うことはできません。詳しくは、「グループを使用してセルフホストランナーへのアクセスを管理する」をご覧ください。

GitHub App で ARC の認証を行う

Organization が所有する GitHub App を作成します。詳しくは、「GitHub App の登録」をご覧ください。次のように GitHub App を構成します。
1. [ホームページの URL] に「https://github.com/actions/actions-runner-controller」と入力します。
2. [アクセス許可] で [リポジトリのアクセス許可] をクリックします。次に、ドロップダウンメニューを使って、次のアクセス許可を選びます。
  - 管理: 読み取りと書き込み
    
    Note
    
    Administration: Read and write は、リポジトリスコープに登録するように Actions Runner Controller を構成する場合にのみ必要です。 Organization のスコープで登録する必要はありません。
  - メタデータ: 読み取り専用
3. [アクセス許可] で、 [Organization のアクセス許可] をクリックします。次に、ドロップダウンメニューを使って、次のアクセス許可を選びます。
  - セルフホステッドランナー: 読み取りと書き込み
GitHub App のページで GitHub App を作成した後、"アプリ ID" の値を書き留めます。この値は後で使用します。
[秘密キー] で、 [秘密キーの生成] をクリックし、.pem ファイルを保存します。このキーは後で使用します。
ページの左上隅のメニューで [アプリのインストール] をクリックし、Organization の横にある [インストール] をクリックして、Organization にアプリをインストールします。
Organization でインストールのアクセス許可を確認した後、アプリのインストール ID を記録しておきます。これは後で使用します。アプリのインストール ID はアプリのインストールページで確認でき、次の URL 形式になっています。

https://HOSTNAME/organizations/ORGANIZATION/settings/installations/INSTALLATION_ID
アプリ ID、インストール ID、および前の手順でダウンロードした .pem 秘密キーファイルを Kubernetes にシークレットとして登録します。

GitHub App の値を使って Kubernetes シークレットを作成するには、次のコマンドを実行します。

Note

gha-runner-scale-set グラフがインストールされているのと同じ名前空間にシークレットを作成します。この例では、名前空間は arc-runners クイックスタートドキュメントと一致します。詳しくは、「アクションランナーコントローラーのクイックスタート」を参照してください。
Bash
```
kubectl create secret generic pre-defined-secret \
   --namespace=arc-runners \
   --from-literal=github_app_id=123456 \
   --from-literal=github_app_installation_id=654321 \
   --from-literal=github_app_private_key='-----BEGIN RSA PRIVATE KEY-----********'
```
```
kubectl create secret generic pre-defined-secret \
   --namespace=arc-runners \
   --from-literal=github_app_id=123456 \
   --from-literal=github_app_installation_id=654321 \
   --from-literal=github_app_private_key='-----BEGIN RSA PRIVATE KEY-----********'
```
次に、values.yaml ファイルのコピーで githubConfigSecret プロパティを使用して、シークレット名を参照として渡します。
```
githubConfigSecret: pre-defined-secret
```

その他の Helm 構成のオプションについては、ARC リポジトリの values.yaml を参照してください。

personal access token (classic) で ARC の認証を行う

ARC では、personal access tokens (classic) を使ってセルフホステッドランナーを登録できます。

Note

personal access token (classic) での ARC の認証は、Enterprise レベルでランナーを登録するためにサポートされている唯一の認証方法です。

必要なスコープを使って personal access token (classic) を作成します。必要なスコープは、リポジトリ、Organization、または Enterprise のどのレベルでランナーを登録するかによって異なります。 personal access token (classic) の作成方法の詳細については、「個人用アクセストークンを管理する」を参照してください。

ARC ランナーに必要な personal access token スコープの一覧を次に示します。
- リポジトリランナー: repo
- Organization ランナー: admin:org
- Enterprise ランナー: manage_runners:enterprise
personal access token (classic) の値を使って Kubernetes シークレットを作成するには、次のコマンドを使います。

Note

gha-runner-scale-set グラフがインストールされているのと同じ名前空間にシークレットを作成します。この例では、名前空間は arc-runners クイックスタートドキュメントと一致します。詳しくは、「アクションランナーコントローラーのクイックスタート」を参照してください。
Bash
```
kubectl create secret generic pre-defined-secret \
   --namespace=arc-runners \
   --from-literal=github_token='YOUR-PAT'
```
```
kubectl create secret generic pre-defined-secret \
   --namespace=arc-runners \
   --from-literal=github_token='YOUR-PAT'
```
values.yaml のお使いのコピーで、シークレット名を参照として渡します。
```
githubConfigSecret: pre-defined-secret
```
その他の Helm 構成のオプションについては、ARC リポジトリの values.yaml を参照してください。

法的通知

Apache-2.0 ライセンスのもとで https://github.com/actions/actions-runner-controller/ から一部を引用しています。

Copyright 2019 Moto Ishizawa

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

この記事の内容

概要

GitHub App で ARC の認証を行う

personal access token (classic) で ARC の認証を行う

法的通知