[Ansible plugins] Lookup Plugin 사용 방법

  



Ansible plugins 중 하나인 Lookup plugin에 대해 알아보겠습니다. Lookup plugin은 플레이북 내에서 외부 데이터를 불러오고 이를 Jinja2 템플릿과 함께 활용할 수 있도록 도와주는 기능입니다.

Lookup plugin 이란?

Ansible plugins 중 하나인 lookup plugin은 공식 문서에서 다음과 같이 정의되어 있습니다.

Lookup plugins are an Ansible-specific extension to the Jinja2 templating language. You can use lookup plugins to access data from outside sources (files, databases, key/value stores, APIs, and other services) within your playbooks. Like all templating , lookups execute and are evaluated on the Ansible control machine. Ansible makes the data returned by a lookup plugin available using the standard templating system. You can use lookup plugins to load variables or templates with information from external sources. You can create custom lookup plugins

간단히 말해, lookup plugin은 플레이북 내에서 외부 소스(파일, 데이터베이스, key/value 저장소, API 등)의 데이터를 가져와 Jinja2 템플릿 언어를 통해 활용할 수 있도록 도와주는 기능입니다. 예를 들어, 외부 파일에 접근해 해당 내용을 변수에 저장하고 이를 작업에 사용할 수 있습니다.

이해를 돕기 위해 아래에 몇 가지 사용 예제를 소개하겠습니다. 참고로 Ansible plugins 개념이 생소하신 분들은 이전에 다룬 "플러그인" 글을 먼저 확인하시면 좋습니다.

 

Lookup 플러그인 활용

Ansible plugins 중 lookup plugin은 기본적으로 활성화되어 있어 별도의 설정 없이 바로 사용할 수 있습니다.

먼저, lookup plugin과 함께 사용할 수 있는 플러그인 목록을 조회해 보겠습니다.

[root@bastion ~]# ansible-doc -l -t lookup 
ansible.builtin.config              Lookup current Ansible configuration values               
ansible.builtin.csvfile             read data from a TSV or CSV file                          
ansible.builtin.dict                returns key/value pair items from dictionaries            
ansible.builtin.env                 Read the value of environment variables                   
ansible.builtin.file                read file contents                                        
ansible.builtin.fileglob            list files matching a pattern                             
ansible.builtin.first_found         return first file found from list

여러 종류의 lookup plugin이 제공되며, 이 중에서 ansible.builtin.file 플러그인을 사용해 보겠습니다. 이 플러그인은 "파일의 내용을 읽어온다"고 설명되어 있습니다.

이제 이 플러그인을 어떻게 활용할 수 있는지, 두 가지 예제를 통해 확인해보겠습니다.

 

예제 1. 파일 내용을 변수의 값으로 사용

test_file.txt 파일에는 다음과 같은 내용이 있습니다.

# cat file/test_file.txt 
webadmin

lookup 플러그인을 이용하면 위 파일의 내용을 불러와 변수에 저장할 수 있습니다.

# cat test.yml
---
- name: lookup test
  hosts: node1
  vars:
    file_contents: "{{ lookup('ansible.builtin.file', 'file/test_file.txt') }}"

  tasks:
    - name: pring variable
      ansible.builtin.debug:
        var: file_contents

위 예제에서는 ansible.builtin.file lookup 플러그인을 사용하여 file/test_file.txt의 내용을 읽고, 이를 file_contents 변수에 저장합니다. 해당 변수를 출력하면 다음과 같은 결과를 확인할 수 있습니다.

# ansible-playbook test.yaml 

PLAY [lookup test] ********************************************************************************

TASK [Gathering Facts] ****************************************************************************
ok: [node1]

TASK [pring variable] *****************************************************************************
ok: [node1] => {
    "file_contents": "webadmin"
}

PLAY RECAP ****************************************************************************************
node1       : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

 

예제 2. 파일 내용을 바로 출력

