25 Mar 2019, 15:22

AnsibleのTerraform moduleを考察してみる

気がつけば、2018年度も終了間際で時の流れの速さを実感しています。
はい。@mosuke5です。

Ansibleのmodule(モジュール)でTerraformが知らぬ間にできていたので、 さっそく触ってみたのと、その有用性や使いみちについて考えてみました。
terraform – Manages a Terraform deployment (and plans)

Terraformでクラウド環境のセットアップをして、その後にそのクラウド環境のサーバに対してプロビジョニングすることが一気通貫でできるようになります。素晴らしいことですね。 一方、こちらのツールを使ってみると、実現にあたっていろいろと工夫しなければ行けない点が出てきたのでご紹介していきます。

AnsibleのTerraform module

Ansibleはもともと?サーバのconfigurationの自動化のツールとして発達し、 ファイルの配置だったり、yumやaptなどのパッケージマネジメント、シェルの実行だったり多くのmoduleを用意しています。 最近では、単なるサーバへのプロビジョニングを超えて、クラウドリソースの制御などもできるようになっており、使い方の幅が広がってきています。 今回発見したのは、クラウド上のリソース管理に強みをもつTerraform(自分が好きなツールでもある)をAnsibleから実行するmoduleが出ていました。 TerraformとAnsibleはカバーする領域が異なりますが、もちろんかぶる領域もあり、今回はその組み合わせ方の1つのあり方かなと思っています。

まずは最小限で試したかったのでこんな感じで用意しました。
terraform_module_test.ymlがAnsibleの実行Taskが記載されたファイルで、terraform/以下がTerraformの実行ファイルを置いています。

% tree
.
├── terraform_module_test.yml
└── terraform
    ├── outputs.tf (こちらはなくていい)
    ├── terraform.tf
    └── terraform.tfvars

以下はAnsibleのコードです。Terraformを実行するのは今回はローカル環境なので、実行の対象ホストはこのPCで、接続方式もlocalで問題ないです。Terraform moduleは機能自体も多くなく、Terraformを実行(apply)するだけなら下記だけで十分です。

# terraform_module_test.yml
---
- hosts: 127.0.0.1
  connection: local
  tasks:
  - name: Exec terraform scripts
    terraform:
      project_path: 'terraform/'
      state: present

さて、実行してみます。まああっさり。これだけじゃつまらんって感じです。

$ ansible-playbook terraform_module_test.yml
PLAY [127.0.0.1] ******************************************************************

TASK [Gathering Facts] ************************************************************
ok: [127.0.0.1]

TASK [Exec terraform scripts] *****************************************************
changed: [127.0.0.1]

PLAY RECAP ************************************************************************
127.0.0.1                  : ok=0    changed=1    unreachable=0    failed=0

クラウド構築とサーバプロビジョニングの一連の流れを考える

AnsibleからTerraformが実行できるとなると、まっさきにやりたいと思うのが、 Terraformでサーバなどのインフラ作って、Ansibleで作ったサーバに対してデプロイのフローを一気通貫でやりたいということでしょう。 こちら実際にやってみたのですが、いくつか実装上の工夫点が必要だったのでお伝えします。

※以下、試行錯誤の過程を書いてますのでご了承ください。

一番はじめに考えたのは、Ansibleベストプラクティスに則って、以下のようなsite.yml作ればそれで終わりや。ということでした。

# site.yml
---
- import_playbook: setup_cloud.yml          # クラウドインフラ構築
- import_playbook: provisioning_config.yml  # 構築したインフラにプロビジョニング

ですが、Ansibleを普段触っている人ならお気づきかと思いますが、 このまま実行しても正しくプロビジョニングされません。 それもそのはずで、Ansible実行時にはプロビジョニングするサーバの対象がわからないからです。

と、まあそこでDynamic Inventryの話がでてくるわけです。 Dynamic Inventryの作り方はいろいろありますが、ここでは簡易的にシェルスクリプトで、 Terraformのstateファイルから生成することにしておきます。 inventry.shというのを次のように雑に書きまして。。

#!/bin/sh
if [ -e terraform/terraform.tfstate ]; then
    ip=`cat terraform/terraform.tfstate | jq '.modules[].outputs[].value' | cut -d '"' -f 2`
    cat << EOS
{
    "cloud_servers"  : [ $ip ]
}
# 実行するとこんな感じにと
$ ./inventry.sh
{
    "cloud_servers"  : [ 47.74.155.39,47.88.168.127,47.88.169.94 ]
}

Dynamic Inventryもできるようになったので、今度こそこれでいけると思って実行して見るわけですが、skipping: no hosts matchedと。 実はもう一つ考慮しなければいけないことに気づきました。

$ ansible-playbook -i ./inventry.sh site.yml -u sshuser
...
PLAY [Provisioning to instances] *************************************************
skipping: no hosts matched

それは、サーバのIPアドレスが決まるのはTerraformの実行が終わったあとになります。 一方、AnsibleでDynamic Inventryを作ったのはAnsibleの実行時です。 そうなると、Terraformの実行とその後のサーバプロビジョニングがこのままでは一気通貫にできないということになります。

なんかいい方法はないのかと調べると、refresh_inventryというのがありました。(公式ドキュメント) こちらを使って、Ansibleの実行中にTaskとしてinventryの更新が可能になります。

- name: Refresh inventory because of creating cloud servers
  meta: refresh_inventory

その他、サーバ起動した直後だとSSHのプロセスが上がっておらず、接続できないこともあったので、 サーバの起動を待つというのも大事な要素になりました。

つまり

いろいろと試行錯誤過程を書いてしまいましたが、下記を考慮しておかなければいけなさそうということです。 今回の実装例についてはAlibaba Cloudの例にはなりますがGithubにコードをあげてあります。
もしもっと効率的なやりかたあるよって方はぜひ教えてくださいm(_ _)m

  1. Dynamic Inventry
  2. Inventryの更新
  3. サーバ起動までのWait

全体を図にすると今感じです。
invoking_terraform_from_ansible

TerraformとAnbileの棲み分けの話

冒頭でも少し書いたのですが、TerraformとAnsible、異なるカバー領域をもつ製品だと私は認識していますが、一方で領域が被る部分もあると思っています。この2つを一緒に使う方法についてレッドハットのホワイトペーパーをみつけました。

このホワイトペーパーにも一緒に使う方法として以下2つがあると書かれていて、今回は後者の方の使い方をご紹介した形になります。 この2つは正解、不正解ではなく、管理する人の立場によって大きく変わると書かれています。

  1. TerraformからAnsibleを実行する方法
  2. AnsibleからTerraformを実行する方法

また、前者の方については少しアプローチが違いますが、過去に「Terraform+ユーザデータ+Ansibleでのサーバプロビジョニングを活用する」書いたことがありますので、合わせて読んでみてください。

おまけ

こんなのも見つけました。
terraform-inventory
https://github.com/adammck/terraform-inventory

関連する記事はこちら
  • Kubernetes上のリソースをTerraformで管理するメリットとデメリット (2019/03/07)
  • Terraformのimportの使い方と注意ポイント (2018/06/20)
  • Terraformのbackend機能を利用してstateファイルを共有する (2018/06/17)
  • Terraform workspaceを利用して環境毎のリソース名の変更を行う (2018/06/16)
  • Terraformで複数リージョンをまたいだリソース制御する (2018/06/08)
  • comments powered by Disqus
    このエントリーをはてなブックマークに追加