Ansible 極簡教程
一、基本部署
安裝Ansible
# yum -y install epel-release
# yum list all *ansible*
# yum info ansible
# yum -y install ansible
Ansible配置檔案
/etc/ansible/ansible.cfg 主配置檔案
/etc/ansible/hosts Inventory
/usr/bin/ansible-doc 幫助檔案
/usr/bin/ansible-playbook 指定執行任務檔案
定義Inventory
# cd /etc/ansible/ # cp hosts{,.bak} # > hosts # cat hosts [webserver] 127.0.0.1 192.168.10.149 [dbserver] 192.168.10.113
使用祕鑰方式連線
# ssh-keygen -t rsa
# ssh-copy-id -i /root/.ssh/id_rsa.pub [email protected]
# ssh-copy-id -i /root/.ssh/id_rsa.pub [email protected]
# ssh-copy-id -i /root/.ssh/id_rsa.pub [email protected]
使用幫助
# ansible-doc -l 列出ansible所有的模組 # ansible-doc -s MODULE_NAME 檢視指定模組具體適用
Ansible命令應用基礎
語法：ansible <host-pattern> [-f forks] [-m module_name] [-a args] <host-pattern> 這次命令對哪些主機生效的 inventory group name ip all -f forks 一次處理多少個主機 -m module_name 要使用的模組 -a args 模組特有的引數 # ansible 192.168.10.113 -m command -a 'date' # ansible webserver -m command -a 'date' # ansible all -m command -a 'date'
二、常見模組
command 命令模組(預設模組)用於在遠端主機執行命令；不能使用變數，管道等
# ansible all -a 'date'
cron 計劃任務
month 指定月份
minute 指定分鐘
job 指定任務
day 表示那一天
hour 指定小時
weekday 表示周幾
state 表示是新增還是刪除
present：安裝
absent：移除
# ansible webserver -m cron -a 'minute="*/10" job="/bin/echo hello" name="test cron job"' #不寫預設都是*，每個任務都必須有一個名字
# ansible webserver -a 'crontab -l'
# ansible webserver -m cron -a 'minute="*/10" job="/bin/echo hello" name="test cron job" state=absent' #移除任務
user 使用者賬號管理
name 使用者名稱
uid uid
state 狀態
group 屬於哪個組
groups 附加組
home 家目錄
createhome 是否建立家目錄
comment 註釋資訊
system 是否是系統使用者
# ansible all -m user -a 'name="user1"'
# ansible all -m user -a 'name="user1" state=absent'
group 組管理
gid gid
name 組名
state 狀態
system 是否是系統組
# ansible webserver -m group -a 'name=mysql gid=306 system=yes'
# ansible webserver -m user -a 'name=mysql uid=306 system=yes group=mysql'
copy 複製檔案(複製本地檔案到遠端主機的指定位置)
src 定義本地原始檔路徑
dest 定義遠端目錄檔案路徑(絕對路徑)
owner 屬主
group 屬組
mode 許可權
content 取代src=,表示直接用此處的資訊生成為檔案內容
# yum -y install libselinux-python
# ansible all -m copy -a 'src=/etc/fstab dest=/tmp/fstab.ansible owner=root mode=640'
# ansible all -m copy -a 'content="hello ansible\nHi ansible" dest=/tmp/test.ansible'
file 設定檔案的屬性
path|dest|name 對那個檔案做設定
建立檔案的符號連結：
src： 指定原始檔
path： 指明符號連結檔案路徑
# ansible all -m file -a 'owner=mysql group=mysql mode=644 path=/tmp/fstab.ansible'
# ansible all -m file -a 'path=/tmp/fstab.link src=/tmp/fstab.ansible state=link'
ping 測試指定主機是否能連線
# ansible all -m ping
service 管理服務執行狀態
enabled 是否開機自動啟動
name 指定服務名
state 指定服務狀態
started 啟動服務
stoped 停止服務
restarted 重啟服務
arguments 服務的引數
# ansible webserver -m service -a 'enabled=true name=httpd state=started'
shell 在遠端主機上執行命令
尤其是用到管道變數等功能的複雜命令
# ansible all -m shell -a 'echo magedu | passwd --stdin user1'
script 將本地指令碼複製到遠端主機並執行之
# ansible all -m script -a '/tmp/test.sh'
yum 安裝程式包
name 程式包名稱(不指定版本就安裝最新的版本latest)
state present,latest表示安裝，absent表示解除安裝
# ansible webserver -m yum -a 'name=httpd'
# ansible all -m yum -a 'name=ntpdate' #預設就是安裝
# ansible all -m yum -a 'name=ntpdate state=absent'
setup 收集遠端主機的facts
每個被管理節點在接受並執行管理命令之前，會將自己主機相關資訊，如作業系統版本，IP地址等報告給遠端的ansible主機
# ansible all -m setup
三、Ansible playbook
組成結構：
inventory #以下操作應用的主機
modules #呼叫哪些模組做什麼樣的操作
ad hoc commands #在這些主機上執行哪些命令
playbooks
tasks #任務,即呼叫模組完成的某操作
variable #變數
templates #模板
handlers #處理器，由某事件觸發執行的操作
roles #角色
四、YAML
4.1 YAML介紹
YAML是一個可讀性高的用來表達資料序列的格式。YAML參考了其它多種語言，包括：XML、C語言、Python、Perl以及電子郵件格式RFC2822等。ClarkEvans在2001年首次發表了這種語言，另外Ingy dot Net與Oren Ben-Kiki也是這語言的共同設計者。
YAML Ain't Markup Language,即YAML不是XML，不過，在開發這種語言時，YAML的意思其實是："Yet Another Markup Language"(仍是一種標記語言)，其特性：
- YAML的可讀性好
- YAML和指令碼語言的互動性好
- YAML使用實現語言的資料型別
- YAML有一個一致的資訊模型
- YAML易於實現
- YAML可以基於流來處理
- YAML表達能力強，擴充套件性好
4.2 YAML語法
YAML的語法和其他高階語言類似，並且可以簡單表達清單、散列表、標量等資料結構，其結構(structure)通過空格來展示，序列(sequence)裡的項用"-"來表示，Map裡面的鍵值對用":"分割，下面是一個示例。
name: john smith
age: 41
gender: male
spouse:
name:jane smith
age:37
gender: female
children:
- name:jimmy smith
age:17
gender: male
- name:jenny smith
age: 13
gender: female
YAML副檔名通常為.yaml，如example.yaml
4.2.1 list
列表的所有元素均使用"-"打頭，例如：
# A list of testy fruits
- Apple
- Orange
- Strawberry
- Mango
4.2.2 dictionary
字典通過key與value進行標識，例如：
---
# An employee record
name: Example Developer
job: Developer
skill: Elite
也可以將key:value放置於{}中進行表示，例如：
---
#An exmloyee record
{name: Example Developer, job: Developer, skill: Elite}
五、Ansible基礎元素
5.1 變數
5.1.1 變數命名
變數名僅能由字母、數字和下劃線組成，且只能以字母開頭。
5.1.2 facts
facts是由正在通訊的遠端目標主機發回的資訊，這些資訊被儲存在ansible變數中。要獲取指定的遠端主機所支援的所有facts，可使用如下命令進行：
#ansible hostname -m setup
5.1.3 register
把任務的輸出定義為變數，然後用於其他任務，例項如下：
tasks:
- shell: /usr/bin/foo
register: foo_result
ignore_errors: True
5.1.4 通過命令列傳遞變數
在執行playbook的時候也可以傳遞一些變數供playbook使用，示例如下：
#ansible-playbook test.yml --extra-vars "hosts=www user=mageedu"
5.1.5 通過roles傳遞變數
當給一個主機應用角色的時候可以傳遞變數，然後在角色內使用這些變數，示例如下：
- hosts: webserver
roles:
- common
- {role: foo_app_instance, dir: '/web/htdocs/a.com', port: 8080}
5.2 Inventory
ansible的主要功用在於批量主機操作，為了便捷的使用其中的部分主機，可以在inventory file中將其分組命名，預設的inventory file為/etc/ansible/hosts
inventory file可以有多個，且也可以通過Dynamic Inventory來動態生成。
5.2.1 inventory檔案格式
inventory檔案遵循INI檔案風格，中括號中的字元為組名。可以將同一個主機同時歸併到多個不同的組中；此外，當如若目標主機使用非預設的SSH埠，還可以在主機名稱之後使用冒號加埠號來表明。
ntp.magedu.com
[webserver]
www1.magedu.com:2222
www2.magedu.com
[dbserver]
db1.magedu.com
db2.magedu.com
db3.magedu.com
如果主機名遵循相似的命名模式，還可使用列表的方式標識個主機，例如：
[webserver]
www[01:50].example.com
[databases]
db-[a:f].example.com
5.2.2 主機變數
可以在inventory中定義主機時為其新增主機變數以便於在playbook中使用，例如：
[webserver]
www1.magedu.com http_port=80 maxRequestsPerChild=808
www2.magedu.com http_port=8080 maxRequestsPerChild=909
5.2.3 組變數
組變數是指賦予給指定組內所有主機上的在playbook中可用的變數。例如：
[webserver]
www1.magedu.com
www2.magedu.com
[webserver:vars]
ntp_server=ntp.magedu.com
nfs_server=nfs.magedu.com
5.2.4 組巢狀
inventory中，組還可以包含其它的組，並且也可以向組中的主機指定變數。不過，這些變數只能在ansible-playbook中使用，而ansible不支援。例如：
[apache]
httpd1.magedu.com
httpd2.magedu.com
[nginx]
ngx1.magedu.com
ngx2.magedu.com
[webserver:children] #固定格式
apache
nginx
[webserver:vars]
ntp_server=ntp.magedu.com
5.2.5 inventory引數
ansible基於ssh連線inventory中指定的遠端主機時，還可以通過引數指定其互動方式，這些引數如下所示：
ansible_ssh_host
ansible_ssh_port
ansible_ssh_user
ansible_ssh_pass
ansible_sudo_pass
ansible_connection
ansible_ssh_private_key_file
ansible_shell_type
ansible_python_interpreter
5.3 條件測試
如果需要根據變數、facts或此前任務的執行結果來做為某task執行與否的前提時要用到條件測試。
5.3.1 when語句
在task後新增when字句即可使用條件測試；when語句支援jinja2表示式語句，例如：
tasks:
- name: 'shutdown debian flavored system"
command: /sbin/shutdown -h now
when: ansible_os_family == "Debian"
when語句中還可以使用jinja2的大多"filter",例如果忽略此前某語句的錯誤並基於其結果(failed或success)執行後面指定的語句，可使用類似如下形式；
tasks:
- command:/bin/false
register: result
ignore_errors: True
- command: /bin/something
when: result|failed
- command: /bin/something_else
when: result|success
- command: /bin/still/something_else
when: result|skipped
此外，when語句中還可以使用facts或playbook中定義的變數
# cat cond.yml
- hosts: all
remote_user: root
vars:
- username: user10
tasks:
- name: create {{ username }} user
user: name={{ username }}
when: ansible_fqdn == "node1.exercise.com"
5.4 迭代
當有需要重複性執行的任務時，可以使用迭代機制。其使用格式為將需要迭代的內容定義為item變數引用，並通過with_items語句來指明迭代的元素列表即可。例如：
- name: add server user
user: name={{ item }} state=persent groups=wheel
with_items:
- testuser1
- testuser2
上面語句的功能等同於下面的語句：
- name: add user testuser1
user: name=testuser1 state=present group=wheel
- name: add user testuser2
user: name=testuser2 state=present group=wheel
事實上，with_items中可以使用元素還可為hashes，例如：
- name: add several users
user: name={{ item.name}} state=present groups={{ item.groups }}
with_items:
- { name: 'testuser1', groups: 'wheel'}
- { name: 'testuser2', groups: 'root'}
六、模板示例：
# grep '{{' conf/httpd.conf
MaxClients {{ maxClients }}
Listen {{ httpd_port }}
# cat /etc/ansible/hosts
[webserver]
127.0.0.1 httpd_port=80 maxClients=100
192.168.10.149 httpd_port=8080 maxClients=200
# cat apache.yml
- hosts: webserver
remote_user: root
vars:
- package: httpd
- service: httpd
tasks:
- name: install httpd package
yum: name={{ package }} state=latest
- name: install configuration file for httpd
template: src=/root/conf/httpd.conf dest=/etc/httpd/conf/httpd.conf
notify:
- restart httpd
- name: start httpd service
service: enabled=true name={{ service }} state=started
handlers:
- name: restart httpd
service: name=httpd state=restarted
七、Ansible playbooks
playbook是由一個或多個"play"組成的列表。play的主要功能在於將事先歸併為一組的主機裝扮成事先通過ansible中的task定義好的角色。從根本上來講，所有task無非是呼叫ansible的一個module。將多個play組織在一個playbook中，即可以讓他們連同起來按事先編排的機制同唱一臺大戲。下面是一個簡單示例。
- hosts: webserver
vars:
http_port: 80
max_clients: 256
remote_user: root
tasks:
- name: ensure apache is at the latest version
yum: name=httpd state=latest
- name: ensure apache is running
service: name=httpd state=started
handlers:
- name: restart apache
service: name=httpd state=restarted
7.1 playbook基礎元件
7.1.1 Hosts和Users
playbook中的每一個play的目的都是為了讓某個或某些主機以某個指定的使用者身份執行任務。hosts用於指定要執行指定任務的主機，其可以使一個或多個由冒號分隔主機組；remote_user則用於指定遠端主機的執行任務的使用者，如上面的例項中的
- hosts: webserver
remote_user: root
不過，remote_user也可用於各task中，也可以通過指定其通過sudo的方式在遠端主機上執行任務，其可用於play全域性或其任務；此外，甚至可以在sudo時使用sudo_user指定sudo時切換的使用者。
- hosts: webserver
remote_user: magedu
tasks:
- name: test connection
ping:
remote_user: magedu
sudo: yes
7.1.2 任務列表和action
play的主題部分是task list。task list中的各任務按次序逐個在hosts中指定的所有主機上執行，即在所有主機上完成第一個任務後再開始第二個。在執行自上而下某playbook時，如果中途發生錯誤，所有已執行任務都可能回滾，在更正playbook後重新執行一次即可。
taks的目的是使用指定的引數執行模組，而在模組引數中可以使用變數。模組執行是冪等的。這意味著多次執行是安全的，因為其結果均一致。
每個task都應該有其name，用於playbook的執行結果輸出，建議其內容儘可能清晰地描述任務執行步驟，如果為提供name，則action的結果將用於輸出。
定義task可以使用"action: module options"或”module：options“的格式推薦使用後者以實現向後相容。如果action一行的內容過多，也中使用在行首使用幾個空白字元進行換行。
tasks:
- name:make sure apache is running
service: name=httpd state=started
在眾多的模組中，只有command和shell模組僅需要給定一個列表而無需使用"key=value"格式，例如：
tasks:
- name: disable selinux
command: /sbin/setenforce 0
如果命令或指令碼的退出碼不為零，可以使用如下方式替代：
tasks:
- name: run this command and ignore the result
shell: /usr/bin/somecommand || /bin/true
或者使用ignore_errors來忽略錯誤資訊：
tasks:
- name: run this command and ignore the result
shell: /usr/bin/somecommand
ignore_errors: True
7.1.3handlers
用於當關注的資源發生變化時採取一定的操作。
"notify"這個action可用於在每個play的最後被觸發，這樣可以避免多次有改變發生時每次都執行執行的操作，取而代之，僅在所有的變化發生完成後一次性地執行指定操作，在notify中列出的操作稱為handlers，也即notify中呼叫handlers中定義的操作。
- name: template configuration file
template: src=template.j2 dest=/etc/foo.conf
notify:
- restart memcached
- restart apache
handlers是task列表，這些task與前述的task並沒有本質上的不同。
handlers：
- name: restart memcached
service: name=memcached state=restarted
- name: restart apache
service: name=apache state=restarted
簡單示例1：
# cat nginx.yml
- hosts: webserver
remote_user: root
tasks:
- name: create nginxn group
group: name=nginx system=yes gid=208
- name: create nginx user
user: name=nginx uid=208 group=nginx system=yes
- hosts: dbserver
remote_user: root
tasks:
- name: copy file to dbserver
copy: src=/etc/inittab dest=/tmp/inittab.ans
# ansible-playbook nginx.yml
簡單示例2：
# cat apache.yml
- hosts: webserver
remote_user: root
tasks:
- name: install httpd package
yum: name=httpd state=latest
- name: install configuration file for httpd
copy: src=/root/conf/httpd.conf dest=/etc/httpd/conf/httpd.conf
- name: start httpd service
service: enabled=true name=httpd state=started
# ansible-playbook apache.yml
handlers 示例：
# cat apache.yml
- hosts: webserver
remote_user: root
tasks:
- name: install httpd package
yum: name=httpd state=latest
- name: install configuration file for httpd
copy: src=/root/conf/httpd.conf dest=/etc/httpd/conf/httpd.conf
notify:
- restart httpd
- name: start httpd service
service: enabled=true name=httpd state=started
handlers:
- name: restart httpd
service: name=httpd state=restarted
# ansible-playbook apache.yml
variable 示例1：
# cat apache.yml
- hosts: webserver
remote_user: root
vars:
- package: httpd
- service: httpd
tasks:
- name: install httpd package
yum: name={{ package }} state=latest
- name: install configuration file for httpd
copy: src=/root/conf/httpd.conf dest=/etc/httpd/conf/httpd.conf
notify:
- restart httpd
- name: start httpd service
service: enabled=true name={{ service }} state=started
handlers:
- name: restart httpd
service: name=httpd state=restarted
variable 示例2：(在playbook中可以使用所有的變數)
# cat facts.yml
- hosts: webserver
remote_user: root
tasks:
- name: copy file
copy: content="{{ ansible_all_ipv4_addresses }} " dest=/tmp/vars.ans
八、roles
ansible自1.2版本引入的新特性，用於層次性、結構化地組織playbook。roles能夠根據層次型結構自動轉載變數檔案、tasks以及handlers等。要使用roles只需要在playbook中使用include指令即可。簡單來講，roles就是通過分別將變數、檔案、任務、模板以及處理器放置於單獨的目錄中，並可以便捷地include他們的一種機制。角色一般用於基於主機構建服務的場景中，但也可以使用於構建守護程序的場景中
一個roles的案例如下所示：
site.yml
webserver.yml
fooserver.yml
roles/
common/
files/
templates/
tasks/
handlers/
vars/
meta/
webserver/
files/
templates/
tasks/
handlers/
vars/
meta/
而在playbook中，可以這樣使用roles
- hosts: webserver
roles:
- common
- webserver
也可以向roles傳遞引數，例如：
- hosts: webserver
roles:
- common
- { role: foo_app_instance, dir:'/opt/a',port:5000}
- { role: foo_app_instance, dir:'/opt/b',port:5001}
甚至也可以條件式地使用roles，例如：
- hosts：webserver
roles:
- { role: some_role, when: "ansible_so_family == 'RedHat" }
8.1 建立role的步驟
- 建立以roles命名的目錄：
- 在roles目錄中分別建立以各角色命名的目錄，如webserver等
- 在每個角色命名的目錄中分別建立files、handlers、meta、tasks、templates和vars目錄；用不到的目錄可以建立為空目錄，也可以不建立
- 在playbook檔案中，呼叫各角色
8.2 role內各目錄中可應用的檔案
- task目錄：至少應該包含一個為main.yml的檔案，其定義了此角色的任務列表；此檔案可以使用include包含其它的位於此目錄中的task檔案；
- file目錄：存放由copy或script等模板塊呼叫的檔案；
- template目錄：template模組會自動在此目錄中尋找jinja2模板檔案；
- handlers目錄：此目錄中應當包含一個main.yml檔案，用於定義此角色用到的各handlers，在handler中使用inclnude包含的其它的handlers檔案也應該位於此目錄中；
- vars目錄：應當包含一個main.yml檔案，用於定義此角色用到的變數
- meta目錄：應當包含一個main.yml檔案，用於定義此角色的特殊設定及其依賴關係；ansible1.3及其以後的版本才支援；
- default目錄：應當包含一個main.yml檔案,用於為當前角色設定預設變數時使用此目錄；
# mkdir -pv ansible_playbooks/roles/{webserver,dbserver}/{tasks,files,templates,meta,handlers,vars}
# cp /etc/httpd/conf/httpd.conf files/
# pwd
/root/ansible_playbooks/roles/webserver
# cat tasks/main.yml
- name: install httpd package
yum: name=httpd state=present
- name: install configuretion file
copy: src=httpd.conf dest=/etc/httpd/conf/httpd.conf
tags:
- conf
notify:
- restart httpd
- name: start httpd
service: name=httpd state=started
# cat handlers/main.yml
- name: restart httpd
service: name=httpd state=restarted
# pwd;ls
/root/ansible_playbooks
roles site.yml
# cat site.yml
- hosts: webserver
remote_user: root
roles:
- webserver
# ansible-playbook site.yml
九、Tags
tags用於讓使用者選擇執行或跳過playbook中的部分程式碼。ansible具有冪等性，因此會自動跳過沒有變化的部分，即便如此，有些程式碼為測試其確實沒有發生變化的時間依然會非常的長。此時，如果確信其沒有變化，就可以通過tags跳過此些程式碼片段。
tags：在playbook可以為某個或某些任務定義一個"標籤"，在執行此playbook時，通過為ansible-playbook命令使用--tags選項能耐實現僅執行指定的tasks而非所有的；
# cat apache.yml
- hosts: webserver
remote_user: root
vars:
- package: httpd
- service: httpd
tasks:
- name: install httpd package
yum: name={{ package }} state=latest
- name: install configuration file for httpd
template: src=/root/conf/httpd.conf dest=/etc/httpd/conf/httpd.conf
tags:
- conf
notify:
- restart httpd
- name: start httpd service
service: enabled=true name={{ service }} state=started
handlers:
- name: restart httpd
service: name=httpd state=restarted
# ansible-playbook apache.yml --tags='conf'
特殊tags：always #無論如何都會執行