README.md

Oracle Cloud

Oracle Cloud を管理している Terraform のコードが管理されています。

• Google Cloud のベストプラクティスガイド

ディレクトリ構成

-- README.md
-- environments/
   -- ENVORONMENT/
      -- main.tf
      -- provider.tf
      -- variables.tf
      -- versions.tf
   -- ...
-- modules/
   -- MODULE/
      -- .terraform-docs.yml
      -- header.md
      -- main.tf
      -- outputs.tf
      -- variables.tf
      -- versions.tf
   -- ...

terraform ドキュメントの生成

terraform-docs を使ってドキュメントを生成しています。

モジュールを作る場合、以下のファイルを作成する必要があります。

• modules/$MODULE/header.md: ヘッダーに表示する情報

# Title

This module is ...

• modules/$MODULE/.terraform-docs.yml: ドキュメントの設定ファイル

formatter: markdown table
header-from: header.md
output:
  file: README.md
  mode: inject
  template: |-
    <!-- BEGIN_TF_DOCS -->
    {{ .Content }}
    <!-- END_TF_DOCS -->

ドキュメントの生成

以下のコマンドでドキュメントを生成できます。

terraform-docs modules/$MODULE