SSD Nodes Learn Hosting plans →
คู่มือ Matt Connorโดย Matt Connor · อัปเดตเมื่อ 2026-10-23

Ansible playbook กับ role เลือกใช้อย่างไรให้เหมาะสม

เรียนรู้ความแตกต่างระหว่างการใช้ Ansible playbook แบบไฟล์เดียวกับการจัดโครงสร้างด้วย role พร้อมเกณฑ์การตัดสินใจตามขนาดโปรเจกต์ การนำโค้ดกลับมาใช้ใหม่ และลำดับความสำคัญของตัวแปร

Verified Every command ran end-to-end on a fresh Ubuntu 24.04 server, July 30, 2026.

ความแตกต่างระหว่าง Ansible playbook และ role

Ansible playbook คือไฟล์ที่คุณเรียกใช้งานด้วย ansible-playbook โดยทำหน้าที่จับคู่กลุ่มโฮสต์เข้ากับงานที่ต้องดำเนินการ ส่วน Ansible role คือไดเรกทอรีที่มีโครงสร้างตายตัวซึ่งเก็บ tasks, templates, handlers และ default variables เอาไว้ โดยที่ playbook จะเป็นตัวเรียกใช้งาน role นั้นๆ ผ่านชื่อ ไวยากรณ์ของ task ภายในทั้งสองแบบนั้นเหมือนกันทุกประการ ดังนั้นนี่จึงไม่ใช่คำถามเกี่ยวกับขีดความสามารถในการเขียนคำสั่ง แต่เป็นเรื่องของการนำกลับมาใช้ใหม่ (reuse)

ให้เริ่มต้นด้วย playbook แบบแบนๆ ก่อน การใช้ site.yml หนึ่งไฟล์ที่บรรจุรายการ tasks: คือรูปแบบที่เหมาะสมสำหรับการทำระบบอัตโนมัติครั้งแรกของคุณ และมันยังคงใช้งานได้ดีนานกว่าที่หลายคนคาดคิด ให้เปลี่ยนไปใช้ role ก็ต่อเมื่อชุดของ task เดิมต้องถูกนำไปรันให้กับโฮสต์กลุ่มที่สอง หรือเมื่อไฟล์มีขนาดใหญ่เกินกว่า 100 บรรทัดจนคุณไม่สามารถหา task ที่ต้องการได้จากการเลื่อนหน้าจอ

หากคุณยังไม่เคยเขียนมาก่อน ให้ เริ่มต้นด้วย playbook แรกสำหรับ VPS เครื่องเดียว แล้วค่อยกลับมาอ่านหน้านี้เมื่อโปรเจกต์ของคุณเริ่มขยายตัวขึ้น

เมื่อใดที่ควรใช้ flat playbook

flat playbook เป็นทางเลือกที่เหมาะสมเมื่อต้องทำงานเพียงครั้งเดียว บนโฮสต์เดียว หรือเมื่อไม่มีผู้อื่นต้องมาอ่านโค้ดของคุณ การจัดเตรียมเซิร์ฟเวอร์แอปพลิเคชันเพียงเครื่องเดียว หรือการแพตช์ระบบก่อนช่วงเวลาบำรุงรักษา ไม่จำเป็นต้องสร้างโครงสร้างไดเรกทอรีที่ซับซ้อน การใช้ role จะเพิ่มไดเรกทอรีขึ้นอีก 7 แห่งและเพิ่มชั้นความซับซ้อนขึ้นอีกหนึ่งระดับ หากมีเพียง playbook เดียวที่เรียกใช้งาน role นั้น ความซับซ้อนที่เพิ่มขึ้นมาก็ไม่มีประโยชน์ และยังทำให้คุณต้องเสียเวลาเปิดไฟล์ไปมาทุกครั้งที่ต้องการตรวจสอบการทำงานจริง

flat playbook จะเริ่มไม่เหมาะสมเมื่อถึงจุดหนึ่ง ซึ่งเป็นจุดที่สังเกตได้ง่าย นั่นคือเมื่อคุณคัดลอกบล็อกของ task ไปไว้ใน playbook ที่สอง การคัดลอกนี้คือสัญญาณเตือน นับจากนั้นเป็นต้นไป การแก้ไขทุกอย่างจะต้องทำซ้ำสองครั้ง และวันหนึ่งคุณจะลืมแก้ไขในที่ใดที่หนึ่งไปอย่างแน่นอน

สิ่งที่ไดเรกทอรีของ role จัดเก็บอยู่จริง

