Ansible AWX のバックアップ

#目次

• 1. はじめに
• 2. tower-cliインストール
• 3. tower-cli使用方法
• 4. オブジェクトのエクスポート
• 5. リストア
• 6. cronで管理
• 7. おわりに
• 8. 技術情報
• 9. 参考URL

#1. はじめに
Ansible AWXはコンテナで動作しているため、初めはコンテナごとバックアップしようと考えていましたが、リストアの際にリスクが大きいと思い、他の手段を模索していたところtower-cliコマンドを発見しました。
簡易的ではありますが、バックアップのようなことが行えることがわかりましたので、使用方法をまとめます。

#2. tower-cli インストール
前提としてpipコマンドを使用できる環境でインストールしてください。
手順ではvirtualenv環境を使用し実行しています。

※仮想環境を作る場合は以下を行うこと
[root@localhost ~]# dnf install python3 -y
[root@localhost ~]# python3 -m venv venv
[root@localhost ~]# source venv/bin/activate
(venv) [root@localhost ~]#

tower-cliをインストールします。

(venv) [root@localhost ~]# pip install ansible-tower-cli

インストールを確認します。

(venv) [root@localhost ~]# pip freeze
ansible-tower-cli==3.3.9

#3. tower-cli使用方法
実際にコマンドを操作してみます。
まずconfigを確認します。

(venv) [root@localhost ~]# tower-cli config

# Defaults.
format: human
certificate:
username:
use_token: False
oauth_token:
verify_ssl: True
insecure: False
description_on: False
password:
verbose: False
host: 127.0.0.1
color: True

Ansible AWXの情報をconfigに設定します。
hostにはhttp(https)でAnsible AWXの宛先を設定します。

(venv) [root@localhost ~]# tower-cli config host http://"ansible awx IP"/
Configuration updated successfully.

usernameはAnsible AWXのログインユーザを設定します。

(venv) [root@localhost ~]# tower-cli config username admin
Configuration updated successfully.

passwordはログインパスワードを設定します。

(venv) [root@localhost ~]# tower-cli config password password
Configuration updated successfully.

ssl証明書の確認を無効にします。

(venv) [root@localhost ~]# tower-cli config verify_ssl false
Configuration updated succe

設定後に確認してみます。
以下のようになっていれば設定完了です。

(venv) [root@localhost ~]# tower-cli config

# User options (set with `tower-cli config`; stored in ~/.tower_cli.cfg).
host: http://"ansible awx IP"/
username: admin
password: password
verify_ssl: False

# Defaults.
description_on: False
format: human
use_token: False
color: True
insecure: False
verbose: False
certificate:
oauth_token:

#4. オブジェクトのエクスポート
Ansible AWXでオブジェクトはテンプレート、プロジェクト、インベントリ、などのことを示しています。
ファイル名は任意です。以下のようにコマンドを記載すれば実行日時で保存されます。

(venv) [root@localhost ~]# tower-cli receive --all > `date +%Y%m%d_%H-%M-%S`.jcon

ファイルを確認します。

(venv) [root@localhost ~]# ls
20200714_02-22-59.jcon

#5. リストア
エクスポートしたファイルを使用し実行します。

(venv) [root@localhost ~]# tower-cli send 20200714_02-22-59.jcon

以下例としてAWX インベントリにtest_inventoryが存在する場合(○)存在しない場合(×)の挙動になります。

バックアップ時	バックアップ後	設定値の変更	リストア結果
test_inventory　○	test_inventory ○	有	設定値が上書きで復元される
test_inventory　×	test_inventory ○	-	復元なし。バックアップ後に存在するオブジェクトも削除されない
test_inventory　○	test_inventory ×	-	オブジェクトごと復元される

実態はREST APIでPOSTしているようです。

#6. cronで管理する
項番5のエクスポートを定期的に行い、cronで世代管理を行います。
まずバックアップ用のディレクトリを作成しておきます。

(venv) [root@localhost ~]# mkdir awx_backup_dir

スクリプトは以下のような感じで作成し、cron.weeklyやmonthlyなどに格納すればその周期で実行され管理することができます。

(venv) [root@localhost ~]# vi ansible_awx_backup
#!/bin/bash

PATH=/user/local/sbin:/user/bin:/bin
backup_dir=/root/awx_backup_dir

# 仮想環境に切り替える
source /root/venv/bin/activate

# ディレクトリを移動する
cd ${backup_dir}

# オブジェクトをエクスポートする
tower-cli receive --all > `date +%Y%m%d_%H-%M-%S`.jcon

# 5世代分残し以降の世代を削除する
ls -t ${backup_dir} | tail -n +6 | xargs -r rm -rf

#7. おわりに
Ansible Towerでのバックアップはsetup.shファイルを使用すれば簡単に出来ますが、Ansible AWXではどのように行うのか気になったのでまとめてみました。
検証中に誤ってオブジェクトを削除してしまったりしてもバックアップを取っていれば安心ですね。

#8. 技術情報
Ansibleの入門者向け学習ガイド(CentOS編)やAnsibleの入門者向け学習ガイド(Windows編)など入門者向けの記事を執筆しています。
また、Ansible-Vaultを使用した暗号化の方法も執筆していますので、ご参考にしていただければと思います。

#9. 参考URL
https://www.unixarena.com/2019/03/backup-restore-ansible-awx-tower-cli.html/
https://docs.ansible.com/ansible-tower/3.1.4/html_ja/towerapi/tower_cli.html