Skip to content

Commit

Permalink
Release Documentation 0.7.0
Browse files Browse the repository at this point in the history
Signed-off-by: Outscale Bot <opensource+bot@outscale.com>
  • Loading branch information
Open-Source-Bot authored and outscale-toa committed Nov 25, 2022
1 parent fdb9c83 commit 670a3f7
Show file tree
Hide file tree
Showing 43 changed files with 242 additions and 79 deletions.
4 changes: 2 additions & 2 deletions docs/data-sources/access_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ For more information on this resource actions, see the [API documentation](https
## Example Usage

```hcl
data "outscale_access_key" "access_keys01" {
data "outscale_access_keys" "access_keys01" {
filter {
name = "access_keys_ids"
name = "access_key_ids"
values = ["ABCDEFGHIJ0123456789", "0123456789ABCDEFGHIJ"]
}
}
Expand Down
46 changes: 46 additions & 0 deletions docs/data-sources/account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
layout: "outscale"
page_title: "OUTSCALE: outscale_account"
sidebar_current: "outscale-account"
description: |-
[Provides information about an account.]
---

# outscale_account Data Source

Provides information about an account.

For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Your-Account.html).
For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-account).

## Example Usage

```hcl
data "outscale_account" "account01" {
}
```

## Argument Reference

No argument is supported.

## Attribute Reference

The following attributes are exported:

* `account_id` - The ID of the account.
* `additional_emails` - One or more additional email addresses for the account. These addresses are used for notifications only.
* `city` - The city of the account owner.
* `company_name` - The name of the company for the account.
* `country` - The country of the account owner.
* `customer_id` - The ID of the customer.
* `email` - The main email address for the account. This address is used for your credentials and for notifications.
* `first_name` - The first name of the account owner.
* `job_title` - The job title of the account owner.
* `last_name` - The last name of the account owner.
* `mobile_number` - The mobile phone number of the account owner.
* `phone_number` - The landline phone number of the account owner.
* `state_province` - The state/province of the account.
* `vat_number` - The value added tax (VAT) number for the account.
* `zip_code` - The ZIP code of the city.
47 changes: 47 additions & 0 deletions docs/data-sources/accounts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: "outscale"
page_title: "OUTSCALE: outscale_accounts"
sidebar_current: "outscale-accounts"
description: |-
[Provides information about accounts.]
---

# outscale_accounts Data Source

Provides information about accounts.

For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Your-Account.html).
For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-account).

## Example Usage

```hcl
data "outscale_accounts" "all_accounts" {
}
```

## Argument Reference

No argument is supported.

## Attribute Reference

The following attributes are exported:

* `accounts` - The list of the accounts.
* `account_id` - The ID of the account.
* `additional_emails` - One or more additional email addresses for the account. These addresses are used for notifications only.
* `city` - The city of the account owner.
* `company_name` - The name of the company for the account.
* `country` - The country of the account owner.
* `customer_id` - The ID of the customer.
* `email` - The main email address for the account. This address is used for your credentials and for notifications.
* `first_name` - The first name of the account owner.
* `job_title` - The job title of the account owner.
* `last_name` - The last name of the account owner.
* `mobile_number` - The mobile phone number of the account owner.
* `phone_number` - The landline phone number of the account owner.
* `state_province` - The state/province of the account.
* `vat_number` - The value added tax (VAT) number for the account.
* `zip_code` - The ZIP code of the city.
2 changes: 1 addition & 1 deletion docs/data-sources/api_access_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The following arguments are supported:
* `ca_ids` - (Optional) One or more IDs of Client Certificate Authorities (CAs).
* `cns` - (Optional) One or more Client Certificate Common Names (CNs).
* `descriptions` - (Optional) One or more descriptions of API access rules.
* `ip_ranges` - (Optional) One or more IP ranges, in CIDR notation (for example, `192.0.2.0/16`).
* `ip_ranges` - (Optional) One or more IP addresses or CIDR blocks (for example, `192.0.2.0/16`).

## Attribute Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/api_access_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The following arguments are supported:
* `ca_ids` - (Optional) One or more IDs of Client Certificate Authorities (CAs).
* `cns` - (Optional) One or more Client Certificate Common Names (CNs).
* `descriptions` - (Optional) One or more descriptions of API access rules.
* `ip_ranges` - (Optional) One or more IP ranges, in CIDR notation (for example, `192.0.2.0/16`).
* `ip_ranges` - (Optional) One or more IP addresses or CIDR blocks (for example, `192.0.2.0/16`).

## Attribute Reference

Expand Down
2 changes: 2 additions & 0 deletions docs/data-sources/dhcp_option.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ The following arguments are supported:
* `dhcp_options_set_ids` - (Optional) The IDs of the DHCP options sets.
* `domain_name_servers` - (Optional) The IPs of the domain name servers used for the DHCP options sets.
* `domain_names` - (Optional) The domain names used for the DHCP options sets.
* `log_servers` - (Optional) The IPs of the log servers used for the DHCP options sets.
* `ntp_servers` - (Optional) The IPs of the Network Time Protocol (NTP) servers used for the DHCP options sets.
* `tag_keys` - (Optional) The keys of the tags associated with the DHCP options sets.
* `tag_values` - (Optional) The values of the tags associated with the DHCP options sets.
Expand All @@ -46,6 +47,7 @@ The following attributes are exported:
* `dhcp_options_set_id` - The ID of the DHCP options set.
* `domain_name_servers` - One or more IPs for the domain name servers.
* `domain_name` - The domain name.
* `log_servers` - One or more IPs for the log servers.
* `ntp_servers` - One or more IPs for the NTP servers.
* `tags` - One or more tags associated with the DHCP options set.
* `key` - The key of the tag, with a minimum of 1 character.
Expand Down
4 changes: 3 additions & 1 deletion docs/data-sources/dhcp_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For more information on this resource actions, see the [API documentation](https
## Example Usage

```hcl
data "outscale_dhcp_option" "data_dhcp_options" {
data "outscale_dhcp_options" "data_dhcp_options" {
filter {
name = "dhcp_options_set_ids"
values = ["dopt-12345678","dopt-87654321"]
Expand All @@ -33,6 +33,7 @@ The following arguments are supported:
* `dhcp_options_set_ids` - (Optional) The IDs of the DHCP options sets.
* `domain_name_servers` - (Optional) The IPs of the domain name servers used for the DHCP options sets.
* `domain_names` - (Optional) The domain names used for the DHCP options sets.
* `log_servers` - (Optional) The IPs of the log servers used for the DHCP options sets.
* `ntp_servers` - (Optional) The IPs of the Network Time Protocol (NTP) servers used for the DHCP options sets.
* `tag_keys` - (Optional) The keys of the tags associated with the DHCP options sets.
* `tag_values` - (Optional) The values of the tags associated with the DHCP options sets.
Expand All @@ -47,6 +48,7 @@ The following attributes are exported:
* `dhcp_options_set_id` - The ID of the DHCP options set.
* `domain_name` - The domain name.
* `domain_name_servers` - One or more IPs for the domain name servers.
* `log_servers` - One or more IPs for the log servers.
* `ntp_servers` - One or more IPs for the NTP servers.
* `tags` - One or more tags associated with the DHCP options set.
* `key` - The key of the tag, with a minimum of 1 character.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,14 @@ The following attributes are exported:
* `block_device_mappings` - One or more block device mappings.
* `bsu` - Information about the BSU volume to create.
* `delete_on_vm_deletion` - By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
* `iops` - The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000`.
* `iops` - The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
* `snapshot_id` - The ID of the snapshot used to create the volume.
* `volume_size` - The size of the volume, in gibibytes (GiB).<br />
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.<br />
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
* `volume_type` - The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created.<br />
For more information about volume types, see [About Volumes > Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops).
* `device_name` - The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX` or `/dev/xvdX` (where `X` is a letter between `b` and `z`).
* `device_name` - The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
* `virtual_device_name` - The name of the virtual device (`ephemeralN`).
* `creation_date` - The date and time at which the OMI was created.
* `description` - The description of the OMI.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,14 @@ The following attributes are exported:
* `block_device_mappings` - One or more block device mappings.
* `bsu` - Information about the BSU volume to create.
* `delete_on_vm_deletion` - By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
* `iops` - The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000`.
* `iops` - The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
* `snapshot_id` - The ID of the snapshot used to create the volume.
* `volume_size` - The size of the volume, in gibibytes (GiB).<br />
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.<br />
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
* `volume_type` - The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created.<br />
For more information about volume types, see [About Volumes > Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops).
* `device_name` - The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX` or `/dev/xvdX` (where `X` is a letter between `b` and `z`).
* `device_name` - The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
* `virtual_device_name` - The name of the virtual device (`ephemeralN`).
* `creation_date` - The date and time at which the OMI was created.
* `description` - The description of the OMI.
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/load_balancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ The following attributes are exported:
If `load_balancer_type` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP.<br />
If `load_balancer_type` is `internal`, the load balancer has a public DNS name that resolves to a private IP.
* `net_id` - The ID of the Net for the load balancer.
* `secured_cookies` - Whether secure cookies are enabled for the load balancer.
* `security_groups` - One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net.
* `source_security_group` - Information about the source security group of the load balancer, which you can use as part of your inbound rules for your registered VMs.<br />
To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/load_balancers.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ The following attributes are exported:
If `load_balancer_type` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP.<br />
If `load_balancer_type` is `internal`, the load balancer has a public DNS name that resolves to a private IP.
* `net_id` - The ID of the Net for the load balancer.
* `secured_cookies` - Whether secure cookies are enabled for the load balancer.
* `security_groups` - One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net.
* `source_security_group` - Information about the source security group of the load balancer, which you can use as part of your inbound rules for your registered VMs.<br />
To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.
Expand Down
22 changes: 11 additions & 11 deletions docs/data-sources/net_peering.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ The following arguments are supported:
* `accepter_net_account_ids` - (Optional) The account IDs of the owners of the peer Nets.
* `accepter_net_ip_ranges` - (Optional) The IP ranges of the peer Nets, in CIDR notation (for example, `10.0.0.0/24`).
* `accepter_net_net_ids` - (Optional) The IDs of the peer Nets.
* `net_peering_ids` - (Optional) The IDs of the Net peering connections.
* `net_peering_ids` - (Optional) The IDs of the Net peerings.
* `source_net_account_ids` - (Optional) The account IDs of the owners of the peer Nets.
* `source_net_ip_ranges` - (Optional) The IP ranges of the peer Nets.
* `source_net_net_ids` - (Optional) The IDs of the peer Nets.
* `state_messages` - (Optional) Additional information about the states of the Net peering connections.
* `state_names` - (Optional) The states of the Net peering connections (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
* `tag_keys` - (Optional) The keys of the tags associated with the Net peering connections.
* `tag_values` - (Optional) The values of the tags associated with the Net peering connections.
* `tags` - (Optional) The key/value combination of the tags associated with the Net peering connections, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `state_messages` - (Optional) Additional information about the states of the Net peerings.
* `state_names` - (Optional) The states of the Net peerings (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
* `tag_keys` - (Optional) The keys of the tags associated with the Net peerings.
* `tag_values` - (Optional) The values of the tags associated with the Net peerings.
* `tags` - (Optional) The key/value combination of the tags associated with the Net peerings, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.

## Attribute Reference

Expand All @@ -50,14 +50,14 @@ The following attributes are exported:
* `account_id` - The account ID of the owner of the accepter Net.
* `ip_range` - The IP range for the accepter Net, in CIDR notation (for example, `10.0.0.0/16`).
* `net_id` - The ID of the accepter Net.
* `net_peering_id` - The ID of the Net peering connection.
* `net_peering_id` - The ID of the Net peering.
* `source_net` - Information about the source Net.
* `account_id` - The account ID of the owner of the source Net.
* `ip_range` - The IP range for the source Net, in CIDR notation (for example, `10.0.0.0/16`).
* `net_id` - The ID of the source Net.
* `state` - Information about the state of the Net peering connection.
* `message` - Additional information about the state of the Net peering connection.
* `name` - The state of the Net peering connection (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
* `tags` - One or more tags associated with the Net peering connection.
* `state` - Information about the state of the Net peering.
* `message` - Additional information about the state of the Net peering.
* `name` - The state of the Net peering (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
* `tags` - One or more tags associated with the Net peering.
* `key` - The key of the tag, with a minimum of 1 character.
* `value` - The value of the tag, between 0 and 255 characters.
Loading

0 comments on commit 670a3f7

Please sign in to comment.