Merge pull request #4433 from betawaffle/packet-docs

Clarify the docs for Packet a bit.
This commit is contained in:
James Nugent 2015-12-23 11:15:20 -05:00
commit 6fb4c6f91b
4 changed files with 18 additions and 19 deletions

View File

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

View File

@ -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
* `project_id`- The ID of the project the device belongs to
* `facility` - The facility the device is in
* `plan` - The config type of the device
* `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

View File

@ -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

View File

@ -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