Ansible 치트 시트

설치 및 설정 (Installation & Setup)

Ubuntu/Debian: apt install ansible

Debian 기반 Linux 시스템에 Ansible 을 설치합니다.

# Ansible 리포지토리 추가
sudo apt-add-repository ppa:ansible/ansible
# 패키지 목록 업데이트
sudo apt-get update
# Ansible 설치
sudo apt-get install ansible
# 설치 확인
ansible --version

CentOS/RHEL: yum install ansible

Red Hat 기반 시스템에 Ansible 을 설치합니다.

# EPEL 리포지토리 설치
sudo yum install epel-release -y
# Ansible 설치
sudo yum install ansible -y
# 설치 확인
ansible --version

macOS: brew install ansible

Homebrew 를 사용하여 macOS 에 Ansible 을 설치합니다.

# Homebrew를 사용하여 설치
brew install ansible
# 설치 확인
ansible --version

구성: /etc/ansible/ansible.cfg

Ansible 설정 및 기본값을 구성합니다.

# 현재 구성 보기
ansible-config list
# 적용되는 구성 보기
ansible-config view
# 사용자 지정 구성 파일
export ANSIBLE_CONFIG=/path/to/ansible.cfg

SSH 설정: 키 기반 인증

Ansible 은 노드 간 통신을 위해 SSH 를 사용합니다.

# SSH 키 생성
ssh-keygen -t rsa -b 4096
# 공개 키를 원격 호스트에 복사
ssh-copy-id user@hostname
# SSH 연결 테스트
ssh user@hostname

환경 설정

Ansible 환경 변수 및 경로를 설정합니다.

# 인벤토리 파일 위치 설정
export ANSIBLE_INVENTORY=/path/to/inventory
# 호스트 키 확인 설정
export ANSIBLE_HOST_KEY_CHECKING=False
# 원격 사용자 설정
export ANSIBLE_REMOTE_USER=ubuntu

인벤토리 관리 (Inventory Management)

기본 인벤토리: /etc/ansible/hosts

그룹 이름은 대괄호 안에 그룹 이름을 지정하여 생성할 수 있습니다.

# 기본 호스트 파일 (INI 형식)
[webservers]
web1.example.com
web2.example.com
[databases]
db1.example.com
db2.example.com
[all:vars]
ansible_user=ubuntu
ansible_ssh_private_key_file=~/.ssh/id_rsa

YAML 인벤토리 형식

인벤토리 파일은 INI 또는 YAML 형식일 수 있습니다.

# inventory.yml
all:
  children:
    webservers:
      hosts:
        web1.example.com:
        web2.example.com:
    databases:
      hosts:
        db1.example.com:
      vars:
        mysql_port: 3306

호스트 변수 및 그룹

호스트별 변수 및 그룹 구성을 정의합니다.

# 변수가 포함된 인벤토리
[webservers]
web1.example.com http_port=80
web2.example.com http_port=8080
[webservers:vars]
ansible_user=nginx
nginx_version=1.18

# 인벤토리 테스트
ansible-inventory --list
ansible-inventory --graph

임시 명령어 (Ad-Hoc Commands)

기본 명령어 구조

Ansible 명령어의 기본 구조: ansible <호스트> -m <모듈> -a "<인수>"

# 연결 테스트
ansible all -m ping
# 특정 그룹 확인
ansible webservers -m ping
# 모든 호스트에서 명령어 실행
ansible all -m command -a "uptime"
# sudo 권한으로 실행
ansible all -m command -a "systemctl status nginx" --become

파일 작업 (File Operations)

호스트에서 디렉터리, 파일 및 심볼릭 링크를 생성합니다.

# 디렉터리 생성
ansible all -m file -a "path=/tmp/test state=directory mode=0755"
# 파일 생성
ansible all -m file -a "path=/tmp/test.txt state=touch"
# 파일/디렉터리 삭제
ansible all -m file -a "path=/tmp/test state=absent"
# 심볼릭 링크 생성
ansible all -m file -a "src=/etc/nginx dest=/tmp/nginx state=link"

