https://github.com/alflag-team/terraform-cloudflare-tunnel

https://github.com/alflag-team/terraform-cloudflare-tunnel

cloudflare cloudflare-tunnel cloudflared terraform

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/alflag-team/terraform-cloudflare-tunnel
• Owner: alflag-team
• Created: 2024-06-16T19:47:58.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-08-27T19:46:28.000Z (10 months ago)
• Last Synced: 2024-08-27T21:44:45.563Z (10 months ago)
• Topics: cloudflare, cloudflare-tunnel, cloudflared, terraform
• Language: HCL
• Size: 10.7 KB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cloudflare Tunnel

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

* [Google Cloud のベストプラクティスガイド](https://cloud.google.com/docs/terraform/best-practices-for-terraform)

## ディレクトリ構成

```plain

-- README.md

-- environments/

   -- ENVIRONMENT/

      -- 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`: ヘッダーに表示する情報

```markdown

# Title

This module is ...

```

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

```yaml

formatter: markdown table

header-from: header.md

output:

  file: README.md

  mode: inject

  template: |-

    

    {{ .Content }}

    

```

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

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

```bash

terraform-docs modules/$MODULE

```