OOS は、コードとしての運用 (Ops as Code) の理念を実装しており、テンプレートはコードを作成するための手段です。このガイドでは、OOS テンプレートを作成するための標準を定義します。これらの標準は、Alibaba Cloud が提供するすべての公開テンプレートに適用されます。
目的
-
テンプレートを読みやすく、理解しやすくすること。
-
継続的なテンプレートのメンテナンスを簡素化すること。
-
組織内での共有を可能にし、統一された運用保守標準を確立すること。
標準
-
各テンプレートの目的を明確に記述してください。実行する運用保守オペレーションと、それによって達成される目標を説明してください。
-
すべてのアクションに大文字のプレフィックスを使用し、アクション名の最後のセクションにはキャメルケースを使用してください (例：
ACS::ExecuteAPI、ACS::ECS::RunInstances)。 -
一貫したインデントを使用してください。2 つのスペースでインデントし、タブとスペースを混在させないでください。
-
可読性を向上させるために、プロパティを論理的な順序で配置してください。アクションの構文を参考にしてください。
-
テンプレートでは、次のフィールド順序を使用してください：
FormatVersion、Description、Parameters、RamRole、Tasks、Outputs。 -
タスクでは、次のフィールド順序を使用してください：
Name、Action、Description、Properties、Loop、Outputs。 -
ACS::ExecuteAPIアクションのプロパティでは、次の順序を使用してください：Service、API、Parameters。
-
-
ACS::ExecuteAPIアクションでは、サービス名に大文字を使用してください (例：ECS、RDS)。 -
PropertySelectorやValueSelectorなどの JQ セレクターは、ドット (.) で始めないでください。システムはドットで始まるセレクターと互換性がありますが、ドットがない方が構文がより簡潔になります。パラメーター、タスク、出力の名前には、InstanceIdやCreateInstanceのようにキャメルケースを使用してください。