Skip to content

Commit

Permalink
chore(docs): clarify disk.file_id format (#1374)
Browse files Browse the repository at this point in the history
chore(docs): clarify `disk.file_id` format

Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
  • Loading branch information
bpg authored Jun 10, 2024
1 parent 24f9990 commit f3ac15a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/resources/virtual_environment_vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,9 +266,9 @@ output "ubuntu_vm_public_key" {
- `qcow2` - QEMU Disk Image v2.
- `raw` - Raw Disk Image.
- `vmdk` - VMware Disk Image.
- `file_id` - (Optional) The file ID for a disk image (experimental -
might cause high CPU utilization during import, especially with large
disk images).
- `file_id` - (Optional) The file ID for a disk image. The ID format is
`<datastore_id>:<content_type>/<file_name>`, for example `local:iso/centos8.img`. Can be also taken from
`proxmox_virtual_environment_download_file` resource.
- `interface` - (Required) The disk interface for Proxmox, currently `scsi`,
`sata` and `virtio` interfaces are supported. Append the disk index at
the end, for example, `virtio0` for the first virtio disk, `virtio1` for
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/virtual_environment_vm2.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The attributes are also marked as optional to allow the practitioner to set (or

### Optional

- `cdrom` (Attributes Map) The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of `ideN`, `sataN`, `scsiN`, where N is the index of the interface. (see [below for nested schema](#nestedatt--cdrom))
- `cdrom` (Attributes Map) The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of `ideN`, `sataN`, `scsiN`, where N is the index of the interface. Note that `q35` machine type only supports `ide0` and `ide2` of IDE interfaces. (see [below for nested schema](#nestedatt--cdrom))
- `clone` (Attributes) The cloning configuration. (see [below for nested schema](#nestedatt--clone))
- `cpu` (Attributes) The CPU configuration. (see [below for nested schema](#nestedatt--cpu))
- `description` (String) The description of the VM.
Expand Down
3 changes: 2 additions & 1 deletion fwprovider/vm/cdrom/resource_schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ func ResourceSchema() schema.Attribute {
return schema.MapNestedAttribute{
Description: "The CD-ROM configuration",
MarkdownDescription: "The CD-ROM configuration. The key is the interface of the CD-ROM, " +
"could be one of `ideN`, `sataN`, `scsiN`, where N is the index of the interface.",
"could be one of `ideN`, `sataN`, `scsiN`, where N is the index of the interface. " +
"Note that `q35` machine type only supports `ide0` and `ide2` of IDE interfaces.",
Optional: true,
Computed: true,
Validators: []validator.Map{
Expand Down

0 comments on commit f3ac15a

Please sign in to comment.