Ansible - basics of ansible-playbook

December 29, 2017 (Last Modified: April 01, 2018)

Page content

`play`

The goal of a play is to map a group of hosts to some well defined roles, represented by things ansible calls tasks. At a basic level, a task is nothing more than a call to an ansible module

play는 명령을 수행할 대상과 수행할 명령을 모두 포함하고 있다.

`playbook`

playbook은 하나 혹은 이상의 play들의 집합으로 정의한다.

Conventional template of playbook

---
- hosts: XXX
  optoins....
  
  tasks:
  -name: YYY
   MODULE_NAME : MODULE_ARGS
  -name : ZZZ
   MODULE_NAME: MODULE_ARGS
  ...

하나의 play는 “하나 혹은 이상의 목적지 그룹에 대해 수행되는 task들의 매핑”으로 정의된다. 즉 하나의 hosts 와 해당 hosts에서 수행할 tasks들 간의 매핑을 하나의 play로 정의한다. hosts 에는 접속 및 로그인에 관련된 옵션 들이 추가될 수 있다.

remote_user : ssh 로그인 시 계정
become : sudo 사용 여부
vars: 변수들… FIXME

tasks에는 { name, MODULE_NAME}의 조합으로 순차적으로 수행할 명령어들이 기술된다.

(FIXME 자주 사용되는 명령어 추가)

examples playbook

---
- 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 (and enable it at boot)
    service: name=httpd state=started enabled=yes
  handlers:
    - name: restart apache
      service: name=httpd state=restarted

key=value 형태의 명령은 다음과 같이 multi-line으로도 표현 가능

  - name: write the apache config file
    template: 
      src: /srv/httpd.j2 
      dest: /etc/httpd.conf
    notify:
    - restart apache

examples playbook - multiple plays

---
- hosts: webservers
  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

- hosts: databases
  remote_user: root

  tasks:
  - name: ensure postgresql is at the latest version
    yum: name=postgresql state=latest
  - name: ensure that postgresql is started
    service: name=postgresql state=started

Execute task with root permission

ssh 로그인 후 login 계정이 아닌 다른 계정으로 명령을 수행하는 경우 task에 become 옵션을 준다. (FIXME 모든 task에 대해 동일하게 옵션을 지정하려면???)

tasks:
  -name: update APT package w/o upgrade
   become: yes
   apt: update_cache=yes
  -name: upgrade to the latest package
   become: yes
   apt: upgrade=dist
Or
   apt: name=“*” state=latest

위와 같이 become만 지정한 경우 기본적으로 root 권한으로 실행한다는 의미이다. 만일 root가 아닌 다른 계정으로 실행하고 싶은 경우 become_user: XXX와 같이 해당 계정을 지정한다.

그리고 ansible-playbook 실행 시 -K 혹은 --ask-become-pass 을 지정한다.

ansible-playbook test.yaml -K

Useful ansible play

apt

-name : install neovim
 apt:  
   name: neovim
   force: yes
   state: present

-name : uninstall neovim
 apt:  
   name: neovim
   force: yes
   state: absent

play

playbook