閱讀(22k) 書簽贊(0) 我要糾錯(cuò)

Ansible 的開發(fā)工具

2018-07-25 10:42 更新

在開始撰寫 Ansible Playbooks 前，讓凍仁先來介紹平日會用到的開發(fā)工具和相關(guān)技巧。

凍仁在「Ansible 如何操作」一文時(shí)早有提到 Playbooks 其實(shí)是使用 YAML 的語法在撰寫，雖說我們只要有純文字編輯器就可以進(jìn)行開發(fā)，但凍仁還是會借由些自動(dòng)補(bǔ)齊 (Auto-complete)、縮排提示、語法 (Syntax) 高亮 (Highlighting) 和檢查 (Check) 等擴(kuò)充套件工具來補(bǔ)助。

純文字編輯器 (Text Editor)

Vim

Vim 是凍仁多年來主要使用的文字編輯器，不管是編寫程式、文件還是設(shè)定檔都是一套打天下，而現(xiàn)在也用它來開發(fā) Playbooks。凍仁自己除了會在 Terminal 使用 Vim 之外，還會額外安裝 GVim (GNU/Linux, Windows) 和 MacVim (macOS) 來使用 Vim。

▲ 以上為使用 MacVim 撰寫 Playbooks 的 demo，其 colorscheme 為 Tomorrow Night Eighties。

ag.vim：在 Vim 里跑 ag 的套件。
ansible-vim：支持 Ansible 檔案 syntax highlighting 的套件。
ctrlp.vim：模糊搜尋檔案的套件。
dash.vim：讓 Vim 整合使用 Dash.app 的套件，但只支持 macOS。
EnhCommentify.vim：可快速對多行注解和反注解的套件。
indentLine：使用垂直線顯示縮排提示的套件。
neobundle.vim：Vim 的套件管理員，可參考凍仁 3 年前寫過的「12. Vim 套件管理 - NeoBundle | 完全用 GNU/Linux 工作」一文。
nerdtree：在 Vim 里使用分割視窗開啟檔案管理員的套件。
syntastic：支持多種語言的程式碼檢查套件，可另外用 pip 安裝 ansible-lint 來檢查 syntax 和 style。
vim-gitgutter：在 Vim 里觀看 git diff 還有新增修改等狀態(tài)的套件。
Vim-Jinja2-Syntax：支持 Jinja2 檔案語法高亮的套件。
YouCompleteMe：自動(dòng)補(bǔ)齊文字的套件。
zeavim.vim：讓 Vim 整合使用 Zeal 的套件。

Syntastic

要讓 Syntastic 可以完整支持 Ansible，我們還需安裝 ansible-vim 和 ansible-lint 才行。

使用 pip 安裝 ansible-lint。
```
$ sudo pip install ansible-lint
```

使用 NeoBundle 安裝 Syntastic 和 ansible-vim，并調(diào)整設(shè)定。

$ vi ~/.vimrc
...
" ansible-vim
NeoBundle 'pearofducks/ansible-vim'

" Syntastic
NeoBundle 'scrooloose/syntastic'
let g:syntastic_enable_highlighting = 1
let g:syntastic_always_populate_loc_list = 1
let g:syntastic_auto_loc_list = 1
let g:syntastic_check_on_open = 1
let g:syntastic_check_on_wq = 0

set statusline+=%#warningmsg#
set statusline+=%{SyntasticStatuslineFlag()}
set statusline+=%*

" ignore files of Ansible Roles.
let g:syntastic_ignore_files = ['\m^roles/']

Syntastic 的細(xì)部設(shè)定可從 GitHub 上找到，特別要提一下的是上面多了停止檢查 roles/ 目錄的設(shè)定，在凍仁的習(xí)慣里 Roles 大多會另外維護(hù)，這部份在再往后的章節(jié)才會多加說明。
如只想用 Syntastic 來檢查語法錯(cuò)誤 (syntax error) 而不想檢查 style 的話，可把 style 的部份關(guān)掉。
```
let g:syntastic_quiet_messages = { "type": "style" }
```

MacDown

MacDown 是 macOS 上 open source 的 Markdown 文字編輯器，凍仁會在撰寫 README.md 時(shí)會用到，但近來發(fā)現(xiàn) Livedown 這個(gè)工具后，就比較常用 Vim 在寫 Markdown 文件了。

題外話，凍仁連現(xiàn)在這篇文章都是用 Vim + Livedown 在寫的呢！

Atom

Atom 是 GitHub 釋出的 open source 文字編輯器，業(yè)界也有不少使用者，凍仁雖不常使用，但它的自動(dòng)補(bǔ)齊功能非常之強(qiáng)大，若本身沒有在使用 Vim，不妨可以用它來開發(fā) Playbooks。

▲ 以上為使用 Atom 撰寫 Playbooks 的 demo，其 UI Theme 為 One Dark，而 Syntax Theme 為 Tomorrow Night Eighties。

ansible-snippets：Snippets for Ansible.
autocomplete-ansible：Ansible 自動(dòng)補(bǔ)齊的套件。
Linter-Ansible-Linting：檢查 Ansible 語法的套件，需手動(dòng)使用 pip 安裝 ansible-lint。
dash：讓 Atom 整合使用 Dash.app 的套件，但只支持 macOS。

Terminal (終端機(jī))

在 GNU/Linux 和 macOS 上都已內(nèi)建 terminal，但凍仁較慣用以下三個(gè) terminal emulator。

iTerm2：macOS 上的 Terminal 不二選擇，為了要相容 Terminator 的習(xí)慣，凍仁還下了不少功夫調(diào)整。
Terminator：GNU/Linux 上支持畫面分割的 Terminator，是個(gè)比 Gnome Terminal 順手的工具。
rxvt-unicode：GNU/Linux 上極輕量的 Terminal。

虛擬環(huán)境 (Virtual Environment)

Docker：凍仁曾在「Ansible 用 Docker 練習(xí) Ansible」一章提過，在此就不多加說明了。
Vagrant：凍仁主要開發(fā) Playbook 的環(huán)境，曾在「Ansible 用Vagrant練習(xí)Ansible」一章提起過。

API 文件瀏覽器 (API Documentation Browser)

Ansible 是 2012 才開始的專案，可 Module 的總數(shù)已經(jīng)高達(dá) 836 之多，雖說各個(gè) Module 的使用文件在官網(wǎng)上都查的到，但凍仁還是習(xí)慣在本機(jī)存一份離線版以備不時(shí)之需。

Dash：macOS 上查詢、自動(dòng)更新 API 文件的工具，其 license 為 US$ 24.99。
Zeal：open source 版的 Dash，支持 GNU/Linux 和 Windows。
DevDocs：網(wǎng)頁版的 Zeal。
LovelyDocs：Android 上類似 Dash 的離線 API 文件瀏覽器。 ¹

其它

Alfred 3：macOS 上的快捷搜神兵，在此凍仁拿它整合 Dash 以快速搜尋 Ansible 文件。
Git：版本控制系統(tǒng) (Version Control System)，用來紀(jì)錄、追蹤 playbooks 版本的工具，這對 Infrastructure as Code 而言是必不可缺的。