roles/common/
  defaults/main.yml
  vars/main.yml
  tasks/main.yml
  handlers/main.yml
  templates/99-hardening.conf.j2
  files/
  meta/main.yml
  • tasks/main.yml คือจุดเริ่มต้น Ansible จะรันไฟล์นี้เมื่อมีการเรียกใช้ role และไดเรกทอรีอื่นๆ ทั้งหมดเป็นเพียงส่วนเสริม
  • defaults/main.yml จัดเก็บตัวแปรที่คาดหวังให้ผู้เรียกทำการ override เป็นแหล่งข้อมูลที่มีลำดับความสำคัญต่ำที่สุดใน Ansible ดังนั้นเกือบทุกอย่างจึงมีความสำคัญเหนือกว่าตัวแปรในส่วนนี้
  • vars/main.yml จัดเก็บตัวแปรที่ไม่ได้คาดหวังให้ผู้เรียกทำการ override โดยมีลำดับความสำคัญสูงกว่า inventory ซึ่งถือเป็นระดับที่สูงมาก ควรใช้งานด้วยความระมัดระวัง
  • handlers/main.yml จัดเก็บ task ที่ถูกเรียกใช้งานโดย notify โดย handler จะทำงานเมื่อจบ play หนึ่งครั้ง ไม่ว่าจะมี task แจ้งเตือนมันกี่ครั้งก็ตาม
  • files/ จัดเก็บไฟล์ที่ถูกคัดลอกแบบตรงตัวโดยโมดูล copy และ templates/ จัดเก็บ Jinja2 template ที่ถูกประมวลผลโดยโมดูล template ภายใน role คุณสามารถอ้างอิงไฟล์ทั้งสองประเภทได้โดยใช้ชื่อไฟล์เปล่าๆ โดยไม่ต้องระบุ path เนื่องจาก Ansible จะค้นหาในไดเรกทอรีของ role นั้นๆ ก่อนเสมอ
  • meta/main.yml ประกาศการพึ่งพาของ role และ metadata ที่ Ansible Galaxy อ่าน

โครงสร้างนี้ไม่ใช่เรื่องของความชอบส่วนบุคคล แต่ Ansible ค้นหาไฟล์ใน path เหล่านี้โดยเฉพาะ ดังนั้น template ที่คุณวางไว้ใน roles/common/template/ (รูปเอกพจน์) จะไม่มีวันถูกค้นพบ

สร้าง role ทั่วไปด้วย ansible-galaxy init

mkdir -p ~/infra/roles
cd ~/infra
ansible-galaxy init --init-path roles common

คำสั่งนี้จะสร้างโครงสร้างไฟล์ทั้งหมดไว้ภายใต้ roles/common รวมถึงไดเรกทอรีที่คุณไม่ได้ใช้งานและไฟล์ main.yml ที่มีเพียง --- เท่านั้น ให้ลบไฟล์ที่คุณไม่ได้ใช้งานทิ้งไป แม้ว่าไฟล์ vars/main.yml ที่ว่างเปล่าจะไม่ส่งผลเสียต่อ Ansible แต่การเก็บไว้จะทำให้มองไม่เห็นว่าไฟล์ใดใน role ที่มีความสำคัญจริง

จากนั้นให้เติมเนื้อหาลงในไฟล์ที่ทำหน้าที่ประมวลผล โดยเริ่มจาก defaults ก่อน เนื่องจากเป็นส่วนติดต่อสาธารณะของ role

# roles/common/defaults/main.yml
---
common_packages:
  - ufw
  - fail2ban
  - unattended-upgrades
common_admin_group: admins
common_permit_root_login: "no"
common_password_authentication: "no"

ให้ใส่เครื่องหมายคำพูดสำหรับ "no" และ "yes" เนื่องจาก Ansible ประมวลผล YAML ด้วย PyYAML ซึ่งจะอ่านค่า no เปล่าๆ ว่าเป็นค่า boolean false ส่งผลให้บรรทัด config ที่ถูกเรนเดอร์กลายเป็น PermitRootLogin False และ sshd จะปฏิเสธการใช้งาน การใส่เครื่องหมายคำพูดจะช่วยรักษาค่าให้เป็นสตริง

# roles/common/tasks/main.yml
---
- name: Install the base packages
  ansible.builtin.apt:
    name: "{{ common_packages }}"
    state: present
    update_cache: true
    cache_valid_time: 3600

- name: Create the admin group
  ansible.builtin.group:
    name: "{{ common_admin_group }}"
    state: present

