VM サービスを使った仮想マシンの管理

Server v4.x

サーバー管理者

このページの内容

VM プロバイダー

VM サービスにより、 Machine Executor とリモート Docker ジョブの実行方法を制御できます。

このセクションでは、VM サービスで利用可能な設定オプションについて説明します。仮想マシンを事前に拡張する方法の詳細については、デフォルトの values.yaml ファイルを参照してください。

CircleCI Server のコアサービスとビルドサービスの設定と検証が完了するまで、これらのオプションはデフォルトのままにしておくことをお勧めします。 VM サービスの設定手順は、 AWS と　 GCP のインストールガイドに記載されています。

Docker レイヤーキャッシュ (DLC) を使用する場合、VM サービスインスタンスをオンデマンドでスピンアップする必要があります。これを実現する方法は 2 つあります。 1 つは、事前割り当てインスタンスを使用中にする、もう 1 つは、リモート Docker と マシン 用の事前割り当てインスタンスのフィールドの両方を 0 に設定することです。

事前割り当てインスタンスを使用する場合、インスタンスが動作不可能状態にならないように、それらのインスタンスを 1 日に 1 回切り替えるように cron ジョブがスケジュールされていることに注意してください。

VM プロバイダー

下記は、AWS または GCP の VM プロバイダー用の設定オプションです。

AWS

AWS EC2 と連携するように VM サービスを設定するには、values.yaml ファイルにセクションを追加する必要があります。

認証

以下のいずれかを実行してください。

IAM キーを選択し、下記を指定します。
- Access Key ID (必須): EC2 へのアクセス用の AWS アクセスキー ID を指定します。
- Secret Key (必須): EC2 へのアクセス用のシークレットキー</a> を指定します。
  
  VM サービスで使用するアクセスキーとシークレットキーは、前述のオブジェクトストレージ用のポリシーとは異なりますのでご注意ください。
または、IAM ロールを選択し、以下を指定します。
- Role ARN (必須):
  
  EC2 アクセス用のサービスアカウントの Role ARN (Amazon Resource Name) を指定します。

vm_service:
  providers:
    ec2:
      enabled: true
      region: <region>
      # Subnets must be in the same availability zone
      subnets:
      - <subnet-id>
      securityGroupId: <security-group-id>

      # Authenticate with IAM access keys
      accessKey: <access-key>
      secretKey: <secret-key>
      # or IRSA (IAM roles for service accounts)
      irsaRole: <role-arn>

デフォルトの AWS AMI リスト

デフォルトの Server v4.x 用の AMI は Ubuntu 22.04 に基づいています。

リージョン	AMI
`us-east-1`	`ami-03dc54f7559144972`
`eu-central-1`	`ami-0575d605472840942`
`ap-south-1`	`ami-047ef6196620f56ca`
`ap-southeast-2`	`ami-0521f8d70ef9dbd24`
`ap-southeast-1`	`ami-0ef0354f4eb3b7428`
`eu-central-1`	`ami-0a8286fff7b5ed33a`
`eu-west-1`	`ami-093618a1d0185f9e8`
`eu-west-2`	`ami-08f00d41b17d3ea0a`
`sa-east-1`	`ami-064b0bfe97e6ec04c`
`us-east-2`	`ami-068cb131f91632f12`
`us-west-1`	`ami-0a4b7cf088a798be3`
`us-west-2`	`ami-018e05f98628cf5e5`
`ap-northeast-1`	`ami-06f32ec6aeecbeaa6`
`ap-northeast-2`	`ami-084c1abb1e8dabffd`
`eu-west-3`	`ami-09b3e24bccae3252f`
`us-east-1`	`ami-0de525cac9ac9bea8`
`us-gov-west-1`	`ami-02abf947586cae56b`

GCP

Google Cloud Platform (GCP) と連携するように VM サービスを設定するには、values.yaml ファイルにセクションを追加する必要があります。

認証

VM サービス専用の一意のサービスアカウントを作成することをお勧めします。コンピューティングインスタンス管理者 (ベータ版) ロールは、VM サービスを運用するための広範な権限を持っています。アクセス権限をより詳細に設定したい場合は、コンピューティングインスタンス管理者 (ベータ版) ロールのドキュメントを参照してください。

以下のオプションのいずれかを選択してください。

GCP IAM Workload Identity を選択した場合は、下記の workloadIdentity フィールドにこちらのポイント 2 と 3 で作成した VM サービスアカウントのメールアドレス (service-account-name@project-id.iam.gserviceaccount.com ) を指定します。
GCP Service Account JSON file を選択した場合は、下記の service-account にサービスアカウントの JSON ファイルを指定します。

vm_service:
  enabled: true
  replicas: 1
  providers:
    gcp:
      enabled: false
      project_id: <project-id>
      network_tags:
      - circleci-vm
      - <your-network>
      zone: <zone>
      network: <network>
      subnetwork: <subnetwork>

      service_account: <service-account-json>
      # OR
      workloadIdentity: ""  # Leave blank if using JSON keys of service account else service account email address

ドキュメントの改善にご協力ください

このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、 GitHub でご利用いただけます。ご協力いただき、ありがとうございます。

このページの編集をご提案ください (最初に「コントリビューションガイド」をご覧ください)。
ドキュメントの問題点を報告する、またはフィードバックやコメントを送信するには、GitHub で issue を作成してください。
CircleCI は、ユーザーの皆様の弊社プラットフォームにおけるエクスペリエンスを向上させる方法を常に模索しています。フィードバックをお寄せいただける場合は、リサーチコミュニティにご参加ください。

サポートが必要ですか

CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。

または、サポートサイトから、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。

CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.