mirrors/terraform-provider-proxmox
0
0
Fork 0
mirror of https://github.com/bpg/terraform-provider-proxmox.git synced 2025-07-12 00:35:03 +00:00
Code

fix(docs): Inconsistent indentations in docs (#961)

Browse Source 
fix(docs): Inconsistent indentations cause rendering issues

Signed-off-by: Ming Xie <git@mxie.dev>
This commit is contained in:
Ming Xie 2024-01-26 20:25:51 -05:00 committed by GitHub
parent 3a5e69d9c8
commit 0d548a7807
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 617 additions and 606 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/resources/virtual_environment_cluster_firewall.md
View File

@ -36,7 +36,8 @@ resource "proxmox_virtual_environment_cluster_firewall" "example" {
- `enabled` - (Optional) Enable or disable the log rate limit. - `enabled` - (Optional) Enable or disable the log rate limit.
- `burst` - (Optional) Initial burst of packages which will always get - `burst` - (Optional) Initial burst of packages which will always get
logged before the rate is applied (defaults to `5`). logged before the rate is applied (defaults to `5`).
- `rate` - (Optional) Frequency with which the burst bucket gets refilled (defaults to `1/second`). - `rate` - (Optional) Frequency with which the burst bucket gets refilled
(defaults to `1/second`).
## Attribute Reference ## Attribute Reference

27
docs/resources/virtual_environment_cluster_firewall_security_group.md
View File

@ -49,14 +49,16 @@ resource "proxmox_virtual_environment_cluster_firewall_security_group" "webserve
- `type` - (Required) Rule type (`in`, `out`). - `type` - (Required) Rule type (`in`, `out`).
- `comment` - (Optional) Rule comment. - `comment` - (Optional) Rule comment.
- `dest` - (Optional) Restrict packet destination address. This can refer to - `dest` - (Optional) Restrict packet destination address. This can refer to
a single IP address, an IP set ('+ipsetname') or an IP alias definition. a single IP address, an IP set ('+ipsetname') or an IP alias
You can also specify an address range like `20.34.101.207-201.3.9.99`, or definition. You can also specify an address range like
a list of IP addresses and networks (entries are separated by comma). `20.34.101.207-201.3.9.99`, or a list of IP addresses and networks
Please do not mix IPv4 and IPv6 addresses inside such lists. (entries are separated by comma). Please do not mix IPv4 and IPv6
addresses inside such lists.
- `dport` - (Optional) Restrict TCP/UDP destination port. You can use - `dport` - (Optional) Restrict TCP/UDP destination port. You can use
service names or simple numbers (0-65535), as defined in '/etc/services'. service names or simple numbers (0-65535), as defined in '/etc/
Port ranges can be specified with '\d+:\d+', for example `80:85`, and services'. Port ranges can be specified with '\d+:\d+', for example
you can use comma separated list to match several ports or ranges. `80:85`, and you can use comma separated list to match several ports or
ranges.
- `enable` - (Optional) Enable this rule. Defaults to `true`. - `enable` - (Optional) Enable this rule. Defaults to `true`.
- `iface` - (Optional) Network interface name. You have to use network - `iface` - (Optional) Network interface name. You have to use network
configuration key names for VMs and containers ('net\d+'). Host related configuration key names for VMs and containers ('net\d+'). Host related
@ -71,12 +73,13 @@ resource "proxmox_virtual_environment_cluster_firewall_security_group" "webserve
to a single IP address, an IP set ('+ipsetname') or an IP alias to a single IP address, an IP set ('+ipsetname') or an IP alias
definition. You can also specify an address range like definition. You can also specify an address range like
`20.34.101.207-201.3.9.99`, or a list of IP addresses and networks ( `20.34.101.207-201.3.9.99`, or a list of IP addresses and networks (
entries are separated by comma). Please do not mix IPv4 and IPv6 addresses entries are separated by comma). Please do not mix IPv4 and IPv6
inside such lists. addresses inside such lists.
- `sport` - (Optional) Restrict TCP/UDP source port. You can use - `sport` - (Optional) Restrict TCP/UDP source port. You can use
service names or simple numbers (0-65535), as defined in '/etc/services'. service names or simple numbers (0-65535), as defined in '/etc/
Port ranges can be specified with '\d+:\d+', for example `80:85`, and services'. Port ranges can be specified with '\d+:\d+', for example
you can use comma separated list to match several ports or ranges. `80:85`, and you can use comma separated list to match several ports or
ranges.
## Attribute Reference ## Attribute Reference

11
docs/resources/virtual_environment_container.md
View File

@ -129,7 +129,9 @@ output "ubuntu_container_public_key" {
- `initialization` - (Optional) The initialization configuration. - `initialization` - (Optional) The initialization configuration.
- `dns` - (Optional) The DNS configuration. - `dns` - (Optional) The DNS configuration.
- `domain` - (Optional) The DNS search domain. - `domain` - (Optional) The DNS search domain.
- `server` - (Optional) The DNS server. The `server` attribute is deprecated and will be removed in a future release. Please use the `servers` attribute instead. - `server` - (Optional) The DNS server. The `server` attribute is
deprecated and will be removed in a future release. Please use
the `servers` attribute instead.
- `servers` - (Optional) The list of DNS servers. - `servers` - (Optional) The list of DNS servers.
- `hostname` - (Optional) The hostname. - `hostname` - (Optional) The hostname.
- `ip_config` - (Optional) The IP configuration (one block per network - `ip_config` - (Optional) The IP configuration (one block per network
@ -202,9 +204,10 @@ output "ubuntu_container_public_key" {
order. order.
- `up` - (Optional) A non-negative number defining the delay in seconds - `up` - (Optional) A non-negative number defining the delay in seconds
before the next container is started. before the next container is started.
- `down` - (Optional) A non-negative number defining the delay in seconds - `down` - (Optional) A non-negative number defining the delay in
before the next container is shut down. seconds before the next container is shut down.
- `start_on_boot` - (Optional) Automatically start container when the host system boots (defaults to `true`). - `start_on_boot` - (Optional) Automatically start container when the host
system boots (defaults to `true`).
- `tags` - (Optional) A list of tags the container tags. This is only meta - `tags` - (Optional) A list of tags the container tags. This is only meta
information (defaults to `[]`). Note: Proxmox always sorts the container tags. information (defaults to `[]`). Note: Proxmox always sorts the container tags.
If the list in template is not sorted, then Proxmox will always report a If the list in template is not sorted, then Proxmox will always report a

17
docs/resources/virtual_environment_file.md
View File

@ -98,8 +98,8 @@ resource "proxmox_virtual_environment_file" "ubuntu_container_template" {
## Argument Reference ## Argument Reference
- `content_type` - (Optional) The content type. If not specified, the content type will be inferred from the file - `content_type` - (Optional) The content type. If not specified, the content
extension. Valid values are: type will be inferred from the file extension. Valid values are:
- `dump` (allowed extensions: `.vzdump`) - `dump` (allowed extensions: `.vzdump`)
- `iso` (allowed extensions: `.iso`, `.img`) - `iso` (allowed extensions: `.iso`, `.img`)
- `snippets` (allowed extensions: any) - `snippets` (allowed extensions: any)
@ -108,16 +108,17 @@ resource "proxmox_virtual_environment_file" "ubuntu_container_template" {
- `node_name` - (Required) The node name. - `node_name` - (Required) The node name.
- `overwrite` - (Optional) Whether to overwrite an existing file (defaults to - `overwrite` - (Optional) Whether to overwrite an existing file (defaults to
`true`). `true`).
- `source_file` - (Optional) The source file (conflicts with `source_raw`), could be a - `source_file` - (Optional) The source file (conflicts with `source_raw`),
local file or a URL. If the source file is a URL, the file will be downloaded could be a local file or a URL. If the source file is a URL, the file will
and stored locally before uploading it to Proxmox VE. be downloaded and stored locally before uploading it to Proxmox VE.
- `checksum` - (Optional) The SHA256 checksum of the source file. - `checksum` - (Optional) The SHA256 checksum of the source file.
- `file_name` - (Optional) The file name to use instead of the source file - `file_name` - (Optional) The file name to use instead of the source file
name. Useful when the source file does not have a valid file extension, for example name. Useful when the source file does not have a valid file extension,
when the source file is a URL referencing a `.qcow2` image. for example when the source file is a URL referencing a `.qcow2` image.
- `insecure` - (Optional) Whether to skip the TLS verification step for - `insecure` - (Optional) Whether to skip the TLS verification step for
HTTPS sources (defaults to `false`). HTTPS sources (defaults to `false`).
- `min_tls` - (Optional) The minimum required TLS version for HTTPS sources. "Supported values: `1.0|1.1|1.2|1.3` (defaults to `1.3`). - `min_tls` - (Optional) The minimum required TLS version for HTTPS
sources. "Supported values: `1.0|1.1|1.2|1.3` (defaults to `1.3`).
- `path` - (Required) A path to a local file or a URL. - `path` - (Required) A path to a local file or a URL.
- `source_raw` - (Optional) The raw source (conflicts with `source_file`). - `source_raw` - (Optional) The raw source (conflicts with `source_file`).
- `data` - (Required) The raw data. - `data` - (Required) The raw data.

6
docs/resources/virtual_environment_firewall_options.md
View File

@ -44,9 +44,11 @@ resource "proxmox_virtual_environment_firewall_options" "example" {
local addresses to the one derived from the interface's MAC address. For local addresses to the one derived from the interface's MAC address. For
containers the configured IP addresses will be implicitly added. containers the configured IP addresses will be implicitly added.
- `log_level_in` - (Optional) Log level for incoming - `log_level_in` - (Optional) Log level for incoming
packets (`emerg`, `alert`, `crit`, `err`, `warning`, `notice`, `info`, `debug`, `nolog`). packets (`emerg`, `alert`, `crit`, `err`, `warning`, `notice`, `info`,
`debug`, `nolog`).
- `log_level_out` - (Optional) Log level for outgoing - `log_level_out` - (Optional) Log level for outgoing
packets (`emerg`, `alert`, `crit`, `err`, `warning`, `notice`, `info`, `debug`, `nolog`). packets (`emerg`, `alert`, `crit`, `err`, `warning`, `notice`, `info`,
`debug`, `nolog`).
- `macfilter` - (Optional) Enable/disable MAC address filter. - `macfilter` - (Optional) Enable/disable MAC address filter.
- `ndp` - (Optional) Enable NDP (Neighbor Discovery Protocol). - `ndp` - (Optional) Enable NDP (Neighbor Discovery Protocol).
- `input_policy` - (Optional) The default input - `input_policy` - (Optional) The default input

22
docs/resources/virtual_environment_firewall_rules.md
View File

@ -60,21 +60,21 @@ resource "proxmox_virtual_environment_firewall_rules" "inbound" {
rules. rules.
- `rule` - (Optional) Firewall rule block (multiple blocks supported). - `rule` - (Optional) Firewall rule block (multiple blocks supported).
The provider supports two types of the `rule` blocks: The provider supports two types of the `rule` blocks:
- a rule definition block, which includes the following arguments: - A rule definition block, which includes the following arguments:
- `action` - (Required) Rule action (`ACCEPT`, `DROP`, `REJECT`). - `action` - (Required) Rule action (`ACCEPT`, `DROP`, `REJECT`).
- `type` - (Required) Rule type (`in`, `out`). - `type` - (Required) Rule type (`in`, `out`).
- `comment` - (Optional) Rule comment. - `comment` - (Optional) Rule comment.
- `dest` - (Optional) Restrict packet destination address. This can - `dest` - (Optional) Restrict packet destination address. This can
refer to a single IP address, an IP set ('+ipsetname') or an IP alias refer to a single IP address, an IP set ('+ipsetname') or an IP
definition. You can also specify an address range alias definition. You can also specify an address range
like `20.34.101.207-201.3.9.99`, or a list of IP addresses and like `20.34.101.207-201.3.9.99`, or a list of IP addresses and
networks (entries are separated by comma). Please do not mix IPv4 and networks (entries are separated by comma). Please do not mix IPv4
IPv6 addresses inside such lists. and IPv6 addresses inside such lists.
- `dport` - (Optional) Restrict TCP/UDP destination port. You can use - `dport` - (Optional) Restrict TCP/UDP destination port. You can use
service names or simple numbers (0-65535), as defined service names or simple numbers (0-65535), as defined
in `/etc/services`. Port ranges can be specified with '\d+:\d+', for in `/etc/services`. Port ranges can be specified with '\d+:\d+', for
example `80:85`, and you can use comma separated list to match several example `80:85`, and you can use comma separated list to match
ports or ranges. several ports or ranges.
- `enabled` - (Optional) Enable this rule. Defaults to `true`. - `enabled` - (Optional) Enable this rule. Defaults to `true`.
- `iface` - (Optional) Network interface name. You have to use network - `iface` - (Optional) Network interface name. You have to use network
configuration key names for VMs and containers ('net\d+'). Host configuration key names for VMs and containers ('net\d+'). Host
@ -89,13 +89,13 @@ resource "proxmox_virtual_environment_firewall_rules" "inbound" {
to a single IP address, an IP set ('+ipsetname') or an IP alias to a single IP address, an IP set ('+ipsetname') or an IP alias
definition. You can also specify an address range definition. You can also specify an address range
like `20.34.101.207-201.3.9.99`, or a list of IP addresses and like `20.34.101.207-201.3.9.99`, or a list of IP addresses and
networks (entries are separated by comma). Please do not mix IPv4 and networks (entries are separated by comma). Please do not mix IPv4
IPv6 addresses inside such lists. and IPv6 addresses inside such lists.
- `sport` - (Optional) Restrict TCP/UDP source port. You can use - `sport` - (Optional) Restrict TCP/UDP source port. You can use
service names or simple numbers (0-65535), as defined service names or simple numbers (0-65535), as defined
in `/etc/services`. Port ranges can be specified with '\d+:\d+', for in `/etc/services`. Port ranges can be specified with '\d+:\d+', for
example `80:85`, and you can use comma separated list to match several example `80:85`, and you can use comma separated list to match
ports or ranges. several ports or ranges.
- a security group insertion block, which includes the following arguments: - a security group insertion block, which includes the following arguments:
- `comment` - (Optional) Rule comment. - `comment` - (Optional) Rule comment.
- `enabled` - (Optional) Enable this rule. Defaults to `true`. - `enabled` - (Optional) Enable this rule. Defaults to `true`.

21
docs/resources/virtual_environment_vm.md
View File

@ -183,10 +183,8 @@ output "ubuntu_vm_public_key" {
- `type` - (Optional) The emulated CPU type, it's recommended to - `type` - (Optional) The emulated CPU type, it's recommended to
use `x86-64-v2-AES` (defaults to `qemu64`). use `x86-64-v2-AES` (defaults to `qemu64`).
- `486` - Intel 486. - `486` - Intel 486.
- `Broadwell`/`Broadwell-IBRS`/`Broadwell-noTSX`/`Broadwell-noTSX-IBRS` - - `Broadwell`/`Broadwell-IBRS`/`Broadwell-noTSX`/`Broadwell-noTSX-IBRS` - Intel Core Processor (Broadwell, 2014).
Intel Core Processor (Broadwell, 2014). - `Cascadelake-Server`/`Cascadelake-Server-noTSX`/`Cascadelake-Server-v2`/`Cascadelake-Server-v4`/`Cascadelake-Server-v5` - Intel Xeon 32xx/42xx/52xx/62xx/82xx/92xx (2019).
- `Cascadelake-Server`/`Cascadelake-Server-noTSX`/`Cascadelake-Server-v2`/`Cascadelake-Server-v4`/`Cascadelake-Server-v5` -
Intel Xeon 32xx/42xx/52xx/62xx/82xx/92xx (2019).
- `Conroe` - Intel Celeron_4x0 (Conroe/Merom Class Core 2, 2006). - `Conroe` - Intel Celeron_4x0 (Conroe/Merom Class Core 2, 2006).
- `Cooperlake`/`Cooperlake-v2` - `Cooperlake`/`Cooperlake-v2`
- `EPYC`/`EPYC-IBPB`/`EPYC-Milan`/`EPYC-Rome`/`EPYC-Rome-v2`/`EPYC-v3` - - `EPYC`/`EPYC-IBPB`/`EPYC-Milan`/`EPYC-Rome`/`EPYC-Rome-v2`/`EPYC-v3` -
@ -194,7 +192,8 @@ output "ubuntu_vm_public_key" {
- `Haswell`/`Haswell-IBRS`/`Haswell-noTSX`/`Haswell-noTSX-IBRS` - Intel - `Haswell`/`Haswell-IBRS`/`Haswell-noTSX`/`Haswell-noTSX-IBRS` - Intel
Core Processor (Haswell, 2013). Core Processor (Haswell, 2013).
- `Icelake-Client`/`Icelake-Client-noTSX` - `Icelake-Client`/`Icelake-Client-noTSX`
- `Icelake-Server`/`Icelake-Server-noTSX`/`Icelake-Server-v3`/`Icelake-Server-v4`/`Icelake-Server-v5`/`Icelake-Server-v6` - `Icelake-Server`/`Icelake-Server-noTSX`/`Icelake-Server-v3`/
`Icelake-Server-v4`/`Icelake-Server-v5`/`Icelake-Server-v6`
- `IvyBridge`/`IvyBridge-IBRS` - Intel Xeon E3-12xx v2 (Ivy Bridge, - `IvyBridge`/`IvyBridge-IBRS` - Intel Xeon E3-12xx v2 (Ivy Bridge,
2012). 2012).
- `KnightsMill` - Intel Xeon Phi 72xx (2017). - `KnightsMill` - Intel Xeon Phi 72xx (2017).
@ -315,8 +314,8 @@ output "ubuntu_vm_public_key" {
- `host` - (Optional) The USB device ID. Use either this or `mapping`. - `host` - (Optional) The USB device ID. Use either this or `mapping`.
- `mapping` - (Optional) The resource mapping name of the device, for - `mapping` - (Optional) The resource mapping name of the device, for
example usbdevice. Use either this or `id`. example usbdevice. Use either this or `id`.
- `usb3` - (Optional) Makes the USB device a USB3 device for the VM (defaults - `usb3` - (Optional) Makes the USB device a USB3 device for the VM
to `false`). (defaults to `false`).
- `initialization` - (Optional) The cloud-init configuration. - `initialization` - (Optional) The cloud-init configuration.
- `datastore_id` - (Optional) The identifier for the datastore to create the - `datastore_id` - (Optional) The identifier for the datastore to create the
cloud-init disk in (defaults to `local-lvm`). cloud-init disk in (defaults to `local-lvm`).
@ -326,7 +325,9 @@ output "ubuntu_vm_public_key" {
otherwise defaults to `ide2`. otherwise defaults to `ide2`.
- `dns` - (Optional) The DNS configuration. - `dns` - (Optional) The DNS configuration.
- `domain` - (Optional) The DNS search domain. - `domain` - (Optional) The DNS search domain.
- `server` - (Optional) The DNS server. The `server` attribute is deprecated and will be removed in a future release. Please use the `servers` attribute instead. - `server` - (Optional) The DNS server. The `server` attribute is
deprecated and will be removed in a future release. Please use the
`servers` attribute instead.
- `servers` - (Optional) The list of DNS servers. - `servers` - (Optional) The list of DNS servers.
- `ip_config` - (Optional) The IP configuration (one block per network - `ip_config` - (Optional) The IP configuration (one block per network
device). device).
@ -440,8 +441,8 @@ output "ubuntu_vm_public_key" {
- `device` - (Optional) The device (defaults to `socket`). - `device` - (Optional) The device (defaults to `socket`).
- `/dev/*` - A host serial device. - `/dev/*` - A host serial device.
- `socket` - A unix socket. - `socket` - A unix socket.
- `scsi_hardware` - (Optional) The SCSI hardware type (defaults - `scsi_hardware` - (Optional) The SCSI hardware type (defaults to
to `virtio-scsi-pci`). `virtio-scsi-pci`).
- `lsi` - LSI Logic SAS1068E. - `lsi` - LSI Logic SAS1068E.
- `lsi53c810` - LSI Logic 53C810. - `lsi53c810` - LSI Logic 53C810.
- `virtio-scsi-pci` - VirtIO SCSI. - `virtio-scsi-pci` - VirtIO SCSI.