Skip to content

Commit

Permalink
Run make docs-generate (#254)
Browse files Browse the repository at this point in the history
  • Loading branch information
joannelynch92 authored Sep 16, 2024
1 parent a362e92 commit 77e54b7
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 31 deletions.
8 changes: 4 additions & 4 deletions docs/data-sources/vmaas_layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
```

Expand Down
6 changes: 5 additions & 1 deletion docs/resources/vmaas_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" {
Expand All @@ -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"]
Expand Down Expand Up @@ -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:

Expand Down
44 changes: 23 additions & 21 deletions docs/resources/vmaas_instance_clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -166,6 +166,27 @@ Read-Only:
- `name` (String) name of the interface


<a id="nestedblock--volume"></a>
### 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


<a id="nestedblock--config"></a>
### Nested Schema for `config`

Expand Down Expand Up @@ -194,25 +215,6 @@ Optional:
exists.


<a id="nestedblock--volume"></a>
### 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


<a id="nestedatt--containers"></a>
### Nested Schema for `containers`

Expand Down
8 changes: 4 additions & 4 deletions examples/data-sources/hpegl_vmaas_layout/data-source.tf
Original file line number Diff line number Diff line change
@@ -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"
}
4 changes: 3 additions & 1 deletion examples/resources/hpegl_vmaas_instance/all_options.tf
Original file line number Diff line number Diff line change
@@ -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" {
Expand All @@ -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"]
Expand Down

0 comments on commit 77e54b7

Please sign in to comment.