Terraformの公式ドキュメントの調べ方

この記事の目的

Terraform、楽しいですよね？

私は最近入門したばかりでまだまだ表面的なところしか使えていないとは思いますが、
それでも楽しさを感じています。

そんなTerraform、公式ドキュメントが良い感じなのですが
最初は調べたいものをどこで調べればいいか戸惑いました。

なので私と同じように、Terraformに関して公式ドキュメントを読みたいけど
知りたいところを探すにはどうすればいいか分からない、といった人のために
この記事にまとめます。

逆に「公式ドキュメントのここ読むとTerraform偏差値高まっていいよ」というのがもしありましたら
ぜひ教えてください！

なお以下の説明は2022/02/17現在での情報になります。
今後Terraform公式サイトのレイアウトや掲載情報など変わる可能性はありますので
その点はご了承ください。

まず結論

Terraformの公式ドキュメントのどれが何について書かれているのかは
公式ページのここに実は記載があります。

すごく端的にまとめてくれていますので、まずはここを見ましょう。

以下ではその中でも良く読むことになるものを紹介します。

Terraformの設定全般について調べたい時

Configuration Language というドキュメントを読みましょう。

例えば、depends_onというmeta-argumentsがありますが、
それについて調べたい時は以下のような流れで行います。

1. まずConfiguration Languageを開く。
2. 左のFilterと書かれている検索窓にdepends_onと入力する。
   
3. その下に表示されている検索結果をクリックする。
   

以上です。簡単ですね。

Providerについて調べたい時

Terraform Registryにあるドキュメントを読みましょう。

例としてここでは、AWSのresourceの1つである
aws_security_groupに関して調べたい場合の流れを書きます。

1. Terraform Registryを開く

2. AWSのリンクをクリックする。
   

3. 右上にあるDocumentationをクリックする
   

4. 左のFilterと書かれている検索窓にaws_security_groupと入力する。
   

5. 下の検索結果に表示されている中から目的のものをクリックする。
   

以上です。

Terraformのドキュメントを横断して調べたい時は？

Terraformのドキュメントの中央上あたりに表示されている検索窓に入力します。

そうすると横断的に検索してくれますが、
私個人的には対象となるドキュメントを開いた上でFilterを使うやり方の方をよく使います。

大抵はConfiguration Languageで検索すれば何とかなります。そう強く信じています。

ちなみにこの横断検索の時Terraform Registry側にあるドキュメントは検索対象に入っていないので注意しましょう。

つまりAWSの設定とかを調べたい時には使えません。

各ProviderやModuleについて横断的に調べたい時はTerraform Registry側にいって検索する必要があります。

あとがき

分からないところがあっていろいろと検索したんだけどもドンピシャの情報がなくて
沼にハマりかけてたところで公式ドキュメント読んでみたら普通に書いてあった、
みたいなことはTerraformに限らず良くあることですよね。

英語だから読むのちょっと面倒だなあと思っていても、
結局はそれが最短だったりします。

エンジニアたるもの、英語だろうとまずは公式ドキュメントという姿勢は常に持っていたいですね。
自戒です。