Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(all): generation with tfplugindocs #2486

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
46 changes: 17 additions & 29 deletions docs/data-sources/account_project.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,29 @@
---
subcategory: "Account"
page_title: "Scaleway: scaleway_account_project"
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaleway_account_project Data Source - terraform-provider-scaleway"
subcategory: ""
description: |-

---

# scaleway_account_project
# scaleway_account_project (Data Source)

Gets information about an existing Project.

## Example Usage

```hcl
# Get info by name
data scaleway_account_project "by_name" {
name = "myproject"
organization_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
# Get default project
data scaleway_account_project "by_name" {
name = "default"
}
# Get info by ID
data scaleway_account_project "by_id" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

## Argument Reference

- `name` - (Optional) The name of the Project.
Only one of the `name` and `project_id` should be specified.
<!-- schema generated by tfplugindocs -->
## Schema

- `project_id` - (Optional) The ID of the Project.
Only one of the `name` and `project_id` should be specified.
### Optional

- `organization_id` - (Optional) The organization ID the Project is associated with.
If no default organization_id is set, one must be set explicitly in this datasource
- `name` (String) The name of the project
- `organization_id` (String) The organization_id you want to attach the resource to
- `project_id` (String) The ID of the SSH key

## Attribute Reference
### Read-Only

Exported attributes are the ones from `account_project` [resource](../resources/account_project.md)
- `created_at` (String) The date and time of the creation of the Project (Format ISO 8601)
- `description` (String) Description of the project
- `id` (String) The ID of this resource.
- `updated_at` (String) The date and time of the last update of the Project (Format ISO 8601)
44 changes: 20 additions & 24 deletions docs/data-sources/account_ssh_key.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,32 @@
---
subcategory: "Account"
page_title: "Scaleway: scaleway_account_ssh_key"
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaleway_account_ssh_key Data Source - terraform-provider-scaleway"
subcategory: ""
description: |-

---

# scaleway_account_ssh_key
# scaleway_account_ssh_key (Data Source)

Use this data source to get SSH key information based on its ID or name.

## Example Usage

```hcl
# Get info by SSH key name
data "scaleway_account_ssh_key" "my_key" {
name = "my-key-name"
}

# Get info by SSH key id
data "scaleway_account_ssh_key" "my_key" {
ssh_key_id = "11111111-1111-1111-1111-111111111111"
}
```

## Argument Reference
<!-- schema generated by tfplugindocs -->
## Schema

- `name` - The SSH key name. Only one of `name` and `ssh_key_id` should be specified.
- `ssh_key_id` - The SSH key id. Only one of `name` and `ssh_key_id` should be specified.
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the SSH key is associated with.
### Optional

## Attributes Reference
- `name` (String) The name of the iam SSH key
- `project_id` (String) The project_id you want to attach the resource to
- `ssh_key_id` (String) The ID of the SSH key

In addition to all above arguments, the following attributes are exported:
### Read-Only

- `id` - The ID of the SSH public key.
- `public_key` - The SSH public key string
- `organization_id` - The ID of the organization the SSH key is associated with.
- `created_at` (String) The date and time of the creation of the iam SSH Key
- `disabled` (Boolean) The SSH key status
- `fingerprint` (String) The fingerprint of the iam SSH key
- `id` (String) The ID of this resource.
- `organization_id` (String) The organization_id you want to attach the resource to
- `public_key` (String) The public SSH key
- `updated_at` (String) The date and time of the last update of the iam SSH Key
40 changes: 21 additions & 19 deletions docs/data-sources/availability_zones.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
---
subcategory: "Account"
page_title: "Scaleway: scaleway_availability_zones"
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaleway_availability_zones Data Source - terraform-provider-scaleway"
subcategory: ""
description: |-

---

# scaleway_availability_zones
# scaleway_availability_zones (Data Source)

Use this data source to get the available zones information based on its Region.

For technical and legal reasons, some products are split by Region or by Availability Zones. When using such product,
you can choose the location that better fits your need (country, latency, …).

## Example Usage

```hcl
# Get info by Region key
data scaleway_availability_zones main {
region = "nl-ams"
}
```

## Argument Reference
<!-- schema generated by tfplugindocs -->
## Schema

- `region` - Region is represented as a Geographical area such as France. Defaults: `fr-par`.
### Optional

## Attributes Reference
- `region` (String) Region is represented as a Geographical area such as France
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

In addition to all above arguments, the following attributes are exported:
### Read-Only

- `id` - The Region ID
- `zones` - List of availability zones by regions
- `id` (String) The ID of this resource.
- `zones` (List of String) Availability Zones (AZ)

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `read` (String)
100 changes: 41 additions & 59 deletions docs/data-sources/baremetal_offer.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,64 @@
---
subcategory: "Elastic Metal"
page_title: "Scaleway: scaleway_baremetal_offer"
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaleway_baremetal_offer Data Source - terraform-provider-scaleway"
subcategory: ""
description: |-

---

# scaleway_baremetal_offer
# scaleway_baremetal_offer (Data Source)

Gets information about a baremetal offer. For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).

## Example Usage

```hcl
# Get info by offer name
data "scaleway_baremetal_offer" "my_offer" {
zone = "fr-par-2"
name = "EM-A210R-SATA"
}

