Adding documentation for new data sources added to cloudstack-terraform-proivder (#45)

Damans227 · web-flow · commit 567f8ab14b70 · 2023-04-25T16:37:35.000+05:30
* add documentation for instance data source

* add documentation for ipaddress data source

* add documentation for network offering data source

* add documentation for service offering data source

* add documentation for ssh keypair data source

* add documentation for user data source

* add documentation for volume data source

* add documentation for vpc data source

* add documentation for vpn connection data source

* add documentation for zone data source

* fix typos in documentation
diff --git a/website/docs/d/instance.html.markdown b/website/docs/d/instance.html.markdown
@@ -0,0 +1,42 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_instance"
+sidebar_current: "docs-cloudstack-datasource-instance"
+description: |-
+  Gets informations about cloudstack instance.
+---
+
+# cloudstack_instance
+
+Use this datasource to get information about an instance for use in other resources.
+
+### Example Usage
+
+```hcl
+data "cloudstack_instance" "my_instance" {
+  filter {
+    name = "name" 
+    value = "server-a"
+  }
+  
+  nic {
+    ip_address="10.1.1.37"
+  }  
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `instance_id` - The ID of the virtual machine.
+* `account` - The account associated with the virtual machine.
+* `display_name` - The user generated name. The name of the virtual machine is returned if no displayname exists.
+* `state` - The state of the virtual machine.
+* `host_id` - The ID of the host for the virtual machine.
+* `zone_id` - The ID of the availablility zone for the virtual machine.
+* `created` - The date when this virtual machine was created.
+* `nic` - The list of nics associated with vm.
diff --git a/website/docs/d/ipaddress.html.markdown b/website/docs/d/ipaddress.html.markdown
@@ -0,0 +1,38 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_ipaddress"
+sidebar_current: "docs-cloudstack-cloudstack_ipaddress"
+description: |-
+  Gets information about cloudstack ipaddress.
+---
+
+# cloudstack_ipaddress
+
+Use this datasource to get information about a public ipaddress for use in other resources.
+
+### Example Usage
+
+```hcl
+data "cloudstack_ipaddress" "ipaddress-data-source"{
+    filter{
+    name = "zone_name"
+    value= "DC"
+    }
+  }
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `is_portable` - Is public IP portable across the zones.
+* `network_id` - The ID of the Network where ip belongs to.
+* `vpc_id` - VPC id the ip belongs to.
+* `zone_name` - The name of the zone the public IP address belongs to.
+* `project` - The project name of the address.
+* `ip_address` - Public IP address.
+* `is_source_nat` - True if the IP address is a source nat address, false otherwise.
diff --git a/website/docs/d/network_offering.html.markdown b/website/docs/d/network_offering.html.markdown
@@ -0,0 +1,35 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_network_offerings"
+sidebar_current: "docs-cloudstack-cloudstack_network_offering"
+description: |-
+  Gets information about cloudstack network offering.
+---
+
+# cloudstack_network_offering
+
+Use this datasource to get information about a network offering for use in other resources.
+
+### Example Usage
+
+```hcl
+  data "cloudstack_network_offering" "net-off-data-source"{
+    filter{
+    name = "name"
+    value="TestNetworkDisplay12"
+    }
+  }
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `name` - The name of the network offering.
+* `display_text` - An alternate display text of the network offering.
+* `guest_ip_type` - Guest type of the network offering, can be Shared or Isolated.
+* `traffic_type` - The traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.
diff --git a/website/docs/d/service_offering.html.markdown b/website/docs/d/service_offering.html.markdown
@@ -0,0 +1,33 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_service_offering"
+sidebar_current: "docs-cloudstack-cloudstack_service_offering"
+description: |-
+  Gets information about cloudstack service offering.
+---
+
+# cloudstack_service_offering
+
+Use this datasource to get information about a service offering for use in other resources.
+
+### Example Usage
+
+```hcl
+    data "cloudstack_service_offering" "service-offering-data-source"{
+    filter{
+    name = "name"
+    value = "TestServiceUpdate"
+    }  
+  }
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `name` - The name of the service offering.
+* `display_text` - An alternate display text of the service offering.
diff --git a/website/docs/d/ssh_keypair.html.markdown b/website/docs/d/ssh_keypair.html.markdown
@@ -0,0 +1,33 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_ssh_keypair"
+sidebar_current: "docs-cloudstack-cloudstack_ssh_keypair"
+description: |-
+  Gets information about cloudstack ssh keypair.
+---
+
+# cloudstack_ssh_keypair
+
+Use this datasource to get information about a ssh keypair for use in other resources.
+
+### Example Usage
+
+```hcl
+  data "cloudstack_ssh_keypair" "ssh-keypair-data" {
+	  filter {
+	  name = "name" 
+	  value = "myKey"
+	}
+  }
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `name` - Name of the keypair.
+* `fingerprint` - Fingerprint of the public key.
diff --git a/website/docs/d/template.html.markdown b/website/docs/d/template.html.markdown
@@ -3,7 +3,7 @@ layout: "cloudstack"
 page_title: "Cloudstack: cloudstack_template"
 sidebar_current: "docs-cloudstack-datasource-template"
 description: |-
-  Get informations on a Cloudstack template.
+  Gets information about Cloudstack template.
 ---
 
 # cloudstack_template
diff --git a/website/docs/d/user.html.markdown b/website/docs/d/user.html.markdown
@@ -0,0 +1,36 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_user"
+sidebar_current: "docs-cloudstack-cloudstack_user"
+description: |-
+  Gets information about cloudstack user.
+---
+
+# cloudstack_user
+
+Use this datasource to get information about a cloudstack user for use in other resources.
+
+### Example Usage
+
+```hcl
+data "cloudstack_user" "user-data-source"{
+    filter{
+    name = "first_name"
+    value= "jon"
+    }
+  }
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `account` - The account name of the userg.
+* `email` - The user email address.
+* `first_name` - The user firstname.
+* `last_name` - The user lastname.
+* `username` - The user name
diff --git a/website/docs/d/volume.html.markdown b/website/docs/d/volume.html.markdown
@@ -0,0 +1,34 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_volume"
+sidebar_current: "docs-cloudstack-cloudstack_volume"
+description: |-
+  Gets information about cloudstack volume.
+---
+
+# cloudstack_volume
+
+Use this datasource to get information about a volume for use in other resources.
+
+### Example Usage
+
+```hcl
+  data "cloudstack_volume" "volume-data-source"{
+    filter{
+    name = "name"
+    value="TestVolume"
+    }
+  }
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `name` - Name of the disk volume.
+* `disk_offering_id` - ID of the disk offering.
+* `zone_id` - ID of the availability zone.
diff --git a/website/docs/d/vpc.html.markdown b/website/docs/d/vpc.html.markdown
@@ -0,0 +1,41 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_vpc"
+sidebar_current: "docs-cloudstack-cloudstack_vpc"
+description: |-
+  Gets information about cloudstack vpc.
+---
+
+# cloudstack_vpc
+
+Use this datasource to get information about a vpc for use in other resources.
+
+### Example Usage
+
+```hcl
+data "cloudstack_vpc" "vpc-data-source"{
+    filter{
+    name = "name"
+    value= "test-vpc"
+    }
+    filter{
+    name = "cidr"
+    value= "10.0.0.0/16"
+  }
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `name` - The name of the VPC.
+* `display_text` - An alternate display text of the VPC.
+* `cidr` - The cidr the VPC.
+* `vpc_offering_name` - Vpc offering name the VPC is created from.
+* `network_domain` - The network domain of the VPC.
+* `project` - The project name of the VPC.
+* `zone_name` - The name of the zone the VPC belongs to.
diff --git a/website/docs/d/vpn_connection.html.markdown b/website/docs/d/vpn_connection.html.markdown
@@ -0,0 +1,36 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_vpn_connection"
+sidebar_current: "docs-cloudstack-cloudstack_vpn_connection"
+description: |-
+  Gets information about cloudstack vpn connection.
+---
+
+# cloudstack_vpn_connection
+
+Use this datasource to get information about a vpn connection for use in other resources.
+
+### Example Usage
+
+```hcl
+data "cloudstack_vpc" "vpc-data-source"{
+    filter{
+    name = "name"
+    value= "test-vpc"
+    }
+    filter{
+    name = "cidr"
+    value= "10.0.0.0/16"
+  }
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `s2s_customer_gateway_id` - The customer gateway ID.
+* `s2s_vpn_gateway_id` - The vpn gateway ID.
diff --git a/website/docs/d/zone.html.markdown b/website/docs/d/zone.html.markdown
@@ -0,0 +1,35 @@
+---
+layout: "cloudstack"
+page_title: "Cloudstack: cloudstack_zone"
+sidebar_current: "docs-cloudstack-cloudstack_zone"
+description: |-
+  Gets information about cloudstack zone.
+---
+
+# cloudstack_zone
+
+Use this datasource to get information about a zone for use in other resources.
+
+### Example Usage
+
+```hcl
+  data "cloudstack_zone" "zone-data-source"{
+    filter{
+    name = "name"
+    value="TestZone"
+    }
+  }
+```
+
+### Argument Reference
+
+* `filter` - (Required) One or more name/value pairs to filter off of. You can apply filters on any exported attributes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `name` - The name of the zone.
+* `dns1` - The first DNS for the Zone.
+* `internal_dns1` - The first internal DNS for the Zone.
+* `network_type` - The network type of the zone; can be Basic or Advanced.