- name: Install the sshd hardening drop-in
  ansible.builtin.template:
    src: 99-hardening.conf.j2
    dest: /etc/ssh/sshd_config.d/99-hardening.conf
    owner: root
    group: root
    mode: "0644"
    validate: /usr/sbin/sshd -t -f %s
  notify: Restart sshd
# roles/common/handlers/main.yml
---
- name: Restart sshd
  ansible.builtin.service:
    name: ssh
    state: restarted
# roles/common/templates/99-hardening.conf.j2
# Managed by Ansible. Local edits are overwritten on the next run.
PermitRootLogin {{ common_permit_root_login }}
PasswordAuthentication {{ common_password_authentication }}

บน Debian และ Ubuntu ระบบ systemd unit จะใช้ชื่อว่า ssh ส่วนบนระบบตระกูล RHEL จะใช้ชื่อว่า sshd หาก handler ระบุชื่อผิดพลาด ระบบจะแจ้งเตือนก็ต่อเมื่อมีการเปลี่ยนแปลงใน template เท่านั้น ซึ่งเป็นสาเหตุว่าทำไมปัญหาประเภทนี้มักจะถูกตรวจพบหลังจากผ่านไปหลายสัปดาห์

บรรทัด validate เป็นส่วนที่มีประโยชน์ที่สุดใน task นั้น Ansible จะเรนเดอร์ template ไปยังไฟล์ชั่วคราว จากนั้นแทนที่พาธของไฟล์นั้นด้วย %s แล้วจึงรันคำสั่ง ปลายทางจะถูกแทนที่ก็ต่อเมื่อคำสั่งรันสำเร็จด้วย exit code 0 เท่านั้น หากคุณใส่ directive ที่ไม่มีอยู่จริงลงใน template แล้วรันอีกครั้ง task จะล้มเหลวพร้อมแจ้ง failed to validate โดยที่ไฟล์ /etc/ssh/sshd_config.d/99-hardening.conf จริงจะยังคงไม่ถูกแก้ไข และคุณจะยังคงสามารถล็อกอินเข้าเซิร์ฟเวอร์ได้ตามปกติ โปรดทราบว่าการตรวจสอบนี้ทดสอบมากกว่าแค่ไวยากรณ์ของคุณ หาก sshd -t ไม่สามารถอ่าน host keys ได้ ระบบจะแจ้ง sshd: no hostkeys available -- exiting. และ Ansible จะรายงาน failed to validate เช่นเดียวกัน ดังนั้นควรอ่าน msg ของโมดูลก่อนที่จะสรุปว่าปัญหาเกิดจาก template

วิธีการเรียกใช้ role ใน playbook

# site.yml
---
- name: Base configuration for every server
  hosts: all
  become: true
  roles:
    - common
# inventory.ini
[local]
localhost ansible_connection=local
ansible-playbook -i inventory.ini site.yml

Play ควรจบลงด้วย failed=0 ในส่วนสรุปการทำงาน ให้ส่งผ่านพารามิเตอร์ที่จุดเรียกใช้ด้วยรูปแบบขยาย ซึ่งเป็นวิธีที่ทำให้ role เดียวสามารถรองรับโฮสต์ได้สองกลุ่ม:

  roles:
    - role: common
      common_admin_group: ops
      common_permit_root_login: prohibit-password

มีกฎการจัดลำดับหนึ่งข้อที่มักทำให้ผู้ใช้ประหลาดใจ Play หนึ่งชุดสามารถประกอบด้วย pre_tasks, roles, tasks และ post_tasks โดย Ansible จะรันตามลำดับนี้เสมอไม่ว่าคุณจะเขียนไว้ในไฟล์ด้วยลำดับใดก็ตาม แม้คุณจะวาง tasks: ไว้เหนือ roles: แต่ role ก็ยังคงทำงานก่อนอยู่ดี ดังนั้นหากมีสิ่งใดที่ต้องเกิดขึ้นก่อน role สิ่งนั้นจะต้องอยู่ใน pre_tasks: ไม่ใช่ที่ส่วนบนของ tasks:

- name: Ordering demonstration
  hosts: local
  gather_facts: false
  pre_tasks:
    - name: Runs first
      ansible.builtin.debug:
        msg: pre
  roles:
    - common
  tasks:
    - name: Runs after the role
      ansible.builtin.debug:
        msg: task
  post_tasks:
    - name: Runs last
      ansible.builtin.debug:
        msg: post

หากต้องการเรียกใช้ role จากภายในรายการ task แทนการใช้คีย์ roles: ให้ใช้ import_role หรือ include_role

  tasks:
    - name: Static, read when the playbook is parsed
      ansible.builtin.import_role:
        name: common

    - name: Dynamic, resolved when the task runs
      ansible.builtin.include_role:
        name: postgres
      when: "'db' in group_names"

