[10 phút ] [Ansible] [Cơ bản] [Phần 4] Viết Playbook trên Ansible

30/12/2020

Qua ba bài viết trước, chúng ta đã làm quen cơ bản với Ansible.

Trong bài viết này, chúng ta sẽ đi tìm hiểu cách viết Playbook – một trong những thứ tạo nên sức mạnh của Ansible

Trước khi bắt tay vào những gì thực tế hơn về Ansible, ta cần làm quen với một số thuật ngữ và khái niệm quan trọng được giới thiệu bởi bộ công cụ này

I. Thuật ngữ

Dưới đây là danh sách một số thuật ngữ được Ansible sử dụng:

  • Control Node/Management Control : server cài đặt Ansible, chịu trách nhiệm cho việc “đưa các công việc bạn cung cấp đến các server từ xa mà bạn quản lý và chạy chúng” .Nói một cách dễ hiểu hơn thì đây là server mà bạn đứng trên đó và lệnh cho các server khác thực hiện các việc bạn muốn mà không cần trực tiếp đăng nhập vào chúng.
  • Inventory : Một file INI chứa các thông tin về các server từ xa mà bạn quản lý.
  • Playbook : Một file YAML chứa một tập các công việc cần tự động hóa.
  • Task : một task sẽ xác định một công việc đơn lẻ sẽ được thực hiện.
  • Module : Một Module sẽ trừu tượng hóa một tác vụ hệ thống. Ansible cũng cấp rất nhiều Module tích hợp để ta sử dụng nhưng nếu muốn bạn cũng có thể tự tạo Module. Nói cách khác, ta giao tiếp với Ansible thông qua các Module.
  • Role : Một tập hợp các Playbook, các template và các file khác, được tổ chức theo cách được xác định trước để tạo điều kiện tái sử dụng và chia sẻ.
  • Play : Một lần thực thi suôn sẻ từ đầu tới cuối được gọi là một play.
  • Facts : Các biến toàn cục chứa các thông tin về hệ thống, như các network interface hay operating system.
  • Handlers : Sử dụng để kích hoạt thay đổi trạng thái các service, như việc ta restart hay reload một service

Một đống các khái niệm khô khan.

Đọc qua chẳng có chút gì đọng lại được cả, đúng không?

Giờ tôi sẽ cung cấp cho bạn một chút ít sự liên quan giữa chúng và chúng ta sẽ khám phá sáng tỏ tác dụng và cách sử dụng chúng ở bên dưới

Bạn đứng trên một Node Control và ra lệnh cho các server mà bạn quản lý.  Tuy nhiên vấn đề đặt ra là số lượng thao tác cần thực hiện trên các server kìa thì nhiều, nhiều server có tác dụng,nhiệm vụ giống nhau nên cần thực hiện các tháo tác giống nhau.  Vậy không lẽ bạn định gõ tay hàng trăm thậm chí hàng ngàn lệnh. Để rồi khi có một server mới, bạn lại gõ tay lại, chưa kể việc sai sót khi thao tác.  Lúc này bạn sẽ cần viết một Playbook - nơi sẽ chứa chi tiết tất cả những gì bạn muốn làm với các server từ xa kia và cách thức thực hiện chúng  Mỗi một thao tác trong Playbook gọi là một Task (Cài đặt, khởi động, dừng,....)  Ta sử dụng Module để tạo thành Task (Ví dụ: muốn cài đặt một gói trên CentOs7 ta sử dụng Module yum của Ansible).  Có việc cần làm rồi, giờ ta cần truyền thông tin chi tiết hơn về server cho Playbook chứ không thì làm sao nó biết sẽ làm việc với ai. Lúc này ta cần đến Inventory. 

II. Định dạng của Task

Một Task sẽ xác định một bước đơn lẻ.Nó thường liên quan đến việc ta sử dụng Module hay thực thi một lệnh

Nhiều Task gộp lại sẽ cho ta một công việc hoàn chỉnh.

- name: Install http package     yum:       name: httpd       state: latest 

name là một tùy chọn nhưng bạn nên sử dụng nó để đặt tên cho Task. Nó sẽ hiển thị khi Task được thực thi, giúp bạn dễ quan sát, theo dõi. Với những người sử dụng lại Playbook của bạn, họ sẽ dễ dàng đọc, hiểu Playbook hơn.

yum là Module tích hợp sẵn của Ansible giúp Ansible hiểu được bạn muốn quản lý các package trên CentOs

Task này thể hiện rằng bạn muốn cập nhật http package lên bản mới nhất. Nếu chưa có, nó sẽ được cài đặt.

III. Định dạng của Playbook

Các Playbook là các file định dạng YAML chứa một loạt các mô tả chỉ thị nhằm mục đích tự động hóa chúng trên server từ xa.

