ワークフローでの Actions Runner Controller の使用

ワークフロー ファイルで Actions Runner Controller ランナーを使用できます。

この記事の内容

法的通知

ワークフロー ファイルでの ARC ランナーの使用について

ランナー スケール セットで実行するジョブを割り当てるには、GitHub Actions ワークフロー ファイル内の runs-on キーの値としてスケール セットの名前を指定できます。

たとえば、ランナー スケール セットの次の構成では、INSTALLATION_NAME 値が arc-runner-set に設定されています。

# Using a Personal Access Token (PAT)
INSTALLATION_NAME="arc-runner-set"
NAMESPACE="arc-runners"
GITHUB_CONFIG_URL="https://github.com/<your_enterprise/org/repo>"
GITHUB_PAT="<PAT>"
helm install "${INSTALLATION_NAME}" \
    --namespace "${NAMESPACE}" \
    --create-namespace \
    --set githubConfigUrl="${GITHUB_CONFIG_URL}" \
    --set githubConfigSecret.github_token="${GITHUB_PAT}" \
    oci://ghcr.io/actions/actions-runner-controller-charts/gha-runner-scale-set

ワークフローでこの構成を使用するには、次の例のように、ワークフロー内の runs-on キーの値を arc-runner-set に設定します。

jobs:
  job_name:
    runs-on: arc-runner-set

ランナー スケール セット名の使用

ランナー スケール セット名は、属するランナー グループ内で一意です。 同じ名前の複数のランナー スケール セットをデプロイするには、それらが異なるランナー グループに属している必要があります。 ランナー スケール セット名の指定の詳細については、「アクション ランナー コントローラーを使用してランナー スケール セットをデプロイする」を参照してください。

ARC によって作成されたランナーをターゲットにするのに追加のラベルを使用することはできません。 できるのは、インストール時に指定したランナー スケール セットのインストール名を使用するか、values.yaml ファイル内に runnerScaleSetName フィールドの値を定義することだけです。 これらは、runs-on ターゲットとして使用する "単一ラベル" として使用されます。 詳しくは、「アクション ランナー コントローラーを使用してランナー スケール セットをデプロイする」を参照してください。

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.