0. テスト環境
- テスト環境1
Ubuntu 20.04,x86
1. 導入
ansibleとは何か
- IT機器の設定（構成）に関わる煩雑な作業を自動化できる
- 米Ansible社によって開発されましたが、Ansible社を買収したレッドハット社が開発・提供
注意点
- 対象機器が少ないシーンでは向いていない
- 間違ったときの影響範囲が大きい
- 複雑な処理に対応しにくい
活用事例
A社
膨大なIT機器の棚卸しを手動で実施.（例．管理対象となるサーバーのOSや物理情報，ミドルウェアの情報等）
Ansibleの導入を進める．選定理由は導入のしやすさ.yaml形式で誰でも定義ファイルを作成できる.
棚卸しコストを50%軽減
B社
大規模なシステムを3ヶ月という短納期で納入する必要に迫られた.手動では間に合わない．
Ansibleによる構成管理の自動化を採用．
Ansibleを導入したことでサーバー環境の設定作業が自動化され、大幅に工数を削減し作業を迅速にすすめられた上にコストも節約できた．
インストール
sudo apt update
sudo apt install software-properties-common
sudo add-apt-repository --yes --update ppa:ansible/ansible
sudo apt install ansible
$ ansible --version
ansible [core 2.12.10]
config file = /etc/ansible/ansible.cfg
configured module search path = ['/home/dev/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
ansible python module location = /usr/lib/python3/dist-packages/ansible
ansible collection location = /home/dev/.ansible/collections:/usr/share/ansible/collections
executable location = /usr/bin/ansible
python version = 3.8.10 (default, May 26 2023, 14:05:08) [GCC 9.4.0]
jinja version = 2.10.1
libyaml = True
参考元
2. 使用例(Example)
-hコマンドをしてみる
よくわからないので-hコマンドをためしてみｒ
$ ansible -h
usage: ansible [-h] [--version] [-v] [-b] [--become-method BECOME_METHOD]
[--become-user BECOME_USER]
[-K | --become-password-file BECOME_PASSWORD_FILE]
[-i INVENTORY] [--list-hosts] [-l SUBSET] [-P POLL_INTERVAL]
[-B SECONDS] [-o] [-t TREE] [--private-key PRIVATE_KEY_FILE]
[-u REMOTE_USER] [-c CONNECTION] [-T TIMEOUT]
[--ssh-common-args SSH_COMMON_ARGS]
[--sftp-extra-args SFTP_EXTRA_ARGS]
[--scp-extra-args SCP_EXTRA_ARGS]
[--ssh-extra-args SSH_EXTRA_ARGS]
[-k | --connection-password-file CONNECTION_PASSWORD_FILE] [-C]
[--syntax-check] [-D] [-e EXTRA_VARS] [--vault-id VAULT_IDS]
[--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES]
[-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR]
[--task-timeout TASK_TIMEOUT] [-a MODULE_ARGS] [-m MODULE_NAME]
pattern
Define and run a single task 'playbook' against a set of hosts
positional arguments:
pattern host pattern
optional arguments:
--ask-vault-password, --ask-vault-pass
ask for vault password
--become-password-file BECOME_PASSWORD_FILE, --become-pass-file BECOME_PASSWORD_FILE
Become password file
--connection-password-file CONNECTION_PASSWORD_FILE, --conn-pass-file CONNECTION_PASSWORD_FILE
Connection password file
--list-hosts outputs a list of matching hosts; does not execute
anything else
--playbook-dir BASEDIR
Since this tool does not use playbooks, use this as a
substitute playbook directory.This sets the relative
path for many features including roles/ group_vars/
etc.
--syntax-check perform a syntax check on the playbook, but do not
execute it
--task-timeout TASK_TIMEOUT
set task timeout limit in seconds, must be positive
integer.
--vault-id VAULT_IDS the vault identity to use
--vault-password-file VAULT_PASSWORD_FILES, --vault-pass-file VAULT_PASSWORD_FILES
vault password file
--version show program's version number, config file location,
configured module search path, module location,
executable location and exit
-B SECONDS, --background SECONDS
run asynchronously, failing after X seconds
(default=N/A)
-C, --check don't make any changes; instead, try to predict some
of the changes that may occur
-D, --diff when changing (small) files and templates, show the
differences in those files; works great with --check
-K, --ask-become-pass
ask for privilege escalation password
-M MODULE_PATH, --module-path MODULE_PATH
prepend colon-separated path(s) to module library (def
ault=~/.ansible/plugins/modules:/usr/share/ansible/plu
gins/modules)
-P POLL_INTERVAL, --poll POLL_INTERVAL
set the poll interval if using -B (default=15)
-a MODULE_ARGS, --args MODULE_ARGS
The action's options in space separated k=v format: -a
'opt1=val1 opt2=val2'
-e EXTRA_VARS, --extra-vars EXTRA_VARS
set additional variables as key=value or YAML/JSON, if
filename prepend with @
-f FORKS, --forks FORKS
specify number of parallel processes to use
(default=5)
-h, --help show this help message and exit
-i INVENTORY, --inventory INVENTORY, --inventory-file INVENTORY
specify inventory host path or comma separated host
list. --inventory-file is deprecated
-k, --ask-pass ask for connection password
-l SUBSET, --limit SUBSET
further limit selected hosts to an additional pattern
-m MODULE_NAME, --module-name MODULE_NAME
Name of the action to execute (default=command)
-o, --one-line condense output
-t TREE, --tree TREE log output to this directory
-v, --verbose verbose mode (-vvv for more, -vvvv to enable
connection debugging)
Privilege Escalation Options:
control how and which user you become as on target hosts
--become-method BECOME_METHOD
privilege escalation method to use (default=sudo), use
`ansible-doc -t become -l` to list valid choices.
--become-user BECOME_USER
run operations as this user (default=root)
-b, --become run operations with become (does not imply password
prompting)
Connection Options:
control as whom and how to connect to hosts
--private-key PRIVATE_KEY_FILE, --key-file PRIVATE_KEY_FILE
use this file to authenticate the connection
--scp-extra-args SCP_EXTRA_ARGS
specify extra arguments to pass to scp only (e.g. -l)
--sftp-extra-args SFTP_EXTRA_ARGS
specify extra arguments to pass to sftp only (e.g. -f,
-l)
--ssh-common-args SSH_COMMON_ARGS
specify common arguments to pass to sftp/scp/ssh (e.g.
ProxyCommand)
--ssh-extra-args SSH_EXTRA_ARGS
specify extra arguments to pass to ssh only (e.g. -R)
-T TIMEOUT, --timeout TIMEOUT
override the connection timeout in seconds
(default=10)
-c CONNECTION, --connection CONNECTION
connection type to use (default=smart)
-u REMOTE_USER, --user REMOTE_USER
connect as this user (default=None)
Some actions do not make sense in Ad-Hoc (include, meta, etc)
記事の内容理解 & テスト 1
導入メリット：
Ansibleサーバーだけにansible入れればいい，被管理サーバーにAnsibleの導入は不要
いくつかコマンドがあるがansible-playbackコマンドを使用するのが一般的．
ansible-playbookコマンドを実行する際には、PlaybookファイルとInventoryファイルが必要
- playbookファイル：、被管理サーバーに対して設定する内容を記述したテキストファイル（YAMLフォーマット）で、パッケージ管理、ユーザー管理、ファイルやディレクトリ操作、サービス操作など、さまざまな設定が可能
- Inventoryファイル：被管理サーバーの接続情報を定義するテキストファイルで、主に被管理サーバーのホスト名やIPアドレスのリストを記載するほか、被管理サーバーにアクセスする際に使用するユーザーID、パスワードやSSH鍵、被管理サーバーに導入されているPythonのパス、といった情報を記載
コマンド実行イメージ
$ ansible-playbook␣-i␣Inventoryファイルパス␣Playbookファイルパス
引用
- Ansibleを利用するには何が必要か
Ansibleサーバーの要件は、Linux、mac OSが導入されているサーバー、もしくはPCが１台必要で、Python 2.7もしくはPython 3.5以上が導入されている必要がある（ただしPython 2のサポートは2020年４月に終了しているため、Python 3の使用を推奨）
ハードウェアのスペックの要件はとくになく、低いスペックでも十分に動作可能である。Windowsはサポート対象外であるが、たとえばWSL（Windows Subsystem for Linux）を使用すれば、Windows環境上でもAnsibleを動作させられる。
構成管理ツールか、それとも自動化ツールか
本稿ではAnsibleは構成管理ツールであると紹介したが、Ansibleの動作の概要から考えると、自動化（自動構成）ツールではないかと疑問に思う読者もいるだろう。
実際、Ansibleは自動化ツールとしての側面も備えている。Ansibleが単なる自動化ツールではなく、構成管理ツールである理由として冪等性（べきとうせい）を担保していることが挙げられる。
冪等性とは、ある操作を何度繰り返しても結果が同じであるという概念である。
Ansibleの場合は、ansible-playbookコマンドでPlaybookを適用した被管理サーバーに再び同じPlaybookを適用しても、設定内容に違いが生じないことを意味している。
引用
たとえば、2重のパラメータ設定や2重のファイル生成などを行わず、すでに求められた設定や操作が行われているのであれば、その設定や操作を行わずにスキップする。
そのためサーバーごとにPlaybookが適用済みであるかどうかを確認する必要はなく、適用済みであろうと、未適用であろうと、まとめて同じPlaybookを適用すればよい。
記事を試してみる その2
1つのモジュールを実行
192.168.33.11サーバーに対して pingモジュール を実行しているそう.pingを実装させた?モジュールにはどのようなものがあるのかな？
ansible 192.168.33.11 -m ping
自身の環境で,自分のpcに対してテスト
$ ansible 127.0.0.1 -m ping
127.0.0.1 | SUCCESS => {
"changed": false,
"ping": "pong"
}
以下,失敗...
$ ansible 127.0.0.1 -m echo "hello"
モジュールの種類
参考: Ansibleでよくつかうモジュール6選
https://dev.classmethod.jp/articles/ansible-my-reference/
file
copy
template
service
lineinfile
yum
file：ファイルやディレクトリの作成や権限変更、削除の処理を行うことができます。
-
/tmp/work/ec2-userディレクトリを作成する例
- name: Make Work Directory
file:
path: /tmp/work/ec2-user
state: directory
owner: ec2-user
group: ec2-user
mode: 0755
path…操作対象のファイルパス指定。
state…操作対象の種別（file、directory、link等）を指定。
owner…所有者ユーザの指定。
group…所有者グループの指定。
mode…権限の指定。
より詳細：https://docs.ansible.com/ansible/latest/collections/ansible/builtin/file_module.html#file-module
または下記コマンド
ansible-doc file
- 自分の環境でテスト
copy
コントローラノードに存在するファイルを、ターゲットノードに送信することができる
ターゲットノードにhttpd.confを送信する例
- name: Copy Config File
copy:
src: httpd.conf
dest: /etc/httpd/conf
mode: 0644
backup: yes
src…コントローラノードにある送信対象のファイルパス。パスが/で終わる場合は、そのディレクトリ内のファイルが送信され、パスが/で終わっていない場合は、ディレクトリ自体が送信されます。
dest…送信先であるターゲットノードの絶対パスを指定。
mode…権限の指定。
backup…ファイルの送信前にバックアップファイルを取得。
記事内容理解３
OSインストールを自動化するには、【Kickstart】や【Cobbler】等が必要
/etc/ansible/hosts: Ansible用hostsファイル, AnsibleおけるDefaltのInventory
client pc内でipを指定したping