🐟

terraform-provider-mackerel で URL外形監視を 2 秒(+α)で始める

2021/05/10に公開

このエントリは @sogaoh の Mackerel Ambassador としての記事 その8です。
(かなり久々 😅 ・・・一覧は こちら

先日 GitHub Pages でちょっとしたページ [1] を立ち上げたので、 URL外形監視を入れておきたいなと思いました。
が、そんなに多いわけでもないのですが、全部を手で入れていくのはちょっと嫌だなと思ってしまったのです。

手動で外形監視を設定する場合にたどる STEPS

ちょっと想像を膨らませました。数が 100 とかになったら手で入れたくないな、と。
そこで、alpha 公開してもらった v0.0.1-alpha20210507 を使ってみることにしました。

https://github.com/mackerelio-labs/terraform-provider-mackerel/releases/

準備 : カスタムプロバイダーのローカルセットアップ

意外に terraform-provider-mackerel 、現状(2021/5/9)では https://registry.terraform.io/browse/providers に未登録なので、ローカルで使えるように設定する必要がありました。
以前の terraform 0.12.29 で gmailfilter を利用した経験 [2] をもとに、最新の terraform 0.15.3 で terraform init しようとしたらつまづいてしまい。。

https://twitter.com/sogaoh/status/1390667818824134659

エラーメッセージで検索したり公式ドキュメントを眺めたりして、なんとなくどう配置するべきなのかはわかったのですが、-plugin-dir オプションを付けて成功した事例を見つけるまでは???状態でした。先人にはほんと感謝です。

https://www.terraform.io/docs/cli/config/config-file.html#provider-installation
https://sioncojp.hateblo.jp/entry/2020/10/13/195117

検証できたことをコードにまとめて準備手順を自分のリポジトリに書いておきました。利用される方の参考になれば幸いです。
ポイントは以下2点だと思います。

  • ${WorkingDirectory}/.terraform/plugins/registry.terraform.io/mackerel/mackerel/X.X.X/darwin_amd64/ にバイナリを置く
  • terraform init -plugin-dir=${PWD}/.terraform/plugins のように -plugin-dir を指定する

https://github.com/sogaoh/mackerel-practice/tree/master/terraform-provider/monitor/external#pre-requirements

実行 : 2 秒で完了して(早すぎて)びっくり

実行したときのコンソール出力です。

terraform init , plan

❯ terraform init -plugin-dir=${PWD}/.terraform/plugins

Initializing the backend...

Initializing provider plugins...
- Finding mackerel/mackerel versions matching "~> 0.0.1"...
- Installing mackerel/mackerel v0.0.1...
- Installed mackerel/mackerel v0.0.1 (unauthenticated)

Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that Terraform can guarantee to make the same selections by default when
you run "terraform init" in the future.

Terraform has been successfully initialized!

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.

❯ terraform plan

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # mackerel_monitor.ant-in-giant_github_io will be created
  + resource "mackerel_monitor" "ant-in-giant_github_io" {
      + id                    = (known after apply)
      + is_mute               = false
      + name                  = "ant-in-giant.github.io"
      + notification_interval = 0

      + external {
          + certification_expiration_critical = 10
          + certification_expiration_warning  = 30
          + contains_string                   = "Slide (index)"
          + max_check_attempts                = 1
          + method                            = "GET"
          + response_time_critical            = 120000
          + response_time_duration            = 3
          + response_time_warning             = 30000
          + service                           = "dev"
          + url                               = "https://ant-in-giant.github.io/slide/"
        }
    }

Plan: 1 to add, 0 to change, 0 to destroy.

Note: You didn't use the -out option to save this plan, so Terraform can't guarantee to take exactly these actions if you run "terraform apply" now.

terraform apply

(色を見せたかったので画像です)


terraform apply ... complete after 2s !

早すぎて正直驚きましたが、管理画面にも反映されてました

https://mackerel.io/orgs/${myOrganization}/monitors#monitor=${monitor_id}



以降、順当に外形監視が続いている感じです。

なお、ドキュメントが整備がまだ未完とのことだったので、項目はコードから推測で指定しました。だいたい意図と合ってたような気がしています。

https://github.com/mackerelio-labs/terraform-provider-mackerel/blob/master/mackerel/resource_mackerel_monitor.go#L169-L241

脚注
  1. https://twitter.com/antingiant/status/1388676886629208070 ↩︎

  2. https://zenn.dev/sogaoh/articles/20-09-13-b239669609bb4145b738 ↩︎

Discussion