💡 このチュートリアルは英語版からAIによって翻訳されています。原文を確認するには、 ここをクリックしてください
Ansible は、インフラストラクチャ管理とデプロイを簡素化する、広く利用されている IT 自動化ツールです。この実験（Lab）では、Ansible を使用して、ファイルとディレクトリを詳細形式でリスト表示する方法を探求します。Ansible のセットアップ、プレイブックの作成、および組み込みモジュールを使用して、リモートシステムからファイル情報をリスト表示する方法を学びます。この実験（Lab）の終わりには、自動化ワークフローを強化できる Ansible コマンドとテクニックに関する実践的な経験が得られます。
このステップでは、システムに Ansible をインストールし、ローカル環境を管理するための基本的なインベントリファイルを作成します。
まず、パッケージマネージャーを使用して Ansible をインストールしましょう。
sudo apt update
sudo apt install -y ansibleインストールが完了したら、バージョンを確認して Ansible が正しくインストールされていることを確認します。
ansible --version次のような出力が表示されるはずです。
ansible [core 2.12.0]
config file = /etc/ansible/ansible.cfg
configured module search path = ['/home/labex/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
ansible python module location = /usr/lib/python3/dist-packages/ansible
ansible collection location = /home/labex/.ansible/collections:/usr/share/ansible/collections
executable location = /usr/bin/ansible
python version = 3.10.x (default, Ubuntu 22.04)
jinja version = 3.0.3
libyaml = Trueインベントリファイルは、Ansible が操作できる管理対象ノードのリストです。この実験（Lab）では、ローカルマシンを含むシンプルなインベントリファイルを作成します。
Ansible プロジェクト用のディレクトリを作成します。
mkdir -p ~/project/ansible-lab
cd ~/project/ansible-lab次に、VS Code エディターを使用してインベントリファイルを作成します。
~/project/ansible-lab ディレクトリに移動します。inventory.ini とします。[local]
localhost ansible_connection=localこのインベントリファイルは、local というグループを定義し、ローカルホストのみを含み、Ansible が SSH を使用するのではなくローカルに接続するように指定します。
デフォルト設定を指定するための基本的な Ansible 設定ファイルを作成しましょう。
ansible-lab ディレクトリを右クリックし、「New File」を選択します。ansible.cfg とします。[defaults]
inventory = inventory.ini
host_key_checking = Falseこの設定ファイルは、Ansible にデフォルトで inventory.ini ファイルを使用するように指示し、実験（Lab）環境に役立つ SSH ホストキーチェックを無効にします。
簡単なコマンドを実行して、Ansible のセットアップをテストしましょう。
cd ~/project/ansible-lab
ansible local -m ping次のような出力が表示されるはずです。
localhost | SUCCESS => {
"changed": false,
"ping": "pong"
}これにより、Ansible が正しく設定され、ローカルマシンと通信できることが確認されます。
このステップでは、ファイルとディレクトリをリスト表示するための基本的な Ansible プレイブックを作成します。プレイブックは、管理対象ノードで実行される一連のタスクを定義する YAML ファイルです。
プレイブックを作成する前に、プレイブックとは何かを理解しましょう。
/etc ディレクトリの内容をリスト表示するシンプルなプレイブックを作成しましょう。
~/project/ansible-lab ディレクトリに移動します。list_files.yml とします。---
- name: List files and directories
hosts: local
tasks:
- name: Get directory listing
command: ls -l /etc
register: directory_contents
- name: Display directory contents
debug:
var: directory_contents.stdout_linesこのプレイブックが何をするのかを理解しましょう。
---) は、YAML ドキュメントの開始を示します。name: List files and directories は、プレイの説明的な名前です。hosts: local は、このプレイが local グループ（インベントリで定義）のホストで実行されることを指定します。tasks: は、実行するタスクのリストを開始します。ls -l /etc を実行し、結果を directory_contents という変数に格納します。directory_contents.stdout_lines 変数の内容を表示します。それでは、プレイブックを実行しましょう。
cd ~/project/ansible-lab
ansible-playbook list_files.yml次のような出力が表示されるはずです。
PLAY [List files and directories] *****************************************************
TASK [Gathering Facts] ****************************************************************
ok: [localhost]
TASK [Get directory listing] **********************************************************
changed: [localhost]
TASK [Display directory contents] *****************************************************
ok: [localhost] => {
"directory_contents.stdout_lines": [
"total 1088",
"drwxr-xr-x 2 root root 4096 Apr 15 12:34 acpi",
"drwxr-xr-x 3 root root 4096 Apr 15 12:34 alternatives",
"-rw-r--r-- 1 root root 3028 Aug 1 2017 bash.bashrc",
"drwxr-xr-x 2 root root 4096 Apr 15 12:34 bash_completion.d",
"... [more files and directories] ..."
]
}
PLAY RECAP ***************************************************************************
localhost : ok=3 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0出力には、/etc ディレクトリの内容が詳細形式で表示され、パーミッション、所有者、グループ、サイズ、および変更日が含まれています。
次に、プレイブックを変更して、/home/labex ディレクトリの内容をリスト表示してみましょう。
list_files.yml ファイルを開きます。/etc から /home/labex に変更します。---
- name: List files and directories
hosts: local
tasks:
- name: Get directory listing
command: ls -l /home/labex
register: directory_contents
- name: Display directory contents
debug:
var: directory_contents.stdout_linesプレイブックをもう一度実行します。
ansible-playbook list_files.yml出力には、/etc ではなく、/home/labex ディレクトリの内容が表示されるようになります。
前のステップでは、command モジュールを使用して ls -l コマンドを実行しました。これは機能しますが、Ansible はファイルとディレクトリを扱うためにより専用のモジュール、ansible.builtin.file モジュールを提供しています。このステップでは、このモジュールと ansible.builtin.find モジュールを組み合わせて、より Ansible ネイティブな方法でファイルをリスト表示する方法を学びます。
ansible.builtin.find モジュールは、特定の条件に一致するファイルを検索するように設計されています。command モジュールと比較して、より強力で柔軟な方法でファイルをリスト表示できます。
find モジュールを使用する新しいプレイブックを作成しましょう。
~/project/ansible-lab ディレクトリに移動します。find_files.yml とします。---
- name: Find files with Ansible
hosts: local
tasks:
- name: Find all files in /etc
ansible.builtin.find:
paths: /etc
file_type: any
register: found_files
- name: Display the first 10 files
debug:
var: found_files.files[:10]このプレイブックは、find モジュールを使用して /etc ディレクトリ内のすべてのファイルとディレクトリを検索し、最初の 10 個の項目を表示します。
プレイブックを実行しましょう。
cd ~/project/ansible-lab
ansible-playbook find_files.yml各ファイルに関する詳細情報を含む出力が表示されるはずです。これには以下が含まれます。
次に、すべての詳細を含む長形式でファイルを表示する、より包括的なプレイブックを作成しましょう。
long_format.yml とします。---
- name: List files in long format
hosts: local
tasks:
- name: Find files in /etc
ansible.builtin.find:
paths: /etc
file_type: any
recurse: no
register: found_files
- name: Create a formatted list of files
set_fact:
formatted_files: "{{ formatted_files | default([]) + [item] }}"
loop: "{{ found_files.files }}"
loop_control:
label: "{{ item.path }}"
vars:
item_info: >-
{{ item.mode }} {{ item.uid | string | ljust(5) }}
{{ item.gid | string | ljust(5) }} {{ item.size | string | ljust(10) }}
{{ item.mtime | string | ljust(11) }} {{ item.path }}
- name: Display files in long format
debug:
msg: "{{ formatted_files[:10] }}"このプレイブックは次のことを行います。
find モジュールを使用して、/etc ディレクトリ内のファイルを検索します。ls -l コマンドの出力に似た形式のリストを作成します。プレイブックを実行しましょう。
ansible-playbook long_format.yml出力には、ls -l コマンドと同様の形式でファイルの詳細が表示されます。
Ansible のモジュールを使用する利点の 1 つは、さまざまな条件に基づいてファイルをフィルタリングできることです。.conf で終わるファイル（設定ファイル）のみをリスト表示するプレイブックを作成しましょう。
filter_files.yml とします。---
- name: List filtered files in long format
hosts: local
tasks:
- name: Find configuration files in /etc
ansible.builtin.find:
paths: /etc
patterns: "*.conf"
file_type: file
register: conf_files
- name: Display configuration files
debug:
msg: "{{ item.mode }} {{ item.uid }} {{ item.gid }} {{ item.size }} {{ item.mtime }} {{ item.path }}"
loop: "{{ conf_files.files }}"
loop_control:
label: "{{ item.path }}"このプレイブックは次のことを行います。
find モジュールを使用して、.conf で終わる /etc ディレクトリ内のファイルを検索します。プレイブックを実行しましょう。
ansible-playbook filter_files.yml出力には、/etc ディレクトリ内の .conf ファイルの詳細のみが表示されます。
find モジュールの出力を従来の ls -l コマンドと比較するために、もう 1 つプレイブックを作成しましょう。
compare_methods.yml とします。---
- name: Compare listing methods
hosts: local
tasks:
- name: Get directory listing with ls command
command: ls -l /etc/passwd
register: ls_output
- name: Get file info with find module
ansible.builtin.find:
paths: /etc
patterns: "passwd"
file_type: file
register: find_output
- name: Display ls command output
debug:
var: ls_output.stdout_lines
- name: Display find module output
debug:
var: find_output.files[0]このプレイブックは次のことを行います。
command モジュールを使用して、/etc/passwd ファイルに対して ls -l を実行します。find モジュールを使用して、同じファイルを検索します。プレイブックを実行しましょう。
ansible-playbook compare_methods.ymlこれで、2 つの方法の違いを確認できます。
ls -l コマンドは、従来の Unix 形式の単一行のテキストを提供します。find モジュールは、Ansible で操作できる構造化データオブジェクトを提供します。このステップでは、ファイルリスト表示のための Ansible ロールを作成する方法を学びます。ロールは、プレイブックを整理し、再利用性を高める方法です。これは、複数のプレイブックまたはプロジェクトで同じタスクを実行する必要がある場合に特に役立ちます。
Ansible ロールは、標準のディレクトリ構造にグループ化された一連のタスク、変数、ファイル、テンプレート、およびその他のリソースです。ロールを使用すると、コードを簡単に再利用し、他のユーザーと共有できます。
ロールの標準的なディレクトリ構造は次のようになります。
roles/
rolename/
tasks/ ## ロールのメインタスク
handlers/ ## タスクによってトリガーされるハンドラー
defaults/ ## デフォルト変数
vars/ ## ロール変数
files/ ## 静的ファイル
templates/ ## テンプレート
meta/ ## ロールのメタデータ長形式でファイルをリスト表示するためのロールを作成しましょう。
cd ~/project/ansible-lab
mkdir -p roles/file_lister/taskscd ~/project/ansible-lab~/project/ansible-lab/roles/file_lister/tasks に移動します。main.yml とします。---
## Tasks for file_lister role
- name: Find files in the specified directory
ansible.builtin.find:
paths: "{{ path | default('/etc') }}"
patterns: "{{ patterns | default('*') }}"
file_type: "{{ file_type | default('any') }}"
recurse: "{{ recurse | default(false) }}"
register: found_files
- name: Display files in long format
debug:
msg: "{{ item.mode }} {{ item.uid }} {{ item.gid }} {{ item.size }} {{ item.mtime }} {{ item.path }}"
loop: "{{ found_files.files | sort(attribute='path') }}"
loop_control:
label: "{{ item.path }}"
when: show_details | default(true)
- name: Display only file paths
debug:
msg: "{{ item.path }}"
loop: "{{ found_files.files | sort(attribute='path') }}"
loop_control:
label: "{{ item.path }}"
when: not (show_details | default(true))このロールは次のことを行います。
次に、新しいロールを使用するプレイブックを作成しましょう。
~/project/ansible-lab ディレクトリに移動します。use_role.yml とします。---
- name: Use file listing role
hosts: local
roles:
- role: file_lister
vars:
path: "/etc"
patterns: "*.conf"
file_type: "file"
show_details: trueこのプレイブックは次のことを行います。
file_lister ロールを使用します。プレイブックを実行しましょう。
cd ~/project/ansible-lab
ansible-playbook use_role.yml/etc ディレクトリ内のすべての .conf ファイルの詳細を示す出力が表示されるはずです。
ロールの利点の 1 つは、変数を変更することでその動作を簡単にカスタマイズできることです。異なるパラメータを使用してロールを使用する別のプレイブックを作成しましょう。
custom_listing.yml とします。---
- name: Custom file listing
hosts: local
roles:
- role: file_lister
vars:
path: "/home/labex"
patterns: "*.yml"
file_type: "file"
show_details: falseこのプレイブックは次のことを行います。
file_lister ロールを使用します。/home/labex ディレクトリを検索するように設定します。プレイブックを実行しましょう。
ansible-playbook custom_listing.yml詳細情報なしで、/home/labex ディレクトリ内のすべての YAML ファイルのリストが表示されるはずです。
最後に、ロールを使用してファイルのレポートを生成する、より高度なプレイブックを作成しましょう。
generate_report.yml とします。---
- name: Generate file listing report
hosts: local
vars:
report_path: "~/project/ansible-lab/file_report.txt"
tasks:
- name: Find files in the specified directory
ansible.builtin.find:
paths: "/etc"
patterns: "*.conf"
file_type: "file"
register: found_files
- name: Create report header
copy:
dest: "{{ report_path }}"
content: |
File Listing Report
Generated on: {{ ansible_date_time.date }} at {{ ansible_date_time.time }}
-----------------------------------------------------------
Mode Owner Group Size Modified Path
-----------------------------------------------------------
force: yes
- name: Append file information to report
lineinfile:
path: "{{ report_path }}"
line: "{{ item.mode }} {{ item.uid }} {{ item.gid }} {{ item.size | string | ljust(10) }} {{ item.mtime }} {{ item.path }}"
loop: "{{ found_files.files | sort(attribute='path') }}"
loop_control:
label: "{{ item.path }}"
- name: Display report location
debug:
msg: "Report generated at {{ report_path }}"このプレイブックは次のことを行います。
/etc ディレクトリ内の .conf ファイルを検索します。プレイブックを実行しましょう。
ansible-playbook generate_report.ymlプレイブックを実行した後、レポートを表示できます。
cat ~/project/ansible-lab/file_report.txt/etc ディレクトリ内のすべての .conf ファイルをリスト表示する、フォーマットされたレポートが表示されるはずです。
この実験では、Ansible を使用してファイルとディレクトリを長形式でリスト表示する方法を学びました。以下の実践的な経験を積みました。
ls -l コマンドを実行するために command モジュールを使用する基本的なプレイブックを作成するこれらのスキルは、インフラストラクチャ全体でファイル管理タスクを自動化し、ファイルリスト表示をより大規模な自動化ワークフローに統合するのに役立ちます。Ansible を使い続けることで、これらの概念に基づいて、環境全体でファイル、ディレクトリ、およびそれらのパーミッションを管理する、より複雑な自動化を作成できます。
