Skip to content

Commit

Permalink
style: reformat README
Browse files Browse the repository at this point in the history
  • Loading branch information
@mvprowess
mvprowess committed Nov 18, 2024
1 parent bd95688 commit 9c573de
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,41 +12,43 @@ module "hetzner_server_apache" {
```

<!-- BEGIN_TF_DOCS -->

## Providers

| Name | Version |
|------|---------|
| <a name="provider_hcloud"></a> [hcloud](#provider\_hcloud) | ~> 1.49 |
| Name | Version |
| --------------------------------------------------------- | ------- |
| <a name="provider_hcloud"></a> [hcloud](#provider_hcloud) | ~> 1.49 |

## Modules

No modules.

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_automount"></a> [automount](#input\_automount) | Whether or not to automount the volume after attaching it within Hetzner Cloud. This is exclusively used within the 'hcloud\_volume\_attachment' resource as not to couple servers. Default is 'true'. | `bool` | `true` | no |
| <a name="input_delete_protection"></a> [delete\_protection](#input\_delete\_protection) | Whether or not to enable delete protection for cloud volume. Default is 'true'. | `bool` | `true` | no |
| <a name="input_format"></a> [format](#input\_format) | The type of format to use for the cloud volume. Default is 'ext4'. | `string` | `"ext4"` | no |
| <a name="input_location"></a> [location](#input\_location) | The location for the new Hetzner Cloud volume. This is enforced since it automatically disallows the use of 'server\_id' within the 'hcloud\_volume' resource so that volumes do NOT get coupled to servers, but instead remain their own separately manageable resource. Default is 'fsn1' and other possible values are 'nbg1', 'hel1', 'ash' or 'hil'. | `string` | `"fsn1"` | no |
| <a name="input_name"></a> [name](#input\_name) | The name to give to the new Hetzner Cloud volume. | `string` | n/a | yes |
| <a name="input_server_id"></a> [server\_id](#input\_server\_id) | The ID of the Hetzner Cloud server to attach the volume to. This is exclusively used with the 'hcloud\_volume\_attachment' resource as not to couple servers and volumes like explained within the 'location' variable description. Default is 'null' in order to allow un-attached volumes to be created. | `number` | `null` | no |
| <a name="input_size"></a> [size](#input\_size) | An integer denoting the size of the volume in Gigabytes. Default is 10. | `number` | `10` | no |
| Name | Description | Type | Default | Required |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -------- | :------: |
| <a name="input_automount"></a> [automount](#input_automount) | Whether or not to automount the volume after attaching it within Hetzner Cloud. This is exclusively used within the 'hcloud_volume_attachment' resource as not to couple servers. Default is 'true'. | `bool` | `true` | no |
| <a name="input_delete_protection"></a> [delete_protection](#input_delete_protection) | Whether or not to enable delete protection for cloud volume. Default is 'true'. | `bool` | `true` | no |
| <a name="input_format"></a> [format](#input_format) | The type of format to use for the cloud volume. Default is 'ext4'. | `string` | `"ext4"` | no |
| <a name="input_location"></a> [location](#input_location) | The location for the new Hetzner Cloud volume. This is enforced since it automatically disallows the use of 'server_id' within the 'hcloud_volume' resource so that volumes do NOT get coupled to servers, but instead remain their own separately manageable resource. Default is 'fsn1' and other possible values are 'nbg1', 'hel1', 'ash' or 'hil'. | `string` | `"fsn1"` | no |
| <a name="input_name"></a> [name](#input_name) | The name to give to the new Hetzner Cloud volume. | `string` | n/a | yes |
| <a name="input_server_id"></a> [server_id](#input_server_id) | The ID of the Hetzner Cloud server to attach the volume to. This is exclusively used with the 'hcloud_volume_attachment' resource as not to couple servers and volumes like explained within the 'location' variable description. Default is 'null' in order to allow un-attached volumes to be created. | `number` | `null` | no |
| <a name="input_size"></a> [size](#input_size) | An integer denoting the size of the volume in Gigabytes. Default is 10. | `number` | `10` | no |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_volume_attachment_id"></a> [volume\_attachment\_id](#output\_volume\_attachment\_id) | The ID for the new volume attachment. |
| <a name="output_volume_attachment_server_id"></a> [volume\_attachment\_server\_id](#output\_volume\_attachment\_server\_id) | The server ID for the new volume attachment. |
| <a name="output_volume_delete_protection"></a> [volume\_delete\_protection](#output\_volume\_delete\_protection) | Whether or not delete protection is enabled for the new cloud volume. |
| <a name="output_volume_id"></a> [volume\_id](#output\_volume\_id) | The ID of the new cloud volume. |
| <a name="output_volume_labels"></a> [volume\_labels](#output\_volume\_labels) | The labels attached to the new cloud volume. |
| <a name="output_volume_linux_device"></a> [volume\_linux\_device](#output\_volume\_linux\_device) | The device path on the file system for the new cloud volume. |
| <a name="output_volume_location"></a> [volume\_location](#output\_volume\_location) | The Hetzner datacenter location of the new cloud volume. |
| <a name="output_volume_name"></a> [volume\_name](#output\_volume\_name) | The name for the new cloud volume. |
| <a name="output_volume_size"></a> [volume\_size](#output\_volume\_size) | An integer representing the size of the new cloud volume in GB. |
| Name | Description |
| -------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| <a name="output_volume_attachment_id"></a> [volume_attachment_id](#output_volume_attachment_id) | The ID for the new volume attachment. |
| <a name="output_volume_attachment_server_id"></a> [volume_attachment_server_id](#output_volume_attachment_server_id) | The server ID for the new volume attachment. |
| <a name="output_volume_delete_protection"></a> [volume_delete_protection](#output_volume_delete_protection) | Whether or not delete protection is enabled for the new cloud volume. |
| <a name="output_volume_id"></a> [volume_id](#output_volume_id) | The ID of the new cloud volume. |
| <a name="output_volume_labels"></a> [volume_labels](#output_volume_labels) | The labels attached to the new cloud volume. |
| <a name="output_volume_linux_device"></a> [volume_linux_device](#output_volume_linux_device) | The device path on the file system for the new cloud volume. |
| <a name="output_volume_location"></a> [volume_location](#output_volume_location) | The Hetzner datacenter location of the new cloud volume. |
| <a name="output_volume_name"></a> [volume_name](#output_volume_name) | The name for the new cloud volume. |
| <a name="output_volume_size"></a> [volume_size](#output_volume_size) | An integer representing the size of the new cloud volume in GB. |

<!-- END_TF_DOCS -->

### 🔃 Contributing
Expand Down

0 comments on commit 9c573de

Please # to comment.