セルフホストランナーとのラベルの利用

ラベルを使い、セルフホストランナーをその特徴に基づいて整理できます。

この記事で

メモ

GitHub Enterprise Server ホステッド ランナーは、現在 GitHub ではサポートされていません。

ラベルを使って、特定の種類の自己ホストランナーにジョブをルーティングする方法の詳細については、「ワークフローでのセルフホステッド ランナーの利用」を参照してください。 ジョブを特定のグループのランナーにルーティングすることもできます。 詳しくは、「ジョブのランナーを選択する」をご覧ください。

セルフホステッド ランナーは、リポジトリまたは Organization のいずれかに配置するか、GitHub Enterprise Server の Enterprise 設定に配置することができます。 セルフホストランナーを管理するには、セルフホストランナーが追加された場所に応じて以下の権限が必要になります。

  • ユーザーのリポジトリ: リポジトリ オーナーである必要があります。

  • Organization: Organization オーナーである必要があります。

  • Organization のリポジトリ: Organization オーナーまたは、そのリポジトリへの管理者アクセスを持っている必要があります。

  • Enterprise: GitHub Enterprise サイト管理者である必要があります。

カスタムラベルの作成

リポジトリ、組織、エンタープライズの各レベルで、ランナー用のカスタムラベルを作成できます。

メモ

ラベルでは大文字と小文字が区別されません。

リポジトリ ランナーのカスタム ラベルの作成

  1. セルフホステッド ランナー グループが登録されているリポジトリのメイン ページに移動します。
  2. [Settings] をクリックします。
  3. 左側のサイドバーで、 [Actions] をクリックしてから [Runners] をクリックします。
  4. ランナーの一覧で、構成するランナーの名前をクリックします。
  5. [ラベル] セクションで、 をクリックします。
  6. [ラベルの検索または作成] フィールドに新しいラベルの名前を入力し、 [新しいラベルの作成] をクリックします。 カスタムラベルが作成され、セルフホストランナーに割り当てられます。 カスタムラベルをセルフホストランナーから取り除くことはできますが、現在はラベルを手動で削除することはできません。 ランナーに割り当てられていない、未使用のラベルは、24時間以内に自動的に削除されます。

組織ランナーのカスタム ラベルの作成

  1. セルフホステッド ランナー グループが登録されている、組織のメイン ページに移動します。
  2. [Settings] をクリックします。
  3. 左側のサイドバーで、 [Actions] をクリックしてから [Runners] をクリックします。
  4. ランナーの一覧で、構成するランナーの名前をクリックします。
  5. [ラベル] セクションで、 をクリックします。
  6. [ラベルの検索または作成] フィールドに新しいラベルの名前を入力し、 [新しいラベルの作成] をクリックします。 カスタムラベルが作成され、セルフホストランナーに割り当てられます。 カスタムラベルをセルフホストランナーから取り除くことはできますが、現在はラベルを手動で削除することはできません。 ランナーに割り当てられていない、未使用のラベルは、24時間以内に自動的に削除されます。

エンタープライズ用ランナーにカスタム ラベルを作成する

  1. GitHub Enterprise Server の右上隅にあるプロフィール画像をクリックしてから、[Enterprise settings] をクリックします。
  2. ページの上部にある [ポリシーの] をクリックします。
  3. [ Policies] で、[Actions] をクリックします。
  4. [Runners](ランナー) タブをクリックします。
  5. ランナーの一覧で、構成するランナーの名前をクリックします。
  6. [ラベル] セクションで、 をクリックします。
  7. [ラベルの検索または作成] フィールドに新しいラベルの名前を入力し、 [新しいラベルの作成] をクリックします。 カスタムラベルが作成され、セルフホストランナーに割り当てられます。 カスタムラベルをセルフホストランナーから取り除くことはできますが、現在はラベルを手動で削除することはできません。 ランナーに割り当てられていない、未使用のラベルは、24時間以内に自動的に削除されます。

セルフホストランナーへのラベルの割り当て

セルフホステッド ランナーには、リポジトリ、組織、エンタープライズの各レベルでラベルを割り当てることができます。

リポジトリ ランナーへのラベルの割り当て

  1. セルフホステッド ランナー グループが登録されているリポジトリのメイン ページに移動します。
  2. [Settings] をクリックします。
  3. 左側のサイドバーで、 [Actions] をクリックしてから [Runners] をクリックします。
  4. [ラベル] セクションで、 をクリックします。
  5. セルフホステッド ランナーにラベルを割り当てるには、[ラベルの検索または作成] フィールドでラベルをクリックします。

