-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
documentation: generate docs from provider schemas (#248)
We make use of [tfplugindocs](https://github.com/hashicorp/terraform-plugin-docs) and refacor the codebase so that all documentation files are generated from the schemas in the source code. To ensure that developers don't forget to update the documentation in the future we add a CI step that verifies that the generated documentation matches the docs checked into git. Additionally we add an indicator to the documentation description of each attribute for which `ForceNew == true`. --------- Co-authored-by: Philipp Sauter <philipp.sauter@exoscale.ch>
- Loading branch information
Showing
453 changed files
with
57,560 additions
and
2,075 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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
name: "Shared setup steps" | ||
runs: | ||
using: "composite" | ||
steps: | ||
- uses: actions/setup-go@v2 | ||
with: | ||
go-version: '~1.18' |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,22 @@ | ||
--- | ||
page_title: "Exoscale: exoscale_affinity" | ||
subcategory: "Deprecated" | ||
description: |- | ||
page_title: "exoscale_affinity Data Source - terraform-provider-exoscale" | ||
subcategory: "Deprecated | ||
"description: |- | ||
Fetch Exoscale Anti-Affinity Groups data. | ||
--- | ||
|
||
# exoscale\_affinity | ||
# exoscale_affinity (Data Source) | ||
|
||
!> **WARNING:** This data source is DEPRECATED and will be removed in the next major version. Please use [exoscale_anti_affinity_group](./anti_affinity_group.md) instead. | ||
|
||
|
||
## Arguments Reference | ||
|
||
* `id` - The anti-affinity group ID to match (conflicts with `name`) | ||
* `name` - The group name to match (conflicts with `id`) | ||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Optional | ||
|
||
## Attributes Reference | ||
- `id` (String) The anti-affinity group ID to match (conflicts with `name`) | ||
- `name` (String) The group name to match (conflicts with `id`) | ||
|
||
In addition to the arguments listed above, the following attributes are exported: | ||
|
||
* n/a |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,37 @@ | ||
--- | ||
page_title: "Exoscale: exoscale_compute" | ||
page_title: "exoscale_compute Data Source - terraform-provider-exoscale" | ||
subcategory: "Deprecated" | ||
description: |- | ||
Fetch Exoscale Compute Instances data. | ||
--- | ||
|
||
# exoscale\_compute | ||
# exoscale_compute (Data Source) | ||
|
||
!> **WARNING:** This data source is **DEPRECATED** and will be removed in the next major version. Please use [exoscale_compute_instance](./compute_instance.md) instead. | ||
|
||
## Arguments Reference | ||
|
||
* `id` - The compute instance ID to match. | ||
* `hostname` - The instance hostname to match. | ||
* `tags` - The instance tags to match (map of key/value). | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
## Attributes Reference | ||
### Optional | ||
|
||
In addition to the arguments listed above, the following attributes are exported: | ||
- `hostname` (String) The instance hostname to match. | ||
- `id` (String) The compute instance ID to match. | ||
- `tags` (Map of String) The instance tags to match (map of key/value). | ||
|
||
### Read-Only | ||
|
||
- `cpu` (Number) Number of cpu the Compute instance is running with | ||
- `created` (String) Date when the Compute instance was created | ||
- `disk_size` (Number) Size of the Compute instance disk | ||
- `ip6_address` (String) Compute instance public ipv6 address (if ipv6 is enabled) | ||
- `ip_address` (String) Compute instance public ipv4 address | ||
- `memory` (Number) Memory allocated for the Compute instance | ||
- `private_network_ip_addresses` (List of String) List of Compute instance private IP addresses (in managed Private Networks only) | ||
- `size` (String) Current size of the Compute instance | ||
- `state` (String) State of the Compute instance | ||
- `template` (String) Name of the template for the Compute instance | ||
- `zone` (String) Name of the availability zone for the Compute instance | ||
|
||
* `zone` - Exoscale Zone name. | ||
* `cpu` - The compute instance number of CPUs. | ||
* `created` - The instance creation date. | ||
* `disk_size` - The instance disk size (GiB). | ||
* `ip_address` - The instance (main network interface) IPv4 address. | ||
* `ip6_address` - The instance (main network interface) IPv6 address (if enabled). | ||
* `memory` - The instance allocated memory. | ||
* `size` - The instance size. | ||
* `state` - The current instance state. | ||
* `template` - The instance template. | ||
|
||
* `private_network_ip_addresses` - List of compute private IPv4 addresses (in *managed* private networks only). |
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.