Skip to content

Commit

Permalink
Release Documentation 1.0.0rc2
Browse files Browse the repository at this point in the history
Signed-off-by: Outscale Bot <[email protected]>
  • Loading branch information
Open-Source-Bot authored and outscale-toa committed Sep 13, 2024
1 parent 9f368aa commit 670eed2
Show file tree
Hide file tree
Showing 57 changed files with 142 additions and 210 deletions.
6 changes: 3 additions & 3 deletions docs/data-sources/access_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The following arguments are supported:
The following attributes are exported:

* `access_key_id` - The ID of the access key.
* `creation_date` - The date and time (UTC) of creation of the access key.
* `expiration_date` - The date (UTC) at which the access key expires.
* `last_modification_date` - The date and time (UTC) of the last modification of the access key.
* `creation_date` - The date and time (UTC) at which the access key was created.
* `expiration_date` - The date and time (UTC) at which the access key expires.
* `last_modification_date` - The date and time (UTC) at which the access key was last modified.
* `state` - The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not).
6 changes: 3 additions & 3 deletions docs/data-sources/access_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The following attributes are exported:

* `access_keys` - A list of access keys.
* `access_key_id` - The ID of the access key.
* `creation_date` - The date and time (UTC) of creation of the access key.
* `expiration_date` - The date (UTC) at which the access key expires.
* `last_modification_date` - The date and time (UTC) of the last modification of the access key.
* `creation_date` - The date and time (UTC) at which the access key was created.
* `expiration_date` - The date and time (UTC) at which the access key expires.
* `last_modification_date` - The date and time (UTC) at which the access key was last modified.
* `state` - The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not).
4 changes: 2 additions & 2 deletions docs/data-sources/api_access_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ 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 addresses or CIDR blocks (for example, `192.0.2.0/16`).
* `ip_ranges` - (Optional) One or more IPs or CIDR blocks (for example, `192.0.2.0/16`).

## Attribute Reference

The following attributes are exported:

* `api_access_rule_id` - The ID of the API access rule.
* `api_access_rule_id` - The ID of the API access rule.
* `ca_ids` - One or more IDs of Client Certificate Authorities (CAs) used for the API access rule.
* `cns` - One or more Client Certificate Common Names (CNs).
* `description` - The description of the API access rule.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/api_access_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ 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 addresses or CIDR blocks (for example, `192.0.2.0/16`).
* `ip_ranges` - (Optional) One or more IPs or CIDR blocks (for example, `192.0.2.0/16`).

## Attribute Reference

The following attributes are exported:

* `api_access_rules` - A list of API access rules.
* `api_access_rule_id` - The ID of the API access rule.
* `api_access_rule_id` - The ID of the API access rule.
* `ca_ids` - One or more IDs of Client Certificate Authorities (CAs) used for the API access rule.
* `cns` - One or more Client Certificate Common Names (CNs).
* `description` - The description of the API access rule.
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 @@ -31,7 +31,7 @@ The following arguments are supported:
* `filter` - (Optional) A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
* `bgp_asns` - (Optional) The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections.
* `client_gateway_ids` - (Optional) The IDs of the client gateways.
* `connection_types` - (Optional) The types of communication tunnels used by the client gateways (only `ipsec.1` is supported).
* `connection_types` - (Optional) The types of communication tunnels used by the client gateways (always `ipsec.1`).
* `public_ips` - (Optional) The public IPv4 addresses of the client gateways.
* `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.
Expand All @@ -44,7 +44,7 @@ The following attributes are exported:

* `bgp_asn` - The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
* `client_gateway_id` - The ID of the client gateway.
* `connection_type` - The type of communication tunnel used by the client gateway (only `ipsec.1` is supported).
* `connection_type` - The type of communication tunnel used by the client gateway (always `ipsec.1`).
* `public_ip` - The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
* `state` - The state of the client gateway (`pending` \| `available` \| `deleting` \| `deleted`).
* `tags` - One or more tags associated with the client gateway.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/client_gateways.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following arguments are supported:
* `filter` - (Optional) A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
* `bgp_asns` - (Optional) The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections.
* `client_gateway_ids` - (Optional) The IDs of the client gateways.
* `connection_types` - (Optional) The types of communication tunnels used by the client gateways (only `ipsec.1` is supported).
* `connection_types` - (Optional) The types of communication tunnels used by the client gateways (always `ipsec.1`).
* `public_ips` - (Optional) The public IPv4 addresses of the client gateways.
* `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.
Expand All @@ -49,7 +49,7 @@ The following attributes are exported:
* `client_gateways` - Information about one or more client gateways.
* `bgp_asn` - The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
* `client_gateway_id` - The ID of the client gateway.
* `connection_type` - The type of communication tunnel used by the client gateway (only `ipsec.1` is supported).
* `connection_type` - The type of communication tunnel used by the client gateway (always `ipsec.1`).
* `public_ip` - The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
* `state` - The state of the client gateway (`pending` \| `available` \| `deleting` \| `deleted`).
* `tags` - One or more tags associated with the client gateway.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/flexible_gpu_catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ No argument is supported.
The following attributes are exported:

* `flexible_gpu_catalog` - Information about one or more fGPUs available in the public catalog.
* `generations` - The generations of VMs that the fGPU is compatible with.
* `generations` - The processor generations that the fGPUs are compatible with.
* `max_cpu` - The maximum number of VM vCores that the fGPU is compatible with.
* `max_ram` - The maximum amount of VM memory that the fGPU is compatible with.
* `model_name` - The model of fGPU.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,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 of creation of the OMI, in ISO 8601 date-time format.
* `creation_date` - The date and time (UTC) at which the OMI was created.
* `description` - The description of the OMI.
* `file_location` - The location from which the OMI files were created.
* `image_id` - The ID of the OMI.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,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 of creation of the OMI, in ISO 8601 date-time format.
* `creation_date` - The date and time (UTC) at which the OMI was created.
* `description` - The description of the OMI.
* `file_location` - The location from which the OMI files were created.
* `image_id` - The ID of the OMI.
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/load_balancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The following attributes are exported:
* `application_sticky_cookie_policies` - The stickiness policies defined for the load balancer.
* `cookie_name` - The name of the application cookie used for stickiness.
* `policy_name` - The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
* `backend_vm_ids` - One or more IDs of back-end VMs for the load balancer.
* `backend_vm_ids` - One or more IDs of backend VMs for the load balancer.
* `dns_name` - The DNS name of the load balancer.
* `health_check` - Information about the health check configuration.
* `check_interval` - The number of seconds between two requests (between `5` and `600` both included).
Expand All @@ -54,8 +54,8 @@ The following attributes are exported:
* `timeout` - The maximum waiting time for a response before considering the VM as unhealthy, in seconds (between `2` and `60` both included).
* `unhealthy_threshold` - The number of consecutive failed requests before considering the VM as unhealthy (between `2` and `10` both included).
* `listeners` - The listeners for the load balancer.
* `backend_port` - The port on which the back-end VM is listening (between `1` and `65535`, both included).
* `backend_protocol` - The protocol for routing traffic to back-end VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
* `backend_port` - The port on which the backend VM is listening (between `1` and `65535`, both included).
* `backend_protocol` - The protocol for routing traffic to backend VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
* `load_balancer_port` - The port on which the load balancer is listening (between `1` and `65535`, both included).
* `load_balancer_protocol` - The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
* `policy_names` - The names of the policies. If there are no policies enabled, the list is empty.
Expand Down
10 changes: 5 additions & 5 deletions docs/data-sources/load_balancer_vm_health.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@ data "outscale_load_balancer_vm_health" "load_balancer_vm_health01" {

The following arguments are supported:

* `backend_vm_ids` - (Optional) One or more IDs of back-end VMs.
* `backend_vm_ids` - (Optional) One or more IDs of backend VMs.
* `load_balancer_name` - (Required) The name of the load balancer.

## Attribute Reference

The following attributes are exported:

* `backend_vm_health` - Information about the health of one or more back-end VMs.
* `description` - The description of the state of the back-end VM.
* `state` - The state of the back-end VM (`InService` \| `OutOfService` \| `Unknown`).
* `backend_vm_health` - Information about the health of one or more backend VMs.
* `description` - The description of the state of the backend VM.
* `state` - The state of the backend VM (`InService` \| `OutOfService` \| `Unknown`).
* `state_reason` - Information about the cause of `OutOfService` VMs.<br />
Specifically, whether the cause is Elastic Load Balancing or the VM (`ELB` \| `Instance` \| `N/A`).
* `vm_id` - The ID of the back-end VM.
* `vm_id` - The ID of the backend VM.
6 changes: 3 additions & 3 deletions docs/data-sources/load_balancers.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The following attributes are exported:
* `application_sticky_cookie_policies` - The stickiness policies defined for the load balancer.
* `cookie_name` - The name of the application cookie used for stickiness.
* `policy_name` - The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
* `backend_vm_ids` - One or more IDs of back-end VMs for the load balancer.
* `backend_vm_ids` - One or more IDs of backend VMs for the load balancer.
* `dns_name` - The DNS name of the load balancer.
* `health_check` - Information about the health check configuration.
* `check_interval` - The number of seconds between two requests (between `5` and `600` both included).
Expand All @@ -55,8 +55,8 @@ The following attributes are exported:
* `timeout` - The maximum waiting time for a response before considering the VM as unhealthy, in seconds (between `2` and `60` both included).
* `unhealthy_threshold` - The number of consecutive failed requests before considering the VM as unhealthy (between `2` and `10` both included).
* `listeners` - The listeners for the load balancer.
* `backend_port` - The port on which the back-end VM is listening (between `1` and `65535`, both included).
* `backend_protocol` - The protocol for routing traffic to back-end VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
* `backend_port` - The port on which the backend VM is listening (between `1` and `65535`, both included).
* `backend_protocol` - The protocol for routing traffic to backend VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
* `load_balancer_port` - The port on which the load balancer is listening (between `1` and `65535`, both included).
* `load_balancer_protocol` - The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
* `policy_names` - The names of the policies. If there are no policies enabled, the list is empty.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/net_peering.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ 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.
* `expiration_date` - The date and time at which the Net peerings expire.
* `expiration_date` - The date and time (UTC) at which the Net peerings expire.
* `net_peering_id` - The ID of the Net peering.
* `next_page_token` - The token to request the next page of results. Each token refers to a specific page.
* `source_net` - Information about the source Net.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/net_peerings.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ 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.
* `expiration_date` - The date and time at which the Net peerings expire.
* `expiration_date` - The date and time (UTC) at which the Net peerings expire.
* `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.
Expand Down
3 changes: 2 additions & 1 deletion docs/data-sources/nic.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ The following arguments are supported:
* `link_nic_vm_ids` - (Optional) The IDs of the VMs the NICs are attached to.
* `link_public_ip_account_ids` - (Optional) The account IDs of the owners of the public IPs associated with the NICs.
* `link_public_ip_link_public_ip_ids` - (Optional) The association IDs returned when the public IPs were associated with the NICs.
* `link_public_ip_public_dns_names` - (Optional) The public DNS names associated with the public IPs.
* `link_public_ip_public_ip_ids` - (Optional) The allocation IDs returned when the public IPs were allocated to their accounts.
* `link_public_ip_public_ips` - (Optional) The public IPs associated with the NICs.
* `mac_addresses` - (Optional) The Media Access Control (MAC) addresses of the NICs.
Expand All @@ -64,7 +65,7 @@ The following attributes are exported:

* `account_id` - The account ID of the owner of the NIC.
* `description` - The description of the NIC.
* `is_source_dest_checked` - (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net.
* `is_source_dest_checked` - (Net only) If true, the source/destination check is enabled. If false, it is disabled.
* `link_nic` - Information about the NIC attachment.
* `delete_on_vm_deletion` - If true, the NIC is deleted when the VM is terminated.
* `device_number` - The device index for the NIC attachment (between `1` and `7`, both included).
Expand Down
3 changes: 2 additions & 1 deletion docs/data-sources/nics.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ The following arguments are supported:
* `link_nic_vm_ids` - (Optional) The IDs of the VMs the NICs are attached to.
* `link_public_ip_account_ids` - (Optional) The account IDs of the owners of the public IPs associated with the NICs.
* `link_public_ip_link_public_ip_ids` - (Optional) The association IDs returned when the public IPs were associated with the NICs.
* `link_public_ip_public_dns_names` - (Optional) The public DNS names associated with the public IPs.
* `link_public_ip_public_ip_ids` - (Optional) The allocation IDs returned when the public IPs were allocated to their accounts.
* `link_public_ip_public_ips` - (Optional) The public IPs associated with the NICs.
* `mac_addresses` - (Optional) The Media Access Control (MAC) addresses of the NICs.
Expand All @@ -69,7 +70,7 @@ The following attributes are exported:
* `nics` - Information about one or more NICs.
* `account_id` - The account ID of the owner of the NIC.
* `description` - The description of the NIC.
* `is_source_dest_checked` - (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net.
* `is_source_dest_checked` - (Net only) If true, the source/destination check is enabled. If false, it is disabled.
* `link_nic` - Information about the NIC attachment.
* `delete_on_vm_deletion` - If true, the NIC is deleted when the VM is terminated.
* `device_number` - The device index for the NIC attachment (between `1` and `7`, both included).
Expand Down
Loading

0 comments on commit 670eed2

Please sign in to comment.