組織ランナーにラベルを割り当てる

  1. セルフホステッド ランナー グループが登録されている、組織のメイン ページに移動します。
  2. [Settings] をクリックします。
  3. 左側のサイドバーで、 [Actions] をクリックしてから [Runners] をクリックします。
  4. [ラベル] セクションで、 をクリックします。
  5. セルフホステッド ランナーにラベルを割り当てるには、[ラベルの検索または作成] フィールドでラベルをクリックします。

エンタープライズ ランナーにラベルを割り当てる

  1. GitHub Enterprise Server の右上隅にあるプロフィール画像をクリックしてから、[Enterprise settings] をクリックします。
  2. ページの上部にある [ポリシーの] をクリックします。
  3. [ Policies] で、[Actions] をクリックします。
  4. [Runners](ランナー) タブをクリックします。
  5. ランナーの一覧で、構成するランナーの名前をクリックします。
  6. [ラベル] セクションで、 をクリックします。
  7. セルフホステッド ランナーにラベルを割り当てるには、[ラベルの検索または作成] フィールドでラベルをクリックします。

セルフホストランナーからカスタムラベルを削除する

リポジトリ、、組織、エンタープライズ、および レベルで、セルフホステッド ランナーからカスタム ラベルを削除できます。

リポジトリ ランナーからのカスタム ラベルの削除

  1. セルフホステッド ランナー グループが登録されているリポジトリのメイン ページに移動します。
  2. [Settings] をクリックします。
  3. 左側のサイドバーで、 [Actions] をクリックしてから [Runners] をクリックします。
  4. [ラベル] セクションで、 をクリックします。
  5. [ラベルの検索または作成] フィールドでは、割り当てられたラベルに アイコンが付きます。 マークされたラベルをクリックして、セルフホステッド ランナーから割り当てを解除します。

組織内のランナーからカスタムラベルを削除する

  1. セルフホステッド ランナー グループが登録されている、組織のメイン ページに移動します。
  2. [Settings] をクリックします。
  3. 左側のサイドバーで、 [Actions] をクリックしてから [Runners] をクリックします。
  4. [ラベル] セクションで、 をクリックします。
  5. [ラベルの検索または作成] フィールドでは、割り当てられたラベルに アイコンが付きます。 マークされたラベルをクリックして、セルフホステッド ランナーから割り当てを解除します。

エンタープライズ ランナーからのカスタム ラベルの削除

  1. GitHub Enterprise Server の右上隅にあるプロフィール画像をクリックしてから、[Enterprise settings] をクリックします。
  2. ページの上部にある [ポリシーの] をクリックします。
  3. [ Policies] で、[Actions] をクリックします。
  4. [Runners](ランナー) タブをクリックします。
  5. ランナーの一覧で、構成するランナーの名前をクリックします。
  6. [ラベル] セクションで、 をクリックします。
  7. [ラベルの検索または作成] フィールドでは、割り当てられたラベルに アイコンが付きます。 マークされたラベルをクリックして、セルフホステッド ランナーから割り当てを解除します。

プログラムによってラベルを割り当てる

ランナーの作成後、またはその初期構成時に、プログラムによってセルフホステッド ランナーにラベルを割り当てることができます。

  • プログラムによって既存のセルフホステッド ランナーにラベルを割り当てるには、REST API を使用する必要があります。 詳しくは、「セルフホステッド ランナーの REST API エンドポイント」をご覧ください。

  • ランナーの初期構成時にプログラムによってセルフホステッド ランナーにラベルを割り当てるには、ラベル名を config パラメーターを使って labels スクリプトに渡します。

    メモ

    config スクリプトを使って、既存の自己ホストランナーにラベルを割り当てることはできません。

    たとえば、次のコマンドを実行すると、新しいセルフホステッド ランナーの構成時に gpu という名前のラベルを割り当てることができます。

    ./config.sh --url <REPOSITORY_URL> --token <REGISTRATION_TOKEN> --labels gpu

    このラベルがまだ存在しなければ、作成されます。 この方法を使用して、x64 または linux といったデフォルトのラベルをランナーに割り当てることもできます。 構成スクリプトを使用して既定のラベルを割り当てると、 GitHub Actions は指定されたとおりにラベルを受け入れ、ランナーがそのオペレーティング システムまたはアーキテクチャを実際に使用していることを検証しません。

    複数のラベルを割り当てるには、カンマ区切りが使えます。 次に例を示します。

    ./config.sh --url <REPOSITORY_URL> --token <REGISTRATION_TOKEN> --labels gpu,x64,linux

    メモ

    既存のランナーを置き換える場合は、カスタム ラベルを割り当てし直す必要があります。