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

Documentation 0.11.0 #417

Merged
merged 1 commit into from
Feb 13, 2024
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions docs/resources/vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ resource "outscale_vm" "vm04" {
image_id = var.image_id
vm_type = "c4.large"
keypair_name = var.keypair_name
nics {
primary_nic {
nic_id = outscale_nic.nic01.nic_id
device_number = "0"
}
Expand Down Expand Up @@ -192,20 +192,33 @@ For more information about volume types, see [About Volumes > Volume Types and I
* `image_id` - (Required) The ID of the OMI used to create the VM. You can find the list of OMIs by calling the [ReadImages](https://docs.outscale.com/api#readimages) method.
* `keypair_name` - (Optional) The name of the keypair.
* `nested_virtualization` - (Optional) (dedicated tenancy only) If true, nested virtualization is enabled. If false, it is disabled.
* `nics` - (Optional) One or more NICs. If you specify this parameter, you must not specify the `subnet_id` and `subregion_name` parameters. You also must define one NIC as the primary network interface of the VM with `0` as its device number.
* `nics` - (Optional) One or more NICs. If you specify this parameter, you must not specify the `subnet_id` and `subregion_name` parameters. To define a NIC as the primary network interface of the VM, use the `primary_nic` argument.
* `delete_on_vm_deletion` - (Optional) If true, the NIC is deleted when the VM is terminated. You can specify this parameter only for a new NIC. To modify this value for an existing NIC, see [UpdateNic](https://docs.outscale.com/api#updatenic).
* `description` - (Optional) The description of the NIC, if you are creating a NIC when creating the VM.
* `device_number` - (Optional) The index of the VM device for the NIC attachment (between `0` and `7`, both included). This parameter is required if you create a NIC when creating the VM.
* `device_number` - (Optional) The index of the VM device for the NIC attachment (between `1` and `7`, both included). This parameter is required if you create a NIC when creating the VM.
* `nic_id` - (Optional) The ID of the NIC, if you are attaching an existing NIC when creating a VM.
* `private_ips` - (Optional) One or more private IPs to assign to the NIC, if you create a NIC when creating a VM. Only one private IP can be the primary private IP.
* `is_primary` - (Optional) If true, the IP is the primary private IP of the NIC.
* `private_ip` - (Optional) The private IP of the NIC.
* `secondary_private_ip_count` - (Optional) The number of secondary private IPs, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP in the `private_ips` parameter.
* `security_group_ids` - (Optional) One or more IDs of security groups for the NIC, if you create a NIC when creating a VM.
* `subnet_id` - (Optional) The ID of the Subnet for the NIC, if you create a NIC when creating a VM. This parameter is required if you create a NIC when creating the VM.

* `performance` - (Optional) The performance of the VM (`medium` | `high` | `highest`). Updating this parameter will trigger a stop/start of the VM.
* `placement_subregion_name` - (Optional) The name of the Subregion where the VM is placed.
* `placement_tenancy` - (Optional) The tenancy of the VM (`default` | `dedicated`).
* `primary_nic` - (Optional) The primary network interface of the VM.
* `delete_on_vm_deletion` - (Optional) If true, the NIC is deleted when the VM is terminated. You can specify this parameter only for a new NIC. To modify this value for an existing NIC, see [UpdateNic](https://docs.outscale.com/api#updatenic).
* `description` - (Optional) The description of the NIC, if you are creating a NIC when creating the VM.
* `device_number` - (Optional) The index of the VM device for the NIC attachment (must be `0`). This parameter is required if you create a NIC when creating the VM.
* `nic_id` - (Optional) The ID of the NIC, if you are attaching an existing NIC when creating a VM.
* `private_ips` - (Optional) One or more private IPs to assign to the NIC, if you create a NIC when creating a VM. Only one private IP can be the primary private IP.
* `is_primary` - (Optional) If true, the IP is the primary private IP of the NIC.
* `private_ip` - (Optional) The private IP of the NIC.
* `secondary_private_ip_count` - (Optional) The number of secondary private IPs, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP in the `private_ips` parameter.
* `security_group_ids` - (Optional) One or more IDs of security groups for the NIC, if you create a NIC when creating a VM.
* `subnet_id` - (Optional) The ID of the Subnet for the NIC, if you create a NIC when creating a VM. This parameter is required if you create a NIC when creating the VM.

* `private_ips` - (Optional) One or more private IPs of the VM.
* `security_group_ids` - (Optional) One or more IDs of security group for the VMs.
* `security_group_names` - (Optional) One or more names of security groups for the VMs.
Expand Down
13 changes: 13 additions & 0 deletions docs/resources/volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ For more information on this resource actions, see the [API documentation](https

## Example Usage

### Creating an io1 volume

```hcl
resource "outscale_volume" "volume01" {
subregion_name = "${var.region}a"
Expand All @@ -24,6 +26,16 @@ resource "outscale_volume" "volume01" {
}
```

### Creating a snapshot before volume deletion

```hcl
resource "outscale_volume" "volume01" {
termination_snapshot_name = "deleting_volume_snap"
subregion_name = "${var.region}a"
size = 40
}
``````

## Argument Reference

The following arguments are supported:
Expand All @@ -35,6 +47,7 @@ The following arguments are supported:
* `tags` - (Optional) A tag to add to this resource. You can specify this argument several times.
* `key` - (Required) The key of the tag, with a minimum of 1 character.
* `value` - (Required) The value of the tag, between 0 and 255 characters.
* `termination_snapshot_name` - (Optional) Whether you want to create a snapshot before the volume deletion.
* `volume_type` - (Optional) The type of volume you want to create (`io1` \| `gp2` \| `standard`). If not specified, 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).

Expand Down
2 changes: 1 addition & 1 deletion scripts/docs/doc-terraform-template
Loading