Add documentation for data collector, region and region enumeration data sources #283

bhadgaonkars · 2020-11-24T19:53:00Z

Add documentation for IaaS data sources:

data "vra_data_collector"
data "vra_region"
data "vra_region_enumeration"
data "vra_region_enumeration_aws"
data "vra_region_enumeration_azure"
data "vra_region_enumeration_gcp"
data "vra_region_enumeration_vmc"
data "vra_region_enumeration_vsphere"

vmwclabot · 2020-11-24T19:53:03Z

@bhadgaonkars, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit b7c7a59 must be signed by [email protected]

dmettem

Please add Required or Optional for all arguments.

dmettem · 2020-12-04T13:49:11Z

website/docs/d/vra_data_collector.html.markdown

+**Data collector data source by its id:**
+```hcl
+data "vra_data_collector" "snapshot" {
+  dcId = var.data_collector_id
+}
+```


This is incorrect. data_collector data source doesn't support lookup by dcId.

dmettem · 2020-12-04T13:50:10Z

website/docs/d/vra_data_collector.html.markdown

+}
+```
+## Argument Reference
+* `dcId` - The data collector identifier. Example: d5316b00-f3b8-4895-9e9a-c4b98649c2ca


This needs to be removed based on the above comment.

dmettem · 2020-12-04T13:50:50Z

website/docs/d/vra_data_collector.html.markdown

+## Argument Reference
+* `dcId` - The data collector identifier. Example: d5316b00-f3b8-4895-9e9a-c4b98649c2ca
+
+* `name` - Data collector name. Example: Datacollector1


Add (Required).

dmettem · 2020-12-04T13:51:22Z

website/docs/d/vra_data_collector.html.markdown

+* `ip_address` - IPv4 Address of the data collector VM. Example: 10.0.0.1
+
+* `hostname` - Data collector host name. Example: dc1-lnd.mycompany.com
+
+* `status` - Current status of the data collector. Example: ACTIVE, INACTIVE
+


Arrange them in the sorted order please.

Please arrange them in sorted order.

dmettem · 2020-12-04T13:58:13Z

website/docs/d/vra_region_enumeration.html.markdown

+* `accept_self_signed_cert` - Accept self signed certificate when connecting to vSphere. Example: false
+
+* `hostname` - Host name for the cloud account endpoint. Example: dc1-lnd.mycompany.com
+
+* `password` - Password for the user used to authenticate with the cloud Account
+
+* `username` - Username to authenticate with the cloud account
+


hostname, username and password are required arguments and accept_self_signed_cert is optional and has default value of false. They all need to be moved to arguments section.

dmettem · 2020-12-04T14:19:18Z

website/docs/d/vra_region_enumeration_azure.html.markdown

+data "vra_region_enumeration_azure" "this" {
+  id = vra_region_enumeration_azure.this.id
+}


Incorrect example. Refer to the source code / test file construct the example.

dmettem · 2020-12-04T14:21:09Z

website/docs/d/vra_region_enumeration_azure.html.markdown

+## Argument Reference
+
+* `id` - (Optional) The id of the region enumeration for Azure account.
+
+## Attribute Reference
+* `application_id` - Azure Client Application ID
+
+* `application_key` - Azure Client Application Secret Key
+
+* `subscription_id` - Azure Subscribtion ID
+
+* `tenant_id` - Azure Tenant ID


application_id, application_key, subscription_id and tenant_id are Required arguments, so should be moved to Argument Reference section.

id is attribute. It should be moved to Attribute Reference section.

dmettem · 2020-12-04T14:22:44Z

website/docs/d/vra_region_enumeration_gcp.html.markdown

+**Region enumeration GCP data source by its id:**
+```hcl
+data "vra_region_enumeration_gcp" "this" {
+  id = vra_region_enumeration_gcp.this.id
+}
+```
+## Argument Reference
+
+* `id` - (Optional) The id of the region enumeration for GCP account.
+
+## Attribute Reference
+
+* `private_key` - GCP Private key.
+
+* `private_key_id` - GCP Private key ID.
+
+* `project_id` - GCP Project ID.


Same comment as above. id is attribute. client_email, private_key, private_key_id, and project_id are Required arguments.

Correct the example as well please.

dmettem · 2020-12-04T14:23:57Z

website/docs/d/vra_region_enumeration_vmc.html.markdown

+data "vra_region_enumeration_vmc" "this" {
+  id = vra_region_enumeration_vmc.this.id
+}
+```
+## Argument Reference
+
+* `id` - (Optional) The id of the region enumeration for VMC account.
+
+## Attribute Reference
+
+* `accept_self_signed_cert` - Accept self signed certificate when connecting to vSphere. Example: false
+
+* `api_token` - Host name for the cloud account endpoint. Example: dc1-lnd.mycompany.com
+
+* `dc_id` - Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors.
+
+* `vcenter_hostname` - The IP address or FQDN of the vCenter Server in the specified SDDC. The cloud proxy belongs on this vCenter.
+
+* `vcenter_password` - Password for the user used to authenticate with the cloud Account
+
+* `sddc_name` - Identifier of the on-premise SDDC to be used by this cloud account.
+
+* `vcenter_username` - vCenter user name for the specified SDDC.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials.


