terraform-hrafnar-gcp-deploy/.terraform-docs.yml at main · openteams-ai/terraform-hrafnar-gcp-deploy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
formatter: markdown

version: ""

header-from: main.tf
footer-from: ""

recursive:
  enabled: false
  path: modules

sections:
  hide: []
  show: []

content: |-
  {{ .Header }}

  ## Usage

  ### Basic Usage (hrafnar app only)

  ```hcl
  module "hrafnar_gcp_deploy" {
    source  = "openteams-ai/hrafnar-gcp-deploy/gcp"
    version = "~> 1.0"

    project_id   = "my-gcp-project"
    region       = "us-central1"
    name_prefix  = "acme-hrafnar"

    # Hrafnar application configuration
    app_image = "gcr.io/my-project/hrafnar:latest"

    # AI API keys (stored securely in Secret Manager)
    ai_api_keys = {
      OPENAI_API_KEY    = "sk-..."
      ANTHROPIC_API_KEY = "sk-ant-..."
    }
  }
  ```

  ### With Cloudflare DNS and React Frontend

  ```hcl
  module "hrafnar_gcp_deploy" {
    source  = "openteams-ai/hrafnar-gcp-deploy/gcp"
    version = "~> 1.0"

    project_id   = "my-gcp-project"
    region       = "us-central1"
    name_prefix  = "acme-hrafnar"

    # Hrafnar application
    app_image = "gcr.io/my-project/hrafnar:latest"

    # Optional React frontend
    enable_react_frontend = true
    react_image          = "gcr.io/my-project/hrafnar-ui:latest"

    # Cloudflare DNS configuration
    enable_cloudflare_dns = true
    cloudflare_api_token  = "your-cloudflare-token"
    cloudflare_zone_id    = "your-zone-id"
    base_domain          = "example.com"
    api_subdomain        = "api"
    ui_subdomain         = "app"

    # AI configuration
    ai_api_keys = {
      OPENAI_API_KEY    = "sk-..."
      ANTHROPIC_API_KEY = "sk-ant-..."
    }

    # MCP servers
    mcp_servers = {
      filesystem = {
        url         = "https://mcp-fs.example.com"
        description = "Filesystem MCP server"
      }
    }
  }
  ```

  {{ .Requirements }}

  {{ .Providers }}

  {{ .Modules }}

  {{ .Resources }}

  {{ .Inputs }}

  {{ .Outputs }}

output:
  file: README.md
  mode: inject
  template: |-
    <!-- BEGIN_TF_DOCS -->
    {{ .Content }}
    <!-- END_TF_DOCS -->

output-values:
  enabled: false
  from: ""

sort:
  enabled: true
  by: name

settings:
  anchor: true
  color: true
  default: true
  description: false
  escape: true
  hide-empty: false
  html: true
  indent: 2
  lockfile: true
  read-comments: true
  required: true
  sensitive: true
  type: true