[Ansible] Playbook 작성
지금까지는 커맨드라인으로 ansible 명령어를 통해 핑때리기, 호스트에 작업하기 등을 해보았는데,
이런 방식을 Ad-hoc 방식이라고 한다.
하지만, 실제로 명령어가 실어지면 Ad-hoc 방식으로는 한계가 있다.
Ansible은 Ad-hoc 방식과 Playbook 방식으로 호스트를 제어할 수 있는데,
실제로 대부분의 작업은 Playbook을 통해 진행된다. Playbook은 쉽게말해 Ad-hoc 커맨드들을 나열해 놓은 것이라고 생각하면 된다.
playbook은 YAML 형태의 파일인데, yaml 파일 작성법은 매우 쉽게 배울 수 있으니 혹시 yaml 을 모른다면 잠깐 학습하고 오자!
playbook 작성 시에는 어떤 값이 key: value이고, 어떤 값이 리스트(-)로 되어야 하는지만 잘 구분하도록 하자.
playbook.yaml (sample)
---
- hosts: webservers
vars:
http_port: 80
max_clients: 200
remote_user: root
tasks:
- name: ensure apache is at the latest version
yum:
name: httpd
state: latest
- name: write the apache config file
template:
src: /srv/httpd.j2
dest: /etc/httpd.conf
notify:
- restart apache
- name: ensure apache is running
service:
name: httpd
state: started
handlers:
- name: restart apache
service:
name: httpd
state: restarted
이제, Playbook을 통해 호스트를 제어하는 방법을 알아보자.
1. Playbook 작성하기.
플레이북 파일의 위치는 크게 상관없다. 플레이북 파일의 위치보다는, 인벤토리/변수 파일이 제 위치(ansible.cfg 의 상대경로)에 있는 것이 더 중요하다.
playbook_ex.yaml
---
- name: Deploy Apache Httpd Webserver
hosts: host1
become: yes
tasks:
- name: Install httpd
yum:
name: ""
state: present
vars:
packages:
- httpd
- name: Copy httpd.conf
copy:
src: /home/vagrant/httpd.conf
dest: /etc/httpd/conf/httpd.conf
- name: Start httpd as a systemctl service
service:
name: httpd
state: started
- name: Open firewalld
firewalld:
service: httpd
permanent: yes
state: enabled
- name: Deploy Apache Httpd Webserver
hosts: host1
become: yes
tasks:
- name: Install httpd
yum:
name: ""
state: present
위와같이 playbook은 여러 play들로 구성되어있고, 각 play는 hosts, task 등의 요소들로 구성되어있다.
하나의 playbook에 여러 play를 둘 수도 있고, play마다 playbook을 따로 만들 수도 있다.
2. Playbook 실행하기.
기본적으로 ansible-playbook [플레이북 파일명]로 플레이북을 실행할 수 있다.
[vagrant@controller tmp]$ ansible-playbook ping.yaml
PLAY [mgmt] ***************************************************************************
TASK [Gathering Facts] ****************************************************************
ok: [host2]
ok: [host1]
TASK [ping] ***************************************************************************
ok: [host1]
ok: [host2]
PLAY RECAP ****************************************************************************
host1 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
host2 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
플레이북의 문법확인이 필요한 경우 ansible-playbook [플레이북 파일명] --syntax-check로 문법체크를 수시로 하자.
[vagrant@controller tmp]$ ansible-playbook ping.yaml --syntax-check
ERROR! Syntax Error while loading YAML.
did not find expected '-' indicator
The error appears to be in '/tmp/ping.yaml': line 3, column 3, but may
be elsewhere in the file depending on the exact syntax problem.
The offending line appears to be:
- hosts: mgmt
tasks: # module name
^ here
3. playbook을 수정한 경우
playbook을 작성하다 보면 설정이 변경되어 서비스를 재시작해야하는 경우가 있다.
예를 들어 httpd의 port가 80->8080으로 변경된 경우 service는 재시작해야되지만,
playbook에는 state: started로 설정되어있으므로 playbook을 실행하면 재시작되지 않는다.
그렇다고 state: restarted로 바꾸기에는 매번 수정할 수도 없는 노릇이다.
Ansible은 Handler라는 모듈을 통해 이러한 재시작 작업을 지원한다.
Handler는 플레이북 작업 이후 변경사항이 발생한 경우 특정 작업을 한 번만 하는 트리거와 같은 역할을 한다.
주의할 점은 handler는 모든 task가 끝난 이후에 일괄적으로 실행된다는 것이다.
또한, handler 중 task에 의해 notify 받은 handler들이 playbook에 나열된 순차적으로 실행된다.
---
- name: Deploy Apache Httpd Webserver
hosts: host1
become: yes
tasks:
- name: Install httpd
...
- name: Copy httpd.conf
copy:
src: /home/vagrant/httpd.conf
dest: /etc/httpd/conf/httpd.conf
notify:
- "Restarting Web Service"
- name: Start httpd as a systemctl service
...
handlers:
- name: Restarting Web Service
service:
name: httpd
state: restarted
4. Variable
재사용성을 높이려면 값들을 변수처리 하는 것이 좋다. 하드코딩은 당연 지양하자.
변수는 아래와같이 playbook 내에서 vars: [key: value] 와 같이 사용될 수 있다.
또한 을 통해 플레이 내에서 변수를 참조해올 수도 있다.
*template 부분은 추후에 따로 다룰 예정이다.
---
- hosts: control
vars:
message: hello world
tasks:
- debug:
var: message
- debug:
msg: "Define Message was !!!"
변수는 그룹으로 구성해서 사용할 수도 있다. 그런 경우에는 아래와같이 [상위그룹].[하위그룹].~.[변수명] 으로 사용할 수 있다.
---
- hosts: control
vars:
http:
port: 80
name: httpd
db:
svc: mysql
port: 3306
tasks:
- debug:
var: db.svc.name
- debug:
var: db.port
5. Fact
플레이북을 작성하다보면, 원격 시스템마다 달라지는 변수를 설정할 필요가 있다.
이 때 Fact변수를 사용하면 된다.
ansible-playbook 명령어를 통해 플레이북을 실행했을 때에 최상단 작업으로 내가 지정한 task 가 아닌
[vagrant@controller ~]$ ansible-playbook jinja.yml
PLAY [control] ************************************************************************
TASK [Gathering Facts] ****************************************************************
ok: [controller]
위와 같이 TASK [Gathering Facts]를 본 적이 있을것이다.
이는 앤서블 플레이북이 시작될 때 가장 초기에 되는 Setup 작업으로, 여기서 미리 fact 변수가 설정되고 이를 playbook에서 활용할 수 있다.
현재 설정된 fact 변수는 ansible [host명] -m setup 명령어로 확인할 수 있다.
[vagrant@controller ~]$ ansible control -m setup
controller | SUCCESS => {
"ansible_facts": {
"ansible_all_ipv4_addresses": [
"192.168.56.100",
"10.0.2.15"
],
"ansible_all_ipv6_addresses": [
"fe80::a00:27ff:fe08:830d",
"fe80::5054:ff:fe8a:fee6"
],
"ansible_apparmor": {
"status": "disabled"
},
...
playbook 내에서는 , 등과 같이 사용할 수 있다.
참고로, playbook 내에서 fact변수를 사용하지 않을 때도 있는데, 팩트변수 수집은 노드가 많아지면 매우 오래걸리는 작업이므로 필요없다면 수집하지 않도록 할 수도 있다.
fact 관련 설정을 변경하려면 Ansible 설정파일(ansible.cfg)에서 변경할 수 있다.
변수가 많아지면 아래와 같이 playbook에는 변수가 선언된 파일을 참조하고, 변수는 vars_file: 를 통해 밖으로 따로 빼도록 하자.
- hosts: control
vars_files:
- vars/sample.yml
tasks:
- debug:
var: message['txt']