Ansible の Role を Ansible Galaxy に登録し再利用 #GitHub

はじめに

前回、CentOS 7(REHL 7) 初期設定 Ansible 編にて、Ansible の Playbook の作成方法について、簡単ですが記載しました。今回は、前回作成したロールを Ansible Galaxy¹ に登録し、いつでも簡単に取り出して再利用できるようにする方法を紹介します。

Ansible Galaxy に登録する前準備

GitHub に空のプロジェクトを作成するところから始めます。Ansible Galaxy に登録する準備として、２つの方法があります。

1.コマンドを実行してテンプレートを作成して始める方法（初めての場合こちらをおススメ）

テンプレート作成

ansible-galaxy init (ロール名=GitHubプロジェクト名)

2.一度作成した roles の下から抜き出して作成する方法

重要な作業：「 meta/main.yml 」の記載

単純なロールに meta/main.yml を記載するだけで Ansible Galaxy に保存することができるようになります。meta/main.yml が作成できたら、GitHubに登録しておくことで事前準備完了です。以下、meta/main.ymlの記載例を紹介します。

meta/main.yml記載方法


galaxy_info:
  author: kouji kojima # 作成者
  description: sample-ansible-el7-init # ロールの説明
  company: your company (optional) # 会社名(任意)

  Some suggested licenses: # ライセンス
  - Apache
  license: Apache License Version 2.0

  min_ansible_version: 2.5.0 # Ansibleのバージョン

  platforms: # プラットフォーム(EL：RHEL,CentOSの意味)
  - name: EL
    versions:
    - 7

  galaxy_tags: # ロールのタグ
    - EL7
    - init
    - locale
    - timezone
    - proxy

dependencies: # 依存するロール
- kouji-kojima.ロール名

Ansible Galaxy と GitHub を紐づける

Ansible Galaxy のサイトから Signin with GitHub でログインします。

ログインしたら、ユーザー名のボタンから My Imports を選択します。

「＋ADD 」ボタンを押します。

Search ボックスの横のリロードマークを押します。

Ansible Galaxy が GitHub とうまく連携ができていたら、GitHub に上げたAnsible Role に関係するプロジェクトの一覧が表示されます。
プロジェクト名の左の ☑ ボタンをクリックすることで Ansible Galaxy へ Role 登録がスタートします。最後にステータスが Succeeded になったら登録完了です。
また GitHub のソースを変更した場合も ☑ ボタンで更新されます。

登録が完了したら、プロジェクト名のリンクを押してみます。すると meta/main.yml の情報が表示されます。

また、README のタブには GitHub にアップした README.md の情報も表示されるようになっています。

登録したロールを再利用する方法

最後に、今回登録したロールを実際に使ってみます。

1.まずロールをローカル(ansibleサーバ)にインストール²します。

インストール方法

ansible-galaxy install kouji-kojima.sample-ansible-el7-init(ユーザ名.ロール名)

インストール先

~/.ansible/roles/kouji-kojima.sample-ansible-el7-init

2.お好きな場所に site.yml を作成します。

site.yml作成例

cat << EOF > site.yml
- hosts: servers
  remote_user: ec2-user
  become: yes # デフォルト root
  #become_user: xxx
  vars:
    val1: xxxxx # README を 見て変数が必要であれば
    val2: yyyyy
  roles:
    # ロールを指定すると勝手にインストール先を見てくれます。
    # dependencies に 記載されているロールが先に実行されます。
    - { role: kouji-kojima.sample-ansible-el7-init }
EOF

3.site.yml と同じディレクトに hosts を作成します。

hostsの作成例(staging環境の場合)

cat << EOF > staging
[servers]
HostName or IP
HostName or IP

[all:vars]
ansible_ssh_user=ec2-user
EOF

4.実行してみます。

実行例

# 実行例
ansible-playbook -i staging site.yml --private-key=/path/key.pem
# デバッグ実行例
ansible-playbook -i staging site.yml --private-key=/path/key.pem -vvv

さいごに

具体的なソースは GitHub をご参照ください。
GitHub 依存無の場合と GitHub 依存有の場合のサンプルを用意しました。

Ansible Galaxy とは Ansible のコンテンツ(ロール)を検索、再利用、共有するための HUB ・・・Ansible Galaxy HP より引用 ↩
meta/main.yml の dependencies に記載したロールも一緒にインストールされます。 ↩

Ansible の Role を Ansible Galaxy に登録し再利用