import_role เป็นแบบ static โดย Ansible จะอ่าน role ในขณะ parse และ task ต่างๆ จะกลายเป็นส่วนหนึ่งของ play ทำให้ ansible-playbook --list-tasks site.yml สามารถแสดงรายการ task เหล่านั้นได้ และ tag ที่กำหนดบน import จะมีผลกับทุก task ภายในนั้น ส่วน include_role เป็นแบบ dynamic ซึ่งจะไม่มีการอ่านข้อมูลจนกว่า task จะทำงานจริง ทำให้คุณสามารถกำหนดชื่อ role ผ่านตัวแปรหรือ loop ได้ แต่ข้อเสียคือ task เหล่านั้นจะไม่ปรากฏให้ --list-tasks และ --start-at-task มองเห็น

มีกับดักที่ต้องระวังคือ when: บน task ประเภท include_role จะถูกประเมินก่อนที่ defaults/main.yml ของ role ที่ถูก include จะอยู่ในขอบเขต (scope) หากคุณเขียน when: common_packages | length > 0 ไว้บนคำสั่ง include การทำงานจะหยุดลงพร้อมกับข้อผิดพลาด 'common_packages' is undefined แม้ว่าตัวแปรนั้นจะถูกกำหนดไว้ใน role ที่คุณกำลัง include อยู่ก็ตาม วิธีแก้ไขคือให้ย้ายตัวแปรควบคุมนั้นออกมานอก role โดยนำไปไว้ใน group_vars/all.yml ซึ่งจะทำให้ตัวแปรอยู่ในขอบเขตที่เข้าถึงได้ทุกที่ และให้คงค่า defaults ของ role ไว้สำหรับค่าที่ role นั้นใช้งานเองเท่านั้น

ตัวแปรใดมีลำดับความสำคัญสูงสุด: defaults, group_vars, vars, extra vars

Ansible มีลำดับความสำคัญของตัวแปรมากกว่า 20 ระดับ แต่มี 4 ระดับที่ตัดสินข้อถกเถียงส่วนใหญ่ได้ โดยเรียงจากลำดับความสำคัญต่ำสุดไปสูงสุดดังนี้:

  • roles/<name>/defaults/main.yml อยู่ในระดับต่ำสุด เกือบทุกค่าที่คุณกำหนดไว้ที่อื่นจะมีความสำคัญเหนือกว่าตัวแปรนี้ ซึ่งเป็นเหตุผลว่าทำไมจึงเป็นตำแหน่งที่เหมาะสมที่สุดสำหรับค่าที่ปรับแต่งได้ของ role
  • group_vars/ และ host_vars/ อยู่ในระดับกลาง นี่คือตำแหน่งที่ควรเก็บค่าเฉพาะสำหรับไซต์ของคุณ ซึ่งจะเข้ามาแทนที่ค่าเริ่มต้นของ role ได้อย่างชัดเจน
  • roles/<name>/vars/main.yml อยู่เหนือกว่า host_vars ค่าที่คุณกำหนดไว้ที่นี่จะไม่สามารถถูกแทนที่ได้จาก inventory ให้สงวนไว้สำหรับสิ่งที่ role จำเป็นต้องใช้เพื่อรักษาความสอดคล้องภายใน เช่น ชื่อแพ็กเกจที่ต้องตรงกับชื่อบริการ
  • พารามิเตอร์ของ role ที่ส่งผ่าน ณ จุดเรียกใช้งานจะมีความสำคัญเหนือกว่า vars/main.yml และ -e ที่กำหนดผ่าน command line จะมีความสำคัญเหนือกว่าทุกอย่าง รวมถึงพารามิเตอร์ของ role ด้วย

คุณสามารถตรวจสอบลำดับการทำงานนี้ได้ภายในเวลาไม่ถึงหนึ่งนาที โดยกำหนดค่าเริ่มต้นและตัวแปร role อย่างละหนึ่งค่าให้กับ role ขนาดเล็ก จากนั้นกำหนดชื่อเดียวกันใน host_vars

# roles/prec/defaults/main.yml
---
prec_tunable: from-defaults
prec_internal: from-defaults
# roles/prec/vars/main.yml
---
prec_internal: from-rolevars
# host_vars/localhost.yml
---
prec_tunable: from-hostvars
prec_internal: from-hostvars
# roles/prec/tasks/main.yml
---
- name: Show which value survived
  ansible.builtin.debug:
    msg: "tunable={{ prec_tunable }} internal={{ prec_internal }}"