# Get info by offer id
data "scaleway_baremetal_offer" "my_offer" {
zone = "fr-par-2"
offer_id = "25dcf38b-c90c-4b18-97a2-6956e9d1e113"
}
```

## Argument Reference
<!-- schema generated by tfplugindocs -->
## Schema

- `name` - (Optional) The offer name. Only one of `name` and `offer_id` should be specified.
### Optional

- `subscription_period` - (Optional) Period of subscription the desired offer. Should be `hourly` or `monthly`.
- `include_disabled` (Boolean) Include disabled offers
- `name` (String) Exact name of the desired offer
- `offer_id` (String) ID of the desired offer
- `subscription_period` (String) Period of subscription the desired offer
- `zone` (String) The zone you want to attach the resource to

- `offer_id` - (Optional) The offer id. Only one of `name` and `offer_id` should be specified.
### Read-Only

- `allow_disabled` - (Optional, default `false`) Include disabled offers.
- `bandwidth` (Number) Available Bandwidth with the offer
- `commercial_range` (String) Commercial range of the offer
- `cpu` (List of Object) CPU specifications of the offer (see [below for nested schema](#nestedatt--cpu))
- `disk` (List of Object) Disk specifications of the offer (see [below for nested schema](#nestedatt--disk))
- `id` (String) The ID of this resource.
- `memory` (List of Object) Memory specifications of the offer (see [below for nested schema](#nestedatt--memory))
- `stock` (String) Stock status for this offer

- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the offer should be created.
<a id="nestedatt--cpu"></a>
### Nested Schema for `cpu`

## Attributes Reference
Read-Only:

In addition to all above arguments, the following attributes are exported:
- `core_count` (Number)
- `frequency` (Number)
- `name` (String)
- `thread_count` (Number)

- `id` - The ID of the offer.

~> **Important:** Baremetal offers' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
<a id="nestedatt--disk"></a>
### Nested Schema for `disk`

- `bandwidth` - Available Bandwidth with the offer.
Read-Only:

- `commercial_range` - Commercial range of the offer.
- `capacity` (Number)
- `type` (String)

- `cpu` - A list of cpu specifications. (Structure is documented below.)

- `disk` - A list of disk specifications. (Structure is documented below.)
<a id="nestedatt--memory"></a>
### Nested Schema for `memory`

- `memory` - A list of memory specifications. (Structure is documented below.)
Read-Only:

- `stock` - Stock status for this offer. Possible values are: `empty`, `low` or `available`.

The `cpu` block supports:

- `name` - Name of the CPU.

- `core_count`- Number of core on this CPU.

- `frequency`- Frequency of the CPU in MHz.

- `thread_count`- Number of thread on this CPU.

The `disk` block supports:

- `type` - Type of disk.

- `capacity`- Capacity of the disk in GB.

The `memory` block supports:

- `type` - Type of memory.

- `capacity`- Capacity of the memory in GB.

- `frequency` - Frequency of the memory in MHz.

- `is_ecc`- True if error-correcting code is available on this memory.
- `capacity` (Number)
- `frequency` (Number)
- `is_ecc` (Boolean)
- `type` (String)
43 changes: 15 additions & 28 deletions docs/data-sources/baremetal_option.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,27 @@
---
subcategory: "Elastic Metal"
page_title: "Scaleway: scaleway_baremetal_option"
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaleway_baremetal_option Data Source - terraform-provider-scaleway"
subcategory: ""
description: |-

---

# scaleway_baremetal_option
# scaleway_baremetal_option (Data Source)

Gets information about a baremetal option.
For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).

## Example Usage

```hcl
# Get info by option name
data "scaleway_baremetal_option" "by_name" {
name = "Remote Access"
}

# Get info by option id
data "scaleway_baremetal_option" "by_id" {
option_id = "931df052-d713-4674-8b58-96a63244c8e2"
}
```

## Argument Reference
<!-- schema generated by tfplugindocs -->
## Schema

- `name` - (Optional) The option name. Only one of `name` and `option_id` should be specified.
- `option_id` - (Optional) The option id. Only one of `name` and `option_id` should be specified.
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the option exists.
### Optional

## Attributes Reference
- `name` (String) Exact label of the desired option
- `option_id` (String) The ID of the option
- `zone` (String) The zone you want to attach the resource to

In addition to all above arguments, the following attributes are exported:
### Read-Only

- `id` - The ID of the option.

~> **Important:** Baremetal options' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`

- `name` - The name of the option.
- `manageable` - Is false if the option could not be added or removed.
- `id` (String) The ID of this resource.
- `manageable` (Boolean) Is false if the option could not be added or removed
Loading
Loading