Skip to content

Commit

Permalink
update terraform-docs to v0.19.0 (#178)
Browse files Browse the repository at this point in the history
  • Loading branch information
mathewab authored Jan 20, 2025
1 parent fec9bd0 commit bd16e94
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ BINARY=terraform-provider-${NAME}
VERSION=1.3.1
OS_ARCH=$(shell uname -s | tr '[:upper:]' '[:lower:]')_$(shell uname -m)
MODULES_DIR=./modules
TERRAFORM_DOCS_IMAGE=quay.io/terraform-docs/terraform-docs:0.17.0
TERRAFORM_DOCS_IMAGE=quay.io/terraform-docs/terraform-docs:0.19.0

default: install

Expand Down
4 changes: 2 additions & 2 deletions modules/bloxone_anycast/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,9 @@ module "bloxone_anycast" {
| <a name="input_anycast_config_name"></a> [anycast\_config\_name](#input\_anycast\_config\_name) | Name of the Anycast configuration. | `string` | n/a | yes |
| <a name="input_anycast_ip_address"></a> [anycast\_ip\_address](#input\_anycast\_ip\_address) | Anycast IP address. | `string` | n/a | yes |
| <a name="input_ha_group_name"></a> [ha\_group\_name](#input\_ha\_group\_name) | Name of the HA group. | `string` | `null` | no |
| <a name="input_hosts"></a> [hosts](#input\_hosts) | Map of hostnames with their roles, routing protocols, BGP, and OSPF configurations. | <pre>map(object({<br> ha_role = optional(string)<br> routing_protocols = list(string)<br> bgp_config = optional(object({<br> asn = optional(string)<br> holddown_secs = optional(number)<br> neighbors = optional(list(object({<br> asn = string<br> ip_address = string<br> })))<br> }))<br> ospf_config = optional(object({<br> area = optional(string)<br> area_type = optional(string)<br> authentication_type = optional(string)<br> authentication_key = optional(string)<br> interface = optional(string)<br> hello_interval = optional(number)<br> dead_interval = optional(number)<br> retransmit_interval = optional(number)<br> transmit_delay = optional(number)<br> }))<br> }))</pre> | `{}` | no |
| <a name="input_hosts"></a> [hosts](#input\_hosts) | Map of hostnames with their roles, routing protocols, BGP, and OSPF configurations. | <pre>map(object({<br/> ha_role = optional(string)<br/> routing_protocols = list(string)<br/> bgp_config = optional(object({<br/> asn = optional(string)<br/> holddown_secs = optional(number)<br/> neighbors = optional(list(object({<br/> asn = string<br/> ip_address = string<br/> })))<br/> }))<br/> ospf_config = optional(object({<br/> area = optional(string)<br/> area_type = optional(string)<br/> authentication_type = optional(string)<br/> authentication_key = optional(string)<br/> interface = optional(string)<br/> hello_interval = optional(number)<br/> dead_interval = optional(number)<br/> retransmit_interval = optional(number)<br/> transmit_delay = optional(number)<br/> }))<br/> }))</pre> | `{}` | no |
| <a name="input_service"></a> [service](#input\_service) | The type of the Service used in anycast configuration, supports (`dns`, `dhcp`, `dfp`). | `string` | `"dhcp"` | no |
| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | The timeouts to use for the BloxOne Host. The timeout value is a string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). If not provided, the default timeouts will be used. | <pre>object({<br> create = string<br> update = string<br> read = string<br> })</pre> | `null` | no |
| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | The timeouts to use for the BloxOne Host. The timeout value is a string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). If not provided, the default timeouts will be used. | <pre>object({<br/> create = string<br/> update = string<br/> read = string<br/> })</pre> | `null` | no |
| <a name="input_wait_for_state"></a> [wait\_for\_state](#input\_wait\_for\_state) | If set to `true`, the resource will wait for the desired state to be reached before returning. If set to `false`, the resource will return immediately after the request is sent to the API. | `bool` | `true` | no |

## Outputs
Expand Down
2 changes: 1 addition & 1 deletion modules/bloxone_infra_host_aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ module "bloxone_infra_host_aws" {
| <a name="input_services"></a> [services](#input\_services) | The services to provision on the BloxOne Host. The services must be a map of valid service type with values of "start" or "stop". Valid service types are "dhcp", "dns", "anycast", "dfp". | `map(string)` | n/a | yes |
| <a name="input_subnet_id"></a> [subnet\_id](#input\_subnet\_id) | The subnet to use for the EC2 instance. The subnet must be in the same VPC as the security group. | `string` | n/a | yes |
| <a name="input_tags"></a> [tags](#input\_tags) | The tags to use for the BloxOne Host. For tags to use in AWS EC2, use `aws_tags`. | `map(string)` | `{}` | no |
| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | The timeouts to use for the BloxOne Host. The timeout value is a string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). If not provided, the default timeouts will be used. | <pre>object({<br> create = string<br> update = string<br> read = string<br> })</pre> | `null` | no |
| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | The timeouts to use for the BloxOne Host. The timeout value is a string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). If not provided, the default timeouts will be used. | <pre>object({<br/> create = string<br/> update = string<br/> read = string<br/> })</pre> | `null` | no |
| <a name="input_vpc_security_group_ids"></a> [vpc\_security\_group\_ids](#input\_vpc\_security\_group\_ids) | The security group to use for EC2 instance. The security group must be in the same VPC as the subnet. | `list(string)` | n/a | yes |
| <a name="input_wait_for_state"></a> [wait\_for\_state](#input\_wait\_for\_state) | If set to `true`, the resource will wait for the desired state to be reached before returning. If set to `false`, the resource will return immediately after the request is sent to the API. | `bool` | `null` | no |

Expand Down
4 changes: 2 additions & 2 deletions modules/bloxone_infra_host_azure/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ module "bloxone_infra_host_azure" {
| <a name="input_source_image_reference_version"></a> [source\_image\_reference\_version](#input\_source\_image\_reference\_version) | The version of the image that you want to deploy. | `string` | `"3.8.1"` | no |
| <a name="input_ssh_public_key_path"></a> [ssh\_public\_key\_path](#input\_ssh\_public\_key\_path) | The path to the SSH public key to use for the BloxOne Host. | `string` | n/a | yes |
| <a name="input_tags"></a> [tags](#input\_tags) | The tags to use for the BloxOne Host. | `map(string)` | `{}` | no |
| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | The timeouts to use for the BloxOne Host. The timeout value is a string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). If not provided, the default timeouts will be used. | <pre>object({<br> create = string<br> update = string<br> read = string<br> })</pre> | `null` | no |
| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | The timeouts to use for the BloxOne Host. The timeout value is a string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). If not provided, the default timeouts will be used. | <pre>object({<br/> create = string<br/> update = string<br/> read = string<br/> })</pre> | `null` | no |
| <a name="input_vm_name"></a> [vm\_name](#input\_vm\_name) | The name of the virtual machine | `string` | n/a | yes |
| <a name="input_vm_network_interface_ids"></a> [vm\_network\_interface\_ids](#input\_vm\_network\_interface\_ids) | The network interface ids that will be associated to the BloxOne Host | `list(string)` | n/a | yes |
| <a name="input_vm_size"></a> [vm\_size](#input\_vm\_size) | Size of the Virtual Machine based on Azure sizing | `string` | `"Standard_F8s"` | no |
Expand All @@ -101,4 +101,4 @@ module "bloxone_infra_host_azure" {
| <a name="output_azurerm_linux_virtual_machine"></a> [azurerm\_linux\_virtual\_machine](#output\_azurerm\_linux\_virtual\_machine) | The Azure virtual machine object for the instance |
| <a name="output_host"></a> [host](#output\_host) | The `bloxone_infra_host` object for the instance |
| <a name="output_services"></a> [services](#output\_services) | The `bloxone_infra_service` objects for the instance. May be empty if no services were specified. |
<!-- END_TF_DOCS -->
<!-- END_TF_DOCS -->
8 changes: 4 additions & 4 deletions modules/bloxone_infra_host_gcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@ module "bloxone_infra_host_gcp" {
| <a name="input_join_token"></a> [join\_token](#input\_join\_token) | The join token to use for the BloxOne Host. If not provided, a join token will be created. | `string` | `null` | no |
| <a name="input_machine_type"></a> [machine\_type](#input\_machine\_type) | The machine type to use for the virtual machine | `string` | `"e2-standard-4"` | no |
| <a name="input_name"></a> [name](#input\_name) | The name of the virtual machine | `string` | n/a | yes |
| <a name="input_network_interfaces"></a> [network\_interfaces](#input\_network\_interfaces) | List of network interfaces to be attached to the virtual machine. | <pre>list(object({<br> network = string<br> subnetwork = string<br> assign_public_ip = optional(bool)<br> }))</pre> | n/a | yes |
| <a name="input_service_account"></a> [service\_account](#input\_service\_account) | The service account to use for the BloxOne Host. | <pre>object({<br> email = string<br> scopes = list(string)<br> })</pre> | `null` | no |
| <a name="input_network_interfaces"></a> [network\_interfaces](#input\_network\_interfaces) | List of network interfaces to be attached to the virtual machine. | <pre>list(object({<br/> network = string<br/> subnetwork = string<br/> assign_public_ip = optional(bool)<br/> }))</pre> | n/a | yes |
| <a name="input_service_account"></a> [service\_account](#input\_service\_account) | The service account to use for the BloxOne Host. | <pre>object({<br/> email = string<br/> scopes = list(string)<br/> })</pre> | `null` | no |
| <a name="input_services"></a> [services](#input\_services) | The services to provision on the BloxOne Host. The services must be a map of valid service type with values of "start" or "stop". Valid service types are "dhcp", "dns", "anycast", "dfp". | `map(string)` | n/a | yes |
| <a name="input_source_image"></a> [source\_image](#input\_source\_image) | The source image to use for the virtual machine. | `string` | n/a | yes |
| <a name="input_tags"></a> [tags](#input\_tags) | The tags to use for the BloxOne Host. | `map(string)` | `{}` | no |
| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | The timeouts to use for the BloxOne Host. The timeout value is a string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). If not provided, the default timeouts will be used. | <pre>object({<br> create = string<br> update = string<br> read = string<br> })</pre> | `null` | no |
| <a name="input_timeouts"></a> [timeouts](#input\_timeouts) | The timeouts to use for the BloxOne Host. The timeout value is a string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). If not provided, the default timeouts will be used. | <pre>object({<br/> create = string<br/> update = string<br/> read = string<br/> })</pre> | `null` | no |
| <a name="input_wait_for_state"></a> [wait\_for\_state](#input\_wait\_for\_state) | If set to `true`, the resource will wait for the desired state to be reached before returning. If set to `false`, the resource will return immediately after the request is sent to the API. | `bool` | `null` | no |

## Outputs
Expand All @@ -101,4 +101,4 @@ module "bloxone_infra_host_gcp" {
| <a name="output_google_compute_instance"></a> [google\_compute\_instance](#output\_google\_compute\_instance) | The GCP instance object for the instance |
| <a name="output_host"></a> [host](#output\_host) | The `bloxone_infra_host` object for the instance |
| <a name="output_services"></a> [services](#output\_services) | The `bloxone_infra_service` objects for the instance. May be empty if no services were specified. |
<!-- END_TF_DOCS -->
<!-- END_TF_DOCS -->

0 comments on commit bd16e94

Please sign in to comment.