ansible-playbook -i inventory.ini prec.yml
ansible-playbook -i inventory.ini prec.yml -e prec_internal=from-cli

การรันครั้งแรกจะแสดงผลเป็น tunable=from-hostvars internal=from-rolevars โดยค่าจาก inventory มีความสำคัญเหนือกว่าค่าเริ่มต้นของ role แต่ยังแพ้ให้กับตัวแปรของ role ส่วนการรันครั้งที่สองจะแสดงผลเป็น internal=from-cli เนื่องจาก extra vars อยู่ในระดับสูงสุดและไม่มีค่าใดที่อยู่ต่ำกว่าจะสามารถแทนที่ได้ นี่คือเหตุผลว่าทำไม -e จึงเหมาะสมสำหรับการรันแบบครั้งเดียว แต่ไม่ควรใช้ในสคริปต์ที่คุณต้องใช้งานต่อเนื่อง เพราะมันจะเข้ามาแทนที่การตัดสินใจทุกอย่างที่ได้วางแผนไว้ใน repository ของคุณโดยไม่มีการแจ้งเตือน

กฎการทำงานคือ: หากคุณต้องการให้ค่าใดสามารถปรับเปลี่ยนได้ ให้ใส่ไว้ใน defaults/ การใส่ค่าไว้ใน vars/ เป็นการบอกผู้ใช้ role ในอนาคตทุกคนว่า inventory ไม่สามารถเปลี่ยนแปลงค่านี้ได้ ซึ่งบางครั้งอาจเป็นสิ่งที่คุณตั้งใจ แต่โดยส่วนใหญ่มักเป็นความผิดพลาดโดยไม่ตั้งใจ

พิสูจน์ความเป็น idempotent ของ role: รันซ้ำสองครั้ง

การรัน Ansible ที่เชื่อถือได้จะต้องให้ผลลัพธ์เดิมในการรันครั้งที่สอง และรายงานว่าไม่มีการเปลี่ยนแปลงใดๆ ให้รัน playbook ซ้ำสองครั้งแล้วอ่านสรุปผล

ansible-playbook -i inventory.ini site.yml
ansible-playbook -i inventory.ini site.yml

สรุปผลการรันครั้งที่สองควรมีลักษณะดังนี้:

PLAY RECAP *********************************************************************
localhost   : ok=4  changed=0  unreachable=0  failed=0  skipped=0  rescued=0  ignored=0

changed=0 หมายความว่าไม่มี task ใดรายงานว่ามีการเปลี่ยนแปลง สำหรับโมดูลอย่าง apt, template และ group นี่คือการตรวจสอบสถานะปัจจุบันอย่างแท้จริง แต่ตัวเลขนี้จะเชื่อถือได้เท่ากับความถูกต้องในการรายงานการเปลี่ยนแปลงของแต่ละ task เท่านั้น: task ที่มี changed_when: false จะถูกนับว่าไม่มีการเปลี่ยนแปลงไม่ว่าจริงๆ แล้วมันจะทำอะไรไปก็ตาม changed=2 ในการรันครั้งที่สองหมายความว่ามีสอง task ที่รายงานว่ามีการเปลี่ยนแปลงอีกครั้ง ซึ่งอาจเป็นงานที่ทำซ้ำจริงๆ เช่น การเขียนไฟล์ใหม่หรือการรีสตาร์ท service ทุกครั้งที่รัน หรืออาจเป็นคำสั่งแบบ read-only ที่ไม่มีวิธีแจ้งว่าไม่มีการเปลี่ยนแปลงเกิดขึ้น ไม่ว่ากรณีใด สรุปผลดังกล่าวได้หยุดแจ้งให้คุณทราบแล้วว่าเซิร์ฟเวอร์มีการเปลี่ยนแปลงไปจากค่าที่กำหนด (drift) หรือไม่ สาเหตุที่พบบ่อยคือ command หรือ shell เนื่องจาก Ansible ไม่มีทางทราบได้ว่าคำสั่งที่กำหนดขึ้นเองนั้นทำอะไรไปบ้าง

# traps.yml
---
- name: Command modules do not know what they changed
  hosts: local
  gather_facts: false
  tasks:
    - name: This appends a line on every run
      ansible.builtin.shell: "echo run >> /tmp/grow.txt"

    - name: This appends a line only once
      ansible.builtin.shell: "echo run >> /tmp/guarded.txt"
      args:
        creates: /tmp/guarded.txt

