From f353f5c62d780fd2224f651d691d6e4ab6b6dca1 Mon Sep 17 00:00:00 2001 From: Andrew Hodges Date: Wed, 16 Dec 2015 09:57:58 -0500 Subject: [PATCH] Clarify the docs for Packet a bit. --- .../docs/providers/packet/index.html.markdown | 7 +++---- .../docs/providers/packet/r/device.html.markdown | 16 ++++++++-------- .../providers/packet/r/project.html.markdown | 10 +++++----- .../providers/packet/r/ssh_key.html.markdown | 4 ++-- 4 files changed, 18 insertions(+), 19 deletions(-) diff --git a/website/source/docs/providers/packet/index.html.markdown b/website/source/docs/providers/packet/index.html.markdown index bbe9f5d1e..5898c3c9a 100644 --- a/website/source/docs/providers/packet/index.html.markdown +++ b/website/source/docs/providers/packet/index.html.markdown @@ -22,9 +22,9 @@ provider "packet" { } # Create a project -resource "packet_project" "tf_project_1" { +resource "packet_project" "cool_project" { name = "My First Terraform Project" - payment_method = "PAYMENT_METHOD_ID" + payment_method = "PAYMENT_METHOD_ID" # Only required for a non-default payment method } # Create a device and add it to tf_project_1 @@ -34,7 +34,7 @@ resource "packet_device" "web1" { facility = "ewr1" operating_system = "coreos_stable" billing_cycle = "hourly" - project_id = "${packet_project.tf_project_1.id}" + project_id = "${packet_project.cool_project.id}" } ``` @@ -44,4 +44,3 @@ The following arguments are supported: * `auth_token` - (Required) This is your Packet API Auth token. This can also be specified with the `PACKET_AUTH_TOKEN` shell environment variable. - diff --git a/website/source/docs/providers/packet/r/device.html.markdown b/website/source/docs/providers/packet/r/device.html.markdown index 6d57dcbb5..75a1f501d 100644 --- a/website/source/docs/providers/packet/r/device.html.markdown +++ b/website/source/docs/providers/packet/r/device.html.markdown @@ -14,14 +14,14 @@ modify, and delete devices. ## Example Usage ``` -# Create a device and add it to tf_project_1 +# Create a device and add it to cool_project resource "packet_device" "web1" { hostname = "tf.coreos2" plan = "baremetal_1" facility = "ewr1" operating_system = "coreos_stable" billing_cycle = "hourly" - project_id = "${packet_project.tf_project_1.id}" + project_id = "${packet_project.cool_project.id}" } ``` @@ -33,7 +33,7 @@ The following arguments are supported: * `project_id` - (Required) The id of the project in which to create the device * `operating_system` - (Required) The operating system slug * `facility` - (Required) The facility in which to create the device -* `plan` - (Required) The config type slug +* `plan` - (Required) The hardware config slug * `billing_cycle` - (Required) monthly or hourly * `user_data` (Optional) - A string of the desired User Data for the device. @@ -43,13 +43,13 @@ The following attributes are exported: * `id` - The ID of the device * `hostname`- The hostname of the device -* `project_id`- The Id of the project the device belonds to -* `facility` - The facility the device is in -* `plan` - The config type of the device +* `project_id`- The ID of the project the device belongs to +* `facility` - The facility the device is in +* `plan` - The hardware config of the device * `network` - The private and public v4 and v6 IPs assigned to the device -* `locked` - Is the device locked +* `locked` - Whether the device is locked * `billing_cycle` - The billing cycle of the device (monthly or hourly) * `operating_system` - The operating system running on the device * `status` - The status of the device * `created` - The timestamp for when the device was created -* `updated` - The timestamp for the last time the device was udpated +* `updated` - The timestamp for the last time the device was updated diff --git a/website/source/docs/providers/packet/r/project.html.markdown b/website/source/docs/providers/packet/r/project.html.markdown index c34b49c20..9b92e1c89 100644 --- a/website/source/docs/providers/packet/r/project.html.markdown +++ b/website/source/docs/providers/packet/r/project.html.markdown @@ -25,16 +25,16 @@ resource "packet_project" "tf_project_1" { The following arguments are supported: -* `name` - (Required) The name of the Project in Packet.net -* `payment_method` - (Required) The id of the payment method on file to use for services created -on this project. +* `name` - (Required) The name of the Project on Packet.net +* `payment_method` - (Optional) The unique ID of the payment method on file to use for services created +in this project. If not given, the project will use the default payment method for your user. ## Attributes Reference The following attributes are exported: * `id` - The unique ID of the project -* `payment_method` - The id of the payment method on file to use for services created -on this project. +* `payment_method` - The unique ID of the payment method on file to use for services created +in this project. * `created` - The timestamp for when the Project was created * `updated` - The timestamp for the last time the Project was updated diff --git a/website/source/docs/providers/packet/r/ssh_key.html.markdown b/website/source/docs/providers/packet/r/ssh_key.html.markdown index cb27aaa77..f3ca1e3c6 100644 --- a/website/source/docs/providers/packet/r/ssh_key.html.markdown +++ b/website/source/docs/providers/packet/r/ssh_key.html.markdown @@ -9,7 +9,7 @@ description: |- # packet\_ssh_key Provides a Packet SSH key resource to allow you manage SSH -keys on your account. All ssh keys on your account are loaded on +keys on your account. All SSH keys on your account are loaded on all new devices, they do not have to be explicitly declared on device creation. @@ -40,4 +40,4 @@ The following attributes are exported: * `public_key` - The text of the public key * `fingerprint` - The fingerprint of the SSH key * `created` - The timestamp for when the SSH key was created -* `updated` - The timestamp for the last time the SSH key was udpated +* `updated` - The timestamp for the last time the SSH key was updated