패키지 관리 (Package Management)

다양한 시스템에서 패키지를 설치, 업데이트 및 제거합니다.

# 패키지 설치 (apt)
ansible webservers -m apt -a "name=nginx state=present" --become
# 패키지 설치 (yum)
ansible webservers -m yum -a "name=httpd state=present" --become
# 모든 패키지 업데이트
ansible all -m apt -a "upgrade=dist" --become
# 패키지 제거
ansible all -m apt -a "name=apache2 state=absent" --become

서비스 관리 (Service Management)

시스템 서비스를 시작, 중지 및 관리합니다.

# 서비스 시작
ansible webservers -m service -a "name=nginx state=started" --become
# 서비스 중지
ansible webservers -m service -a "name=apache2 state=stopped" --become
# 서비스 재시작
ansible webservers -m service -a "name=ssh state=restarted" --become
# 부팅 시 서비스 활성화
ansible all -m service -a "name=nginx enabled=yes" --become

플레이북 및 작업 (Playbooks & Tasks)

기본 플레이북 구조

어떤 작업을 실행해야 하며 어떤 호스트에서 실행해야 하는지를 정의하는 YAML 파일입니다.

---
- name: 웹 서버 설정
  hosts: webservers
  become: yes
  vars:
    nginx_port: 80

  tasks:
    - name: nginx 설치
      apt:
        name: nginx
        state: present

    - name: nginx 서비스 시작
      service:
        name: nginx
        state: started
        enabled: yes

플레이북 실행

다양한 옵션과 구성을 사용하여 플레이북을 실행합니다.

# 플레이북 실행
ansible-playbook site.yml
# 특정 인벤토리로 실행
ansible-playbook -i inventory.yml site.yml
# 드라이 런 (체크 모드)
ansible-playbook site.yml --check
# 특정 호스트에서 실행
ansible-playbook site.yml --limit webservers
# 추가 변수로 실행
ansible-playbook site.yml --extra-vars "nginx_port=8080"

작업 옵션 및 조건문

작업에 조건, 루프 및 오류 처리를 추가합니다.

tasks:
  - name: 패키지 설치
    apt:
      name: '{{ item }}'
      state: present
    loop:
      - nginx
      - mysql-server
      - php
    when: ansible_os_family == "Debian"

  - name: 사용자 생성
    user:
      name: webuser
      state: present
    register: user_result

  - name: 사용자 생성 결과 표시
    debug:
      msg: '사용자 생성됨: {{ user_result.changed }}'

핸들러 및 알림 (Handlers & Notifications)

작업에서 알림을 받을 때 실행되는 핸들러를 정의합니다.

tasks:
  - name: nginx 구성 업데이트
    template:
      src: nginx.conf.j2
      dest: /etc/nginx/nginx.conf
    notify: nginx 재시작

handlers:
  - name: nginx 재시작
    service:
      name: nginx
      state: restarted

변수 및 템플릿 (Variables & Templates)

변수 정의

다양한 수준과 범위에서 변수를 정의합니다.

# 플레이북 내에서
vars:
  app_name: myapp
  app_port: 8080

# group_vars/all.yml 내에서
database_host: db.example.com
database_port: 5432

# host_vars/web1.yml 내에서
server_role: frontend
max_connections: 100

# 명령줄 변수
ansible-playbook site.yml -e "env=production"

Jinja2 템플릿

템플릿을 사용하여 동적 구성 파일을 생성합니다.

# 템플릿 파일: nginx.conf.j2
server {
    listen {{ nginx_port }};
    server_name {{ server_name }};

    location / {
        proxy_pass http://{{ backend_host }}:{{ backend_port }};
    }
}

# template 모듈 사용
- name: nginx 구성 배포
  template:
    src: nginx.conf.j2
    dest: /etc/nginx/sites-available/default
  notify: nginx 리로드

