Skip to content

Commit

Permalink
Release Documentation 0.8.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 Feb 9, 2023
1 parent 9a726a2 commit 1967c28
Show file tree
Hide file tree
Showing 79 changed files with 646 additions and 573 deletions.
10 changes: 5 additions & 5 deletions docs/data-sources/api_access_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ For more information on this resource actions, see the [API documentation](https
## Example Usage

```hcl
data "outscale_api_access_rule" "api_access_rule_01" {
filter {
name = "api_access_rule_ids"
values = ["aar-12345678"]
}
data "outscale_api_access_rule" "api_access_rule01" {
filter {
name = "api_access_rule_ids"
values = ["aar-12345678"]
}
}
```

Expand Down
14 changes: 9 additions & 5 deletions docs/data-sources/api_access_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,15 @@ For more information on this resource actions, see the [API documentation](https
## Example Usage

```hcl
data "outscale_api_access_rules" "api_access_rules_01" {
filter {
name = "api_access_rule_ids"
values = ["aar-12345678", "aar-87654321"]
}
data "outscale_api_access_rules" "api_access_rules01" {
filter {
name = "ca_ids"
values = ["ca-12345678", "ca-87654321"]
}
filter {
name = "ip_ranges"
values = ["192.0.2.0/16"]
}
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/client_gateway.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_client_gateway" "data_client_gateway01" {
data "outscale_client_gateway" "client_gateway01" {
filter {
name = "client_gateway_ids"
values = ["cgw-12345678"]
Expand All @@ -36,7 +36,7 @@ The following arguments are supported:
* `states` - (Optional) The states of the client gateways (`pending` \| `available` \| `deleting` \| `deleted`).
* `tag_keys` - (Optional) The keys of the tags associated with the client gateways.
* `tag_values` - (Optional) The values of the tags associated with the client gateways.
* `tags` - (Optional) The key/value combination of the tags associated with the client gateways, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `tags` - (Optional) The key/value combinations of the tags associated with the client gateways, in the following format: `TAGKEY=TAGVALUE`.

## Attribute Reference

Expand Down
12 changes: 8 additions & 4 deletions docs/data-sources/client_gateways.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@ For more information on this resource actions, see the [API documentation](https
## Example Usage

```hcl
data "outscale_client_gateways" "data_client_gateways01" {
data "outscale_client_gateways" "client_gateways01" {
filter {
name = "client_gateway_ids"
values = ["cgw-12345678","cgw-87654321"]
name = "bgp_asns"
values = ["65000"]
}
filter {
name = "public_ips"
values = ["111.11.111.1", "222.22.222.2"]
}
}
```
Expand All @@ -36,7 +40,7 @@ The following arguments are supported:
* `states` - (Optional) The states of the client gateways (`pending` \| `available` \| `deleting` \| `deleted`).
* `tag_keys` - (Optional) The keys of the tags associated with the client gateways.
* `tag_values` - (Optional) The values of the tags associated with the client gateways.
* `tags` - (Optional) The key/value combination of the tags associated with the client gateways, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `tags` - (Optional) The key/value combinations of the tags associated with the client gateways, in the following format: `TAGKEY=TAGVALUE`.

## Attribute Reference

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/dhcp_option.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_option" {
data "outscale_dhcp_option" "dhcp_option01" {
filter {
name = "dhcp_options_set_id"
values = ["dopt-12345678"]
Expand All @@ -37,7 +37,7 @@ The following arguments are supported:
* `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.
* `tags` - (Optional) The key/value combination of the tags associated with the DHCP options sets, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `tags` - (Optional) The key/value combinations of the tags associated with the DHCP options sets, in the following format: `TAGKEY=TAGVALUE`.

## Attribute Reference

Expand Down
16 changes: 10 additions & 6 deletions docs/data-sources/dhcp_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,15 @@ For more information on this resource actions, see the [API documentation](https
## Example Usage

```hcl
data "outscale_dhcp_options" "data_dhcp_options" {
filter {
name = "dhcp_options_set_ids"
values = ["dopt-12345678","dopt-87654321"]
}
data "outscale_dhcp_options" "dhcp_options01" {
filter {
name = "domain_name_servers"
values = ["111.11.111.1", "222.22.222.2"]
}
filter {
name = "domain_names"
values = ["example.com"]
}
}
```

Expand All @@ -37,7 +41,7 @@ The following arguments are supported:
* `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.
* `tags` - (Optional) The key/value combination of the tags associated with the DHCP options sets, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `tags` - (Optional) The key/value combinations of the tags associated with the DHCP options sets, in the following format: `TAGKEY=TAGVALUE`.

## Attribute Reference

Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/flexible_gpu.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_flexible_gpu" "flexible_gpu01" {
filter {
name = "flexible_gpu_ids"
values = ["fgpu-12345678"]
}
filter {
name = "flexible_gpu_ids"
values = ["fgpu-12345678"]
}
}
```

Expand Down
12 changes: 8 additions & 4 deletions docs/data-sources/flexible_gpus.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_flexible_gpus" "flexible_gpus01" {
filter {
name = "fgpu_ids"
values = ["fgpu-12345678", "fgpu-12345679"]
}
filter {
name = "model_names"
values = ["nvidia-p6", "nvidia-p100"]
}
filter {
name = "states"
values = ["attached"]
}
}
```

Expand Down
12 changes: 6 additions & 6 deletions docs/data-sources/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_image" "image01" {
filter {
name = "image_ids"
values = ["ami-12345678"]
}
filter {
name = "image_ids"
values = ["ami-12345678"]
}
}
```

Expand Down Expand Up @@ -50,7 +50,7 @@ The following arguments are supported:
* `states` - (Optional) The states of the OMIs (`pending` \| `available` \| `failed`).
* `tag_keys` - (Optional) The keys of the tags associated with the OMIs.
* `tag_values` - (Optional) The values of the tags associated with the OMIs.
* `tags` - (Optional) The key/value combination of the tags associated with the OMIs, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `tags` - (Optional) The key/value combinations of the tags associated with the OMIs, in the following format: `TAGKEY=TAGVALUE`.
* `virtualization_types` - (Optional) The virtualization types (always `hvm`).

## Attribute Reference
Expand All @@ -72,7 +72,7 @@ If you specify a snapshot ID but no volume size, the volume is created with a si
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`, `/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.
* `creation_date` - The date and time of creation of the OMI.
* `description` - The description of the OMI.
* `file_location` - The location of the bucket where the OMI files are stored.
* `image_id` - The ID of the OMI.
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/image_export_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_image_export_task" "image_export_task01" {
filter {
name = "task_ids"
values = ["image-export-12345678"]
}
filter {
name = "task_ids"
values = ["image-export-12345678"]
}
}
```

Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/image_export_tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_image_export_tasks" "image_export_tasks01" {
filter {
name = "task_ids"
values = ["image-export-12345678", "image-export-87654321"]
}
filter {
name = "task_ids"
values = ["image-export-12345678", "image-export-87654321"]
}
}
```

Expand Down
16 changes: 10 additions & 6 deletions docs/data-sources/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_images" "images01" {
filter {
name = "image_ids"
values = ["ami-12345678", "ami-12345679"]
}
filter {
name = "account_aliases"
values = ["Outscale"]
}
filter {
name = "image_names"
values = ["Ubuntu*", "RockyLinux*"]
}
}
```

Expand Down Expand Up @@ -50,7 +54,7 @@ The following arguments are supported:
* `states` - (Optional) The states of the OMIs (`pending` \| `available` \| `failed`).
* `tag_keys` - (Optional) The keys of the tags associated with the OMIs.
* `tag_values` - (Optional) The values of the tags associated with the OMIs.
* `tags` - (Optional) The key/value combination of the tags associated with the OMIs, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `tags` - (Optional) The key/value combinations of the tags associated with the OMIs, in the following format: `TAGKEY=TAGVALUE`.
* `virtualization_types` - (Optional) The virtualization types (always `hvm`).

## Attribute Reference
Expand All @@ -73,7 +77,7 @@ If you specify a snapshot ID but no volume size, the volume is created with a si
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`, `/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.
* `creation_date` - The date and time of creation of the OMI.
* `description` - The description of the OMI.
* `file_location` - The location of the bucket where the OMI files are stored.
* `image_id` - The ID of the OMI.
Expand Down
10 changes: 5 additions & 5 deletions docs/data-sources/internet_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_internet_service" "internet_service01" {
filter {
name = "internet_service_ids"
values = ["igw-12345678"]
}
filter {
name = "internet_service_ids"
values = ["igw-12345678"]
}
}
```

Expand All @@ -34,7 +34,7 @@ The following arguments are supported:
* `link_states` - (Optional) The current states of the attachments between the Internet services and the Nets (only `available`, if the Internet gateway is attached to a VPC).
* `tag_keys` - (Optional) The keys of the tags associated with the Internet services.
* `tag_values` - (Optional) The values of the tags associated with the Internet services.
* `tags` - (Optional) The key/value combination of the tags associated with the Internet services, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `tags` - (Optional) The key/value combinations of the tags associated with the Internet services, in the following format: `TAGKEY=TAGVALUE`.

## Attribute Reference

Expand Down
14 changes: 9 additions & 5 deletions docs/data-sources/internet_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_internet_services" "internet_services01" {
filter {
name = "internet_service_ids"
values = ["igw-12345678", "igw-12345679"]
}
filter {
name = "tag_keys"
values = ["env"]
}
filter {
name = "tag_values"
values = ["prod", "test"]
}
}
```

Expand All @@ -34,7 +38,7 @@ The following arguments are supported:
* `link_states` - (Optional) The current states of the attachments between the Internet services and the Nets (only `available`, if the Internet gateway is attached to a VPC).
* `tag_keys` - (Optional) The keys of the tags associated with the Internet services.
* `tag_values` - (Optional) The values of the tags associated with the Internet services.
* `tags` - (Optional) The key/value combination of the tags associated with the Internet services, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `tags` - (Optional) The key/value combinations of the tags associated with the Internet services, in the following format: `TAGKEY=TAGVALUE`.

## Attribute Reference

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.
* `public_ip` - (internet-facing only) The public IP associated with 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 />
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/load_balancer_listener_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_load_balancer_listener_rule" "rule01" {
filter {
name = "listener_rule_names"
values = ["terraform-listener-rule02"]
}
filter {
name = "listener_rule_names"
values = ["terraform-listener-rule02"]
}
}
```

Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/load_balancer_listener_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_load_balancer_listener_rules" "rules01" {
filter {
name = "listener_rule_names"
values = ["terraform-listener-rule02","terraform-listener-rule01"]
}
filter {
name = "listener_rule_names"
values = ["terraform-listener-rule02","terraform-listener-rule01"]
}
}
```

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.
* `public_ip` - (internet-facing only) The public IP associated with 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 />
Expand Down
10 changes: 5 additions & 5 deletions docs/data-sources/nat_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ For more information on this resource actions, see the [API documentation](https

```hcl
data "outscale_nat_service" "nat_service01" {
filter {
name = "nat_service_ids"
values = ["nat-12345678"]
}
filter {
name = "nat_service_ids"
values = ["nat-12345678"]
}
}
```

Expand All @@ -35,7 +35,7 @@ The following arguments are supported:
* `subnet_ids` - (Optional) The IDs of the Subnets in which the NAT services are.
* `tag_keys` - (Optional) The keys of the tags associated with the NAT services.
* `tag_values` - (Optional) The values of the tags associated with the NAT services.
* `tags` - (Optional) The key/value combination of the tags associated with the NAT services, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}.
* `tags` - (Optional) The key/value combinations of the tags associated with the NAT services, in the following format: `TAGKEY=TAGVALUE`.

## Attribute Reference

Expand Down
Loading

0 comments on commit 1967c28

Please sign in to comment.