https://github.com/alflag-team/terraform-dns

https://github.com/alflag-team/terraform-dns

cloudflare cloudflare-dns dns terraform

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/alflag-team/terraform-dns
• Owner: alflag-team
• Created: 2023-10-01T04:12:24.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-03-14T16:08:23.000Z (11 months ago)
• Last Synced: 2024-11-10T13:09:37.526Z (3 months ago)
• Topics: cloudflare, cloudflare-dns, dns, terraform
• Language: HCL
• Homepage:
• Size: 33.2 KB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# dns

DNS に関する Terraform のコードを管理するリポジトリです。

## ディレクトリ構成

```plain

-- README.md

-- main.tf

-- provider.tf

-- variables.tf

-- versions.tf

-- modules/

   -- 

      -- .terraform-docs.yml

      -- header.md

      -- main.tf

      -- outputs.tf

      -- variables.tf

      -- versions.tf

   -- ...

```

## terraform ドキュメントの生成

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

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

- `zones//header.md`: ヘッダーに表示する情報

```markdown

# Title

This zone is ...

```

- `zones//.terraform-docs.yml`: ドキュメントの設定ファイル

```yaml

formatter: markdown table

header-from: header.md

output:

  file: README.md

  mode: inject

  template: |-

    

    {{ .Content }}

    

```

### ドキュメントの生成

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

```bash

terraform-docs zones//

```