doc: scaleway_compute_instance_server

website/docs/r/compute_instance_server.html.markdown

@@ -0,0 +1,180 @@
+---
+layout: "scaleway"
+page_title: "Scaleway: scaleway_compute_instance_server"
+sidebar_current: "docs-scaleway-resource-compute-instance-server"
+description: |-
+  Manages Scaleway Compute Instance servers.
+---
+
+# scaleway_compute_instance_server
+
+Creates and manages Scaleway Compute Instance servers. For more information, see [the documentation](https://developers.scaleway.com/en/products/instance/api/#servers-8bf7d7).
+
+## Examples
+
+### Basic
+
+```hcl
+resource "scaleway_compute_instance_ip" "public_ip" {
+  server_id = "${scaleway_compute_instance_server.web.id}"
+}
+
+resource "scaleway_compute_instance_server" "web" {
+  type = "DEV1-S"
+  image_id = "f974feac-abae-4365-b988-8ec7d1cec10d"
+}
+```
+
+### With additional volumes, public IP and tags
+
+```hcl
+resource "scaleway_compute_instance_volume" "data" {
+  size_in_gb = 100
+}
+
+resource "scaleway_compute_instance_server" "web" {
+  type = "DEV1-L"
+  image_id = "f974feac-abae-4365-b988-8ec7d1cec10d"
+
+  tags = [ "hello", "public" ]
+
+  root_volume {
+    delete_on_termination = false
+  }
+
+  additional_volume_ids = [ "${scaleway_compute_instance_volume.data.id}" ]
+}
+```
+
+### With security group
+
+```hcl
+resource "scaleway_compute_instance_security_group" "www" {
+  inbound_default_policy = "drop"
+  outbound_default_policy = "accept"
+
+  inbound {
+    action = "accept"
+    port = "22"
+    ip = "212.47.225.64"
+  }
+
+  inbound {
+    action = "accept"
+    port = "80"
+  }
+
+  inbound {
+    action = "accept"
+    port = "443"
+  }
+
+  outbound {
+    action = "drop"
+    ip_range = "10.20.0.0/24"
+  }
+}
+
+resource "scaleway_compute_instance_server" "web" {
+  type = "DEV1-S"
+  image_id = "f974feac-abae-4365-b988-8ec7d1cec10d"
+
+  security_group_id= "${scaleway_compute_instance_security_group.www.id}"
+}
+```
+
+### With user data and could-init
+
+```hcl
+resource "scaleway_compute_instance_server" "web" {
+  type = "DEV1-L"
+  image_id = "f974feac-abae-4365-b988-8ec7d1cec10d"
+
+  tags = [ "web", "public" ]
+
+  user_data {
+    key = "plop"
+    value = "world"
+  }
+
+  user_data {
+    key = "xavier"
+    value = "niel"
+  }
+
+  cloud_init = file("${path.module}/cloud-init.yml")
+}
+```
+
+## Arguments Reference
+
+The following arguments are supported:
+
+- `type` - (Required) The commercial type of the server.
+You find all the available types on the [pricing page](https://www.scaleway.com/en/pricing/).
+Updates to this field will recreate a new resource.
+
+[//]: # (TODO: Improve me)
+
+- `image_id` - (Required) The base image of the server. You can use [this endpoint](https://api-marketplace.scaleway.com/images?page=1&per_page=100)
+to find the right local image `ID` for a given image `name` and a given `commercial_type`.
+
+[//]: # (TODO: Improve me)
+
+- `name` - (Optional) The name of the server.
+
+- `tags` - (Optional) The tags associated with the server.
+
+- `security_group_id` - (Optional) The [security group](https://developers.scaleway.com/en/products/instance/api/#security-groups-8d7f89) the server is attached to.
+
+- `root_volume` - (Optional) Root [volume](https://developers.scaleway.com/en/products/instance/api/#volumes-7e8a39) attached to the server on creation.
+   - `size_in_gb` - (Required) Size of the root volume in gigabytes.
+   To find the right size use [this endpoint](https://api.scaleway.com/instance/v1/zones/fr-par-1/products/servers) and
+   check the `volumes_constraint.{min|max}_size` (in bytes) for your `commercial_type`.
+   Updates to this field will recreate a new resource.
+   - `delete_on_termination` - (Defaults to `true`) Forces deletion of the root volume on instance termination.
+
+~> **Important:** Updates to `root_volume.size_in_gb` will trigger a stop/start of the server.
+
+- `additional_volume_ids` - (Optional) The [additional volumes](https://developers.scaleway.com/en/products/instance/api/#volumes-7e8a39)
+attached to the server. Updates to this field will trigger a stop/start of the server.
+
+~> **Important:** If this field contains local volumes, updates will trigger a stop/start of the server.
+
+- `enable_ipv6` - (Defaults to `false`) Determines if IPv6 is enabled for the server.
+
+- `state` - (Defaults to `started`) The state of the server. Possible values are: `started`, `stopped` or `standby`.
+
+- `cloud_init` - (Optional) The cloud init script associated with this server. Updates to this field will trigger a stop/start of the server.
+
+- `user_data` - (Optional) The user data associated with the server.
+
+  - `key` - (Required) The user data key. The `cloud-init` key is reserved, please use `cloud_init` attribute instead.
+
+  - `value` - (Required) The user data content. It could be a string or a file content using [file](https://www.terraform.io/docs/configuration/functions/file.html) or [filebase64](https://www.terraform.io/docs/configuration/functions/filebase64.html) for example.
+
+- `zone` - (Default: provider `default_zone`) The [zone](https://developers.scaleway.com/en/quickstart/#zone-definition) in which the server should be created.
+
+[//]: # (TODO: Add a provider `default_zone` link)
+
+- `project_id` - (Default: provider `project_id`) The ID of the project the server is associated with.
+
+[//]: # (TODO: Add a provider `default_zone` link)
+
+## Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+- `id` - The ID of the server.
+- `root_volume`
+  - `volume_id` - The volume ID of the root volume of the server.
+- `private_ip` - The Scaleway internal IP address of the server.
+- `public_ip` - The public IPv4 address of the server.
+
+## Import
+
+Instance servers can be imported using the `{zone}/{id}`, e.g.
+
+```bash
+$ terraform import scaleway_compute_instance_server.web fr-par-1/11111111-1111-1111-1111-111111111111
+```

website/scaleway.erb

@@ -34,6 +34,9 @@
             <li>
               <a href="/docs/providers/scaleway/r/compute_instance_ip.html">scaleway_compute_instance_ip</a>
             </li>
+            <li>
+              <a href="/docs/providers/scaleway/r/compute_instance_server.html">scaleway_compute_instance_server</a>
+            </li>
           </ul>
         </li>