Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kindermoumoute committed Dec 3, 2019
1 parent 113c533 commit 46dea6c
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 1 deletion.
2 changes: 1 addition & 1 deletion website/docs/d/instance_security_group.html.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: "scaleway"
page_title: "Scaleway: scaleway_security_group"
page_title: "Scaleway: scaleway_instance_security_group"
description: |-
Gets information about a Security Group.
---
Expand Down
82 changes: 82 additions & 0 deletions website/docs/d/instance_server.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
layout: "scaleway"
page_title: "Scaleway: scaleway_instance_server"
description: |-
Gets information about an Instance Server.
---

# scaleway_instance_server

Gets information about an instance server.

## Example Usage

```hcl
// Get info by server name
data "scaleway_instance_server" "my_key" {
name = "my-server-name"
}
// Get info by server id
data "scaleway_instance_server" "my_key" {
server_id = "11111111-1111-1111-1111-111111111111"
}
```

## Argument Reference

- `name` - (Optional) The server name. Only one of `name` and `server_id` should be specified.

- `server_id` - (Optional) The server id. Only one of `name` and `server_id` should be specified.

- `zone` - (Defaults to [provider](../index.html#zone) `zone`) The [zone](../guides/regions_and_zones.html#zones) in which the server should be created.

- `organization_id` - (Defaults to [provider](../index.html#organization_id) `organization_id`) The ID of the organization the server is associated with.

## Attributes Reference

In addition to all above arguments, the following attributes are exported:

- `id` - The ID of the server.

- `tags` - The tags associated with the server.

- `security_group_id` - The [security group](https://developers.scaleway.com/en/products/instance/api/#security-groups-8d7f89) the server is attached to.

- `placement_group_id` - The [placement group](https://developers.scaleway.com/en/products/instance/api/#placement-groups-d8f653) the server is attached to.

- `root_volume` - Root [volume](https://developers.scaleway.com/en/products/instance/api/#volumes-7e8a39) attached to the server on creation.
- `size_in_gb` - Size of the root volume in gigabytes.
- `delete_on_termination` - Forces deletion of the root volume on instance termination.

- `additional_volume_ids` - The [additional volumes](https://developers.scaleway.com/en/products/instance/api/#volumes-7e8a39)
attached to the server.

- `enable_ipv6` - Determines if IPv6 is enabled for the server.

- `disable_dynamic_ip` - Disable dynamic IP on the server.

- `state` - The state of the server. Possible values are: `started`, `stopped` or `standby`.

- `cloud_init` - The cloud init script associated with this server. Updates to this field will trigger a stop/start of the server.

- `user_data` - The user data associated with the server.

- `key` - The user data key. The `cloud-init` key is reserved, please use `cloud_init` attribute instead.

- `value` - The user data content.

- `placement_group_policy_respected` - True when the placement group policy is respected.

- `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.

- `ipv6_address` - The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )

- `ipv6_gateway` - The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )

- `ipv6_prefix_length` - The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )
3 changes: 3 additions & 0 deletions website/scaleway.erb
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@
<li>
<a href="#">Instance Data Sources</a>
<ul class="nav nav-visible">
<li>
<a href="/docs/providers/scaleway/d/instance_server.html">scaleway_instance_server</a>
</li>
<li>
<a href="/docs/providers/scaleway/d/bootscript.html">scaleway_bootscript</a>
</li>
Expand Down

0 comments on commit 46dea6c

Please sign in to comment.