Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joshw123 committed Dec 10, 2024
1 parent 4e8a745 commit 8f16176
Show file tree
Hide file tree
Showing 11 changed files with 146 additions and 133 deletions.
57 changes: 29 additions & 28 deletions fast/stages/0-bootstrap/README.md

Large diffs are not rendered by default.

23 changes: 12 additions & 11 deletions fast/stages/1-resman/README.md

Large diffs are not rendered by default.

19 changes: 10 additions & 9 deletions fast/stages/2-network-security/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,15 +180,16 @@ Make sure the CAs and the trusted configs created for NGFW Enterprise in the [2-
|---|---|:---:|:---:|:---:|:---:|
| [automation](variables-fast.tf#L19) | Automation resources created by the bootstrap stage. | <code title="object&#40;&#123;&#10; outputs_bucket &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> || | <code>0-bootstrap</code> |
| [billing_account](variables-fast.tf#L27) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | <code title="object&#40;&#123;&#10; id &#61; string&#10; is_org_level &#61; optional&#40;bool, true&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> || | <code>0-bootstrap</code> |
| [folder_ids](variables-fast.tf#L40) | Folders to be used for the networking resources in folders/nnnnnnnnnnn format. If null, folder will be created. | <code title="object&#40;&#123;&#10; networking &#61; string&#10; networking-dev &#61; string&#10; networking-prod &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> || | <code>1-resman</code> |
| [organization](variables-fast.tf#L82) | Organization details. | <code title="object&#40;&#123;&#10; domain &#61; string&#10; id &#61; number&#10; customer_id &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> || | <code>00-globals</code> |
| [prefix](variables-fast.tf#L92) | Prefix used for resources that need unique names. Use a maximum of 9 chars for organizations, and 11 chars for tenants. | <code>string</code> || | <code>0-bootstrap</code> |
| [vpc_self_links](variables-fast.tf#L102) | Self link for the shared VPC. | <code title="object&#40;&#123;&#10; dev-spoke-0 &#61; string&#10; prod-spoke-0 &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> || | <code>2-networking</code> |
| [factories_config](variables.tf#L17) | Configuration for network resource factories. | <code title="object&#40;&#123;&#10; cidrs &#61; optional&#40;string, &#34;data&#47;cidrs.yaml&#34;&#41;&#10; firewall_policy_rules &#61; optional&#40;object&#40;&#123;&#10; dev &#61; string&#10; prod &#61; string&#10; &#125;&#41;&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code title="&#123;&#10; firewall_policy_rules &#61; &#123;&#10; dev &#61; &#34;data&#47;firewall-policy-rules&#47;dev&#34;&#10; prod &#61; &#34;data&#47;firewall-policy-rules&#47;prod&#34;&#10; &#125;&#10;&#125;">&#123;&#8230;&#125;</code> | |
| [host_project_ids](variables-fast.tf#L51) | Host project for the shared VPC. | <code title="object&#40;&#123;&#10; dev-spoke-0 &#61; optional&#40;string&#41;&#10; prod-spoke-0 &#61; optional&#40;string&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>&#123;&#125;</code> | <code>2-networking</code> |
| [ngfw_enterprise_config](variables.tf#L35) | NGFW Enterprise configuration. | <code title="object&#40;&#123;&#10; endpoint_zones &#61; list&#40;string&#41;&#10; quota_project_id &#61; optional&#40;string, null&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code title="&#123;&#10; endpoint_zones &#61; &#91;&#10; &#34;europe-west1-b&#34;,&#10; &#34;europe-west1-c&#34;,&#10; &#34;europe-west1-d&#34;&#10; &#93;&#10;&#125;">&#123;&#8230;&#125;</code> | |
| [ngfw_tls_configs](variables-fast.tf#L62) | The NGFW Enterprise TLS configurations. | <code title="object&#40;&#123;&#10; tls_enabled &#61; optional&#40;bool, false&#41;&#10; tls_ip_ids_by_region &#61; optional&#40;object&#40;&#123;&#10; dev &#61; optional&#40;map&#40;string&#41;, &#123;&#125;&#41;&#10; prod &#61; optional&#40;map&#40;string&#41;, &#123;&#125;&#41;&#10; &#125;&#41;&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code title="&#123;&#10; tls_enabled &#61; false&#10; tls_ip_ids_by_region &#61; &#123;&#10; dev &#61; &#123;&#125;&#10; prod &#61; &#123;&#125;&#10; &#125;&#10;&#125;">&#123;&#8230;&#125;</code> | <code>2-security</code> |
| [outputs_location](variables.tf#L51) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | <code>string</code> | | <code>null</code> | |
| [default_alerts_email](variables-fast.tf#L40) | Default email address for alerting. | <code>string</code> || | |
| [folder_ids](variables-fast.tf#L46) | Folders to be used for the networking resources in folders/nnnnnnnnnnn format. If null, folder will be created. | <code title="object&#40;&#123;&#10; networking &#61; string&#10; networking-dev &#61; string&#10; networking-prod &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> || | <code>1-resman</code> |
| [organization](variables-fast.tf#L88) | Organization details. | <code title="object&#40;&#123;&#10; domain &#61; string&#10; id &#61; number&#10; customer_id &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> || | <code>00-globals</code> |
| [prefix](variables-fast.tf#L98) | Prefix used for resources that need unique names. Use a maximum of 9 chars for organizations, and 11 chars for tenants. | <code>string</code> || | <code>0-bootstrap</code> |
| [vpc_self_links](variables-fast.tf#L108) | Self link for the shared VPC. | <code title="object&#40;&#123;&#10; dev-spoke-0 &#61; string&#10; prod-spoke-0 &#61; string&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> || | <code>2-networking</code> |
| [factories_config](variables.tf#L17) | Configuration for network resource factories. | <code title="object&#40;&#123;&#10; cidrs &#61; optional&#40;string, &#34;data&#47;cidrs.yaml&#34;&#41;&#10; firewall_policy_rules &#61; optional&#40;object&#40;&#123;&#10; dev &#61; string&#10; prod &#61; string&#10; &#125;&#41;&#41;&#10; logging_metrics &#61; optional&#40;string, &#34;data&#47;logging-metrics&#34;&#41;&#10; channels &#61; optional&#40;string, &#34;data&#47;channels&#34;&#41;&#10; alerts &#61; optional&#40;string, &#34;data&#47;alerts&#34;&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code title="&#123;&#10; firewall_policy_rules &#61; &#123;&#10; dev &#61; &#34;data&#47;firewall-policy-rules&#47;dev&#34;&#10; prod &#61; &#34;data&#47;firewall-policy-rules&#47;prod&#34;&#10; &#125;&#10;&#125;">&#123;&#8230;&#125;</code> | |
| [host_project_ids](variables-fast.tf#L57) | Host project for the shared VPC. | <code title="object&#40;&#123;&#10; dev-spoke-0 &#61; optional&#40;string&#41;&#10; prod-spoke-0 &#61; optional&#40;string&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code>&#123;&#125;</code> | <code>2-networking</code> |
| [ngfw_enterprise_config](variables.tf#L38) | NGFW Enterprise configuration. | <code title="object&#40;&#123;&#10; endpoint_zones &#61; list&#40;string&#41;&#10; quota_project_id &#61; optional&#40;string, null&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code title="&#123;&#10; endpoint_zones &#61; &#91;&#10; &#34;europe-west1-b&#34;,&#10; &#34;europe-west1-c&#34;,&#10; &#34;europe-west1-d&#34;&#10; &#93;&#10;&#125;">&#123;&#8230;&#125;</code> | |
| [ngfw_tls_configs](variables-fast.tf#L68) | The NGFW Enterprise TLS configurations. | <code title="object&#40;&#123;&#10; tls_enabled &#61; optional&#40;bool, false&#41;&#10; tls_ip_ids_by_region &#61; optional&#40;object&#40;&#123;&#10; dev &#61; optional&#40;map&#40;string&#41;, &#123;&#125;&#41;&#10; prod &#61; optional&#40;map&#40;string&#41;, &#123;&#125;&#41;&#10; &#125;&#41;&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code title="&#123;&#10; tls_enabled &#61; false&#10; tls_ip_ids_by_region &#61; &#123;&#10; dev &#61; &#123;&#125;&#10; prod &#61; &#123;&#125;&#10; &#125;&#10;&#125;">&#123;&#8230;&#125;</code> | <code>2-security</code> |
| [outputs_location](variables.tf#L54) | Path where providers and tfvars files for the following stages are written. Leave empty to disable. | <code>string</code> | | <code>null</code> | |

## Outputs

Expand Down
Loading

0 comments on commit 8f16176

Please sign in to comment.