Skip to content

Commit

Permalink
Release Documentation 0.12.0
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 Apr 5, 2024
1 parent d4b471e commit a2e6d50
Show file tree
Hide file tree
Showing 63 changed files with 419 additions and 95 deletions.
3 changes: 2 additions & 1 deletion docs/data-sources/api_access_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,5 @@ No argument is supported.
The following attributes are exported:

* `max_access_key_expiration_seconds` - The maximum possible lifetime for your access keys, in seconds. If `0`, your access keys can have unlimited lifetimes.
* `require_trusted_env` - If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see the `ApiKeyAuth` authentication scheme in the [Authentication](https://docs.outscale.com/api#authentication) section.
* `require_trusted_env` - If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html).<br />
If this is enabled, it is required that you and all your users log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication).
3 changes: 3 additions & 0 deletions docs/data-sources/dhcp_option.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ The following arguments are supported:
* `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 combinations of the tags associated with the DHCP options sets, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.

## Attribute Reference

Expand All @@ -48,6 +50,7 @@ The following attributes are exported:
* `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.
* `next_page_token` - The token to request the next page of results. Each token refers to a specific page.
* `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
3 changes: 3 additions & 0 deletions docs/data-sources/dhcp_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ The following arguments are supported:
* `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 combinations of the tags associated with the DHCP options sets, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.

## Attribute Reference

Expand All @@ -57,3 +59,4 @@ The following attributes are exported:
* `tags` - One or more tags associated with the DHCP options set.
* `key` - The key of the tag, with a minimum of 1 character.
* `value` - The value of the tag, between 0 and 255 characters.
* `next_page_token` - The token to request the next page of results. Each token refers to a specific page.
12 changes: 8 additions & 4 deletions docs/data-sources/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,24 +42,27 @@ The following arguments are supported:
* `hypervisors` - (Optional) The hypervisor type of the OMI (always `xen`).
* `image_ids` - (Optional) The IDs of the OMIs.
* `image_names` - (Optional) The names of the OMIs, provided when they were created.
* `permissions_to_launch_account_ids` - (Optional) The account IDs of the users who have launch permissions for the OMIs.
* `permissions_to_launch_account_ids` - (Optional) The account IDs which have launch permissions for the OMIs.
* `permissions_to_launch_global_permission` - (Optional) If true, lists all public OMIs. If false, lists all private OMIs.
* `product_code_names` - (Optional) The names of the product codes associated with the OMI.
* `product_codes` - (Optional) The product codes associated with the OMI.
* `root_device_names` - (Optional) The name of the root device. This value must be /dev/sda1.
* `root_device_types` - (Optional) The types of root device used by the OMIs (always `bsu`).
* `root_device_types` - (Optional) The types of root device used by the OMIs (`bsu` or `ebs`).
* `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 combinations of the tags associated with the OMIs, in the following format: `TAGKEY=TAGVALUE`.
* `virtualization_types` - (Optional) The virtualization types (always `hvm`).
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.

## Attribute Reference

The following attributes are exported:

* `account_alias` - The account alias of the owner of the OMI.
* `account_id` - The account ID of the owner of the OMI.
* `architecture` - The architecture of the OMI (by default, `i386`).
* `architecture` - The architecture of the OMI.
* `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.
Expand All @@ -74,10 +77,11 @@ For more information about volume types, see [About Volumes > Volume Types and I
* `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.
* `description` - The description of the OMI.
* `file_location` - The location of the bucket where the OMI files are stored.
* `file_location` - The location from which the OMI files were created.
* `image_id` - The ID of the OMI.
* `image_name` - The name of the OMI.
* `image_type` - The type of the OMI.
* `next_page_token` - The token to request the next page of results. Each token refers to a specific page.
* `permissions_to_launch` - Permissions for the resource.
* `account_ids` - One or more account IDs that the permission is associated with.
* `global_permission` - A global permission for all accounts.<br />
Expand Down
12 changes: 8 additions & 4 deletions docs/data-sources/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,19 @@ The following arguments are supported:
* `hypervisors` - (Optional) The hypervisor type of the OMI (always `xen`).
* `image_ids` - (Optional) The IDs of the OMIs.
* `image_names` - (Optional) The names of the OMIs, provided when they were created.
* `permissions_to_launch_account_ids` - (Optional) The account IDs of the users who have launch permissions for the OMIs.
* `permissions_to_launch_account_ids` - (Optional) The account IDs which have launch permissions for the OMIs.
* `permissions_to_launch_global_permission` - (Optional) If true, lists all public OMIs. If false, lists all private OMIs.
* `product_code_names` - (Optional) The names of the product codes associated with the OMI.
* `product_codes` - (Optional) The product codes associated with the OMI.
* `root_device_names` - (Optional) The name of the root device. This value must be /dev/sda1.
* `root_device_types` - (Optional) The types of root device used by the OMIs (always `bsu`).
* `root_device_types` - (Optional) The types of root device used by the OMIs (`bsu` or `ebs`).
* `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 combinations of the tags associated with the OMIs, in the following format: `TAGKEY=TAGVALUE`.
* `virtualization_types` - (Optional) The virtualization types (always `hvm`).
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.

## Attribute Reference

Expand All @@ -64,7 +67,7 @@ The following attributes are exported:
* `images` - Information about one or more OMIs.
* `account_alias` - The account alias of the owner of the OMI.
* `account_id` - The account ID of the owner of the OMI.
* `architecture` - The architecture of the OMI (by default, `i386`).
* `architecture` - The architecture of the OMI.
* `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.
Expand All @@ -79,7 +82,7 @@ For more information about volume types, see [About Volumes > Volume Types and I
* `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.
* `description` - The description of the OMI.
* `file_location` - The location of the bucket where the OMI files are stored.
* `file_location` - The location from which the OMI files were created.
* `image_id` - The ID of the OMI.
* `image_name` - The name of the OMI.
* `image_type` - The type of the OMI.
Expand All @@ -98,3 +101,4 @@ For more information about volume types, see [About Volumes > Volume Types and I
* `tags` - One or more tags associated with the OMI.
* `key` - The key of the tag, with a minimum of 1 character.
* `value` - The value of the tag, between 0 and 255 characters.
* `next_page_token` - The token to request the next page of results. Each token refers to a specific page.
2 changes: 1 addition & 1 deletion docs/data-sources/internet_service.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:
* `internet_service_ids` - (Optional) The IDs of the Internet services.
* `link_net_ids` - (Optional) The IDs of the Nets the Internet services are attached to.
* `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).
* `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 Net).
* `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 combinations of the tags associated with the Internet services, in the following format: `TAGKEY=TAGVALUE`.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/internet_services.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:
* `internet_service_ids` - (Optional) The IDs of the Internet services.
* `link_net_ids` - (Optional) The IDs of the Nets the Internet services are attached to.
* `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).
* `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 Net).
* `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 combinations of the tags associated with the Internet services, in the following format: `TAGKEY=TAGVALUE`.
Expand Down
2 changes: 2 additions & 0 deletions docs/data-sources/keypair.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,12 @@ 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:
* `keypair_fingerprints` - (Optional) The fingerprints of the keypairs.
* `keypair_names` - (Optional) The names of the keypairs.
* `keypair_types` - (Optional) The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).

