-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use
tfplugindocs
to generate the provider documentation (#258)
* Update the index.md to be tfplugindocs generated Signed-off-by: Dom Del Nano <[email protected]> * Update the network data source docs to be tfplugindocs generated Signed-off-by: Dom Del Nano <[email protected]> * Update the cloud_config resource docs to be tfplugindocs generated * Update the cloud_config data source docs to be tfplugindocs generated Signed-off-by: Dom Del Nano <[email protected]> * Update the acl resource docs to be tfplugindocs generated * Update the host data source docs to be tfplugindocs generated * Update the hosts data source docs to be tfplugindocs generated * Update the pif data source docs to be tfplugindocs generated * Update the pool data source docs to be tfplugindocs generated and refactor host data source cpus description * Update the resource set data source docs to be tfplugindocs generated * Update the resource set resource docs to be tfplugindocs generated Signed-off-by: Dom Del Nano <[email protected]> * Update the user data source docs to be tfplugindocs generated * Update the sr data source docs to be tfplugindocs generated * Update the template data source docs to be tfplugindocs generated * Update the vdi data source docs to be tfplugindocs generated * Update the vdi resource docs to be tfplugindocs generated * Update the vms data source and vm resource schemas with doc descriptions and add examples Signed-off-by: Dom Del Nano <[email protected]> --------- Signed-off-by: Dom Del Nano <[email protected]>
- Loading branch information
Showing
55 changed files
with
1,121 additions
and
481 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,34 @@ | ||
# xenorchestra_cloud_config | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "xenorchestra_cloud_config Data Source - terraform-provider-xenorchestra" | ||
subcategory: "" | ||
description: |- | ||
Provides information about cloud config. | ||
NOTE: If there are multiple cloud configs with the same name Terraform will fail. Ensure that your names are unique when using the data source. | ||
--- | ||
|
||
# xenorchestra_cloud_config (Data Source) | ||
|
||
Provides information about cloud config. | ||
|
||
**NOTE:** If there are multiple cloud configs with the same name Terraform will fail. Ensure that your names are unique when using the data source. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
```terraform | ||
data "xenorchestra_cloud_config" "cloud_config" { | ||
name = "Name of cloud config" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
* name - (Required) The name of the cloud config you want to look up. | ||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
~> **NOTE:** If there are multiple cloud configs with the same name | ||
Terraform will fail. Ensure that your names are unique when | ||
using the data source. | ||
- `name` (String) The name of the cloud config you want to look up. | ||
|
||
### Read-Only | ||
|
||
## Attributes Reference | ||
* id - Id of the resource set. | ||
* template - The contents of the cloud-config. | ||
- `id` (String) The ID of this resource. | ||
- `template` (String) The contents of the cloud-config. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,50 @@ | ||
# xenorchestra_host | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "xenorchestra_host Data Source - terraform-provider-xenorchestra" | ||
subcategory: "" | ||
description: |- | ||
Provides information about a host. | ||
NOTE: If there are multiple hosts with the same name | ||
Terraform will fail. Ensure that your names are unique when | ||
using the data source. | ||
--- | ||
|
||
# xenorchestra_host (Data Source) | ||
|
||
Provides information about a host. | ||
|
||
**NOTE:** If there are multiple hosts with the same name | ||
Terraform will fail. Ensure that your names are unique when | ||
using the data source. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
```terraform | ||
data "xenorchestra_host" "host1" { | ||
name_label = "Your host" | ||
} | ||
resource "xenorchestra_vm" "node" { | ||
//... | ||
affinity_host = data.xenorchestra_host.ng6.id | ||
affinity_host = data.xenorchestra_host.host1.id | ||
//... | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
* name_label - (Required) The name of the host you want to look up. | ||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
~> **NOTE:** If there are multiple hosts with the same name | ||
Terraform will fail. Ensure that your names are unique when | ||
using the data source. | ||
### Required | ||
|
||
- `name_label` (String) The name label of the host. | ||
|
||
### Optional | ||
|
||
- `tags` (Set of String) The tags (labels) applied to the given entity. | ||
|
||
### Read-Only | ||
|
||
## Attributes Reference | ||
* id - The id of the host. | ||
* name_label - Name label of the host. | ||
* pool_id - Id of the pool that the host belongs to. | ||
* tags - The tags applied to the host. | ||
* memory - The memory size for the host. | ||
* memory_usage - The memory usage for the host. | ||
* cpus - Host cpu information. | ||
* cores - The number of cores. | ||
* sockets - The number of sockets. | ||
- `cpus` (Map of Number) CPU information about the host. The 'cores' key will contain the number of cpu cores and the 'sockets' key will contain the number of sockets. | ||
- `id` (String) The ID of this resource. | ||
- `memory` (Number) The memory size of the host. | ||
- `memory_usage` (Number) The memory usage of the host. | ||
- `pool_id` (String) Id of the pool that the host belongs to. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.