Same comment as above. Correct the example. Organize arguments and attributes correctly.

dmettem · 2020-12-04T14:24:38Z

website/docs/d/vra_region_enumeration_vsphere.html.markdown

+```hcl
+data "vra_region_enumeration_vsphere" "this" {
+  id = vra_region_enumeration_vsphere.this.id
+}
+```
+## Argument Reference
+
+* `id` - (Optional) The id of the region enumeration for vSphere account.
+
+* `dcId` - Identifier of a data collector vm deployed in the on premise infrastructure. Example: d5316b00-f3b8-4895-9e9a-c4b98649c2ca
+
+## Attribute Reference
+* `accept_self_signed_cert` - Accept self signed certificate when connecting to vSphere. Example: false
+
+* `hostname` - Host name for the cloud account endpoint. Example: dc1-lnd.mycompany.com
+
+* `password` - Password for the user used to authenticate with the cloud Account
+
+* `username` - Username to authenticate with the cloud account
+


Same comment as above. Correct the example. Organize arguments and attributes correctly.

vmwclabot · 2020-12-12T04:05:27Z

@bhadgaonkars, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit d0961a8 must be signed by [email protected]

…ata sources Add documentation for IaaS data sources: data "vra_data_collector" data "vra_region" data "vra_region_enumeration" data "vra_region_enumeration_aws" data "vra_region_enumeration_azure" data "vra_region_enumeration_gcp" data "vra_region_enumeration_vmc" data "vra_region_enumeration_vsphere" Signed-off-by: Sagar <[email protected]>

dmettem · 2020-12-12T04:38:43Z

website/docs/d/vra_region_enumeration_gcp.html.markdown

+
+
+## Attribute Reference
+* `id` - (Optional) The id of the region enumeration for GCP account.


No need to give optional for attributes.

dmettem · 2020-12-12T04:39:12Z

website/docs/d/vra_data_collector.html.markdown

+* `ip_address` - IPv4 Address of the data collector VM. Example: 10.0.0.1
+
+* `hostname` - Data collector host name. Example: dc1-lnd.mycompany.com
+
+* `status` - Current status of the data collector. Example: ACTIVE, INACTIVE
+


Please arrange them in sorted order.

dmettem · 2020-12-12T04:44:18Z

website/docs/d/vra_region.html.markdown

+
+This is an example of how to read a region data source.
+
+DeprecationMessage: 'region_enumeration' is deprecated. Use 'region_enumeration_vsphere' instead.


I don't think vra_region is deprecated. Please check and add the example.

…on data sources Add documentation for IaaS data sources: data "vra_data_collector" data "vra_region" data "vra_region_enumeration" data "vra_region_enumeration_aws" data "vra_region_enumeration_azure" data "vra_region_enumeration_gcp" data "vra_region_enumeration_vmc" data "vra_region_enumeration_vsphere" Signed-off-by: Sagar <[email protected]>

vmwclabot added the dco-required DCO Required label Nov 24, 2020

dmettem suggested changes Dec 4, 2020

View reviewed changes

bhadgaonkars force-pushed the docs-for-dc-region-and-region-enum-ds branch from b7c7a59 to d0961a8 Compare December 12, 2020 04:05

bhadgaonkars force-pushed the docs-for-dc-region-and-region-enum-ds branch from d0961a8 to 016b789 Compare December 12, 2020 04:11

vmwclabot removed the dco-required DCO Required label Dec 12, 2020

dmettem reviewed Dec 12, 2020

View reviewed changes

bhadgaonkars added 2 commits December 11, 2020 23:00

dmettem approved these changes Dec 12, 2020

View reviewed changes

dmettem merged commit ed1e4cd into vmware:master Dec 12, 2020

vmware locked and limited conversation to collaborators Jul 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for data collector, region and region enumeration data sources #283

Add documentation for data collector, region and region enumeration data sources #283

bhadgaonkars commented Nov 24, 2020

vmwclabot commented Nov 24, 2020

dmettem left a comment

dmettem Dec 4, 2020

dmettem Dec 4, 2020

dmettem Dec 4, 2020

dmettem Dec 4, 2020

dmettem Dec 12, 2020

dmettem Dec 4, 2020

dmettem Dec 4, 2020

dmettem Dec 4, 2020

dmettem Dec 4, 2020

dmettem Dec 4, 2020

dmettem Dec 4, 2020

vmwclabot commented Dec 12, 2020

dmettem Dec 12, 2020

dmettem Dec 12, 2020

dmettem Dec 12, 2020



		## Attribute Reference
		* `id` - (Optional) The id of the region enumeration for GCP account.


		This is an example of how to read a region data source.

		DeprecationMessage: 'region_enumeration' is deprecated. Use 'region_enumeration_vsphere' instead.

Add documentation for data collector, region and region enumeration data sources #283

Add documentation for data collector, region and region enumeration data sources #283

Conversation

bhadgaonkars commented Nov 24, 2020

vmwclabot commented Nov 24, 2020

dmettem left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vmwclabot commented Dec 12, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment