From 77e54b7e2b70142623db6f00f55596cfe28fa42d Mon Sep 17 00:00:00 2001 From: joannelynch92 Date: Mon, 16 Sep 2024 12:00:37 +0100 Subject: [PATCH] Run make docs-generate (#254) --- docs/data-sources/vmaas_layout.md | 8 ++-- docs/resources/vmaas_instance.md | 6 ++- docs/resources/vmaas_instance_clone.md | 44 ++++++++++--------- .../hpegl_vmaas_layout/data-source.tf | 8 ++-- .../hpegl_vmaas_instance/all_options.tf | 4 +- 5 files changed, 39 insertions(+), 31 deletions(-) diff --git a/docs/data-sources/vmaas_layout.md b/docs/data-sources/vmaas_layout.md index f75fc33..1b3545b 100644 --- a/docs/data-sources/vmaas_layout.md +++ b/docs/data-sources/vmaas_layout.md @@ -15,11 +15,11 @@ The hpegl_vmaas_layout data source can be used to discover the ID of a hpegl vma ## Example Usage ```terraform -# (C) Copyright 2021 Hewlett Packard Enterprise Development LP +# (C) Copyright 2021-2024 Hewlett Packard Enterprise Development LP -data "hpegl_vmaas_layout" "vmware_centos" { - name = "VMware VM with vanilla CentOS" - instance_type_code = "glhc-vanilla-centos" +data "hpegl_vmaas_layout" "vmware" { + name = "Vmware VM" + instance_type_code = "vmware" } ``` diff --git a/docs/resources/vmaas_instance.md b/docs/resources/vmaas_instance.md index 9afe356..18e5f78 100644 --- a/docs/resources/vmaas_instance.md +++ b/docs/resources/vmaas_instance.md @@ -77,7 +77,7 @@ this field to identify whether snapshot got deleted (because of reconfigure or a ## Example usage for creating new instance with all possible attributes ```terraform -# (C) Copyright 2021 Hewlett Packard Enterprise Development LP +# (C) Copyright 2021-2024 Hewlett Packard Enterprise Development LP # create instance with all possible options resource "hpegl_vmaas_instance" "tf_instance" { @@ -98,12 +98,14 @@ resource "hpegl_vmaas_instance" "tf_instance" { name = "root_vol" size = 5 datastore_id = data.hpegl_vmaas_datastore.c_3par.id + storage_type = data.hpegl_vmaas_instance_disk_type.vmaas_cloud_vmware_thin_lazy.id } volume { name = "local_vol" size = 5 datastore_id = data.hpegl_vmaas_datastore.c_3par.id + storage_type = data.hpegl_vmaas_instance_disk_type.vmware_thin.id } labels = ["test_label"] @@ -243,6 +245,8 @@ Required: Optional: - `root` (Boolean) true if volume is root +- `storage_type` (Number) Storage type ID can be obtained from hpegl_vmaas_instance_disk_type + data source. Read-Only: diff --git a/docs/resources/vmaas_instance_clone.md b/docs/resources/vmaas_instance_clone.md index 1e7141b..9dfe411 100644 --- a/docs/resources/vmaas_instance_clone.md +++ b/docs/resources/vmaas_instance_clone.md @@ -111,6 +111,8 @@ resource "hpegl_vmaas_instance_clone" "tf_instance_clone" { - `network` (Block List, Min: 1, Max: 5) Details of the network to which the instance should belong. (see [below for nested schema](#nestedblock--network)) - `source_instance_id` (Number) Instance ID of the source instance. For getting source instance ID use 'hpeg_vmaas_instance' resource. +- `volume` (Block List, Min: 1) A list of volumes to be created inside a provisioned instance. + It can have a root volume and other secondary volumes. (see [below for nested schema](#nestedblock--volume)) ### Optional @@ -137,8 +139,6 @@ resource "hpegl_vmaas_instance_clone" "tf_instance_clone" { should be unique for each snapshot. Any change in name or description will result in the creation of a new snapshot. (see [below for nested schema](#nestedblock--snapshot)) - `tags` (Map of String) A list of key and value pairs used to tag instances of similar type. -- `volume` (Block List) A list of volumes to be created inside a provisioned instance. - It can have a root volume and other secondary volumes. (see [below for nested schema](#nestedblock--volume)) ### Read-Only @@ -166,6 +166,27 @@ Read-Only: - `name` (String) name of the interface + +### Nested Schema for `volume` + +Required: + +- `datastore_id` (String) Datastore ID can be obtained from hpegl_vmaas_datastore + data source. Use the value 'auto' so that the datastore is automatically selected. +- `name` (String) Unique name for the volume. +- `size` (Number) Size of the volume in GB. + +Optional: + +- `root` (Boolean) true if volume is root +- `storage_type` (Number) Storage type ID can be obtained from hpegl_vmaas_instance_disk_type + data source. + +Read-Only: + +- `id` (Number) ID for the volume + + ### Nested Schema for `config` @@ -194,25 +215,6 @@ Optional: exists. - -### Nested Schema for `volume` - -Required: - -- `datastore_id` (String) Datastore ID can be obtained from hpegl_vmaas_datastore - data source. Use the value 'auto' so that the datastore is automatically selected. -- `name` (String) Unique name for the volume. -- `size` (Number) Size of the volume in GB. - -Optional: - -- `root` (Boolean) true if volume is root - -Read-Only: - -- `id` (Number) ID for the volume - - ### Nested Schema for `containers` diff --git a/examples/data-sources/hpegl_vmaas_layout/data-source.tf b/examples/data-sources/hpegl_vmaas_layout/data-source.tf index b220d79..be6f541 100644 --- a/examples/data-sources/hpegl_vmaas_layout/data-source.tf +++ b/examples/data-sources/hpegl_vmaas_layout/data-source.tf @@ -1,6 +1,6 @@ -# (C) Copyright 2021 Hewlett Packard Enterprise Development LP +# (C) Copyright 2021-2024 Hewlett Packard Enterprise Development LP -data "hpegl_vmaas_layout" "vmware_centos" { - name = "VMware VM with vanilla CentOS" - instance_type_code = "glhc-vanilla-centos" +data "hpegl_vmaas_layout" "vmware" { + name = "Vmware VM" + instance_type_code = "vmware" } diff --git a/examples/resources/hpegl_vmaas_instance/all_options.tf b/examples/resources/hpegl_vmaas_instance/all_options.tf index b63050c..2ecbda9 100644 --- a/examples/resources/hpegl_vmaas_instance/all_options.tf +++ b/examples/resources/hpegl_vmaas_instance/all_options.tf @@ -1,4 +1,4 @@ -# (C) Copyright 2021 Hewlett Packard Enterprise Development LP +# (C) Copyright 2021-2024 Hewlett Packard Enterprise Development LP # create instance with all possible options resource "hpegl_vmaas_instance" "tf_instance" { @@ -19,12 +19,14 @@ resource "hpegl_vmaas_instance" "tf_instance" { name = "root_vol" size = 5 datastore_id = data.hpegl_vmaas_datastore.c_3par.id + storage_type = data.hpegl_vmaas_instance_disk_type.vmaas_cloud_vmware_thin_lazy.id } volume { name = "local_vol" size = 5 datastore_id = data.hpegl_vmaas_datastore.c_3par.id + storage_type = data.hpegl_vmaas_instance_disk_type.vmware_thin.id } labels = ["test_label"]