이번에는 변수에 저장하지 않고, 파일 내용을 메시지 형태로 바로 출력해보겠습니다. test_file.txt 파일의 내용은 이전과 동일합니다.

# cat file/test_file.txt 
webadmin

아래는 해당 파일 내용을 불러와 메시지에 포함시키는 Ansible 플레이북입니다.

# cat test.yaml
---
- name: lookup test
  hosts: node1
  vars:
    server: webserver

  tasks:
    - name: pring message
      ansible.builtin.debug:
        msg: "{{ server + ' username is ' + lookup('ansible.builtin.file', 'file/test_file.txt') }}"

debug 모듈의 msg 내용을 자세히 분석해 보면 다음과 같이 해석할 수 있습니다.

  • server 변수에는 "webserver"가 저장되어 있습니다.
  • “+” 기호를 이용하여 문자열을 연결합니다.
  • username is라는 문자열이 출력됩니다.
  • lookup 함수에서 file모듈을 사용하여 file/test_file.txt의 파일 내용을 불러옵니다.

최종적으로 출력되는 문구는 아래와 같습니다.

$ ansible-playbook test.yml 
...
TASK [pring message] ******************************************************************************
ok: [node1] => {
    "msg": "webserver username is webadmin"
}
..

 

마치며

이번 글에서는 lookup plugins 중 ansible.builtin.file 플러그인의 기능을 중심으로 살펴보았습니다. lookup plugin은 외부 데이터를 플레이북에서 직접 불러와 활용할 수 있도록 해주는 유용한 기능입니다.

lookup plugin에서 제공하는 다른 플러그인들도 다양하며, 아래 명령어를 통해 전체 목록을 확인할 수 있습니다.

# ansible-doc -t lookup -l

 

 

참고 사이트

 

댓글

댓글 쓰기

이 블로그의 인기 게시물

[Linux] RHEL Local YUM Repository 구성

이미지
RHEL(Redhat Enterprise Linux)에 Local YUM Repository 구성하는 방법에 대하여 설명합니다. 레드햇 리눅스 같은 경우 기업환경의 인터넷이 되지 않는 환경에서 사용되는 경우가 많은데 Local YUM Repository를 구성하여 패키지를 쉽게 설치할 수 있습니다.   테스트 환경 • Red Hat Enterprise Linux (RHEL)   Local YUM Repository 구성 목적 Local YUM Repository를 구성하는 방법에 여러 가지가 있지만 가장 간단한 방법인 설치 CD를 이용해 구성하는 방법에 대해 소개합니다. 주로 이 방법은 OS 엔지니어가 RHEL을 설치 후 사용하며, local repo를 서버에 구성한 뒤 철수합니다. 그러면 애플리케이션 측에서 추가 패키지를 요청하여도 서버 관리자분들이 yum 명령어를 사용하여 쉽게 서버에 설치할 수 있습니다.   Local YUM Repository 설정 레드햇 설치 CD에는 기본 RHEL 서브스크립션에서 제공하는 RPM 패키지들이 모두 포함되어 있습니다. 따라서 RHEL을 설치한 버전과 동일한 ISO 파일 이 준비되어 있어야 하며, 이를 통해 로컬 저장소를 구성할 수 있습니다.   VMware Workstation을 기준으로 설명하자면, RHEL ISO 파일을 가상 머신에 마운트 하면 됩니다. ISO 파일이 마운트되면 시스템은 자동으로 /dev/sr0 장치를 생성하게 되며, 이는 udev 에 의해 처리됩니다.   CD가 삽입되면 시스템에서는 /dev/sr0 장치를 자동으로 생성합니다. 이 장치는 **광학 디스크 장치(CD/DVD)**로 인식되며, 이를 확인하는 가장 쉬운 방법은 lsblk 명령어를 사용하는 것입니다. # lsblk NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS sda 8:0 0 2G 0 disk └─mpatha ...
자세한 내용 보기

[Linux Command] sudo command 설명