ให้รัน playbook นั้นสองครั้ง แล้วนับจำนวนบรรทัดที่มี wc -l /tmp/grow.txt /tmp/guarded.txt โดย /tmp/grow.txt จะมีสองบรรทัดและ /tmp/guarded.txt จะมีหนึ่งบรรทัด ในการรันครั้งที่สอง task ที่มีการป้องกันไว้จะไม่ทำงานเลย: มันจะรายงาน ok พร้อมข้อความ Did not run command since '/tmp/guarded.txt' exists เนื่องจาก creates ทำให้โมดูลมีผลลัพธ์ที่มองเห็นได้ให้ตรวจสอบก่อน เมื่อคำสั่งไม่ทิ้งผลลัพธ์ดังกล่าวไว้ ให้เก็บ output ไว้ในตัวแปรแล้วตัดสินใจด้วยตัวเองโดยใช้ changed_when

ansible-playbook --check --diff site.yml ใช้คาดการณ์การเปลี่ยนแปลงโดยไม่ลงมือทำจริง และ --diff จะแสดงบรรทัดที่ template จะเขียนทับออกมาให้ดู ให้อ่านผลลัพธ์โดยคำนึงถึงข้อควรระวังหนึ่งประการ: task ประเภท shell หรือ command จะถูกข้ามไปในโหมดตรวจสอบ (สำหรับ creates หรือ removes มันจะรายงานเพียงว่าจะทำงานหรือไม่เท่านั้น) และ task ที่ระบุว่า check_mode: false จะทำงานจริงแม้จะอยู่ภายใต้ --check ดังนั้นแผนที่ดูสะอาดตาอาจยังมีการทำงานแอบแฝงอยู่ และการรันแบบ dry run ไม่ได้แห้งเสมอไป

อีกหนึ่งคอลัมน์ในสรุปผลที่ควรให้ความสำคัญไม่แพ้กันคือ: host ที่ Ansible ไม่สามารถเชื่อมต่อได้จะถูกนับรวมใน unreachable แทนที่จะเป็น failed และไม่มี task ใดของ host นั้นทำงานเลย ดังนั้น ตัดสินใจล่วงหน้าว่า host ที่ติดต่อไม่ได้หนึ่งเครื่องควรหยุดการรันทั้งหมดหรือไม่ ก่อนที่คุณจะสั่งให้ role นี้ทำงานกับเครื่องจำนวนมาก

เหตุใด Ansible จึงแจ้งว่าไม่พบ role

Ansible จะค้นหาไดเรกทอรี roles/ ในตำแหน่งที่อยู่ถัดจากไฟล์ playbook จากนั้นจึงค้นหาใน roles_path โดยลำดับการค้นหาจะอ้างอิงตามตำแหน่งของ playbook ไม่ใช่ตำแหน่งของ shell ที่คุณใช้งานอยู่

[ERROR]: The role 'common' was not found in: /home/deploy/lonely/roles:/home/deploy/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles:/home/deploy/lonely

ข้อความดังกล่าวหมายความว่า site.yml และ roles/ ไม่ตรงกัน ซึ่งระบบจะแสดง path ที่พยายามค้นหาให้เห็นอย่างชัดเจน นี่เป็นรูปแบบข้อความของ ansible-core 2.21 ส่วนรุ่นเก่าจะแสดงเป็น the role 'common' was not found in โดยขึ้นต้นด้วยตัวพิมพ์เล็กและไม่มีเครื่องหมาย colon ดังนั้นให้สังเกตที่ was not found in คุณควรเก็บไฟล์ทั้งสองไว้ในไดเรกทอรีเดียวกัน การสั่งรันจากไดเรกทอรีแม่สามารถทำได้โดยไม่มีปัญหา เนื่องจาก path ของ playbook คือสิ่งที่ Ansible ใช้ในการอ้างอิง:

ansible-playbook -i infra/inventory.ini infra/site.yml

ยังมีปัญหาในลักษณะเดียวกันที่เงียบกว่านั้น คือ Ansible จะเพิกเฉยต่อไฟล์ ansible.cfg ในไดเรกทอรีปัจจุบันหากไดเรกทอรีนั้นอนุญาตให้ทุกคนเขียนไฟล์ได้ (world writable) เนื่องจากผู้ใช้รายอื่นบนเครื่องอาจวางไฟล์ config ไว้เพื่อเปลี่ยนพฤติกรรมการทำงานของคุณได้

[WARNING]: Ansible is being run in a world writable directory (/tmp/infra), ignoring it as an ansible.cfg source. For more information see https://docs.ansible.com/ansible/devel/reference_appendices/config.html#cfg-in-world-writable-dir

