Added tfplugin docs and generated documentation (#21)

* Added tfplugin docs and generated documentation - Added terraform-plugin-docs - Generated documentation for Vmaas 0.1.8 * Staticcheck rule not being excluded, ignoring linter
HPE · May 11, 2022 · 7fa5e35 · 7fa5e35
1 parent ec71a5c
commit 7fa5e35
Show file tree

Hide file tree

Showing 36 changed files with 559 additions and 689 deletions.
diff --git a/docs/data-sources/vmaas_cloud.md b/docs/data-sources/vmaas_cloud.md
@@ -1,38 +1,31 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hpegl_vmaas_cloud Data Source - terraform-provider-hpegl"
-subcategory: ""
+subcategory: "vmaas"
 description: |-
   The hpeglvmaascloud data source can be used to discover the ID of a hpegl vmaas Cloud.
            This can then be used with resources or data sources that require a hpegl vmaas cloud,
            such as the hpeglvmaasdatastore data source, hpeglvmaasinstance resource, etc.
 ---
-
 # hpegl_vmaas_cloud (Data Source)
-
 The hpegl_vmaas_cloud data source can be used to discover the ID of a hpegl vmaas Cloud.
 		 This can then be used with resources or data sources that require a hpegl vmaas cloud,
 		 such as the hpegl_vmaas_datastore data source, hpegl_vmaas_instance resource, etc.
-
 ## Example Usage
-
 ```terraform
 # (C) Copyright 2021 Hewlett Packard Enterprise Development LP
 
 data "hpegl_vmaas_cloud" "cloud" {
   name = "HPE GreenLake VMaaS Cloud"
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **name** (String) Name of the cloud as it appears on GLPC Portal. If there is no cloud with this name, a 'NOT FOUND' error will returned.
-
-### Optional
+- `name` (String) Name of the cloud as it appears on HPE GreenLake for private cloud dashboard. If there is no cloud with this name, a 'NOT FOUND' error will returned.
 
-- **id** (String) The ID of this resource.
+### Read-Only
 
+- `id` (String) The ID of this resource.
 
diff --git a/docs/data-sources/vmaas_cloud_folder.md b/docs/data-sources/vmaas_cloud_folder.md
@@ -1,21 +1,16 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hpegl_vmaas_cloud_folder Data Source - terraform-provider-hpegl"
-subcategory: ""
+subcategory: "vmaas"
 description: |-
   The hpeglvmaascloudfolder data source can be used to discover the ID for a folder.
-          hpeglvmaascloudfolder can be used along with hpeglvmaasinstance, if so all instances/VMs spawned will store
-          on the specified folder.
+          hpeglvmaascloudfolder can be used along with hpeglvmaasinstance, If it is used, all instances/VMs
+          spawned will be stored in the specified folder.
 ---
-
 # hpegl_vmaas_cloud_folder (Data Source)
-
 The hpegl_vmaas_cloud_folder data source can be used to discover the ID for a folder.
-		hpegl_vmaas_cloud_folder can be used along with hpegl_vmaas_instance, if so all instances/VMs spawned will store
-		on the specified folder.
-
+		hpegl_vmaas_cloud_folder can be used along with hpegl_vmaas_instance, If it is used, all instances/VMs
+		spawned will be stored in the specified folder.
 ## Example Usage
-
 ```terraform
 # (C) Copyright 2021 Hewlett Packard Enterprise Development LP
 
@@ -24,21 +19,16 @@ data "hpegl_vmaas_cloud_folder" "compute_folder" {
   name     = "ComputeFolder"
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **cloud_id** (String) Unique ID to identify a cloud.
-- **name** (String) Name of the cloud folder as it appears on GLPC Portal. If there is no cloud folder with this name, a 'NOT FOUND' error will returned.
-
-### Optional
-
-- **id** (String) The ID of this resource.
+- `cloud_id` (String) Unique ID to identify a cloud.
+- `name` (String) Name of the cloud folder as it appears on HPE GreenLake for private cloud dashboard. If there is no cloud folder with this name, a 'NOT FOUND' error will returned.
 
 ### Read-Only
 
-- **code** (String) External ID or code for the folder.
-
+- `code` (String) External ID or code for the folder.
+- `id` (String) The ID of this resource.
 
diff --git a/docs/data-sources/vmaas_datastore.md b/docs/data-sources/vmaas_datastore.md
@@ -1,21 +1,16 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hpegl_vmaas_datastore Data Source - terraform-provider-hpegl"
-subcategory: ""
+subcategory: "vmaas"
 description: |-
   The hpeglvmaasdatastore data source can be used to discover the ID of a hpegl vmaas datastore.
           This can then be used with resources or data sources that require a hpeglvmaasdatastore,
           such as the hpeglvmaasinstance resource.
 ---
-
 # hpegl_vmaas_datastore (Data Source)
-
 The hpegl_vmaas_datastore data source can be used to discover the ID of a hpegl vmaas datastore.
 		This can then be used with resources or data sources that require a hpegl_vmaas_datastore,
 		such as the hpegl_vmaas_instance resource.
-
 ## Example Usage
-
 ```terraform
 # (C) Copyright 2021 Hewlett Packard Enterprise Development LP
 
@@ -24,17 +19,15 @@ data "hpegl_vmaas_datastore" "c_3par" {
   name     = "Compute-3par-A64G-FC-1TB"
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **cloud_id** (String) Unique ID to identify a cloud.
-- **name** (String) Name of the datastore as it appears on GLPC Portal. If there is no datastore with this name, a 'NOT FOUND' error will returned.
-
-### Optional
+- `cloud_id` (String) Unique ID to identify a cloud.
+- `name` (String) Name of the datastore as it appears on HPE GreenLake for private cloud dashboard. If there is no datastore with this name, a 'NOT FOUND' error will returned.
 
-- **id** (String) The ID of this resource.
+### Read-Only
 
+- `id` (String) The ID of this resource.
 
diff --git a/docs/data-sources/vmaas_edge_cluster.md b/docs/data-sources/vmaas_edge_cluster.md
@@ -1,42 +1,32 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hpegl_vmaas_edge_cluster Data Source - terraform-provider-hpegl"
-subcategory: ""
+subcategory: "vmaas"
 description: |-
   The hpeglvmaasedgecluster data source can be used to discover the Provider ID of a hpegl vmaas Edge cluster.
           This can then be used with resources or data sources that require a hpeglvmaasedgecluster
 ---
-
 # hpegl_vmaas_edge_cluster (Data Source)
-
 The hpegl_vmaas_edge_cluster data source can be used to discover the Provider ID of a hpegl vmaas Edge cluster.
 		This can then be used with resources or data sources that require a hpegl_vmaas_edge_cluster
-
 ## Example Usage
-
 ```terraform
 # (C) Copyright 2021 Hewlett Packard Enterprise Development LP
 
 data "hpegl_vmaas_edge_cluster" "tf_edge_cluster" {
   name = "nsx_edge_cluster"
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **name** (String) Name of the Edge Cluster as it appears on GLPC Portal. If there is no Edge Cluster with this name, a 'NOT FOUND' error will returned.
-
-### Optional
-
-- **id** (String) The ID of this resource.
+- `name` (String) Name of the Edge Cluster as it appears on HPE GreenLake for private cloud dashboard. If there is no Edge Cluster with this name, a 'NOT FOUND' error will returned.
 
 ### Read-Only
 
-- **external_id** (String)
-- **internal_id** (String)
-- **provider_id** (String) ProviderId of the Edge Cluster. Use the provider_id as EdgeCluster while creating NSX-T Router
-
+- `external_id` (String)
+- `id` (String) The ID of this resource.
+- `internal_id` (String)
+- `provider_id` (String) ProviderId of the Edge Cluster. Use the provider_id as EdgeCluster while creating NSX-T Router
 
diff --git a/docs/data-sources/vmaas_environment.md b/docs/data-sources/vmaas_environment.md
@@ -1,42 +1,32 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hpegl_vmaas_environment Data Source - terraform-provider-hpegl"
-subcategory: ""
+subcategory: "vmaas"
 description: |-
   The hpeglvmaasenvironment data source can be used to discover the ID/Code of a hpegl vmaas environment.
           This can then be used with resources or data sources that require a hpeglvmaasenvironment,
           such as the hpeglvmaasinstance resource.
 ---
-
 # hpegl_vmaas_environment (Data Source)
-
 The hpegl_vmaas_environment data source can be used to discover the ID/Code of a hpegl vmaas environment.
 		This can then be used with resources or data sources that require a hpegl_vmaas_environment,
 		such as the hpegl_vmaas_instance resource.
-
 ## Example Usage
-
 ```terraform
 # (C) Copyright 2021 Hewlett Packard Enterprise Development LP
 
 data "hpegl_vmaas_environment" "staging" {
   name = "Staging"
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **name** (String) Name of the Environment as it appears on GLPC Portal. If there is no Environment with this name, a 'NOT FOUND' error will returned.
-
-### Optional
-
-- **id** (String) The ID of this resource.
+- `name` (String) Name of the Environment as it appears on HPE GreenLake for private cloud dashboard. If there is no Environment with this name, a 'NOT FOUND' error will returned.
 
 ### Read-Only
 
-- **code** (String) code of each environment
-
+- `code` (String) code of each environment
+- `id` (String) The ID of this resource.
 
diff --git a/docs/data-sources/vmaas_group.md b/docs/data-sources/vmaas_group.md
@@ -1,38 +1,31 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hpegl_vmaas_group Data Source - terraform-provider-hpegl"
-subcategory: ""
+subcategory: "vmaas"
 description: |-
   The hpeglvmaasgroup data source can be used to discover the ID of a hpegl vmaas group.
           This can then be used with resources or data sources that require a hpeglvmaasgroup,
           such as the hpeglvmaasinstance resource.
 ---
-
 # hpegl_vmaas_group (Data Source)
-
 The hpegl_vmaas_group data source can be used to discover the ID of a hpegl vmaas group.
 		This can then be used with resources or data sources that require a hpegl_vmaas_group,
 		such as the hpegl_vmaas_instance resource.
-
 ## Example Usage
-
 ```terraform
 # (C) Copyright 2021 Hewlett Packard Enterprise Development LP
 
 data "hpegl_vmaas_group" "default_group" {
   name = "Default"
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **name** (String) Name of the group as it appears on GLPC Portal. If there is no group with this name, a 'NOT FOUND' error will returned.
-
-### Optional
+- `name` (String) Name of the group as it appears on HPE GreenLake for private cloud dashboard. If there is no group with this name, a 'NOT FOUND' error will returned.
 
-- **id** (String) The ID of this resource.
+### Read-Only
 
+- `id` (String) The ID of this resource.
 
diff --git a/docs/data-sources/vmaas_layout.md b/docs/data-sources/vmaas_layout.md
@@ -1,21 +1,16 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hpegl_vmaas_layout Data Source - terraform-provider-hpegl"
-subcategory: ""
+subcategory: "vmaas"
 description: |-
   The hpeglvmaaslayout data source can be used to discover the ID of a hpegl vmaas layout.
           This can then be used with resources or data sources that require a hpeglvmaaslayout,
           such as the hpeglvmaasinstance resource.
 ---
-
 # hpegl_vmaas_layout (Data Source)
-
 The hpegl_vmaas_layout data source can be used to discover the ID of a hpegl vmaas layout.
 		This can then be used with resources or data sources that require a hpegl_vmaas_layout,
 		such as the hpegl_vmaas_instance resource.
-
 ## Example Usage
-
 ```terraform
 # (C) Copyright 2021 Hewlett Packard Enterprise Development LP
 
@@ -24,18 +19,16 @@ data "hpegl_vmaas_layout" "vmware_centos" {
   instance_type_code = "glhc-vanilla-centos"
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **instance_type_code** (String) Unique code used to identify the instance type. instance_type_code
+- `instance_type_code` (String) Unique code used to identify the instance type. instance_type_code
 					can be used in resource hpegl_vmaas_instance
-- **name** (String) Name of the layout as it appears on GLPC Portal. If there is no layout with this name, a 'NOT FOUND' error will returned.
-
-### Optional
+- `name` (String) Name of the layout as it appears on HPE GreenLake for private cloud dashboard. If there is no layout with this name, a 'NOT FOUND' error will returned.
 
-- **id** (String) The ID of this resource.
+### Read-Only
 
+- `id` (String) The ID of this resource.
 
diff --git a/docs/data-sources/vmaas_network.md b/docs/data-sources/vmaas_network.md
@@ -1,38 +1,31 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hpegl_vmaas_network Data Source - terraform-provider-hpegl"
-subcategory: ""
+subcategory: "vmaas"
 description: |-
   The hpeglvmaasnetwork data source can be used to discover the ID of a hpegl vmaas network.
           This can then be used with resources or data sources that require a hpeglvmaasnetwork,
           such as the hpeglvmaasinstance resource.
 ---
-
 # hpegl_vmaas_network (Data Source)
-
 The hpegl_vmaas_network data source can be used to discover the ID of a hpegl vmaas network.
 		This can then be used with resources or data sources that require a hpegl_vmaas_network,
 		such as the hpegl_vmaas_instance resource.
-
 ## Example Usage
-
 ```terraform
 # (C) Copyright 2021 Hewlett Packard Enterprise Development LP
 
 data "hpegl_vmaas_network" "blue_net" {
   name = "Blue-Net"
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **name** (String) Name of the network as it appears on GLPC Portal. If there is no network with this name, a 'NOT FOUND' error will returned.
-
-### Optional
+- `name` (String) Name of the network as it appears on HPE GreenLake for private cloud dashboard. If there is no network with this name, a 'NOT FOUND' error will returned.
 
-- **id** (String) The ID of this resource.
+### Read-Only
 
+- `id` (String) The ID of this resource.