コンテナーグループを作成するための呼び出しで ALIYUN::ECI::ContainerGroup を使用する - Resource Orchestration Service

ALIYUN::ECI::ContainerGroup は、コンテナーグループを作成するために使用されます。コンテナーグループは、Elastic Container Instance です。

構文

{
  "Type": "ALIYUN::ECI::ContainerGroup",
  "Properties": {
    "SecurityContextSysctl": List,
    "Memory": Number,
    "InitContainer": List,
    "Cpu": Number,
    "EipInstanceId": String,
    "ContainerGroupName": String,
    "Container": List,
    "ImageSnapshotId": String,
    "DnsConfig": Map,
    "AutoMatchImageCache": Boolean,
    "Ipv6AddressCount": Integer,
    "ImageRegistryCredential": List,
    "SpotPriceLimit": Number,
    "InstanceType": String,
    "SpotStrategy": String,
    "ActiveDeadlineSeconds": Integer,
    "HostAliase": List,
    "ZoneId": String,
    "TerminationGracePeriodSeconds": Integer,
    "VSwitchId": String,
    "SecurityGroupId": String,
    "SlsEnable": Boolean,
    "RestartPolicy": String,
    "RamRoleName": String,
    "Volume": List,
    "AcrRegistryInfo": List,
    "Tag": List,
    "ResourceGroupId": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
EipInstanceId	String	いいえ	いいえ	Elastic IPアドレス（EIP）のID。	なし。
コンテナー	一覧	はい	はい	コンテナーグループ内のコンテナー。	詳細については、「コンテナーのプロパティ」をご参照ください。
EipInstanceId	String	いいえ	いいえ	Elastic IP アドレス (EIP) の ID。	詳細については、「DnsConfig プロパティ」をご参照ください。
Container	List	はい	はい	コンテナーグループ内のコンテナー。	詳細については、「InitContainer のプロパティ」をご参照ください。
SecurityGroupId	String	いいえ	いいえ	コンテナーグループが属するセキュリティグループのID。	同じセキュリティグループ内のインスタンスは相互にアクセスできます。
ContainerGroupName	String	はい	いいえ	コンテナーグループの名前です。	なし。
ゾーン ID	文字列	いいえ	いいえ	コンテナーグループのゾーン ID です。	このプロパティは、デフォルトでは空です。このプロパティが空の場合、システムはゾーンを選択します。
DnsConfig	Map	いいえ	はい	ドメインネームシステム (DNS) の構成。	最大 20 ボリュームをマウントできます。詳細については、「ボリュームのプロパティ」をご参照ください。
InitContainer	List	いいえ	はい	初期化コンテナー。	詳細については、「HostAliase プロパティ」をご参照ください。
SecurityGroupId	String	いいえ	いいえ	コンテナーグループが属するセキュリティグループの ID。	有効な値: 常時（既定）失敗時なし
ContainerGroupName	String	はい	いいえ	コンテナーグループの名前。	なし。
ZoneId	String	いいえ	いいえ	コンテナーグループのゾーン ID。	各コンテナーグループには最大 20 個のタグを追加できます。キーと値は文字列型です。詳細については、「タグのプロパティ」をご参照ください。
VSwitch ID	文字列	いいえ	いいえ	コンテナーグループのvSwitch IDです。作成するコンテナーグループは、仮想プライベートクラウド（VPC）タイプです。	Volume
ImageRegistryCredential	リスト	いいえ	はい	コンテナーイメージリポジトリのログオン情報。サーバーの IP アドレス、ユーザー名、およびパスワードが含まれます。	詳細については、「ImageRegistryCredential プロパティ」をご参照ください。
メモリ	数値	いいえ	はい	メモリサイズ。	なし。
SlsEnable	ブール値	いいえ	いいえ	ログ記録を有効にするかどうかを指定します。	有効な値: true false (デフォルト)
HostAliase	List	いいえ	いいえ	ポッド内のコンテナーのホスト名と IP アドレス間のマッピング。	詳細については、「SecurityContext プロパティ」をご参照ください。
CPU	数値	いいえ	はい	vCPU の数。	なし。
ImageSnapshotId	String	いいえ	いいえ	イメージキャッシュまたはスナップショットの ID です。	なし。
SpotPriceLimit	数値	いいえ	いいえ	コンテナーグループの 1 時間あたりの最大価格です。	このプロパティの値には、小数点以下 3 桁まで含めることができます。このプロパティは、SpotStrategy が SpotWithPriceLimit に設定されている場合に有効になります。
AutoMatchImageCache	ブール値	いいえ	いいえ	イメージキャッシュを自動的に一致させるかどうかを指定します。	なし。
RestartPolicy	String	いいえ	はい	コンテナーグループを再起動するために使用するポリシー。	有効な値： Always (デフォルト) OnFailure SpotAsPriceGo: コンテナグループは、購入時の市場価格に基づいて入札価格が設定されるプリエンプティブルインスタンスとして作成されます。
TerminationGracePeriodSeconds	整数	いいえ	いいえ	プログラムが停止する前に、プログラムが操作を処理するためのバッファ時間です。	単位：秒。
ActiveDeadlineSeconds	整数	いいえ	いいえ	有効期間。	単位：秒。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
Ramロール名	文字列	いいえ	いいえ	コンテナーグループのResource Access Management ( RAM ) ロールの名前。	Tag
AcrRegistryInfo	リスト	いいえ	いいえ	コンテナーレジストリ Enterprise Edition インスタンスのアクセス資格情報の設定です。	詳細については、「AcrRegistryInfo プロパティ」をご参照ください。
InstanceType	String	いいえ	いいえ	インスタンスタイプ。	なし。

コンテナー構文

"Container": [
  {
    "EnvironmentVar": List, // 環境変数
    "Tty": Boolean, // TTY
    "SecurityContext": Map, // セキュリティコンテキスト
    "Name": String, // 名前
    "ImagePullPolicy": String, // イメージプルポリシー
    "Image": String, // イメージ
    "Stdin": boolean, // 標準入力
    "WorkingDir": String, // 作業ディレクトリ
    "LivenessProbe": Map, // ライブネスプローブ
    "Cpu": Number, // CPU
    "Command": List, // コマンド
    "Memory": Number, // メモリ
    "ReadinessProbe": Map, // レディネプローブ
    "VolumeMount": List, // ボリュームマウント
    "Port": List, // ポート
    "Arg": List, // 引数
    "StdinOnce": Boolean // 標準入力 (一度だけ)
  }
]

コンテナープロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
EnvironmentVar	リスト	いいえ	いいえ	コンテナの環境変数。	各環境変数はキーと値のペアです。キーと値は文字列型です。キーは変数の名前を指定し、値は変数の値を指定します。最大 100 個の環境変数を指定できます。詳細については、「EnvironmentVar プロパティ」をご参照ください。
Tty	ブール値	いいえ	いいえ	コンテナに TeleTYpe（TTY）端末を割り当てるかどうかを指定します。	有効な値： true：コンテナに TTY 端末を割り当てます。このプロパティを true に設定する場合は、Stdin を true に設定する必要があります。 false：コンテナに TTY 端末を割り当てません。
SecurityContext	マップ	いいえ	いいえ	コンテナグループのセキュリティコンテキスト。	なし。
Name	文字列	はい	いいえ	コンテナ名。	なし。
ImagePullPolicy	文字列	いいえ	いいえ	イメージをプルするためのポリシー。	なし。
Image	文字列	はい	いいえ	イメージ。	なし。
Stdin	ブール値	いいえ	いいえ	コンテナランタイムの標準入力にバッファを割り当てるかどうかを指定します。	有効な値： true false
WorkingDir	文字列	いいえ	いいえ	コンテナの作業ディレクトリ。	なし。
LivenessProbe	マップ	いいえ	いいえ	コンテナのライブネスプローブ。	詳細については、「LivenessProbe プロパティ」をご参照ください。
Cpu	数値	いいえ	いいえ	コンテナに割り当てる vCPU の数。	なし。
Command	リスト	いいえ	いいえ	コンテナに送信するコマンド。	最大 1 つのコマンドを指定できます。コマンドは文字列型で、最大 256 文字です。
Memory	数値	いいえ	いいえ	コンテナに割り当てるメモリーサイズ。	単位：GiB。
ReadinessProbe	マップ	いいえ	いいえ	コンテナのレディネプローブ。	詳細については、「ReadinessProbe プロパティ」をご参照ください。
VolumeMount	リスト	いいえ	いいえ	コンテナにマウントするボリューム。	最大 16 個のボリュームをマウントできます。詳細については、「VolumeMount プロパティ」をご参照ください。
Port	リスト	いいえ	いいえ	コンテナに使用するポートとプロトコル。	最大 100 個のポートを指定できます。有効な値： TCP UDP 詳細については、「Port プロパティ」をご参照ください。
Arg	リスト	いいえ	いいえ	コマンドに指定する引数。	引数は文字列型です。最大 10 個の引数を指定できます。
StdinOnce	ブール値	いいえ	いいえ	最初に接続されたクライアントが切断された後、標準入力ストリームを閉じるかどうかを指定します。	有効な値： true false

LivenessProbe 構文

"LivenessProbe": {
  "TcpSocket.Port": Integer, // TCP ソケットのポート
  "HttpGet.Scheme": String, // HTTP Get のスキーム
  "HttpGet.Port": Integer, // HTTP Get のポート
  "FailureThreshold": Integer, // 失敗のしきい値
  "InitialDelaySeconds": Integer, // 初期遅延時間（秒）
  "TimeoutSeconds": Integer, // タイムアウト時間（秒）
  "SuccessThreshold": Integer, // 成功のしきい値
  "Exec.Command": List, // 実行するコマンドのリスト
  "PeriodSeconds": Integer, // プローブの実行間隔（秒）
  "HttpGet.Path": String // HTTP Get のパス
}

LivenessProbe のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
TcpSocket.Port	Integer	いいえ	いいえ	ヘルスチェックのためにシステムが TCP ソケットリクエストを送信するポート。	なし。
HttpGet.Scheme	String	いいえ	いいえ	ホストへの接続に使用するプロトコル。	有効な値： HTTP HTTPS
HttpGet.Port	Integer	いいえ	いいえ	ヘルスチェックのためにシステムが HTTP GET リクエストを送信するポート。	なし。
FailureThreshold	Integer	いいえ	いいえ	正常なコンテナがヘルスチェックに連続して失敗し、異常と宣言されるまでの回数。	デフォルト値：3。
InitialDelaySeconds	Integer	いいえ	いいえ	コンテナの起動後、プローブが開始されるまでの期間。	単位：秒。
TimeoutSeconds	Integer	いいえ	いいえ	プローブのタイムアウト期間。単位：秒。	最小値：1。デフォルト値：1。
SuccessThreshold	Integer	いいえ	いいえ	異常なコンテナがヘルスチェックに連続して合格し、正常と宣言されるまでの回数。	値を 1 に設定します。デフォルト値：1。
Exec.Command	List	いいえ	いいえ	ヘルスチェックを実行するためにコンテナ内で実行するコマンド。	なし。
PeriodSeconds	Integer	いいえ	いいえ	2 つの連続したヘルスチェックの間隔。	単位：秒。最小値：1。デフォルト値：10。
HttpGet.Path	String	いいえ	いいえ	ヘルスチェックのためにシステムが HTTP GET リクエストを送信するパス。	なし。

DnsConfig 構文

"DnsConfig": {
  "NameServer": List, // ネームサーバーのリスト
  "Search": List, // 検索ドメインのリスト
  "Option": List // オプションのリスト
}

DnsConfig プロパティ

プロパティ	型	必須	編集可能	説明	制約
NameServer	リスト	いいえ	いいえ	DNS サーバーの IP アドレス。	なし。
Search	リスト	いいえ	いいえ	DNS 検索ドメイン。	なし。
Option	リスト	いいえ	いいえ	オプション。	各オプションは、名前と値で構成されます。オプション値は省略可能です。詳細については、「オプションのプロパティ」をご参照ください。

InitContainer の構文

"InitContainer": [
  {
    "EnvironmentVar": List, // 環境変数
    "SecurityContext": Map, // セキュリティコンテキスト
    "Name": String, // 名前
    "Image": String, // イメージ
    "Arg": List, // 引数
    "WorkingDir": String, // 作業ディレクトリ
    "Port": List, // ポート
    "Command": List, // コマンド
    "Memory": Number, // メモリ
    "ImagePullPolicy": String, // イメージプルポリシー
    "VolumeMount": List, // ボリュームマウント
    "Cpu": Number // CPU
  }
]

InitContainer のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
EnvironmentVar	リスト	いいえ	いいえ	コンテナの環境変数。	各環境変数はキーと値のペアです。キーと値は文字列型です。キーは変数の名前を指定し、値は変数の値を指定します。最大 100 個の環境変数を指定できます。値を status.podIP に設定します。
SecurityContext	マップ	いいえ	いいえ	コンテナグループのセキュリティコンテキスト。	なし。
Name	文字列	いいえ	いいえ	コンテナ名。	なし。
Image	文字列	いいえ	いいえ	コンテナイメージ。	なし。
Arg	リスト	いいえ	いいえ	コマンドに指定する引数。	引数は文字列型です。最大 10 個の引数を指定できます。
WorkingDir	文字列	いいえ	いいえ	コンテナの作業ディレクトリ。	なし。
Port	リスト	いいえ	いいえ	コンテナに使用するポートとプロトコル。	最大 100 個のポートを指定できます。有効な値： TCP UDP
Command	リスト	いいえ	いいえ	コンテナに送信するコマンド。	最大 1 つのコマンドを指定できます。コマンドは文字列型で、最大 256 文字です。
Memory	数値	いいえ	いいえ	コンテナに割り当てるメモリサイズ。	単位：GB。
ImagePullPolicy	文字列	いいえ	いいえ	イメージをプルするためのポリシー。	なし。
VolumeMount	リスト	いいえ	いいえ	コンテナにマウントするボリューム。	最大 16 個のボリュームをマウントできます。
Cpu	数値	いいえ	いいえ	コンテナに割り当てる vCPU の数。	なし。

ボリューム構文

"Volume": [
  {
    "NFSVolume.Path": String, // NFS ボリュームのパス
    "Name": String, // ボリューム名
    "EmptyDirVolume.Medium": String, // EmptyDir ボリュームのメディア
    "NFSVolume.Server": String, // NFS ボリュームのサーバー
    "NFSVolume.ReadOnly": Boolean, // NFS ボリュームを読み取り専用にするかどうか
    "ConfigFileVolume.ConfigFileToPath": List, // 設定ファイルボリュームの設定ファイルからパスへのマッピング
    "Type": String, // ボリュームのタイプ
    "FlexVolume.Options": Map, // FlexVolume のオプション
    "FlexVolume.Driver": String, // FlexVolume のドライバー
    "FlexVolume.FsType": String // FlexVolume のファイルシステムタイプ
  }
]

ボリュームのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
NFSVolume.Path	String	いいえ	いいえ	ネットワークファイルシステム（NFS）ボリュームのパス。	なし。
Name	String	はい	いいえ	ボリューム名。	なし。
EmptyDirVolume.Medium	String	いいえ	いいえ	ストレージメディア。	デフォルトでは、ノードのファイルシステムが使用されます。値を Memory に設定します。このプロパティを Memory に設定すると、emptyDir ボリュームはメモリに保存されます。
NFSVolume.Server	String	いいえ	いいえ	NFS サーバーの IP アドレス。	なし。
NFSVolume.ReadOnly	Boolean	いいえ	いいえ	NFS ボリュームが読み取り専用かどうかを指定します。	デフォルト値：false。
ConfigFileVolume.ConfigFileToPath	List	いいえ	いいえ	ConfigFile ボリュームのパス。	詳細については、「ConfigFileVolume.ConfigFileToPath プロパティ」をご参照ください。
Type	String	はい	いいえ	ボリュームタイプ。	有効な値： EmptyDirVolume NFSVolume ConfigFileVolume
FlexVolume.Options	Map	いいえ	いいえ	FlexVolume オプション。	各オプションは JSON 形式のキーと値のペアです。たとえば、FlexVolume を使用してクラウドディスクをマウントする場合は、FlexVolume.Options を `{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}` に設定します。
FlexVolume.Driver	String	いいえ	いいえ	FlexVolume を使用してボリュームをマウントするときのドライバー名。	なし。
FlexVolume.FsType	String	いいえ	いいえ	マウントするファイルシステムのタイプ。	なし。

HostAliase 構文

"HostAliase": [
  {
    "Ip": String, // IPアドレス
    "Hostname": List // ホスト名
  }
]

HostAliase プロパティ

プロパティ	型	必須	編集可能	説明	制約
Ip	String	いいえ	いいえ	IP アドレス。	なし。
Hostname	List	いいえ	いいえ	ホスト名。	なし。

ImageRegistryCredential の構文

"ImageRegistryCredential": [
  {
    "UserName": String, // ユーザー名
    "Password": String, // パスワード
    "Server": String // サーバー
  }
]

ImageRegistryCredential のプロパティ

プロパティ	型	必須	編集可能	説明	制約
UserName	String	はい	いいえ	イメージリポジトリのログオンユーザー名。	なし。
Password	String	はい	いいえ	イメージリポジトリのログオンパスワード。	なし。
Server	String	はい	いいえ	イメージリポジトリの IP アドレス。	IPアドレスには、プロトコルプレフィックスを含めることはできません。 IP アドレスには、`http://` や `https://` などのプロトコルプレフィックスを含めることはできません。

EnvironmentVar の構文

"EnvironmentVar": {
  "Key": String, // キー
  "Value": String, // 値
  "FieldRef.FieldPath": String // FieldRef の FieldPath
}

EnvironmentVar プロパティ

プロパティ	型	必須	編集可能	説明	制約
Key	String	いいえ	いいえ	変数名。	名前は 1 ～ 128 文字で、数字、文字、アンダースコア (_) を使用できます。数字で始めることはできません。
Value	String	いいえ	いいえ	変数の値。	値は最大 256 文字です。
FieldRef.FieldPath	String	いいえ	いいえ	別の変数への参照。	値を status.podIP に設定します。

SecurityContext の構文

"SecurityContext": {
  // 追加する機能
  "Capability.Add": List,
  // 実行ユーザー
  "RunAsUser": Integer,
  // 読み取り専用のルートファイルシステム
  "ReadOnlyRootFilesystem": Boolen
}

SecurityContext プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Capability.Add	リスト	いいえ	いいえ	コンテナー内のプロセスに付与する権限。	値を NET_ADMIN に設定します。
RunAsUser	整数	いいえ	いいえ	ユーザー ID。	なし。
ReadOnlyRootFilesystem	ブール値	いいえ	いいえ	ルートファイルシステムを読み取り専用にするかどうかを指定します。	既定値: true。

VolumeMount の構文

"VolumeMount": [
  {
    "Name": String, // 名前
    "ReadOnly": Boolean, // 読み取り専用かどうか
    "MountPath": String, // マウントパス
    "MountPropagation": String, // マウント伝播
    "SubPath": String // サブパス
  }
]

VolumeMount プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Name	String	いいえ	いいえ	ボリューム名。	この名前は、このトピックの「Volume プロパティ」セクションの Name プロパティに指定した値と同じである必要があります。
ReadOnly	Boolean	いいえ	いいえ	ボリュームが読み取り専用かどうかを指定します。	デフォルト値: false。
MountPath	String	いいえ	いいえ	ボリュームのマウントパス。	このパスに保存されているデータは、マウントされたボリュームのデータによって上書きされます。
MountPropagation	String	いいえ	いいえ	ボリュームのマウント伝播設定。	マウント伝播を使用すると、1 つのコンテナーにマウントされているボリュームを、同じポッド内の他のコンテナー、または同じノード上の他のポッドと共有できます。有効な値： None: ボリュームマウントは、このボリュームまたはこのボリュームのサブディレクトリで後続に実行されるマウントを受け取りません。 HostToContainer: ボリュームマウントは、このボリュームまたはこのボリュームのサブディレクトリで後続に実行されるマウントを受け取ります。 Bidirectional: この値は HostToContainer と似ています。ボリュームマウントは、このボリュームまたはこのボリュームのサブディレクトリで後続に実行されるマウントを受け取ります。さらに、コンテナーで実行されるすべてのボリュームマウントはホストに伝播され、同じボリュームを使用するすべてのポッドのすべてのコンテナーに伝播されます。
SubPath	String	いいえ	いいえ	ボリュームのサブディレクトリ。	このプロパティを使用すると、同じボリュームの異なるディレクトリをコンテナーの異なるサブディレクトリにマウントできます。

ポート構文

"Port": [
  {
    "Port": Interger, // ポート番号
    "Protocol": String // プロトコル
  }
]

ポートのプロパティ

プロパティ

種類

必須

編集可能

説明

制約

ポート

整数

いいえ

ポート番号。

有効な値: 1 ～ 65535。

プロトコル

文字列

いいえ

ポートのプロトコル。

有効な値:

ConfigFileVolume.ConfigFileToPath の構文

"onfigFileVolume.ConfigFileToPath": [
  {
    "Content": String, // コンテンツ
    "Path": String // パス
  }
]

ConfigFileVolume.ConfigFileToPath プロパティ

プロパティ	種類	必須	編集可能	説明	制約
Content	String	いいえ	いいえ	ConfigFile ボリュームの内容。	内容は最大 32 KB です。
Path	String	はい	いいえ	ConfigFile ボリュームの相対パス。	別のディレクトリを基準としたディレクトリの場所を指定できます。

SecurityContextSysctl の構文

"SecurityContextSysctl": [
  {
    "Value": String, // 値
    "Name": String // 名前
  }
]

SecurityContextSysctl プロパティ

プロパティ

種類

必須

編集可能

説明

制約

Value

String

いいえ

コンテナーグループが実行されるセキュリティコンテキストの変数値。

なし。

Name