resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed some formatting issues and language with the Softlayer docs (#10732)

This commit is contained in:
James Turnbull 2016-12-14 11:25:57 -05:00 committed by Paul Stack
parent 70b1f4e708
commit 572796d002
3 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
website/source/docs/providers/softlayer/index.html.markdown
View File

@ -12,20 +12,19 @@ The SoftLayer provider is used to manage SoftLayer resources.
Use the navigation to the left to read about the available resources.
<div class="alert alert-block alert-info">
<strong>Note:</strong> The SoftLayer provider is new as of Terraform 0.X.
-> **Note:** The SoftLayer provider is new as of Terraform 0.6.16.
It is ready to be used but many features are still being added. If there
is a SoftLayer feature missing, please report it in the GitHub repo.
</div>
## Example Usage
Here is an example that will setup the following:
+ An SSH key resource.
+ A virtual server resource that uses an existing SSH key.
+ A virtual server resource using an existing SSH key and a Terraform managed SSH key (created as "test_key_1" in the example below).
+ A virtual server resource using an existing SSH key and a Terraform managed SSH key (created as `test_key_1` in the example below).
(create this as sl.tf and run terraform commands from this directory):
Add the below to a file called `sl.tf` and run the `terraform` command from the same directory:
```hcl
provider "softlayer" {

12
website/source/docs/providers/softlayer/r/ssh_key.html.markdown
View File

@ -25,15 +25,15 @@ resource "softlayer_ssh_key" "test_ssh_key" {
The following arguments are supported:
* `name` - (Required) A descriptive name used to identify a ssh key.
* `public_key` - (Required) The public ssh key.
* `notes` - (Optional) A small note about a ssh key to use at your discretion.
* `name` - (Required) A descriptive name used to identify an SSH key.
* `public_key` - (Required) The public SSH key.
* `notes` - (Optional) A small note about an SSH key to use at your discretion.
Fields `name` and `notes` are editable.
The `name` and `notes` fields are editable.
## Attributes Reference
The following attributes are exported:
* `id` - id of the new ssh key
* `fingerprint` - sequence of bytes to authenticate or lookup a longer ssh key.
* `id` - The ID of the new SSH key
* `fingerprint` - sequence of bytes to authenticate or lookup a longer SSH key.

33
website/source/docs/providers/softlayer/r/virtual_guest.html.markdown
View File

@ -13,8 +13,9 @@ and deleted. For additional details please refer to [API documentation](http://s
## Example Usage
```
# Create a new virtual guest using image "Debian"
Create a new virtual guest using the "Debian" image.
```hcl
resource "softlayer_virtual_guest" "twc_terraform_sample" {
name = "twc-terraform-sample-name"
domain = "bar.example.com"
@ -34,8 +35,9 @@ resource "softlayer_virtual_guest" "twc_terraform_sample" {
}
```
```
# Create a new virtual guest using block device template
Create a new virtual guest using block device template.
```hcl
resource "softlayer_virtual_guest" "terraform-sample-BDTGroup" {
name = "terraform-sample-blockDeviceTemplateGroup"
domain = "bar.example.com"
@ -69,10 +71,10 @@ The following arguments are supported:
* Specifies which datacenter the instance is to be provisioned in.
* **Required**
* `hourly_billing` | *boolean*
* Specifies the billing type for the instance. When true the computing instance will be billed on hourly usage, otherwise it will be billed on a monthly basis.
* Specifies the billing type for the instance. When `true`, the computing instance will be billed on hourly usage, otherwise it will be billed on a monthly basis.
* **Required**
* `local_disk` | *boolean*
* Specifies the disk type for the instance. When true the disks for the computing instance will be provisioned on the host which it runs, otherwise SAN disks will be provisioned.
* Specifies the disk type for the instance. When `true`, the disks for the computing instance will be provisioned on the host which it runs, otherwise SAN disks will be provisioned.
* **Required**
* `dedicated_acct_host_only` | *boolean*
* Specifies whether or not the instance must only run on hosts with instances from the same account
@ -80,10 +82,10 @@ The following arguments are supported:
* *Optional*
* `image` | *string*
* An identifier for the operating system to provision the computing instance with.
* **Conditionally required** - Disallowed when blockDeviceTemplateGroup.globalIdentifier is provided, as the template will specify the operating system.
* **Conditionally required** - Disallowed when `blockDeviceTemplateGroup.globalIdentifier` is provided, as the template will specify the operating system.
* `block_device_template_group_gid` | *string*
* A global identifier for the template to be used to provision the computing instance.
* **Conditionally required** - Disallowed when operatingSystemReferenceCode is provided, as the template will specify the operating system.
* **Conditionally required** - Disallowed when `operatingSystemReferenceCode` is provided, as the template will specify the operating system.
* `public_network_speed` | *int*
* Specifies the connection speed for the instance's network components.
* *Default*: 10
@ -93,11 +95,11 @@ The following arguments are supported:
* *Default*: False
* *Optional*
* `frontend_vlan_id` | *int*
* Specifies the network vlan which is to be used for the frontend interface of the computing instance.
* Specifies the network VLAN which is to be used for the front end interface of the computing instance.
* *Default*: nil
* *Optional*
* `backend_vlan_id` | *int*
* Specifies the network vlan which is to be used for the backend interface of the computing instance.
* Specifies the network VLAN which is to be used for the back end interface of the computing instance.
* *Default*: nil
* *Optional*
* `disks` | *array*
@ -113,22 +115,21 @@ The following arguments are supported:
* *Default*: nil
* *Optional*
* `ipv4_address` | *string*
* Uses editObject call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
* Uses `editObject` call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
* *Default*: nil
* *Optional*
* `ipv4_address_private` | *string*
* Uses editObject call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
* Uses `editObject` call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
* *Default*: nil
* *Optional*
* `post_install_script_uri` | *string*
* As defined in the [SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions).
* *Default*: nil
* *Optional*
## Attributes Reference
The following attributes are exported:
The following attributes are exported:
* `id` - id of the virtual guest.
* `id` - The ID of the virtual guest.