ในกรณีนี้ การตั้งค่า roles_path และ inventory ของคุณจะถูกละเว้นโดยไม่มีการแจ้งเตือน ทำให้การค้นหา role ล้มเหลวด้วยสาเหตุที่ไม่เกี่ยวข้องกับตัว role เอง คุณสามารถใช้ ansible --version เพื่อดูว่า config file ใดที่ถูกโหลดใช้งานจริง และใช้ ansible-config dump --only-changed เพื่อดูการตั้งค่าทั้งหมดที่แตกต่างไปจากค่าเริ่มต้นของระบบ ให้ตรวจสอบทั้งสองคำสั่งนี้เสมอเมื่อการรันงานมีพฤติกรรมเหมือนกับว่าไฟล์ config ของคุณไม่มีอยู่จริง

การแชร์ role: requirements.yml และการระบุเวอร์ชัน

Role ที่ผู้อื่นเขียนขึ้นควรใช้วิธีติดตั้งแทนการคัดลอกไฟล์ ให้ประกาศไว้ในไฟล์ดังนี้:

# requirements.yml
---
roles:
  - name: postgres
    src: https://github.com/example/ansible-role-postgres
    scm: git
    version: v1.4.0
ansible-galaxy install -r requirements.yml -p galaxy_roles

ต้องระบุค่า version เสมอ หากไม่มีค่านี้ คุณจะได้รับเวอร์ชันล่าสุดจาก branch เริ่มต้น ณ วันที่รันคำสั่ง ซึ่งอาจทำให้การ deploy ที่เคยใช้งานได้เมื่อเดือนก่อนเกิดข้อผิดพลาดขึ้นมาได้ ทั้งที่ไม่มีการเปลี่ยนแปลงใดๆ ใน repository ของคุณเอง ให้กำหนดค่า roles_path ไปยังไดเรกทอรีสำหรับดาวน์โหลด และไม่ต้องนำไดเรกทอรีดังกล่าวเข้าสู่ git:

# ansible.cfg
[defaults]
inventory = inventory.ini
roles_path = ./galaxy_roles

Role ที่อยู่ใน roles/ ซึ่งอยู่ถัดจาก playbook จะยังคงถูกค้นพบตามปกติ เนื่องจากระบบจะค้นหา path ดังกล่าวเพิ่มเติมจาก roles_path เสมอ ดังนั้น role ของคุณเองจะยังคงถูก commit และตรวจสอบได้ตามปกติ ในขณะที่ role ของบุคคลที่สามจะเป็นไฟล์ที่ดาวน์โหลดมาแบบทำซ้ำได้และถูกล็อกเวอร์ชันไว้ด้วย tag

เมื่อ Role ไม่ใช่คำตอบสำหรับทุกปัญหา

Role คือหน่วยสำหรับการนำกลับมาใช้ใหม่ภายใน Ansible run หนึ่งครั้ง Role ไม่สามารถสร้างเซิร์ฟเวอร์หรือระเบียน DNS ที่ผู้ให้บริการของคุณได้ และการพยายามทำให้ Role ทำหน้าที่ดังกล่าวจะทำให้ Playbook กลายเป็นสิ่งที่ไม่มีใครอยากดูแลรักษา การทำความเข้าใจ การแบ่งงานระหว่าง Ansible และ Terraform เป็นสิ่งที่ควรอ่านก่อนเริ่มต้น นอกจากนี้ Role ไม่สามารถทดแทนการออกแบบ Inventory ได้ เมื่อคุณมีเครื่องจำนวนมาก วิธีการจัดกลุ่มและเข้าถึงเซิร์ฟเวอร์เหล่านั้น จะมีความสำคัญมากกว่าวิธีการจัดเก็บ Task

การทำ Hardening ที่ Role common นี้ติดตั้งให้ ก็ควรมีการตัดสินใจแยกต่างหาก การตั้งค่าข้างต้นกำหนด Directive ไว้เพียงสองรายการเท่านั้น ดังนั้นควรอ่าน การตั้งค่า SSH ใดที่ควรเปลี่ยนจริง และ วิธีการตั้งค่าให้ Ubuntu อัปเดตความปลอดภัยด้วยตนเอง ก่อนที่คุณจะตัดสินใจว่าสิ่งใดควรอยู่ใน Role สำหรับทุกโฮสต์ที่คุณเป็นเจ้าของ

FAQ

เมื่อใดที่ควรเปลี่ยน Ansible playbook ให้เป็น role?

