mirrors/terraform-provider-proxmox
0
0
Fork 0
mirror of https://github.com/bpg/terraform-provider-proxmox.git synced 2025-07-01 11:02:59 +00:00
Code

chore(docs): Minor documentation Improvements (#266)

Browse Source 
* add port to endpoint + examples to the root doc

* clarify disk `interface` values
This commit is contained in:
Pavel Boldyrev 2023-03-17 21:31:19 -04:00 committed by GitHub
parent ce8bd3008b
commit 696ecb05d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/index.md
View File

@ -18,7 +18,7 @@ Use the navigation to the left to read about the available resources.
```terraform ```terraform
provider "proxmox" { provider "proxmox" {
virtual_environment { virtual_environment {
endpoint = "https://10.0.0.2" endpoint = "https://10.0.0.2:8006/"
username = "root@pam" username = "root@pam"
password = "the-password-set-during-installation-of-proxmox-ve" password = "the-password-set-during-installation-of-proxmox-ve"
insecure = true insecure = true
@ -83,7 +83,8 @@ Proxmox `provider` block:
- `virtual_environment` - (Optional) The Proxmox Virtual Environment - `virtual_environment` - (Optional) The Proxmox Virtual Environment
configuration. configuration.
- `endpoint` - (Required) The endpoint for the Proxmox Virtual Environment - `endpoint` - (Required) The endpoint for the Proxmox Virtual Environment
API (can also be sourced from `PROXMOX_VE_ENDPOINT`). API (can also be sourced from `PROXMOX_VE_ENDPOINT`). Usually this is
`https://<your-cluster-endpoint>:8006/`.
- `insecure` - (Optional) Whether to skip the TLS verification step (can - `insecure` - (Optional) Whether to skip the TLS verification step (can
also be sourced from `PROXMOX_VE_INSECURE`). If omitted, defaults also be sourced from `PROXMOX_VE_INSECURE`). If omitted, defaults
to `false`. to `false`.
@ -92,4 +93,5 @@ Proxmox `provider` block:
- `password` - (Required) The password for the Proxmox Virtual Environment - `password` - (Required) The password for the Proxmox Virtual Environment
API (can also be sourced from `PROXMOX_VE_PASSWORD`). API (can also be sourced from `PROXMOX_VE_PASSWORD`).
- `username` - (Required) The username and realm for the Proxmox Virtual - `username` - (Required) The username and realm for the Proxmox Virtual
Environment API (can also be sourced from `PROXMOX_VE_USERNAME`). Environment API (can also be sourced from `PROXMOX_VE_USERNAME`). For
example, `root@pam`.

10
docs/resources/virtual_environment_vm.md
View File

@ -205,8 +205,8 @@ output "ubuntu_vm_public_key" {
- `phenom` - AMD Phenom (2010). - `phenom` - AMD Phenom (2010).
- `qemu32`/`qemu64` - QEMU Virtual CPU version 2.5+ (32 & 64 bit - `qemu32`/`qemu64` - QEMU Virtual CPU version 2.5+ (32 & 64 bit
variants). variants).
- `custom-<model>` - Custom CPU model. All `custom-<model>` values should be - `custom-<model>` - Custom CPU model. All `custom-<model>` values
defined in `/etc/pve/virtual-guest/cpu-models.conf` file. should be defined in `/etc/pve/virtual-guest/cpu-models.conf` file.
- `units` - (Optional) The CPU units (defaults to `1024`). - `units` - (Optional) The CPU units (defaults to `1024`).
- `description` - (Optional) The description. - `description` - (Optional) The description.
- `disk` - (Optional) A disk (multiple blocks supported). - `disk` - (Optional) A disk (multiple blocks supported).
@ -222,8 +222,10 @@ output "ubuntu_vm_public_key" {
- `file_id` - (Optional) The file ID for a disk image (experimental - - `file_id` - (Optional) The file ID for a disk image (experimental -
might cause high CPU utilization during import, especially with large might cause high CPU utilization during import, especially with large
disk images). disk images).
- `interface` - (Required) The disk interface for Proxmox, currently scsi, - `interface` - (Required) The disk interface for Proxmox, currently `scsi`,
sata and virtio are supported. `sata` and `virtio` interfaces are supported. Append the disk index at
the end, for example, `virtio0` for the first virtio disk, `virtio1` for
the second, etc.
- `iothread` - (Optional) Whether to use iothreads for this disk (defaults - `iothread` - (Optional) Whether to use iothreads for this disk (defaults
to `false`). to `false`).
- `size` - (Optional) The disk size in gigabytes (defaults to `8`). - `size` - (Optional) The disk size in gigabytes (defaults to `8`).