全部產品
Search
文件中心

CloudOps Orchestration Service:模板編寫規範

更新時間:Jun 30, 2024

OOS實現了營運即代碼(Operations as Code或簡稱Ops as Code)的營運理念。模板(Template)即是OOS產品內Code的具體形式。像優秀的代碼需要遵守規範一樣,優秀的模板也需要遵守相應的規範。特此建立了模板的編寫規範供您參考。此規範同樣適用於阿里雲提供的所有公用模板。

編寫目的

  • 易於閱讀和理解模板的用途。

  • 方便後續的模板維護。

  • 方便在組織內分享,建立統一的營運規範。

規範內容

  1. 所有的模板(Template),都要寫清楚其目的,包括了什麼的營運操作,以達到什麼目的。

  2. 所有的動作,首碼都大寫,最後一節適用駝峰式。如ACS::ExecuteAPI或ACS::ECS::RunInstances。

  3. 縮排,要統一,建議用2個空格縮排,不允許有Tab和空格混排。

  4. 屬性的順序和符合正常的讀取順序。可以參考動作的文法順序。 

    1. 模板(Template)的欄位順序推薦為:FormatVersion,Description,Parameters,RamRole,Tasks,Outputs。

    2. 任務(Task)的欄位順序推薦為:Name,Action,Description,Properties,Loop,Outputs。

    3. 動作ACS::ExecuteAPI的Properties順序推薦如下:Service,API,Parameters。

  5. ACS::ExecuteAPI裡面的Service推薦用大寫,如ECS,RDS等。

  6. JQ selector,(如PropertySelector,ValueSelector)裡面不要以點(.)開頭。雖然系統相容有點和沒點的兩種情況,但是沒點看起來更優美一些。Parameter Name,Task Name,Output Name建議使用駝峰式命名,例如 InstanceId,CreateInstance。