Regenerate vm resource and data source documentation

Signed-off-by: Dom Del Nano <ddelnano@gmail.com>
vatesfr · Jan 25, 2024 · 33b7f19 · 33b7f19
1 parent bc7dea4
commit 33b7f19
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/docs/data-sources/vms.md b/docs/data-sources/vms.md
@@ -85,6 +85,7 @@ Read-Only:
 - `vga` (String)
 - `videoram` (Number)
 - `wait_for_ip` (Boolean)
+- `xenstore` (Map of String)
 
 <a id="nestedobjatt--vms--disk"></a>
 ### Nested Schema for `vms.disk`

diff --git a/docs/index.md b/docs/index.md
@@ -46,14 +46,11 @@ provider "xenorchestra" {
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Required
-
-- `password` (String) Password for xoa api. Can be set via the XOA_PASSWORD environment variable.
-- `url` (String) Hostname of the xoa router. Can be set via the XOA_URL environment variable.
-- `username` (String) User account for xoa api. Can be set via the XOA_USER environment variable.
-
 ### Optional
 
 - `insecure` (Boolean) Whether SSL should be verified or not. Can be set via the XOA_INSECURE environment variable.
+- `password` (String) Password for xoa api. Can be set via the XOA_PASSWORD environment variable.
 - `retry_max_time` (String) If `retry_mode` is set, this specifies the duration for which the backoff method will continue retries. Can be set via the `XOA_RETRY_MAX_TIME` environment variable
 - `retry_mode` (String) Specifies if retries should be attempted for requests that require eventual . Can be set via the XOA_RETRY_MODE environment variable.
+- `url` (String) Hostname of the xoa router. Can be set via the XOA_URL environment variable.
+- `username` (String) User account for xoa api. Can be set via the XOA_USER environment variable.
diff --git a/docs/resources/vm.md b/docs/resources/vm.md
@@ -89,6 +89,13 @@ resource "xenorchestra_vm" "bar" {
     timeouts {
       create = "20m"
     }
+
+    // Note: Xen Orchestra populates values within Xenstore and will need ignored via
+    // lifecycle ignore_changes or modeled in your terraform code
+    xenstore = {
+      key1 = "val1"
+      key2 = "val2"
+    }
 }
 
 # vm resource that uses wait_for_ip
@@ -170,6 +177,7 @@ $ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd
 - `vga` (String) The video adapter the VM should use. Possible values include std and cirrus.
 - `videoram` (Number) The videoram option the VM should use. Possible values include 1, 2, 4, 8, 16
 - `wait_for_ip` (Boolean) Whether terraform should wait until IP addresses are present on the VM's network interfaces before considering it created. This only works if guest-tools are installed in the VM. Defaults to false.
+- `xenstore` (Map of String) The key value pairs to be populated in xenstore.
 
 ### Read-Only