From aaa74240c7b0e7e3e4efd33bd175174b09da7141 Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 12:26:44 -0400 Subject: [PATCH 01/11] add documentation for instance data source --- website/docs/d/instance.html.markdown | 42 +++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 website/docs/d/instance.html.markdown diff --git a/website/docs/d/instance.html.markdown b/website/docs/d/instance.html.markdown new file mode 100644 index 00000000..76c01e94 --- /dev/null +++ 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: |- + Get informations on a cloudstack instance. +--- + +# cloudstack_instance + +Use this datasource to get the ID of 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. From 70555f03fad1c191790a7674245eaf407ae918e4 Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 13:00:32 -0400 Subject: [PATCH 02/11] add documentation for ipaddress data source --- website/docs/d/ipaddress.html.markdown | 38 ++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 website/docs/d/ipaddress.html.markdown diff --git a/website/docs/d/ipaddress.html.markdown b/website/docs/d/ipaddress.html.markdown new file mode 100644 index 00000000..890c61a2 --- /dev/null +++ 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: |- + Get informations on a 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. From 303901c1d01f5ad6a8c6e7bbf78b2414a01360fc Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 13:15:23 -0400 Subject: [PATCH 03/11] add documentation for network offering data source --- website/docs/d/network_offering.html.markdown | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 website/docs/d/network_offering.html.markdown diff --git a/website/docs/d/network_offering.html.markdown b/website/docs/d/network_offering.html.markdown new file mode 100644 index 00000000..0f89a0c3 --- /dev/null +++ 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. \ No newline at end of file From b43e5a8d29ecb8ddd5c5d01ec7a706a10fb52a01 Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 13:20:36 -0400 Subject: [PATCH 04/11] add documentation for service offering data source --- website/docs/d/service_offering.html.markdown | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 website/docs/d/service_offering.html.markdown diff --git a/website/docs/d/service_offering.html.markdown b/website/docs/d/service_offering.html.markdown new file mode 100644 index 00000000..8c22f104 --- /dev/null +++ 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_network_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. \ No newline at end of file From fb36a225dc25ae43a95cac948e2a899bf7118516 Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 13:26:26 -0400 Subject: [PATCH 05/11] add documentation for ssh keypair data source --- website/docs/d/ssh_keypair.html.markdown | 33 ++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 website/docs/d/ssh_keypair.html.markdown diff --git a/website/docs/d/ssh_keypair.html.markdown b/website/docs/d/ssh_keypair.html.markdown new file mode 100644 index 00000000..e8f5a6ed --- /dev/null +++ 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. \ No newline at end of file From 66c1e374e38df7faa974b26d5bb125349dd63757 Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 13:33:30 -0400 Subject: [PATCH 06/11] add documentation for user data source --- website/docs/d/user.html.markdown | 36 +++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 website/docs/d/user.html.markdown diff --git a/website/docs/d/user.html.markdown b/website/docs/d/user.html.markdown new file mode 100644 index 00000000..abc069b8 --- /dev/null +++ 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 \ No newline at end of file From d2215d9e34a61cc90cd40084b36942ce9d27eabf Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 13:42:26 -0400 Subject: [PATCH 07/11] add documentation for volume data source --- website/docs/d/volume.html.markdown | 34 +++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 website/docs/d/volume.html.markdown diff --git a/website/docs/d/volume.html.markdown b/website/docs/d/volume.html.markdown new file mode 100644 index 00000000..5a933365 --- /dev/null +++ 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. From 2e485333ab34ec55f8c9e626dd4835117061a3e7 Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 13:49:52 -0400 Subject: [PATCH 08/11] add documentation for vpc data source --- website/docs/d/vpc.html.markdown | 41 ++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 website/docs/d/vpc.html.markdown diff --git a/website/docs/d/vpc.html.markdown b/website/docs/d/vpc.html.markdown new file mode 100644 index 00000000..3ccbd886 --- /dev/null +++ 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. \ No newline at end of file From c1f089bfd9fc248662df90f34ed6c8e0b1d5d6c1 Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 13:55:47 -0400 Subject: [PATCH 09/11] add documentation for vpn connection data source --- website/docs/d/vpn_connection.html.markdown | 36 +++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 website/docs/d/vpn_connection.html.markdown diff --git a/website/docs/d/vpn_connection.html.markdown b/website/docs/d/vpn_connection.html.markdown new file mode 100644 index 00000000..1b60195f --- /dev/null +++ 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. \ No newline at end of file From 5f0774739345afb951087580b2132c160acc768e Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 14:06:54 -0400 Subject: [PATCH 10/11] add documentation for zone data source --- website/docs/d/zone.html.markdown | 35 +++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 website/docs/d/zone.html.markdown diff --git a/website/docs/d/zone.html.markdown b/website/docs/d/zone.html.markdown new file mode 100644 index 00000000..e4c8f795 --- /dev/null +++ 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. \ No newline at end of file From d5a6e97a514c5f68dc2473cea2a58f9c75c448ac Mon Sep 17 00:00:00 2001 From: damans227 Date: Sat, 3 Sep 2022 14:32:14 -0400 Subject: [PATCH 11/11] fix typos in documentation --- website/docs/d/instance.html.markdown | 4 ++-- website/docs/d/ipaddress.html.markdown | 2 +- website/docs/d/service_offering.html.markdown | 2 +- website/docs/d/template.html.markdown | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/docs/d/instance.html.markdown b/website/docs/d/instance.html.markdown index 76c01e94..3c2f7b2c 100644 --- a/website/docs/d/instance.html.markdown +++ b/website/docs/d/instance.html.markdown @@ -3,12 +3,12 @@ layout: "cloudstack" page_title: "Cloudstack: cloudstack_instance" sidebar_current: "docs-cloudstack-datasource-instance" description: |- - Get informations on a cloudstack instance. + Gets informations about cloudstack instance. --- # cloudstack_instance -Use this datasource to get the ID of an instance for use in other resources. +Use this datasource to get information about an instance for use in other resources. ### Example Usage diff --git a/website/docs/d/ipaddress.html.markdown b/website/docs/d/ipaddress.html.markdown index 890c61a2..119af938 100644 --- a/website/docs/d/ipaddress.html.markdown +++ b/website/docs/d/ipaddress.html.markdown @@ -3,7 +3,7 @@ layout: "cloudstack" page_title: "Cloudstack: cloudstack_ipaddress" sidebar_current: "docs-cloudstack-cloudstack_ipaddress" description: |- - Get informations on a cloudstack ipaddress. + Gets information about cloudstack ipaddress. --- # cloudstack_ipaddress diff --git a/website/docs/d/service_offering.html.markdown b/website/docs/d/service_offering.html.markdown index 8c22f104..1ac70979 100644 --- a/website/docs/d/service_offering.html.markdown +++ b/website/docs/d/service_offering.html.markdown @@ -6,7 +6,7 @@ description: |- Gets information about cloudstack service offering. --- -# cloudstack_network_offering +# cloudstack_service_offering Use this datasource to get information about a service offering for use in other resources. diff --git a/website/docs/d/template.html.markdown b/website/docs/d/template.html.markdown index 357c56cd..cfc50e2b 100644 --- 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