zecfoundation
/
cloud-foundation-fabric
mirror of https://github.com/ZcashFoundation/cloud-foundation-fabric.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fast readmes tfdoc

This commit is contained in:
Ludovico Magnocavallo 2022-01-17 11:11:52 +01:00
parent 4f82723a71
commit 6259f7592a
2 changed files with 62 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
fast/stages/02-networking/README.md
View File

@ -279,12 +279,13 @@ DNS configurations are centralised in the `dns.tf` file. Spokes delegate DNS res
<!-- BEGIN TFDOC -->
## Files
| name | description | modules | resources |
| ---------------------------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
|---|---|---|---|
| [dns-dev.tf](./dns-dev.tf) | Development spoke DNS zones and peerings setup. | <code>dns</code> | |
| [dns-landing.tf](./dns-landing.tf) | Landing DNS zones and peerings setup. | <code>dns</code> | |
| [dns-prod.tf](./dns-prod.tf) | Production spoke DNS zones and peerings setup. | <code>dns</code> | |
@ -303,7 +304,7 @@ DNS configurations are centralised in the `dns.tf` file. Spokes delegate DNS res
## Variables
| name | description | type | required | default | producer |
| ------------------ | -------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------: |
|---|---|:---:|:---:|:---:|:---:|
| billing_account_id | Billing account id. | <code>string</code> | ✓ | | <code>00-bootstrap</code> |
| organization | 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-bootstrap</code> |
| prefix | Prefix used for resources that need unique names. | <code>string</code> | ✓ | | <code>00-bootstrap</code> |
@ -323,7 +324,7 @@ DNS configurations are centralised in the `dns.tf` file. Spokes delegate DNS res
## Outputs
| name | description | sensitive | consumers |
| ------------------------ | ----------------------------------------------- | :-------: | --------- |
|---|---|:---:|---|
| cloud_dns_inbound_policy | IP Addresses for Cloud DNS inbound policy. | | |
| project_ids | Network project ids. | | |
| project_numbers | Network project numbers. | | |
@ -351,3 +352,4 @@ DNS configurations are centralised in the `dns.tf` file. Spokes delegate DNS res

8
fast/stages/03-project-factory/prod/README.md
View File

@ -97,12 +97,13 @@ terraform apply
<!-- BEGIN TFDOC -->
## Files
| name | description | modules | resources |
| ------------------------------ | ----------------- | ---------------------------- | --------- |
|---|---|---|---|
| [main.tf](./main.tf) | Project factory. | <code>project-factory</code> | |
| [outputs.tf](./outputs.tf) | Module outputs. | | |
| [variables.tf](./variables.tf) | Module variables. | | |
@ -110,7 +111,7 @@ terraform apply
## Variables
| name | description | type | required | default | producer |
| -------------------- | --------------------------------------------------------------------- | :-----------------: | :------: | :-------------------------------------------: | :------------------------: |
|---|---|:---:|:---:|:---:|:---:|
| billing_account_id | Billing account id. | <code>string</code> | ✓ | | <code>00-bootstrap</code> |
| shared_vpc_self_link | Self link for the shared VPC. | <code>string</code> | ✓ | | <code>02-networking</code> |
| vpc_host_project | Host project for the shared VPC. | <code>string</code> | ✓ | | <code>02-networking</code> |
@ -121,10 +122,11 @@ terraform apply
## Outputs
| name | description | sensitive | consumers |
| -------- | -------------------------------------- | :-------: | --------- |
|---|---|:---:|---|
| projects | Created projects and service accounts. | | |
<!-- END TFDOC -->