kovagoadi/hunfabric
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

New tfdoc version (#396)

Browse Source 
* update tfdoc

* rewrite check docs, refactor tfdoc replace, regenerate modules READMEs

* remove dead code from check docs

* do not fail on missing variable files in check docs

* fix typos
This commit is contained in:
Ludovico Magnocavallo
2021-12-21 08:51:51 +01:00
committed by GitHub
parent d2cbf800fc
commit 1ac3fe4460
81 changed files with 1456 additions and 1206 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
modules/net-cloudnat/README.md
View File

@@ -16,23 +16,24 @@ module "nat" {
```
<!-- BEGIN TFDOC -->
## Variables
| name | description | type | required | default |
|---|---|:---: |:---:|:---:|
| name | Name of the Cloud NAT resource. | <code title="">string</code> | ✓ | |
| project_id | Project where resources will be created. | <code title="">string</code> | ✓ | |
| region | Region where resources will be created. | <code title="">string</code> | ✓ | |
| *addresses* | Optional list of external address self links. | <code title="list&#40;string&#41;">list(string)</code> | | <code title="">[]</code> |
| *config_min_ports_per_vm* | Minimum number of ports allocated to a VM from this NAT config. | <code title="">number</code> | | <code title="">64</code> |
| *config_source_subnets* | Subnetwork configuration (ALL_SUBNETWORKS_ALL_IP_RANGES, ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, LIST_OF_SUBNETWORKS). | <code title="">string</code> | | <code title="">ALL_SUBNETWORKS_ALL_IP_RANGES</code> |
| *config_timeouts* | Timeout configurations. | <code title="object&#40;&#123;&#10;icmp &#61; number&#10;tcp_established &#61; number&#10;tcp_transitory &#61; number&#10;udp &#61; number&#10;&#125;&#41;">object({...})</code> | | <code title="&#123;&#10;icmp &#61; 30&#10;tcp_established &#61; 1200&#10;tcp_transitory &#61; 30&#10;udp &#61; 30&#10;&#125;">...</code> |
| *logging_filter* | Enables logging if not null, value is one of 'ERRORS_ONLY', 'TRANSLATIONS_ONLY', 'ALL'. | <code title="">string</code> | | <code title="">null</code> |
| *router_asn* | Router ASN used for auto-created router. | <code title="">number</code> | | <code title="">64514</code> |
| *router_create* | Create router. | <code title="">bool</code> | | <code title="">true</code> |
| *router_name* | Router name, leave blank if router will be created to use auto generated name. | <code title="">string</code> | | <code title="">null</code> |
| *router_network* | Name of the VPC used for auto-created router. | <code title="">string</code> | | <code title="">null</code> |
| *subnetworks* | Subnetworks to NAT, only used when config_source_subnets equals LIST_OF_SUBNETWORKS. | <code title="list&#40;object&#40;&#123;&#10;self_link &#61; string,&#10;config_source_ranges &#61; list&#40;string&#41;&#10;secondary_ranges &#61; list&#40;string&#41;&#10;&#125;&#41;&#41;">list(object({...}))</code> | | <code title="">[]</code> |
|---|---|:---:|:---:|:---:|
| name | Name of the Cloud NAT resource. | <code>string</code> | ✓ | |
| project_id | Project where resources will be created. | <code>string</code> | ✓ | |
| region | Region where resources will be created. | <code>string</code> | ✓ | |
| addresses | Optional list of external address self links. | <code>list&#40;string&#41;</code> | | <code>&#91;&#93;</code> |
| config_min_ports_per_vm | Minimum number of ports allocated to a VM from this NAT config. | <code>number</code> | | <code>64</code> |
| config_source_subnets | Subnetwork configuration (ALL_SUBNETWORKS_ALL_IP_RANGES, ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, LIST_OF_SUBNETWORKS). | <code>string</code> | | <code>&#34;ALL_SUBNETWORKS_ALL_IP_RANGES&#34;</code> |
| config_timeouts | Timeout configurations. | <code title="object&#40;&#123;&#10; icmp &#61; number&#10; tcp_established &#61; number&#10; tcp_transitory &#61; number&#10; udp &#61; number&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> | | <code title="&#123;&#10; icmp &#61; 30&#10; tcp_established &#61; 1200&#10; tcp_transitory &#61; 30&#10; udp &#61; 30&#10;&#125;">&#123;&#8230;&#125;</code> |
| logging_filter | Enables logging if not null, value is one of 'ERRORS_ONLY', 'TRANSLATIONS_ONLY', 'ALL'. | <code>string</code> | | <code>null</code> |
| router_asn | Router ASN used for auto-created router. | <code>number</code> | | <code>64514</code> |
| router_create | Create router. | <code>bool</code> | | <code>true</code> |
| router_name | Router name, leave blank if router will be created to use auto generated name. | <code>string</code> | | <code>null</code> |
| router_network | Name of the VPC used for auto-created router. | <code>string</code> | | <code>null</code> |
| subnetworks | Subnetworks to NAT, only used when config_source_subnets equals LIST_OF_SUBNETWORKS. | <code title="list&#40;object&#40;&#123;&#10; self_link &#61; string,&#10; config_source_ranges &#61; list&#40;string&#41;&#10; secondary_ranges &#61; list&#40;string&#41;&#10;&#125;&#41;&#41;">list&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> | | <code>&#91;&#93;</code> |
## Outputs
@@ -43,4 +44,6 @@ module "nat" {
| region | Cloud NAT region. | |
| router | Cloud NAT router resources (if auto created). | |
| router_name | Cloud NAT router name. | |
<!-- END TFDOC -->