Update description

harvester · Sep 21, 2022 · 813727e · 813727e
1 parent 658d9b0
commit 813727e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/docs/data-sources/virtualmachine.md b/docs/data-sources/virtualmachine.md
@@ -46,7 +46,7 @@ data "harvester_virtualmachine" "ubuntu20-dev" {
 - **node_name** (String)
 - **restart_after_update** (Boolean) restart vm after the vm is updated
 - **run_strategy** (String) more info: https://kubevirt.io/user-guide/virtual_machines/run_strategies/
-- **secure_boot** (Boolean)
+- **secure_boot** (Boolean) EFI must be enabled to use this feature
 - **ssh_keys** (List of String)
 - **start** (Boolean, Deprecated)
 - **state** (String)

diff --git a/docs/resources/virtualmachine.md b/docs/resources/virtualmachine.md
@@ -175,7 +175,7 @@ resource "harvester_virtualmachine" "ubuntu20-dev" {
 - **namespace** (String)
 - **restart_after_update** (Boolean) restart vm after the vm is updated
 - **run_strategy** (String) more info: https://kubevirt.io/user-guide/virtual_machines/run_strategies/
-- **secure_boot** (Boolean)
+- **secure_boot** (Boolean) EFI must be enabled to use this feature
 - **ssh_keys** (List of String)
 - **start** (Boolean, Deprecated)
 - **tags** (Map of String)
@@ -221,9 +221,9 @@ Optional:
 
 - **mac_address** (String)
 - **model** (String)
-- **network_name** (String)
+- **network_name** (String) if the value is empty, management network is used
 - **type** (String)
-- **wait_for_lease** (Boolean) wait for this network interface to obtain an IP address
+- **wait_for_lease** (Boolean) wait for this network interface to obtain an IP address. If a non-management network is used, this feature requires qemu-guest-agent installed and started in the VM, otherwise, VM creation will stuck until timeout
 
 Read-Only:
 

diff --git a/internal/provider/virtualmachine/schema_virtualmachine_network_interface.go b/internal/provider/virtualmachine/schema_virtualmachine_network_interface.go
@@ -50,15 +50,16 @@ func resourceNetworkInterfaceSchema() map[string]*schema.Schema {
 			Type:        schema.TypeBool,
 			Optional:    true,
 			Default:     false,
-			Description: "wait for this network interface to obtain an IP address",
+			Description: "wait for this network interface to obtain an IP address. If a non-management network is used, this feature requires qemu-guest-agent installed and started in the VM, otherwise, VM creation will stuck until timeout",
 		},
 		constants.FiledNetworkInterfaceInterfaceName: {
 			Type:     schema.TypeString,
 			Computed: true,
 		},
 		constants.FiledNetworkInterfaceNetworkName: {
-			Type:     schema.TypeString,
-			Optional: true,
+			Type:        schema.TypeString,
+			Optional:    true,
+			Description: "if the value is empty, management network is used",
 		},
 	}
 	return s