เมื่อชุดงาน (task) เดิมต้องถูกเรียกใช้ใน play ที่สอง หรือใช้กับกลุ่มโฮสต์กลุ่มที่สอง การคัดลอก task ระหว่าง playbook เป็นสัญญาณเตือน เพราะหลังจากนั้นทุกครั้งที่มีการแก้ไข คุณต้องตามไปแก้ให้ครบทุกจุด และวันหนึ่งคุณจะลืมแก้จุดใดจุดหนึ่งไป Playbook ที่มีความยาวไม่เกิน 100 บรรทัดและกำหนดเป้าหมายเพียงกลุ่มเดียว ไม่ได้รับประโยชน์จากการทำเป็น role และโครงสร้างไดเรกทอรีที่เพิ่มขึ้นจะทำให้การอ่านทำความเข้าใจยากขึ้น

Role ทำงานก่อน task อื่นๆ ใน play เดียวกันหรือไม่?

ใช่ Ansible จะรัน pre_tasks ก่อน จากนั้นจึงรันทุกอย่างที่ระบุไว้ภายใต้ roles:, ตามด้วย tasks: และ post_tasks: โดย Ansible จะไม่สนใจลำดับที่คีย์เหล่านี้ปรากฏในไฟล์ของคุณ การเขียน tasks: ไว้เหนือ roles: ไม่ได้ทำให้ task เหล่านั้นทำงานก่อน หากมีสิ่งใดที่ต้องเกิดขึ้นก่อน role ให้ใส่ไว้ใน pre_tasks:

ทำไมค่าใน group_vars ของฉันถึงไม่ทับค่าใน role?

ตรวจสอบว่าตัวแปรนั้นถูกตั้งค่าไว้ใน vars/main.yml ของ role แทนที่จะเป็น defaults/main.yml หรือไม่ vars/ มีลำดับความสำคัญสูงกว่า group_vars และ host_vars ในลำดับการประมวลผลของ Ansible ดังนั้น inventory จึงไม่สามารถทับค่าได้ ให้ย้ายตัวแปรไปไว้ที่ defaults/main.yml ซึ่งอยู่เกือบล่างสุดของลำดับความสำคัญ และเป็นตำแหน่งที่ถูกต้องสำหรับค่าที่ผู้เรียกใช้ควรจะสามารถเปลี่ยนแปลงได้ เพื่อยืนยันว่าปัญหาเกิดจากลำดับความสำคัญไม่ใช่การพิมพ์ผิด ให้รันด้วย -e name=value ซึ่งมีลำดับความสำคัญสูงกว่าแหล่งข้อมูลอื่นทั้งหมด

ทำไม Ansible ถึงแจ้งว่าไม่พบ role?

การค้นหาจะเริ่มจากตำแหน่งที่อยู่ข้างไฟล์ playbook ดังนั้น site.yml และ roles/ จะต้องอยู่ในไดเรกทอรีเดียวกัน ข้อความแสดงข้อผิดพลาดจะระบุ path ที่พยายามค้นหาโดยเริ่มจาก The role 'common' was not found in: /home/deploy/lonely/roles การรัน playbook จากไดเรกทอรีแม่สามารถทำได้ เพราะการค้นหาจะอ้างอิงตาม path ของ playbook ไม่ใช่ working directory ของ shell หากคุณพึ่งพา roles_path จาก ansible.cfg ให้ยืนยันว่าไฟล์นั้นถูกโหลดด้วย ansible --version เนื่องจาก Ansible จะเพิกเฉยต่อไฟล์หาก working directory นั้นอนุญาตให้ทุกคนเขียนได้ (world writable)

ฉันจำเป็นต้องใช้ ansible-galaxy init เพื่อสร้าง role หรือไม่?

ไม่จำเป็น Role เป็นเพียงไดเรกทอรีที่มีชื่อตามที่กำหนด ดังนั้น mkdir -p roles/common/tasks ร่วมกับ tasks/main.yml ก็ถือเป็น role ที่ใช้งานได้แล้ว ansible-galaxy init --init-path roles common ช่วยลดการพิมพ์และให้โครงสร้างพื้นฐานที่สมบูรณ์ รวมถึง meta/main.yml และไฟล์ README เบื้องต้น ให้ลบไดเรกทอรีที่คุณไม่ได้ใช้งานทิ้ง เพราะ vars/main.yml ที่ว่างเปล่าจะทำให้ดูไม่ออกว่าไฟล์ใดใน role ที่ทำงานจริง

บทความนี้มีประโยชน์หรือไม่

#ansible#roles#playbook#structure#automation