Ansible語法最佳實踐，YAML詞典（key：value）或等號（key = value）？

Question

我已經習慣了看到Ansible例子爲：

- file: path=/tmp/file state=touch 

但有人在工作人員告訴我，我應該只使用YAML語法，這樣是一致的：

- file: 
    path: /tmp/file 
    state: touch 

，或者

- file: {path: /tmp/file, state:touch} 

哪一個滿足Ansible最佳實踐？

Answer 1

從https://www.ansible.com/blog/ansible-best-practices-essentials

兩者在其核心，所述Ansible劇本轉輪是YAML解析器具有添加邏輯，諸如命令行鍵值對簡寫。雖然在啓動快速手冊或文檔示例時很方便，但這種格式化會降低可讀性。我們建議您避免使用該速記（即使使用YAML摺疊樣式）作爲最佳做法。

下面是使用的key = value速記的一些任務的例子：使用本地YAML語法相同的任務

- name: install telegraf 
    yum: 
    name: telegraf-{{ telegraf_version }} state=present update_cache=yes disable_gpg_check=yes enablerepo=telegraf 
    notify: restart telegraf 

- name: configure telegraf 
    template: src=telegraf.conf.j2 dest=/etc/telegraf/telegraf.conf 
    notify: restart telegraf 

- name: start telegraf 
    service: name=telegraf state=started enabled=yes 

現在的位置：

- name: install telegraf 
    yum: telegraf-{{ telegraf_version }} 
    state: present 
    update_cache: yes 
    disable_gpg_check: yes 
    enablerepo: telegraf 
    notify: restart telegraf 

- name: configure telegraf 
    template: 
    src: telegraf.conf.j2 
    dest: /etc/telegraf/telegraf.conf 
    notify: restart telegraf 

- name: start telegraf 
    service: 
    name: telegraf 
    state: started 
    enabled: yes 

本地YAML有更多線條;但是，這些線條較短，減少了水平滾動和線條纏繞。它可以讓眼睛直接沿着遊戲進行掃描。任務參數被堆疊並且容易與下一個區分。原生YAML語法在幾乎所有現代文本編輯器中都具有改進的語法高亮顯示功能。作爲本地YAML，vim和Atom等編輯會從它們的值中突出顯示YAML鍵（模塊名稱，指令，參數名稱），進一步幫助您提高內容的可讀性。我們許多自己的文檔使用這個速記，因爲遺留原因，儘管我們正在逐步改變這種速記。 （接受文件請求）