terraformコーディング規約
はじめに
この文書は、terraformのコーディング規約をまとめたものです。
ファイル命名規則
- ファイル名は、アンダースコア(_)を使用して単語を区切る
- ファイル名は、小文字で記述する
- ファイル名は、拡張子を含めて、最大64文字までとする
リソースの記述
- リソースの記述は、特殊な事情がない限り、moduleを使用する
- moduleの引数は、必要最小限にする
- moduleの引数は、デフォルト値を設定する
- moduleの引数は、必要に応じて、コメントを記述する
変数の記述
- 変数の記述は、特殊な事情がない限り、variables.tfファイルに記述する
- 変数の記述は、必要最小限にする
- 変数の記述は、デフォルト値を設定する
- 変数の記述は、必要に応じて、コメントを記述する
出力の記述
- 出力の記述は、特殊な事情がない限り、outputs.tfファイルに記述する
- 出力の記述は、必要最小限にする
- 出力の記述は、必要に応じて、コメントを記述する
providerの記述
- providerの記述は、特殊な事情がない限り、provider.tfファイルに記述する
- providerの記述は、必要最小限にする
- providerの記述は、必要に応じて、コメントを記述する
モジュールの記述
- モジュールの記述は、特殊な事情がない限り、moduleディレクトリに記述する
- モジュールの記述は、必要最小限にする
- モジュールの記述は、必要に応じて、コメントを記述する
ドキュメント
全てのモジュールパッケージには、README.mdファイルを含めること ドキュメント生成ツールを使用して、ドキュメントを生成すること
フォーマット
全てのファイルは、terraform fmtコマンドを実行してフォーマットを行うこと
1 | |