リソースクラスの概要

11 months ago1 min read

クラウド

Server v4.x

Server v3.x

このページの内容

リソースクラス機能を使用すると、以下が可能です。

各 job のコンピューティングリソースのサイズ (CPU および RAM) を指定
リソースクラスのインサイト機能を使用してこれまでの傾向に基づき Executor を最適化
.circleci/config.yml ファイルで使用するセルフホストランナーの設定

概要

resource_class の設定オプションには複数の用途があります。最も一般的な用途は、Executor に resource_class キーを設定して、各ジョブに必要な CPU と RAM を指定することです。

jobs:
  my-job:
    docker: # use the Docker executor
      - image: cimg/base:2022.09 # specify a Docker image
    resource_class: xlarge # specify a resource class
    steps:
      - run: echo "Hello World"

Executor のリソースクラスは、small や medium などのサイズにより指定します。各サイズごとに、特定の CPU と RAM が割り当てられています。使用可能なリソースクラスの全オプションリストは、設定ファイルのリファレンスでご確認ください。リソースクラスの製品概要のページでは、各リソースクラスのクレジットの使用量や各プランで使用できるリソースクラスに関する情報をご確認いただけます。

CIrcleCI のセルフホストランナーを使用する際は、プロジェクト設定で resource_class キーを使って各ジョブで使用するランナーを指定します。セルフホストランナーのリソースクラスはインストールプロセスで割り当てられ、設定されます。

jobs:
  my-job:
    machine: true
    resource_class: <my-namespace>/<my-runner>
    steps:
      - run: echo "Hello runner"

もう一つの resource_class キーの用途は、実行環境の指定です。たとえば、 Arm は machine Executor を使用する場合のリソースクラスのオプションです。

jobs:
  my-job:
    machine:
      image: ubuntu-2004:202101-01
    resource_class: arm.medium
    steps:
      - run: uname -a
      - run: echo "Hello, Arm!"

クイックスタート

各実行環境の CPU と RAM のサイズを指定する ための resource_class キーの使い方が分かる設定ファイル例は、設定ファイルのリファレンスのページの以下のセクションでご確認ください。

セルフホストランナー のセットアップを開始する場合は、 Web アプリでのセルフホストランナーのインストールを参照してください。

デフォルトのリソースクラス

各ジョブの resource_class が明示的に宣言されていない場合、CircleCI はデフォルトのリソースクラスサイズを使用します。デフォルトは変更される場合があります。デフォルトにしておくよりも、リソースクラスを指定することをお勧めします。

リソースクラスの使用状況ツール

ジョブにおけるリソースクラスの使用状況に関する情報は Web アプリで、または API を使ってご確認いただけます。詳細については以下のセクションをお読みください。

ジョブに使用されているリソースクラスを確認する

各ジョブに使用されているリソースクラスは、Web アプリのジョブの詳細のページで確認できます。

Screenshot showing how to view the resource class used for a job in the web app

Figure 1. Web アプリでのリソースクラスの識別子

または "Get job details" エンドポイントを使うと、使用されているリソースクラスを含むジョブの情報を返すことができます。使用手順については、ジョブの詳細情報の取得方法を参照してください。

リソースクラスのインサイト機能

リソースクラスのインサイト機能により、ジョブのリソースの使用状況を把握することができます。この情報を検証および使用して、過去の傾向やジョブのニーズに基づき Executor を更新することができます。

リソースクラスのインサイトを確認するには:

Web アプリのサイドバーから Insights を選択します。
ダッシュボードにプロジェクトレベルのインサイトが表示されます。ジョブレベルでの詳細なリソースクラスのインサイトを見つけるには:
1. ドロップダウンからプロジェクトを選択します
2. リストからワークフローを選択します
3. Jobs タブを選択します
4. ジョブを開いてリソースクラスのインサイトを表示します
  
  Figure 2. リソースクラスのインサイト機能