이미지
  이번 글에서는 Linux 명령어 중 sudo 명령어에 대해 알아보겠습니다. 일반 사용자에게 "root" 권한을 부여하려면 보통 root 계정의 비밀번호를 제공해야 합니다. 이후 사용자는 su 명령어를 통해 root 계정으로 로그인할 수 있습니다. root 계정은 시스템 내 모든 명령을 실행할 수 있는 강력한 권한을 가지고 있기 때문에, 신중한 관리가 필요합니다. 리눅스에 익숙하지 않은 사용자가 root 권한을 사용할 경우, 시스템 운영에 필요한 핵심 파일이 삭제되거나 권한 설정이 변경되는 등의 사고가 발생할 수 있습니다. sudo 기능을 사용하면 root 전체 권한이 아닌 특정 명령어만 일반 사용자에게 허용할 수 있어 이러한 위험을 줄일 수 있습니다. 또한, 사용 권한은 부여하되 root 비밀번호를 공개하지 않아도 된다는 점도 sudo 의 중요한 장점 중 하나입니다.   환경 : Red Hat Enterprise Linux (RHEL)   sudo command 개념 명령어 사용법을 보기 전에, sudo 명령어로 어떤 작업이 가능한지 먼저 알아보겠습니다. 일반 사용자가 /etc/shadow 파일을 열려고 하면 권한 부족으로 인해 파일을 열 수 없습니다. 아래는 실제 출력 예시입니다. 일반유저로 shadow파일 오픈 실패 [user1@localhost ~]$ cat /etc/shadow cat: /etc/shadow: Permission denied 또한 mount 명령어도 일반 사용자 권한으로는 실행할 수 없습니다. 일반 유저로 mount 명령 실패 [user1@localhost sbin]$ mount /dev/sr0 /media mount: only root can do that 이제 일반 사용자에게 mount 명령어만 sudo 를 통해 root 권한으로 실행할 수 있도록 설정해보겠습니다. [user1@localhost ~]$ sudo mount /dev/...
자세한 내용 보기

[Ansible Modules] Fetch module 설명 및 활용

이미지
  Ansible modules 중 하나인 Fetch module에 대해 알아보겠습니다. Fetch는 관리 대상 노드에서 제어 노드로 파일을 복사해 오는 데 사용되는 모듈입니다 Fetch module 이란 Fetch는 영어로 "가져오다"라는 의미입니다. Ansible의 copy 모듈과 반대로 동작하는 기능으로, copy 가 제어 노드에서 관리 노드로 파일을 전송하는 데 사용된다면, fetch 는 그 반대 방향으로, 관리 대상 노드의 파일을 제어 노드로 복사해 오는 데 사용됩니다. 여기서 제어 노드(control node)는 Ansible을 실행하는 노드를, 관리 노드(managed node)는 Ansible로 관리되는 대상 시스템을 의미합니다. Ansible modules(fetch_module) Fetch module 옵션   fetch 모듈에서 주로 사용되는 주요 옵션은 다음과 같습니다: src : 관리 대상 노드에서 복사해 올 파일의 경로입니다. dest : 제어 노드에 파일을 저장할 경로입니다. flat (기본값: false ) false : {{ inventory_hostname }}/path/to/file 형태의 디렉토리 구조로 파일이 저장됩니다. 호스트별로 디렉토리가 생성되므로 여러 노드에서 같은 파일 경로를 가져올 때 유용합니다. true : 파일 경로 구조 없이 파일만 단순 복사됩니다. 이름이 같은 파일은 덮어써지기 때문에, 관리 노드가 하나이거나 파일명이 충돌하지 않는 경우에 적합합니다. 또한 디렉토리를 지정할 경우 dest 경로 끝에 슬래시( / )를 반드시 붙여야 합니다. Fetch module 사용 방법 예제에서는 다음과 같은 인벤토리 파일을 사용합니다. [test] rocky86.lab.example.com rocky84.lab.example.com   예제 1. 기본값( flat: false )으로 파일 가져오기 fetch  모듈을 이용해 관리 노드의...
자세한 내용 보기