🌊

【Terraform】公式ドキュメントの読み方

2023/05/10に公開

ドキュメントについて

HCL を作成するにはドキュメントを読むことが必須。基本的な読み方について解説する。

以下は、Terraform の Azure のドキュメント。英語しかないです。

Terraform Registry

使用方法

  1. 作成したいリソースを検索する
  2. トグルからサービスを選択する
  3. データブロックなのかリソースブロックなのかを選択する。XX_ブロック を参照
  4. サンプルコードや設定可能なパラメータの一覧が出てくるため、それをもとにコードを作成する
  • 例えば、Azure Storage Account を作成したい場合、左上に「Storage Account」と検索をかける。

    結果として、[サービス名]>[Resource] or [Data] >[リソース名]という感じで誘導される。
    自分の作成したいリソースを階層を参考に選択する。
    基本的には[Example Usage]部分をコピペするだけで最低限の機能を持ったリソースを作成することが可能。
    ただし、そのほかにもパラメータを設定したい場合は、下のほうにある各種パラメータやgit などを参考に要件を満たすように記述を行う。
    参考1
    参考2
    参考3

Discussion