## Attribute Reference

The following attributes are exported:

* `keypair_fingerprint` - The MD5 public key fingerprint as specified in section 4 of RFC 4716.
* `keypair_name` - The name of the keypair.
* `keypair_type` - The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).
2 changes: 2 additions & 0 deletions docs/data-sources/keypairs.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +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:
* `keypair_fingerprints` - (Optional) The fingerprints of the keypairs.
* `keypair_names` - (Optional) The names of the keypairs.
* `keypair_types` - (Optional) The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).

## Attribute Reference

Expand All @@ -39,3 +40,4 @@ The following attributes are exported:
* `keypairs` - Information about one or more keypairs.
* `keypair_fingerprint` - The MD5 public key fingerprint as specified in section 4 of RFC 4716.
* `keypair_name` - The name of the keypair.
* `keypair_type` - The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).
8 changes: 4 additions & 4 deletions docs/data-sources/load_balancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ The following attributes are exported:
* `backend_vm_ids` - One or more IDs of back-end 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 pings (between `5` and `600` both included).
* `healthy_threshold` - The number of consecutive successful pings before considering the VM as healthy (between `2` and `10` both included).
* `path` - If you use the HTTP or HTTPS protocols, the ping path.
* `check_interval` - The number of seconds between two requests (between `5` and `600` both included).
* `healthy_threshold` - The number of consecutive successful requests before considering the VM as healthy (between `2` and `10` both included).
* `path` - If you use the HTTP or HTTPS protocols, the request URL path.
* `port` - The port number (between `1` and `65535`, both included).
* `protocol` - The protocol for the URL of the VM (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
* `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 pings before considering the VM as unhealthy (between `2` and `10` 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`).
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/load_balancers.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ The following attributes are exported:
* `backend_vm_ids` - One or more IDs of back-end 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 pings (between `5` and `600` both included).
* `healthy_threshold` - The number of consecutive successful pings before considering the VM as healthy (between `2` and `10` both included).
* `path` - If you use the HTTP or HTTPS protocols, the ping path.
* `check_interval` - The number of seconds between two requests (between `5` and `600` both included).
* `healthy_threshold` - The number of consecutive successful requests before considering the VM as healthy (between `2` and `10` both included).
* `path` - If you use the HTTP or HTTPS protocols, the request URL path.
* `port` - The port number (between `1` and `65535`, both included).
* `protocol` - The protocol for the URL of the VM (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
* `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 pings before considering the VM as unhealthy (between `2` and `10` 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`).
Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/nat_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,16 @@ The following arguments are supported:
* `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 combinations of the tags associated with the NAT services, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.

## Attribute Reference

The following attributes are exported:

* `nat_service_id` - The ID of the NAT service.
* `net_id` - The ID of the Net in which the NAT service is.
* `next_page_token` - The token to request the next page of results. Each token refers to a specific page.
* `public_ips` - Information about the public IP or IPs associated with the NAT service.
* `public_ip` - The public IP associated with the NAT service.
* `public_ip_id` - The allocation ID of the public IP associated with the NAT service.
Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/nat_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ The following arguments are supported:
* `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 combinations of the tags associated with the NAT services, in the following format: `TAGKEY=TAGVALUE`.
* `next_page_token` - (Optional) The token to request the next page of results. Each token refers to a specific page.
* `results_per_page` - (Optional) The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`.

## Attribute Reference

Expand All @@ -56,3 +58,4 @@ The following attributes are exported:
* `tags` - One or more tags associated with the NAT service.
* `key` - The key of the tag, with a minimum of 1 character.
* `value` - The value of the tag, between 0 and 255 characters.
* `next_page_token` - The token to request the next page of results. Each token refers to a specific page.
Loading

0 comments on commit a2e6d50

Please sign in to comment.