Operation Orchestration Service (OOS) は、Operations as Code (Ops as Code) の O&M コンセプトを採用しています。テンプレートは、OOS におけるコードの具体的な形式です。コードと同様に、テンプレートは関連する標準に準拠する必要があります。このトピックでは、参考のためにテンプレートのコーディング標準について説明します。この標準は、Alibaba Cloud が提供するすべてのパブリック テンプレートにも適用されます。
目的
- テンプレートを読みやすくし、テンプレートの使用方法を理解しやすくします。
- 後続のテンプレート メンテナンスを容易にします。
- O&M テンプレートの統一されたコーディング標準を確立し、組織内で標準を共有します。
コーディング標準
- すべてのテンプレートの目的と O&M 操作を定義します。
- 操作名については、プレフィックスを大文字にし、最後のセクションにはキャメルケースを使用します。たとえば、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 などの jQuery セレクタがピリオド (.) で始まっていないことを確認します。システムは、ピリオド (.) で始まる形式とピリオド (.) なしで始まる形式の両方をサポートしています。ただし、ピリオド (.) なしで始まる形式の方が洗練されています。
- パラメータ、タスク、および出力パラメータの名前には、InstanceId や CreateInstance など、キャメルケースを使用することをお勧めします。