From b6af836386bfc07d887339cd49280f033b9e3a7d Mon Sep 17 00:00:00 2001 From: Pavel Boldyrev <627562+bpg@users.noreply.github.com> Date: Sun, 5 May 2024 15:23:21 -0400 Subject: [PATCH] misc: update documentation Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 5 +- CONTRIBUTING.md | 2 +- README.md | 7 ++ .../virtual_environment_datastores.md | 2 +- docs/data-sources/virtual_environment_dns.md | 2 +- .../data-sources/virtual_environment_group.md | 2 +- .../virtual_environment_groups.md | 2 +- .../data-sources/virtual_environment_hosts.md | 2 +- docs/data-sources/virtual_environment_node.md | 2 +- .../data-sources/virtual_environment_nodes.md | 2 +- docs/data-sources/virtual_environment_pool.md | 2 +- .../data-sources/virtual_environment_pools.md | 2 +- docs/data-sources/virtual_environment_role.md | 2 +- .../data-sources/virtual_environment_roles.md | 2 +- docs/data-sources/virtual_environment_time.md | 2 +- docs/data-sources/virtual_environment_user.md | 2 +- .../data-sources/virtual_environment_users.md | 2 +- docs/data-sources/virtual_environment_vm.md | 2 +- docs/data-sources/virtual_environment_vms.md | 2 +- docs/index.md | 38 ++++---- .../virtual_environment_certificate.md | 2 +- .../virtual_environment_cluster_firewall.md | 2 +- ...ronment_cluster_firewall_security_group.md | 2 +- .../virtual_environment_container.md | 2 +- docs/resources/virtual_environment_dns.md | 2 +- docs/resources/virtual_environment_file.md | 8 +- .../virtual_environment_firewall_alias.md | 2 +- .../virtual_environment_firewall_ipset.md | 2 +- .../virtual_environment_firewall_options.md | 2 +- .../virtual_environment_firewall_rules.md | 2 +- docs/resources/virtual_environment_group.md | 2 +- docs/resources/virtual_environment_hosts.md | 2 +- docs/resources/virtual_environment_pool.md | 2 +- docs/resources/virtual_environment_role.md | 2 +- docs/resources/virtual_environment_time.md | 2 +- docs/resources/virtual_environment_user.md | 2 +- docs/resources/virtual_environment_vm.md | 4 +- docs/resources/virtual_environment_vm2.md | 5 +- fwprovider/tests/resource_vm_test.go | 92 ++++++++++++++----- .../resources/virtual_environment_vm2.md.tmpl | 5 +- 40 files changed, 139 insertions(+), 89 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 179af8a4..180004dd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -37,7 +37,8 @@ If applicable, add screenshots to help explain your problem. Add any other context about the problem here. - Single or clustered Proxmox: +- Proxmox version: - Provider version (ideally it should be the latest version): -- Terraform version: -- OS (where you run Terraform from): +- Terraform/OpenTofu version: +- OS (where you run Terraform/OpenTofu from): - Debug logs (`TF_LOG=DEBUG terraform apply`): diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ae50689..716fabbf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,7 +78,7 @@ testing changes to the provider before submitting a PR. - Create a $HOME/.terraformrc (POSIX) or %APPDATA%/terraform.rc (Windows) file with the following contents: - ```terraform + ```hcl provider_installation { dev_overrides { diff --git a/README.md b/README.md index 3885bddc..195f9733 100644 --- a/README.md +++ b/README.md @@ -142,3 +142,10 @@ See [CONTRIBUTORS.md](CONTRIBUTORS.md) for a list of contributors to this projec - [Ben Bouillet](https://github.com/benbouillet) Thanks again for your support, it is much appreciated! 🙏 + + +## Acknowledgements + +This project has been developed with **GoLand** IDE under the [JetBrains Open Source license](https://www.jetbrains.com/community/opensource/#support), generously provided by JetBrains s.r.o. + +GoLand logo diff --git a/docs/data-sources/virtual_environment_datastores.md b/docs/data-sources/virtual_environment_datastores.md index 73825435..8000573b 100644 --- a/docs/data-sources/virtual_environment_datastores.md +++ b/docs/data-sources/virtual_environment_datastores.md @@ -11,7 +11,7 @@ Retrieves information about all the datastores available to a specific node. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_datastores" "first_node" { node_name = "first-node" } diff --git a/docs/data-sources/virtual_environment_dns.md b/docs/data-sources/virtual_environment_dns.md index 19eb7b16..77e9975e 100644 --- a/docs/data-sources/virtual_environment_dns.md +++ b/docs/data-sources/virtual_environment_dns.md @@ -11,7 +11,7 @@ Retrieves the DNS configuration for a specific node. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_dns" "first_node" { node_name = "first-node" } diff --git a/docs/data-sources/virtual_environment_group.md b/docs/data-sources/virtual_environment_group.md index 53eb783e..2ae3bd00 100644 --- a/docs/data-sources/virtual_environment_group.md +++ b/docs/data-sources/virtual_environment_group.md @@ -11,7 +11,7 @@ Retrieves information about a specific user group. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_group" "operations_team" { group_id = "operations-team" } diff --git a/docs/data-sources/virtual_environment_groups.md b/docs/data-sources/virtual_environment_groups.md index 50d6a800..c6ddb328 100644 --- a/docs/data-sources/virtual_environment_groups.md +++ b/docs/data-sources/virtual_environment_groups.md @@ -11,7 +11,7 @@ Retrieves basic information about all available user groups. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_groups" "available_groups" {} ``` diff --git a/docs/data-sources/virtual_environment_hosts.md b/docs/data-sources/virtual_environment_hosts.md index 25eb5fe6..8ff4cb4a 100644 --- a/docs/data-sources/virtual_environment_hosts.md +++ b/docs/data-sources/virtual_environment_hosts.md @@ -11,7 +11,7 @@ Retrieves all the host entries from a specific node. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_hosts" "first_node_host_entries" { node_name = "first-node" } diff --git a/docs/data-sources/virtual_environment_node.md b/docs/data-sources/virtual_environment_node.md index 14485076..d505c95e 100644 --- a/docs/data-sources/virtual_environment_node.md +++ b/docs/data-sources/virtual_environment_node.md @@ -11,7 +11,7 @@ Retrieves information about node. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_node" "node" {} ``` diff --git a/docs/data-sources/virtual_environment_nodes.md b/docs/data-sources/virtual_environment_nodes.md index 3f79750a..335e2563 100644 --- a/docs/data-sources/virtual_environment_nodes.md +++ b/docs/data-sources/virtual_environment_nodes.md @@ -11,7 +11,7 @@ Retrieves information about all available nodes. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_nodes" "available_nodes" {} ``` diff --git a/docs/data-sources/virtual_environment_pool.md b/docs/data-sources/virtual_environment_pool.md index 81a96503..3961469a 100644 --- a/docs/data-sources/virtual_environment_pool.md +++ b/docs/data-sources/virtual_environment_pool.md @@ -11,7 +11,7 @@ Retrieves information about a specific resource pool. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_pool" "operations_pool" { pool_id = "operations" } diff --git a/docs/data-sources/virtual_environment_pools.md b/docs/data-sources/virtual_environment_pools.md index 352aba88..7238fee6 100644 --- a/docs/data-sources/virtual_environment_pools.md +++ b/docs/data-sources/virtual_environment_pools.md @@ -11,7 +11,7 @@ Retrieves the identifiers for all the available resource pools. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_pools" "available_pools" {} ``` diff --git a/docs/data-sources/virtual_environment_role.md b/docs/data-sources/virtual_environment_role.md index d481d810..d71a2616 100644 --- a/docs/data-sources/virtual_environment_role.md +++ b/docs/data-sources/virtual_environment_role.md @@ -11,7 +11,7 @@ Retrieves information about a specific role. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_role" "operations_role" { role_id = "operations" } diff --git a/docs/data-sources/virtual_environment_roles.md b/docs/data-sources/virtual_environment_roles.md index a12b2666..25284af0 100644 --- a/docs/data-sources/virtual_environment_roles.md +++ b/docs/data-sources/virtual_environment_roles.md @@ -11,7 +11,7 @@ Retrieves information about all the available roles. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_roles" "available_roles" {} ``` diff --git a/docs/data-sources/virtual_environment_time.md b/docs/data-sources/virtual_environment_time.md index 4fcec329..619f08de 100644 --- a/docs/data-sources/virtual_environment_time.md +++ b/docs/data-sources/virtual_environment_time.md @@ -11,7 +11,7 @@ Retrieves the current time for a specific node. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_time" "first_node_time" { node_name = "first-node" } diff --git a/docs/data-sources/virtual_environment_user.md b/docs/data-sources/virtual_environment_user.md index d25c46d1..e03dff3f 100644 --- a/docs/data-sources/virtual_environment_user.md +++ b/docs/data-sources/virtual_environment_user.md @@ -11,7 +11,7 @@ Retrieves information about a specific user. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_user" "operations_user" { user_id = "operation@pam" } diff --git a/docs/data-sources/virtual_environment_users.md b/docs/data-sources/virtual_environment_users.md index 2e8d3c11..4864435c 100644 --- a/docs/data-sources/virtual_environment_users.md +++ b/docs/data-sources/virtual_environment_users.md @@ -11,7 +11,7 @@ Retrieves information about all the available users. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_users" "available_users" {} ``` diff --git a/docs/data-sources/virtual_environment_vm.md b/docs/data-sources/virtual_environment_vm.md index 5a269314..59f7aca1 100644 --- a/docs/data-sources/virtual_environment_vm.md +++ b/docs/data-sources/virtual_environment_vm.md @@ -11,7 +11,7 @@ Retrieves information about a specific VM. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_vm" "test_vm" { node_name = "test" vm_id = 100 diff --git a/docs/data-sources/virtual_environment_vms.md b/docs/data-sources/virtual_environment_vms.md index 07099ba3..8e45293a 100644 --- a/docs/data-sources/virtual_environment_vms.md +++ b/docs/data-sources/virtual_environment_vms.md @@ -11,7 +11,7 @@ Retrieves information about all VMs in the Proxmox cluster. ## Example Usage -```terraform +```hcl data "proxmox_virtual_environment_vms" "ubuntu_vms" { tags = ["ubuntu"] } diff --git a/docs/index.md b/docs/index.md index 204ab291..20190bed 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,7 +12,7 @@ Use the navigation to the left to read about the available resources. ## Example Usage -```terraform +```hcl provider "proxmox" { endpoint = "https://10.0.0.2:8006/" # TODO: use terraform variable or remove the line, and use PROXMOX_VE_USERNAME environment variable @@ -41,7 +41,7 @@ Static credentials can be provided to the `proxmox` block through either a `api_ Static credentials can be provided by adding a `username` and `password`, or `api_token` in-line in the Proxmox provider block: -```terraform +```hcl provider "proxmox" { endpoint = "https://10.0.0.2:8006/" username = "username@realm" @@ -51,7 +51,7 @@ provider "proxmox" { A better approach is to extract these values into Terraform variables, and reference the variables instead: -```terraform +```hcl provider "proxmox" { endpoint = var.virtual_environment_endpoint username = var.virtual_environment_username @@ -67,7 +67,7 @@ See the [Terraform documentation](https://www.terraform.io/docs/configuration/va Instead of using static arguments, credentials can be handled through the use of environment variables. For example: -```terraform +```hcl provider "proxmox" { endpoint = "https://10.0.0.2:8006/" } @@ -91,7 +91,7 @@ For example, to import VM disks, or to uploading certain type of resources, such The SSH connection configuration is provided via the optional `ssh` block in the `provider` block: -```terraform +```hcl provider "proxmox" { endpoint = "https://10.0.0.2:8006/" username = "username@realm" @@ -124,7 +124,7 @@ you can use the `private_key` argument in the `ssh` block (or alternatively `PRO The private key mut not be encrypted, and must be in PEM format. You can provide the private key from a file: -```terraform +```hcl provider "proxmox" { // ... ssh { @@ -135,20 +135,20 @@ provider "proxmox" { ``` Alternatively, although not recommended due to the increased risk of exposing an unprotected key, heredoc syntax can be used to supply the private key as a string. -Note that the content of the private key must not be indented: -```terraform +Note that the content of the private key is injected using `<<-` format to ignore indentation: +```hcl provider "proxmox" { // ... ssh { agent = false - private_key = < -DMUWUEaH7yMCKl7uCZ9xAAAAAAECAwQF ------END OPENSSH PRIVATE KEY----- -EOF + private_key = <<-EOF + -----BEGIN OPENSSH PRIVATE KEY----- + b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW + + DMUWUEaH7yMCKl7uCZ9xAAAAAAECAwQF + -----END OPENSSH PRIVATE KEY----- + EOF } } ``` @@ -158,7 +158,7 @@ EOF By default, the provider will use the same username for the SSH connection as the one used for the Proxmox API connection (when using PAM authentication). This can be overridden by specifying the `username` argument in the `ssh` block (or alternatively a username in the `PROXMOX_VE_SSH_USERNAME` environment variable): -```terraform +```hcl provider "proxmox" { // ... @@ -234,7 +234,7 @@ In some cases this may not be the desired behavior, for example, when the node h To override the node IP address used for SSH connection, you can use the optional `node` blocks in the `ssh` block, and specify the desired IP address (or FQDN) for each node. For example: -```terraform +```hcl provider "proxmox" { // ... ssh { @@ -257,7 +257,7 @@ The provider supports SSH connection to the target node via a SOCKS5 proxy. To enable the SOCKS5 proxy, you need to configure the `ssh` block in the `provider` block, and specify the `socks5_server` argument: -```terraform +```hcl provider "proxmox" { // ... ssh { @@ -309,7 +309,7 @@ Refer to the upstream docs as needed for additional details concerning [PVE User Generating the token will output a table containing the token's ID and secret which are meant to be concatenated into a single string for use with either the `api_token` field of the `provider` block (fine for testing but should be avoided) or sourced from the `PROXMOX_VE_API_TOKEN` environment variable. -```terraform +```hcl provider "proxmox" { endpoint = var.virtual_environment_endpoint api_token = "terraform@pve!provider=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" diff --git a/docs/resources/virtual_environment_certificate.md b/docs/resources/virtual_environment_certificate.md index cda45751..4b2cd24b 100644 --- a/docs/resources/virtual_environment_certificate.md +++ b/docs/resources/virtual_environment_certificate.md @@ -11,7 +11,7 @@ Manages the custom SSL/TLS certificate for a specific node. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_certificate" "example" { certificate = tls_self_signed_cert.proxmox_virtual_environment_certificate.cert_pem node_name = "first-node" diff --git a/docs/resources/virtual_environment_cluster_firewall.md b/docs/resources/virtual_environment_cluster_firewall.md index e3b9f6d7..3ebeaab0 100644 --- a/docs/resources/virtual_environment_cluster_firewall.md +++ b/docs/resources/virtual_environment_cluster_firewall.md @@ -11,7 +11,7 @@ Manages firewall options on the cluster level. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_cluster_firewall" "example" { enabled = false diff --git a/docs/resources/virtual_environment_cluster_firewall_security_group.md b/docs/resources/virtual_environment_cluster_firewall_security_group.md index 1547e913..e455769e 100644 --- a/docs/resources/virtual_environment_cluster_firewall_security_group.md +++ b/docs/resources/virtual_environment_cluster_firewall_security_group.md @@ -13,7 +13,7 @@ with rules to open the http and https ports. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_cluster_firewall_security_group" "webserver" { name = "webserver" comment = "Managed by Terraform" diff --git a/docs/resources/virtual_environment_container.md b/docs/resources/virtual_environment_container.md index f5f5f290..37429c03 100644 --- a/docs/resources/virtual_environment_container.md +++ b/docs/resources/virtual_environment_container.md @@ -11,7 +11,7 @@ Manages a container. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_container" "ubuntu_container" { description = "Managed by Terraform" diff --git a/docs/resources/virtual_environment_dns.md b/docs/resources/virtual_environment_dns.md index 5b0306df..4ec9d7ed 100644 --- a/docs/resources/virtual_environment_dns.md +++ b/docs/resources/virtual_environment_dns.md @@ -11,7 +11,7 @@ Manages the DNS configuration for a specific node. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_dns" "first_node_dns_configuration" { domain = data.proxmox_virtual_environment_dns.first_node_dns_configuration.domain node_name = data.proxmox_virtual_environment_dns.first_node_dns_configuration.node_name diff --git a/docs/resources/virtual_environment_file.md b/docs/resources/virtual_environment_file.md index e53e8c85..cb9a0fe9 100644 --- a/docs/resources/virtual_environment_file.md +++ b/docs/resources/virtual_environment_file.md @@ -15,7 +15,7 @@ Manages a file. -> The resource with this content type uses SSH access to the node. You might need to configure the [`ssh` option in the `provider` section](../index.md#node-ip-address-used-for-ssh-connection). -```terraform +```hcl resource "proxmox_virtual_environment_file" "backup" { content_type = "dump" datastore_id = "local" @@ -31,7 +31,7 @@ resource "proxmox_virtual_environment_file" "backup" { -> Consider using `proxmox_virtual_environment_download_file` resource instead. Using this resource for images is less efficient (requires to transfer uploaded image to node) though still supported. -```terraform +```hcl resource "proxmox_virtual_environment_file" "ubuntu_container_template" { content_type = "iso" datastore_id = "local" @@ -49,7 +49,7 @@ resource "proxmox_virtual_environment_file" "ubuntu_container_template" { -> The resource with this content type uses SSH access to the node. You might need to configure the [`ssh` option in the `provider` section](../index.md#node-ip-address-used-for-ssh-connection). -```terraform +```hcl resource "proxmox_virtual_environment_file" "cloud_config" { content_type = "snippets" datastore_id = "local" @@ -84,7 +84,7 @@ EOF -> Consider using `proxmox_virtual_environment_download_file` resource instead. Using this resource for container images is less efficient (requires to transfer uploaded image to node) though still supported. -```terraform +```hcl resource "proxmox_virtual_environment_file" "ubuntu_container_template" { content_type = "vztmpl" datastore_id = "local" diff --git a/docs/resources/virtual_environment_firewall_alias.md b/docs/resources/virtual_environment_firewall_alias.md index f793501d..43a7f209 100644 --- a/docs/resources/virtual_environment_firewall_alias.md +++ b/docs/resources/virtual_environment_firewall_alias.md @@ -13,7 +13,7 @@ created on the cluster level, on VM / Container level. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_firewall_alias" "local_network" { depends_on = [proxmox_virtual_environment_vm.example] diff --git a/docs/resources/virtual_environment_firewall_ipset.md b/docs/resources/virtual_environment_firewall_ipset.md index 0b7557d4..bf8fdacd 100644 --- a/docs/resources/virtual_environment_firewall_ipset.md +++ b/docs/resources/virtual_environment_firewall_ipset.md @@ -12,7 +12,7 @@ created on the cluster level, on VM / Container level. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_firewall_ipset" "ipset" { depends_on = [proxmox_virtual_environment_vm.example] diff --git a/docs/resources/virtual_environment_firewall_options.md b/docs/resources/virtual_environment_firewall_options.md index 9ed769fe..be887158 100644 --- a/docs/resources/virtual_environment_firewall_options.md +++ b/docs/resources/virtual_environment_firewall_options.md @@ -11,7 +11,7 @@ Manages firewall options on VM / Container level. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_firewall_options" "example" { depends_on = [proxmox_virtual_environment_vm.example] diff --git a/docs/resources/virtual_environment_firewall_rules.md b/docs/resources/virtual_environment_firewall_rules.md index 54fdcb79..a3219b5b 100644 --- a/docs/resources/virtual_environment_firewall_rules.md +++ b/docs/resources/virtual_environment_firewall_rules.md @@ -14,7 +14,7 @@ level, on VM / Container level. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_firewall_rules" "inbound" { depends_on = [ proxmox_virtual_environment_vm.example, diff --git a/docs/resources/virtual_environment_group.md b/docs/resources/virtual_environment_group.md index 46b31f2f..d8234df5 100644 --- a/docs/resources/virtual_environment_group.md +++ b/docs/resources/virtual_environment_group.md @@ -11,7 +11,7 @@ Manages a user group. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_group" "operations_team" { comment = "Managed by Terraform" group_id = "operations-team" diff --git a/docs/resources/virtual_environment_hosts.md b/docs/resources/virtual_environment_hosts.md index 34908552..99422884 100644 --- a/docs/resources/virtual_environment_hosts.md +++ b/docs/resources/virtual_environment_hosts.md @@ -11,7 +11,7 @@ Manages the host entries on a specific node. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_hosts" "first_node_host_entries" { node_name = "first-node" diff --git a/docs/resources/virtual_environment_pool.md b/docs/resources/virtual_environment_pool.md index 50673cd2..f4d2d72d 100644 --- a/docs/resources/virtual_environment_pool.md +++ b/docs/resources/virtual_environment_pool.md @@ -11,7 +11,7 @@ Manages a resource pool. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_pool" "operations_pool" { comment = "Managed by Terraform" pool_id = "operations-pool" diff --git a/docs/resources/virtual_environment_role.md b/docs/resources/virtual_environment_role.md index 57cc7131..fed2dcb2 100644 --- a/docs/resources/virtual_environment_role.md +++ b/docs/resources/virtual_environment_role.md @@ -11,7 +11,7 @@ Manages a role. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_role" "operations_monitoring" { role_id = "operations-monitoring" diff --git a/docs/resources/virtual_environment_time.md b/docs/resources/virtual_environment_time.md index e0696650..68ffcb43 100644 --- a/docs/resources/virtual_environment_time.md +++ b/docs/resources/virtual_environment_time.md @@ -11,7 +11,7 @@ Manages the time for a specific node. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_time" "first_node_time" { node_name = "first-node" time_zone = "UTC" diff --git a/docs/resources/virtual_environment_user.md b/docs/resources/virtual_environment_user.md index a17cf2af..ac3885b9 100644 --- a/docs/resources/virtual_environment_user.md +++ b/docs/resources/virtual_environment_user.md @@ -11,7 +11,7 @@ Manages a user. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_user" "operations_automation" { acl { path = "/vms/1234" diff --git a/docs/resources/virtual_environment_vm.md b/docs/resources/virtual_environment_vm.md index 34b3d7b3..b8c83d19 100644 --- a/docs/resources/virtual_environment_vm.md +++ b/docs/resources/virtual_environment_vm.md @@ -13,7 +13,7 @@ Manages a virtual machine. ## Example Usage -```terraform +```hcl resource "proxmox_virtual_environment_vm" "ubuntu_vm" { name = "terraform-provider-proxmox-ubuntu-vm" description = "Managed by Terraform" @@ -634,7 +634,7 @@ attaching one disk to multiple VM will cause errors or even data corruption. Do *not* move or resize `data_vm` disks. (Resource `data_user_vm` should reject attempts to move or resize non-owned disks.) -```terraform +```hcl resource "proxmox_virtual_environment_vm" "data_vm" { node_name = "first-node" started = false diff --git a/docs/resources/virtual_environment_vm2.md b/docs/resources/virtual_environment_vm2.md index dcb44d41..29dffc05 100644 --- a/docs/resources/virtual_environment_vm2.md +++ b/docs/resources/virtual_environment_vm2.md @@ -12,11 +12,10 @@ description: |- !> **DO NOT USE** This is an experimental implementation of a Proxmox VM resource using Plugin Framework.

It is a Proof of Concept, highly experimental and **will** change in future. It does not support all features of the Proxmox API for VMs and **MUST NOT** be used in production. --> Note: Many attributes are marked as **optional** _and_ **computed** in the schema, +-> Many attributes are marked as **optional** _and_ **computed** in the schema, hence you may seem added to the plan with "(known after apply)" status, even if they are not set in the configuration. This is done to support the `clone` operation, when a VM is created from an existing one, -and attributes of the original VM are copied to the new one. - +and attributes of the original VM are copied to the new one.

Computed attributes allow the provider to set those attributes without user input. The attributes are marked as optional to allow the user to set (or overwrite) them if needed. In order to remove the computed attribute from the plan, you can set it to an empty value (e.g. `""` for string, `[]` for collection). diff --git a/fwprovider/tests/resource_vm_test.go b/fwprovider/tests/resource_vm_test.go index 2d59baee..3382b926 100644 --- a/fwprovider/tests/resource_vm_test.go +++ b/fwprovider/tests/resource_vm_test.go @@ -190,14 +190,14 @@ func TestAccResourceVMInitialization(t *testing.T) { datastore_id = "local" node_name = "{{.NodeName}}" source_raw { - data = < **DO NOT USE** {{ .Description | trimspace }} --> Note: Many attributes are marked as **optional** _and_ **computed** in the schema, +-> Many attributes are marked as **optional** _and_ **computed** in the schema, hence you may seem added to the plan with "(known after apply)" status, even if they are not set in the configuration. This is done to support the `clone` operation, when a VM is created from an existing one, -and attributes of the original VM are copied to the new one. - +and attributes of the original VM are copied to the new one.

Computed attributes allow the provider to set those attributes without user input. The attributes are marked as optional to allow the user to set (or overwrite) them if needed. In order to remove the computed attribute from the plan, you can set it to an empty value (e.g. `""` for string, `[]` for collection).