--- - hosts: centos7   become: True   tasks:   - name: Install httpd     yum:       name: httpd       state: latest   - name: Start httpd     service:       name: httpd       state: started       enabled: True 

YAML dựa vào việc thụt đầu dòng để sắp xếp cấu trúc dữ liệu. Bạn cần cẩn thận điều này khi viết Playbook và đặc biệt là khi sao chép nội dung của chúng.

Ở phía dưới, tôi sẽ cho bạn thấy một ví dụ trực quan của Playbook và giải thích chúng.

IV. Viết Playbook

Oke, tôi nghĩ là chắc bạn cũng hơi nhớ một chút gì đó về khái niệm của các thuật ngữ cơ bản rồi. Giờ ta hãy tiến sâu hơn với Playbook bằng cách tìm hiểu một số tính năng của nó. Đi kèm với đó, một số thuật ngữ được đề cập bên trên sẽ được sử dụng giúp bạn hiểu rõ hơn về chúng.

4.1 Làm việc với các biến

Các đơn giản nhất để xác định các biến là sử dụng section có tên là vars của Playbook.

Ví dụ dưới đây, ta định nghĩa biến package – biến mà sau này được sử dụng bên trong các Task

--- - hosts: centos7   become: True   vars:     package: httpd   tasks:   - name: Install httpd     yum:       name: "{{package}}"       state: latest  

Biến package có phạm vi sử dụng trên toàn Playbook

4.2 Sử dụng vòng lặp

Ta sử dụng vòng lặp khi phải lặp lại cùng một task nhiều lần, chỉ khác giá trị input.

Chẳng hạn như cài 20 package khác nhau. Chắc hẳn bạn không muốn viết đi viết lại 30 task này đúng không nào.

Để tạo một vòng lặp bên trong một task, ta sử dụng with_items kèm theo bên dưới là 1 mảng các giá trị. Ta truy xuất đến các giá trị này thông qua biến vòng lặp item

--- - hosts: centos7   become: True   tasks:   - name: Install packages     yum:       name: "{{item}}"       state: latest     with_items:     - httpd     - mariadb-server     - mariadb     - php     - php-mysql     - php-fpm   

Ta cũng có thể sử dụng kết hợp một biến mảng

--- - hosts: centos7   become: True   tasks:   - name: Install packages     yum:       name: ['httpd','mariadb-server','mariadb','php','php-mysql','php-fpm']       state: latest 

4.3 Sử dụng các điều kiện (Conditionals)

Các điều kiện được sử dụng để tự động quyết định xem liệu một task có được thực thi hay không dựa trên một biến hay một output từ một nguồn, ví dụ : output của một command.

Ví dụ

  - name: Shutdown CentOS Based Systems     command: /sbin/shutdown -t now     when: ansible_facts['distribution'] == "CentOS"  

Ở ví dụ trên tôi sử dụng một trong các biến ansible_facts (các biến đặc biệt của Ansible) là ansible_facts[‘distribution’] nhằm kiểm tra OS hiện tại của node client. Nếu node này cài CentOS thì sẽ thực hiện lệnh shutdown để tắt nó.

Một ví dụ khác

--- - hosts: centos7   become: True   tasks:   - name: Check if HTTPD is installed     register: http_installed     command: httpd -v     ignore_errors: true    - name: This task is only executed if HTTPD is installed     debug: var=http_installed     when: http_installed is success    - name: This task is only executed if HTTPD is NOT installed     debug: msg='HTTPD is NOT installed'     when: http_installed is failed 

Ở ví dụ này ta viết 3 task

  • task 1 : Chạy lệnh kiểm tra version của apache trên CentOS. Nếu đã cài apache thì lệnh sẽ chạy bình thường ; output và các giá trị trả về sẽ lưu vào biến http_installed
  • task 2 : Kiểm tra xem lệnh ở task 1 có được thực thi thành công không thông qua việc kiểm tra biến http_installed. Nếu thành công thì hiển thị nội dung của biến http_installed.
  • task 3 : Kiểm tra xem lệnh ở task 1 có được thực thi thành công không thông qua việc kiểm tra biến http_installed. Nếu không thành công thì hiển thị nội dung HTTPD is NOT installed.

4.4 Làm việc với các Template

Các template thường được sử dụng để thiết lập các tệp cấu hình, cho phép sử dụng các biến và các tính năng khác nhằm làm cho các tệp trở nên linh hoạt hơn và thuận tiện cho việc sử dụng lại chúng.

Ansible sử dụng template engine có tên Jinja2

Ví dụ:

Tôi có 1 file tên là index.html có nội dung như sau

Để ý biến my_name nhé.

Cùng với đó tôi có một playbook ở cùng folder chứa file index.html kia.

--- - hosts: centos7   become: True   vars:     my_name: 'Pham Khanh'    tasks:   - name: Test template     template:       src: index.html       dest: /var/www/html/index.html 