팩트 및 시스템 정보 (Facts & System Information)

플레이북에서 시스템 팩트를 수집하고 사용합니다.

# 수동으로 팩트 수집
ansible all -m setup
# 특정 팩트 수집
ansible all -m setup -a "filter=ansible_eth*"

# 플레이북에서 팩트 사용
- name: 시스템 정보 표시
  debug:
    msg: '{{ ansible_hostname }}는 {{ ansible_distribution }}을 (를) 실행 중'

- name: OS 기반 패키지 설치
  apt:
    name: apache2
  when: ansible_os_family == "Debian"

볼트 및 비밀 관리 (Vault & Secrets Management)

Ansible Vault 를 사용하여 민감한 데이터를 암호화합니다.

# 암호화된 파일 생성
ansible-vault create secrets.yml
# 암호화된 파일 편집
ansible-vault edit secrets.yml
# 기존 파일 암호화
ansible-vault encrypt passwords.yml
# 볼트를 사용하여 플레이북 실행
ansible-playbook site.yml --ask-vault-pass
# 볼트 암호 파일 사용
ansible-playbook site.yml --vault-password-file .vault_pass

역할 및 구성 (Roles & Organization)

역할 구조

재사용 가능한 역할로 플레이북을 구성합니다.

# 역할 구조 생성
ansible-galaxy init webserver

# 역할 디렉터리 구조
webserver/
├── tasks/
│   └── main.yml
├── handlers/
│   └── main.yml
├── templates/
├── files/
├── vars/
│   └── main.yml
├── defaults/
│   └── main.yml
└── meta/
    └── main.yml

플레이북에서 역할 사용

플레이북에서 역할에 역할을 적용합니다.

---
- hosts: webservers
  roles:
    - common
    - webserver
    - { role: database, database_type: mysql }

# 또는 include_role 사용
- hosts: webservers
  tasks:
    - include_role:
        name: webserver
      vars:
        nginx_port: 8080

Ansible Galaxy

Ansible Galaxy 에서 커뮤니티 역할을 다운로드하고 관리합니다.

# Galaxy에서 역할 설치
ansible-galaxy install geerlingguy.nginx
# 특정 버전 설치
ansible-galaxy install geerlingguy.nginx,2.8.0
# 요구 사항 파일에서 설치
ansible-galaxy install -r requirements.yml
# 설치된 역할 목록
ansible-galaxy list
# 역할 제거
ansible-galaxy remove geerlingguy.nginx

컬렉션 (Collections)

확장된 기능을 위해 Ansible 컬렉션을 사용합니다.

# 컬렉션 설치
ansible-galaxy collection install community.general

# 플레이북에서 컬렉션 사용
collections:
  - community.general
tasks:
  - name: 패키지 설치
    community.general.snap:
      name: code
      state: present

디버깅 및 문제 해결 (Debugging & Troubleshooting)

작업 디버깅

플레이북 실행을 디버그하고 문제 해결합니다.

# 디버그 작업 추가
- name: 변수 값 표시
  debug:
    var: my_variable
- name: 사용자 지정 메시지 표시
  debug:
    msg: '서버 {{ inventory_hostname }}는 IP {{ ansible_default_ipv4.address }}를 가짐'

# 자세한 실행
ansible-playbook site.yml -v
ansible-playbook site.yml -vvv  # 최대 상세 수준

오류 처리 (Error Handling)

오류를 우아하게 처리합니다.

- name: 실패할 수 있는 작업
  command: /bin/false
  ignore_errors: yes

- name: rescue 를 사용한 작업
  block:
    - command: /bin/false
  rescue:
    - debug:
        msg: '작업 실패, rescue 실행 중'
  always:
    - debug:
        msg: '항상 실행됨'

테스트 및 검증 (Testing & Validation)

플레이북 테스트 및 구성 검증.

