ALIYUN::SAE::Application を使用して SAE アプリケーションを作成する - Resource Orchestration Service

ALIYUN::SAE::Application タイプは、Serverless App Engine (SAE) でアプリケーションを作成するために使用されます。

構文

{
  "Type": "ALIYUN::SAE::Application",
  "Properties": {
    "Timezone": String,
    "AppDescription": String,
    "MountDesc": String,
    "NasId": String,
    "WarStartOptions": String,
    "Liveness": String,
    "Memory": Integer,
    "WebContainer": String,
    "SlsConfigs": String,
    "Cpu": Integer,
    "Deploy": Boolean,
    "PackageVersion": String,
    "AppName": String,
    "Jdk": String,
    "JarStartArgs": String,
    "PreStop": String,
    "Readiness": String,
    "PackageType": String,
    "CommandArgs": String,
    "Envs": String,
    "VSwitchId": String,
    "ImageUrl": String,
    "PostStart": String,
    "JarStartOptions": String,
    "MountHost": String,
    "Replicas": Integer,
    "CustomHostAlias": String,
    "VpcId": String,
    "Tags": List,
    "SecurityGroupId": String,
    "Command": String,
    "EdasContainerVersion": String,
    "PackageUrl": String,
    "NamespaceId": String,
    "AssociateEip": Boolean,
    "AcrInstanceId": String,
    "OssAkId": String,
    "ProgrammingLanguage": String,
    "OssAkSecret": String,
    "Python": String,
    "BaseAppId": String,
    "EnableEbpf": String,
    "PhpArmsConfigLocation": String,
    "PhpConfig": String,
    "MicroRegistrationConfig": String,
    "TerminationGracePeriodSeconds": Integer,
    "ConfigMapMountDesc": String,
    "PvtzDiscoverySvc": String,
    "AcrAssumeRoleArn": String,
    "TomcatConfig": String,
    "AppSource": String,
    "PythonModules": String,
    "NasConfigs": String,
    "MicroRegistration": String,
    "ServiceTags": String,
    "ImagePullSecrets": String,
    "AutoConfig": Boolean,
    "KafkaConfigs": String,
    "Php": String,
    "OssMountDescs": List,
    "PhpConfigLocation": String,
    "SaeVersion": String,
    "NewSaeVersion": String,
    "EnableNewArms": Boolean,
    "EnableSidecarResourceIsolated": Boolean,
    "SidecarContainersConfig": List,
    "InitContainersConfig": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
AppName	String	はい	いいえ	アプリケーション名。	名前は最大 36 文字です。先頭は英字である必要があり、英字、数字、ハイフン (-) を使用できます。
Cpu	Integer	はい	いいえ	各インスタンスに必要な CPU コア数。定義された仕様のインスタンスのみがサポートされます。	有効な値： 500 1000 2000 4000 8000 16000 32000 単位: ミリコア。
Memory	Integer	はい	いいえ	各インスタンスに必要なメモリサイズ。定義された仕様のインスタンスのみがサポートされます。	メモリサイズは CPU コアと連動します。次の仕様がサポートされています: 1024 MB のメモリ: 500 ミリコアの CPU に対応します。 2048 MB のメモリ: 500 または 1000 ミリコアの CPU に対応します。 4096 MB のメモリ: 1000 または 2000 ミリコアの CPU に対応します。 8192: 2,000 または 4,000 ミリコアの CPU 割り当てを指定します。 16384: 4,000 から 8,000 ミリコアの CPU を表します。 32768 は 16,000 ミリコアの CPU に対応します。 65536 MB のメモリ: 8000、16000、または 32000 ミリコアの CPU に対応します。 131072: 32,000 CPU ミリコアを表します。単位：MB。
Replicas	Integer	はい	いいえ	インスタンスの初期数。	なし
PackageType	String	はい	いいえ	アプリケーションパッケージのタイプ。	有効な値： FatJar War Image
Timezone	String	いいえ	はい	タイムゾーン。	デフォルト値：Asia/Shanghai。
AppDescription	String	いいえ	いいえ	アプリケーションの説明。	説明は最大 1,024 文字まで入力できます。
MountDesc	String	いいえ	はい	マウントの説明。	なし
NasId	String	いいえ	はい	マウントする NAS ファイルシステムの ID。	NAS ファイルシステムには、利用可能なマウントポイントのクォータがあるか、そのマウントポイントが VPC 内の vSwitch 上にある必要があります。このパラメーターを指定せずに MountDesc パラメーターを指定した場合、NAS ファイルシステムが自動的に購入され、VPC 内の vSwitch にマウントされます。
WarStartOptions	String	いいえ	はい	WAR パッケージの起動オプション。	デフォルトの起動コマンドは次のとおりです: `java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start`。
Liveness	String	いいえ	はい	コンテナーのヘルスチェック。ヘルスチェックに失敗したコンテナーは再起動されます。	現在、コンテナー内でコマンドを実行してヘルスチェックを実行することのみが可能です。例: `{"exec":{"command":["sleep","5s"]},"initialDelaySeconds":10,"timeoutSeconds":11}`。
WebContainer	String	いいえ	はい	デプロイメントパッケージが依存する Tomcat コンテナーのバージョン。	このパラメーターはイメージではサポートされていません。
SlsConfigs	String	いいえ	はい	ファイルログ収集設定。	なし
Deploy	Boolean	いいえ	いいえ	アプリケーションをすぐにデプロイするどうかを指定します。	有効な値： true: すぐにデプロイします。 false (デフォルト): すぐにデプロイしません。
Tags	List	いいえ	はい	タグ。	最大 20 個のタグを追加できます。詳細については、「タグの構文」と「タグのプロパティ」をご参照ください。
PackageVersion	String	いいえ	はい	デプロイメントパッケージのバージョン番号。	このパラメーターは、PackageType が War または FatJar に設定されている場合に必須です。
Jdk	String	いいえ	はい	デプロイメントパッケージが依存する JDK のバージョン。	このパラメーターはイメージではサポートされていません。
JarStartArgs	String	いいえ	はい	JAR パッケージの起動引数。	デフォルトの起動コマンドは次のとおりです: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`。
PreStop	String	いいえ	はい	コンテナーが停止する前に実行するスクリプト。	コンテナーが停止する前に実行するスクリプト。例: `{"exec":{"command":"cat","/etc/group"}}`。
Readiness	String	いいえ	はい	準備完了チェック用のスクリプト。	準備完了チェック用のスクリプト。例: `{"exec":{"command":["sleep","6s"]},"initialDelaySeconds":15,"timeoutSeconds":12}`。ヘルスチェックに複数回失敗したコンテナーは再起動されます。ヘルスチェックに合格しないコンテナーは、SLB からのトラフィックを受信しません。
CommandArgs	String	いいえ	はい	イメージ起動コマンドの引数。	なし
Envs	String	いいえ	はい	コンテナーの環境変数。	環境変数のフォーマットは次のとおりです: `[{"name":"envtmp","value":"0"}]`。 `name`: 環境変数の名前。 `value`: 環境変数の値または参照。
VSwitchId	String	いいえ	いいえ	アプリケーションインスタンスの ENI が配置されている vSwitch。	vSwitch は指定された VPC 内にある必要があります。vSwitch は EDAS 名前空間にバインドされています。このパラメーターを指定しない場合、名前空間にバインドされている VSwitchId が使用されます。
ImageUrl	String	いいえ	はい	イメージのアドレス。	Image タイプのアプリケーションに対してのみイメージアドレスを設定できます。
PostStart	String	いいえ	はい	コンテナーの起動後に実行するスクリプト。	コンテナーの起動後に実行するスクリプト。例: `{"exec":{"command":"cat","/etc/group"}}`。
JarStartOptions	String	いいえ	はい	JAR パッケージの起動オプション。	デフォルトの起動コマンドは次のとおりです: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`。
MountHost	String	いいえ	はい	VPC 内の NAS ファイルシステムのマウントターゲット。	なし
CustomHostAlias	String	いいえ	はい	コンテナー内のカスタムホストマッピング。	カスタムホストマッピングのフォーマットは次のとおりです: `[{"hostName":"samplehost","ip":"127.0.XX.XX"}]` 。 `hostName`: ドメイン名またはホスト名。 `ip`: IP アドレス。
VpcId	String	いいえ	いいえ	SAE 名前空間に対応する VPC。	SAE では、1 つの名前空間は 1 つの VPC にのみ対応でき、変更することはできません。名前空間で SAE アプリケーションを初めて作成すると、バインディング関係が形成されます。複数の名前空間が 1 つの VPC に対応できます。このパラメーターを入力しない場合、デフォルトで名前空間にバインドされている VpcId が使用されます。
SecurityGroupId	String	いいえ	いいえ	セキュリティグループ ID。	なし
Command	String	いいえ	はい	イメージの起動コマンド。	コマンドは、コンテナー内に存在する実行可能オブジェクトである必要があります。例： sleep。コマンドは、コンテナー内に存在する実行可能なオブジェクトである必要があります。例: sleep。このコマンドを設定すると、イメージの元の起動コマンドがオーバーライドされます。
EdasContainerVersion	String	いいえ	はい	EDAS Pandora アプリケーションが使用するランタイム環境。	なし
PackageUrl	String	いいえ	はい	デプロイメントパッケージのアドレス。	このパラメーターは、PackageType が War または FatJar に設定されている場合に有効です。
NamespaceId	String	はい	いいえ	EDAS 名前空間の ID。	名前が小文字とハイフン (-) で構成される名前空間のみがサポートされます。名前は小文字で始まる必要があります。
AssociateEip	Boolean	いいえ	いいえ	EIP をバインドするかどうかを指定します。	有効な値： true: バインドします。 false: バインドしません。
AcrInstanceId	String	いいえ	はい	ACR Enterprise インスタンスの ID。	なし
OssAkId	String	いいえ	いいえ	OSS への読み書き用の AccessKey ID。	なし
ProgrammingLanguage	String	いいえ	いいえ	アプリケーションを作成するための技術スタック言語。	有効な値： java: Java 言語。 php: PHP 言語。 other: Python、C++、Go、.NET、Node.js などの複数の言語。
OssAkSecret	String	いいえ	いいえ	OSS への読み書き用の AccessKey シークレット。	なし
Python	String	いいえ	いいえ	Python 環境。	PYTHON 3.9.15 がサポートされています。
BaseAppId	String	いいえ	いいえ	ベースアプリケーションの ID。	なし
EnableEbpf	String	いいえ	いいえ	eBPF テクノロジーに基づいて、非 Java アプリケーションのアプリケーション監視を有効にします。	有効な値： true: 有効にします。 false: 無効にします。これがデフォルト値です。
PhpArmsConfigLocation	String	いいえ	いいえ	PHP アプリケーション監視のマウントパス。PHP サーバーがこのパスから設定ファイルをロードすることを確認してください。	設定内容を管理する必要はありません。SAE は自動的に正しい設定ファイルをレンダリングします。
PhpConfig	String	いいえ	いいえ	PHP 設定ファイルの内容。	なし
MicroRegistrationConfig	String	いいえ	いいえ	レジストリの設定情報。	なし
TerminationGracePeriodSeconds	Integer	いいえ	いいえ	安全停止のタイムアウト期間。	デフォルト値は 30 です。単位: 秒。値は 1 から 300 の範囲である必要があります。
ConfigMapMountDesc	String	いいえ	いいえ	ConfigMap マウントの説明。	名前空間設定ページで作成された設定項目を使用して、設定情報をコンテナーに挿入します。パラメーターは次のとおりです: configMapId: ConfigMap インスタンスの ID。 key: キー値。 mountPath: マウントパス。説明 `sae-sys-configmap-all` パラメーターを渡して、すべてのキーをマウントできます。
PvtzDiscoverySvc	String	いいえ	いいえ	K8s Service の登録と検出を有効にします。	パラメーターは次のとおりです: serviceName: サービスの名前。フォーマットは `custom-namespace ID` である必要があります。サフィックス `-namespace ID` はカスタマイズできず、アプリケーションが存在する名前空間に基づいている必要があります。たとえば、中国北部 2 (北京) リージョンのデフォルト名前空間にあるアプリケーションの場合、サフィックスは `-cn-beijing-default` です。 namespaceId: 名前空間 ID。 portProtocols: ポートとプロトコル。ポート値は 1 から 65535 の範囲である必要があります。プロトコルは TCP と UDP をサポートします。 portAndProtocol: ポートとプロトコル。ポート値は 1 から 65535 の範囲である必要があります。プロトコルは TCP と UDP をサポートします。portProtocols の使用を推奨します。portProtocols と portAndProtocol の両方を設定した場合、portProtocols のみが有効になります。 enable: K8s Service の登録と検出を有効にします。
AcrAssumeRoleArn	String	いいえ	いいえ	アカウント間でイメージをプルするために必要な RAM ロールの ARN。	詳細については、「RAM ロールに権限を付与する」をご参照ください。
TomcatConfig	String	いいえ	いいえ	Tomcat ファイル設定。	設定を削除するには "" または "{}" に設定します: port: ポート番号。値は 1024 から 65535 の範囲である必要があります。1024 未満のポートには root 権限が必要です。コンテナーは管理者権限で設定されているため、1024 より大きいポート番号を指定してください。このパラメーターを設定しない場合、デフォルト値は 8080 です。 contextPath: アクセスパス。デフォルトはルートディレクトリ "/" です。 maxThreads: 接続プールのサイズ。デフォルトサイズは 400 です。 uriEncoding: Tomcat のエンコード形式。UTF-8、ISO-8859-1、GBK、GB2312 が含まれます。これを設定しない場合、デフォルトは ISO-8859-1 です。 useBodyEncodingForUri: URL に BodyEncoding を使用するかどうかを指定します。デフォルトは true です。
AppSource	String	いいえ	いいえ	マイクロサービスアプリケーション。	有効値: micro_service
PythonModules	String	いいえ	いいえ	カスタムインストールモジュールの依存関係。	デフォルトでは、ルートディレクトリの requirements.txt ファイルで定義された依存関係がインストールされます。パッケージが設定またはカスタマイズされていない場合は、インストールする依存関係を指定できます。
NasConfigs	String	いいえ	いいえ	NAS をマウントするための設定。	パラメーターは次のとおりです: mountPath: コンテナーのマウントパス。 readOnly: false の値は読み取りおよび書き込み権限を示します。 nasId: NAS ID。 mountDomain: コンテナーのマウントポイントアドレス。詳細については、「DescribeMountTargets」をご参照ください。 nasPath: NAS 内の相対ファイルディレクトリ。
MicroRegistration	String	いいえ	いいえ	Nacos レジストリを選択します。	有効な値： 0: SAE 組み込み Nacos。 1: ユーザー作成 Nacos。 2: MSE Nacos。
ServiceTags	String	いいえ	いいえ	アプリケーションに設定されたグレースケールタグ。	なし
ImagePullSecrets	String	いいえ	いいえ	対応するシークレット ID。	なし
AutoConfig	Boolean	いいえ	いいえ	ネットワーク環境を自動的に設定するかどうかを指定します。	有効な値： true: アプリケーション作成時に SAE がネットワーク環境を自動的に設定します。NamespaceId、VpcId、vSwitchId、および SecurityGroupId の値は無視されます。 false: アプリケーション作成時にネットワーク環境を手動で設定します。説明 true を選択した場合、渡された他の NamespaceId の値は無視されます。
KafkaConfigs	String	いいえ	いいえ	Kafka にログを収集するための設定の概要。	パラメーターは次のとおりです: kafkaEndpoint: Kafka API のサービスアクセスアドレス。 kafkaInstanceId: Kafka インスタンスの ID。 kafkaConfigs: 1 つ以上のログの設定の概要。値については、このトピックの KafkaConfigs リクエストパラメーターをご参照ください。
Php	String	いいえ	いいえ	PHP デプロイメントパッケージが依存する PHP のバージョン。	なし。
OssMountDescs	List	いいえ	いいえ	OSS マウントの説明。	パラメーターは次のとおりです: bucketName: バケットの名前。 bucketPath: OSS で作成したディレクトリまたは OSS オブジェクト。OSS マウントディレクトリが存在しない場合、例外がトリガーされます。 mountPath: SAE のコンテナーパス。パスが既に存在する場合は上書きされます。パスが存在しない場合は作成されます。 readOnly: コンテナーパスがマウントされたディレクトリリソースに対する読み取り権限を持つかどうかを指定します。有効値: true: 読み取り専用権限。 false: 読み書き権限。
PhpConfigLocation	String	いいえ	いいえ	PHP アプリケーション起動設定のマウントパス。	PHP サーバーがこの設定ファイルを使用して起動することを確認してください。
SaeVersion	String	いいえ	いいえ	SAE バージョン。	サポートされているバージョン: v1 v2
NewSaeVersion	String	いいえ	いいえ	新しい SAE バージョン。	有効値: lite std pro
EnableNewArms	Boolean	いいえ	いいえ	新しい Arms 機能を有効にするかどうかを指定します。	有効値: true: 有効にする false: 有効にしない
EnableSidecarResourceIsolated	Boolean	いいえ	はい	サイドカーコンテナーのリソース分離を有効にするかどうかを指定します。	有効値: true: リソースを分離します。 false: リソースを分離しません。
SidecarContainersConfig	List	いいえ	はい	サイドカーコンテナーの設定。	詳細については、「SidecarContainersConfig プロパティ」をご参照ください。
InitContainersConfig	List	いいえ	はい	init コンテナーの設定。	詳細については、「InitContainersConfig プロパティ」をご参照ください。

SidecarContainersConfig 構文

"SidecarContainersConfig": [
  {
    "CommandArgs": String,
    "AcrInstanceId": String,
    "Memory": Integer,
    "Name": String,
    "EmptyDirDesc": String,
    "Command": String,
    "ImageUrl": String,
    "Cpu": Integer,
    "Envs": String,
    "ConfigMapMountDesc": String
  }
]

SidecarContainersConfig プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
CommandArgs	String	いいえ	はい	init コンテナーで実行されるコマンドのパラメーター	なし
AcrInstanceId	String	いいえ	はい	ACR インスタンスの ID。	なし
Memory	Integer	はい	はい	サイドカーコンテナーに割り当てられるメモリ量。	なし
Name	String	はい	はい	サイドカーコンテナーの名前。	なし
EmptyDirDesc	String	いいえ	はい	emptyDir ボリュームマウントの説明。	なし
Command	String	いいえ	はい	init コンテナーで実行されるコマンド。	なし
ImageUrl	String	いいえ	はい	イメージのアドレス。	Image タイプのアプリケーションに対してのみイメージアドレスを設定できます。
Cpu	Integer	はい	はい	サイドカーコンテナーに割り当てられる CPU コア数。	なし
Envs	String	いいえ	はい	コンテナーの環境変数。	例: `[{ "name": "envtmp", "value": "0"}]`
ConfigMapMountDesc	String	いいえ	はい	ConfigMap マウントの説明。	なし

InitContainersConfig 構文

"InitContainersConfig": [
  {
    "Command": String,
    "ConfigMapMountDesc": String,
    "ImageUrl": String,
    "CommandArgs": String,
    "Envs": String,
    "Name": String
  }
]

InitContainersConfig プロパティ

プロパティ	タイプ	必須	更新を許可	説明	制約
Command	String	いいえ	はい	init コンテナーで実行するコマンド。	なし
ConfigMapMountDesc	String	いいえ	いいえ	ConfigMap マウントの説明。	なし
ImageUrl	String	いいえ	はい	イメージのアドレス。	Image タイプのアプリケーションに対してのみイメージアドレスを設定できます。
CommandArgs	String	いいえ	はい	init コンテナーで実行するコマンドの引数。	なし
Envs	String	いいえ	はい	コンテナーの環境変数。	例: `[{ "name": "envtmp", "value": "0"}]`
Name	String	はい	はい	init コンテナーの名前。	なし

タグの構文

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

タグのプロパティ

プロパティ	タイプ	必須	更新を許可	説明	制約
Key	String	はい	いいえ	タグキー。	キーは 1～128 文字である必要があります。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。
Value	String	いいえ	いいえ	タグ値。	値は 0～128 文字である必要があります。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。

戻り値

Fn::GetAtt

AppId: アプリケーション ID。
ChangeOrderId: リリースオーダーの ID。この ID を使用して、タスクの実行ステータスをクエリできます。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  NamespaceId:
    Type: String
    Description: |-
      EDAS 名前空間の ID。名前空間の名前には小文字とハイフン (-) のみを含めることができ、先頭は英字である必要があります。
      DescribeNamespaceList 操作の応答から名前空間 ID を取得できます。
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
  SecurityGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
Resources:
  Application:
    Type: ALIYUN::SAE::Application
    Properties:
      AppName: TestApp
      NamespaceId:
        Ref: NamespaceId
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
      SecurityGroupId:
        Ref: SecurityGroupId
      Cpu: 500
      Memory: 1024
      Replicas: 2
      PackageType: War
      Deploy: true
      Timezone: Asia/Shanghai
Outputs: {}

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "NamespaceId": {
      "Type": "String",
      "Description": "EDAS 名前空間の ID。名前空間の名前には小文字とハイフン (-) のみを含めることができ、先頭は英字である必要があります。\nDescribeNamespaceList 操作の応答から名前空間 ID を取得できます。"
    },
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}"
      }
    },
    "SecurityGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}"
      }
    }
  },
  "Resources": {
    "Application": {
      "Type": "ALIYUN::SAE::Application",
      "Properties": {
        "AppName": "TestApp",
        "NamespaceId": {
          "Ref": "NamespaceId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "SecurityGroupId": {
          "Ref": "SecurityGroupId"
        },
        "Cpu": 500,
        "Memory": 1024,
        "Replicas": 2,
        "PackageType": "War",
        "Deploy": true,
        "Timezone": "Asia/Shanghai"
      }
    }
  },
  "Outputs": {
  }
}

名前空間の作成、SAE アプリケーションの作成、および SLB インスタンスのバインド方法の例については、「YAML の例」をご参照ください。