Node Client đã cài đặt Apache. Sau khi chạy playbook ta thu được kết quả

Ta hoàn toàn có thể sử dụng lại file index này với một cái tên khác, chỉ cần thay đổi giá trị biến my_name

4.5 Khai báo và kích hoạt các Handler

Các handler được sử dụng để kích hoạt một trạng thái nào đó của service như restart hay stop

Các handler trông khá giống các task nhưng chúng chỉ được thực thi khi được kích hoạt bởi một chỉ thị notify bên trong một task

Chúng thường được khai báo như một mảng trong phần handlers của playbook nhưng cũng hoàn toàn có thể đặt trong các tệp riêng biệt

--- - hosts: centos7   become: True   vars:     my_name: 'PhamKhanh123'   tasks:   - name: template configuration file     template:       src: index.html       dest: /var/www/html/index.html     notify:       - restart httpd   handlers:       - name: restart httpd         service:           name: httpd           state: restarted 

V. Playbook mẫu

Cuối cùng tôi sẽ đưa cho bạn một ví dụ về playbook, giải thích thêm về và đưa cho bạn cách để chạy nó.

--- - hosts: centos7   become: True   vars:     my_name: 'PhamKhanh123'     package: httpd   tasks:   - name: Install httpd     yum:       name: "{{package}}"       state: latest    - name: Check if HTTPD is installed     register: http_installed     command: httpd -v     ignore_errors: true    - name: This task is only executed if HTTPD is installed     debug: var=http_installed     when: http_installed is success    - name: This task is only executed if HTTPD is NOT installed     debug: msg='HTTPD is NOT installed'     when: http_installed is failed    - name: template configuration file     template:       src: index.html       dest: /var/www/html/index.html     notify:       - restart httpd   handlers:       - name: restart httpd         service:           name: httpd           state: restarted 

Một số điểm ta cần chú ý là:

  • host: centos7 : playbook bắt đầu bằng cách nói rằng nó sẽ được áp dụng cho một máy chủ được đặt tên là centos7 hoặc tất cả các máy chủ nằm trong nhóm centos7 bên trong inventory của bạn.
  • become: True : nói với Ansible rằng nó sẽ sử dụng leo thang đặc quyền (sudo) để chạy tất cả các task trong playbook.
  • vars : Khai báo các biến.
  • tasks : Nơi các task được khai báo.
  • handlers : Nơi các service cùng trạng thái của nó được khai báo.

Còn về mục đích của playbook thì tôi nghĩ mình không cần nhắc lại một lần nữa bởi các task nhỏ bên trong đã được tôi giải thích ở các phần trên rồi.

VI. Chạy một Playbook

Việc chạy một playbook cũng không có gì quá phức tạp

$ansible-playbook -i path_to_inventory_file path_to_playbook 
  • -i : Chỉ định đường dẫn inventory file

Bạn hãy để ý dòng cuối cùng. Đây chính là ưu điểm của Ansible.

Đó là nếu Ansible duyệt qua 1 task mà task đó đã được thực hiện trước đó rồi và không có gì thay đổi thì Ansible sẽ đi tới task tiếp theo mà không phải mất công chạy lại task đó nữa

VII. Tổng kết

Như vậy, tôi đã hướng dẫn xong cho các bạn cách để viết và chạy một playbook. Chúc các bạn viết playbook thành công !!!

Ở phần tiếp theo, chúng ta sẽ cùng nhau viết playbook cho use case cụ thể. Đó là Triển khai một trang WordPress.

Cảm ơn sự quan tâm của bạn, hi vọng sẽ có những trao đổi tại comment của bài viết này.

ONET IDC thành lập vào năm 2012, là công ty chuyên nghiệp tại Việt Nam trong lĩnh vực cung cấp dịch vụ Hosting, VPS, máy chủ vật lý, dịch vụ Firewall Anti DDoS, SSL… Với 10 năm xây dựng và phát triển, ứng dụng nhiều công nghệ hiện đại, ONET IDC đã giúp hàng ngàn khách hàng tin tưởng lựa chọn, mang lại sự ổn định tuyệt đối cho website của khách hàng để thúc đẩy việc kinh doanh đạt được hiệu quả và thành công.
Bài viết liên quan

Hướng dẫn cài đặt và sử dụng cơ bản BigBlueButton

BigBlueButton thường được viết tắt là BBB một mã nguồn mở chạy trên web phục vụ cho hội nghị...
30/12/2020

Hướng dẫn cài đặt Rclone

Giới thiệu Rclone mang đến giải pháp thực sự hữu ích để đồng bộ hóa dữ liệu của bạn với...
30/12/2020

Performance Testing [Phần 2] Hướng dẫn cài đặt Gatling trên Ubuntu 18.04

Gatling là công cụ kiểm tra tải thông minh, cao cấp, dể dàng sử dụng. Gatling hỗ trợ rất tốt giao...
30/12/2020