# 구문 확인
ansible-playbook site.yml --syntax-check
# 작업 목록 보기
ansible-playbook site.yml --list-tasks
# 호스트 목록 보기
ansible-playbook site.yml --list-hosts
# 단계별 실행
ansible-playbook site.yml --step
# 체크 모드로 테스트
ansible-playbook site.yml --check --diff

성능 및 최적화 (Performance & Optimization)

플레이북 성능 및 실행을 최적화합니다.

# 병렬로 작업 실행
- name: 패키지 설치
  apt:
    name: '{{ packages }}'
  vars:
    packages:
      - nginx
      - mysql-server

# 장기 실행 작업에 async 사용
- name: 장기 실행 작업
  command: /usr/bin/long-task
  async: 300
  poll: 5

모범 사례 및 팁 (Best Practices & Tips)

보안 모범 사례

Ansible 인프라 및 운영을 보호합니다.

# 비밀번호 관리를 위해 Ansible Vault 사용
ansible-vault create group_vars/all/vault.yml
# 호스트 키 확인은 신중하게 비활성화
host_key_checking = False
# 필요한 경우에만 become 사용
become: yes
become_user: root
# 플레이북 범위 제한
ansible-playbook site.yml --limit production

코드 구성

Ansible 프로젝트를 효과적으로 구성합니다.

# 권장 디렉터리 구조
ansible-project/
├── inventories/
│   ├── production/
│   └── staging/
├── group_vars/
├── host_vars/
├── roles/
├── playbooks/
└── ansible.cfg

# 의미 있는 이름과 문서 사용
- name: 설명이 포함된 작업 이름
  # 복잡한 로직에 대한 주석 추가

버전 관리 및 테스트

적절한 버전 관리로 Ansible 코드를 관리합니다.

# 버전 관리를 위해 Git 사용
git init
git add .
git commit -m "초기 Ansible 설정"
# 프로덕션 전에 스테이징에서 테스트
ansible-playbook -i staging site.yml
# 선택적 실행을 위해 태그 사용
ansible-playbook site.yml --tags "nginx,ssl"

구성 및 고급 기능 (Configuration & Advanced Features)

Ansible 구성

구성 옵션으로 Ansible 동작을 사용자 지정합니다.

# ansible.cfg
[defaults]
inventory = ./inventory
remote_user = ansible
host_key_checking = False
timeout = 30
forks = 5

[ssh_connection]
ssh_args = -o ControlMaster=auto -o ControlPersist=60s
pipelining = True

콜백 플러그인 (Callback Plugins)

콜백 플러그인을 사용하여 출력 및 로깅을 향상시킵니다.

# ansible.cfg 에서 콜백 플러그인 활성화
[defaults]
stdout_callback = yaml
callbacks_enabled = profile_tasks, timer

# 사용자 지정 콜백 구성
[callback_profile_tasks]
task_output_limit = 20

필터 및 조회 플러그인 (Filters & Lookups)

데이터 조작을 위해 Jinja2 필터 및 조회 플러그인을 사용합니다.

# 템플릿의 일반적인 필터
{{ variable | default('default_value') }}
{{ list_var | length }}
{{ string_var | upper }}
{{ dict_var | to_nice_yaml }}

# 조회 플러그인
- name: 파일 내용 읽기
  debug:
    msg: "{{ lookup('file', '/etc/hostname') }}"

- name: 환경 변수
  debug:
    msg: "{{ lookup('env', 'HOME') }}"

동적 인벤토리 (Dynamic Inventories)

클라우드 및 컨테이너 환경을 위해 동적 인벤토리를 사용합니다.

# AWS EC2 동적 인벤토리
ansible-playbook -i ec2.py site.yml
# Docker 동적 인벤토리
ansible-playbook -i docker.yml site.yml
# 사용자 지정 인벤토리 스크립트
ansible-playbook -i ./dynamic_inventory.py site.yml

관련 링크 (Relevant Links)

• Linux 치트 시트
• Shell 치트 시트
• DevOps 치트 시트
• Docker 치트 시트
• Kubernetes 치트 시트
• Python 치트 시트