From 0ceeacaf8d77c66cda54488bf2b8f17b9e399c11 Mon Sep 17 00:00:00 2001 From: Kate Lyons Date: Fri, 2 Jun 2017 12:01:52 -0500 Subject: [PATCH 1/3] Cleaned up text for clarity. Added commands to retrieve values. --- .../ibmcloud/d/cf_account.html.markdown | 2 +- .../providers/ibmcloud/d/cf_app.html.markdown | 16 +++++++------- .../providers/ibmcloud/d/cf_org.html.markdown | 2 +- .../ibmcloud/d/cf_route.html.markdown | 8 +++---- .../d/cf_service_instance.html.markdown | 4 ++-- .../ibmcloud/d/cf_service_key.html.markdown | 4 ++-- .../ibmcloud/d/cf_service_plan.html.markdown | 4 ++-- .../ibmcloud/d/cf_space.html.markdown | 4 ++-- .../ibmcloud/d/cs_cluster.html.markdown | 6 ++--- .../d/cs_cluster_config.html.markdown | 8 +++---- .../ibmcloud/d/cs_worker.html.markdown | 6 ++--- .../d/infra_image_template.html.markdown | 2 +- .../d/infra_virtual_guest.html.markdown | 6 ++--- .../ibmcloud/d/infra_vlan.html.markdown | 2 +- .../providers/ibmcloud/index.html.markdown | 22 +++++++++---------- 15 files changed, 47 insertions(+), 49 deletions(-) diff --git a/website/source/docs/providers/ibmcloud/d/cf_account.html.markdown b/website/source/docs/providers/ibmcloud/d/cf_account.html.markdown index a31d13427b4f..d7584e62c171 100644 --- a/website/source/docs/providers/ibmcloud/d/cf_account.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cf_account.html.markdown @@ -26,7 +26,7 @@ data "ibmcloud_cf_account" "accountData" { The following arguments are supported: -* `org_guid` - (Required) The GUID of the Bluemix org. The value can be retrieved from the `ibmcloud_cf_org` data source. +* `org_guid` - (Required) The GUID of the Bluemix org. The value can be retrieved from the `ibmcloud_cf_org` data source, or by running the `bx iam orgs --guid` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). ## Attributes Reference diff --git a/website/source/docs/providers/ibmcloud/d/cf_app.html.markdown b/website/source/docs/providers/ibmcloud/d/cf_app.html.markdown index 2efdf1447be1..17f9b0035b6c 100644 --- a/website/source/docs/providers/ibmcloud/d/cf_app.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cf_app.html.markdown @@ -23,20 +23,20 @@ data "ibmcloud_cf_app" "testacc_ds_app" { The following arguments are supported: -* `name` - (Required, string) The name of the application. -* `space_guid` - (Required, string) Define space guid to which application belongs. The values can be retrieved from data source `ibmcloud_cf_space`. +* `name` - (Required, string) The name of the application. The value can be retrieved by running the `bx app list` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). +* `space_guid` - (Required, string) The GUID of the Bluemix space where the application is deployed. The value can be retrieved with the `ibmcloud_cf_space` data source, or by running the `bx iam space --guid` command in the Bluemix CLI. ## Attributes Reference The following attributes are exported: * `id` - The ID of the application. -* `memory` - Memory allocated to the application. In megabytes. +* `memory` - Memory that is allocated to the application, specified in megabytes. * `instances` - The number of instances of the application. -* `disk_quota` - The disk allocated to an instance of an application. In megabytes. -* `buildpack` - Buildpack used by the application.It can be a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack. +* `disk_quota` - The disk quota for an instance of the application, specified in megabytes. +* `buildpack` - Buildpack used by the application. It can be a) Blank to indicate auto-detection, b) A Git URL pointing to a buildpack, or c) The name of an installed buildpack. * `environment_json` - Key/value pairs of all the environment variables. Does not include any system or service variables. -* `route_guid` - The route guids which are bound to the application. -* `service_instance_guid` - The service instance guids which are bound to the application. -* `package_state` - The state of the application package whether staged, pending etc. +* `route_guid` - The route GUIDs that are bound to the application. +* `service_instance_guid` - The service instance GUIDs that are bound to the application. +* `package_state` - The state of the application package, such as staged, pending. * `state` - The state of the application. diff --git a/website/source/docs/providers/ibmcloud/d/cf_org.html.markdown b/website/source/docs/providers/ibmcloud/d/cf_org.html.markdown index b0f42c94e90b..d55e1c9a0304 100644 --- a/website/source/docs/providers/ibmcloud/d/cf_org.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cf_org.html.markdown @@ -22,7 +22,7 @@ data "ibmcloud_cf_org" "orgdata" { The following arguments are supported: -* `org` - (Required) The name of the Bluemix org. +* `org` - (Required) The name of the Bluemix org. The value can be retrieved by running the `bx iam orgs` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). ## Attributes Reference diff --git a/website/source/docs/providers/ibmcloud/d/cf_route.html.markdown b/website/source/docs/providers/ibmcloud/d/cf_route.html.markdown index f907b5646e6b..cf429c2527cc 100644 --- a/website/source/docs/providers/ibmcloud/d/cf_route.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cf_route.html.markdown @@ -25,11 +25,11 @@ data "ibmcloud_cf_route" "route" { The following arguments are supported: -* `domain_guid` - (Required, string) The GUID of the associated domain. The values can be retrieved from data source `ibmcloud_cf_shared_domain`. -* `space_guid` - (Required, string) The GUID of the space where you want to create the route. The values can be retrieved from data source `ibmcloud_cf_space`. -* `host` - (Optional, string) The host portion of the route. Required for shared-domains. +* `domain_guid` - (Required, string) The GUID of the associated domain. The values can be retrieved from the `ibmcloud_cf_shared_domain` data source. +* `space_guid` - (Required, string) The GUID of the space where you want to create the route. The values can be retrieved from the `ibmcloud_cf_space` data source, or by running the `bx iam space --guid` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). +* `host` - (Optional, string) The host portion of the route. Required for shared domains. * `port` - (Optional, int) The port of the route. Supported for domains of TCP router groups only. -* `path` - (Optional, string) The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'. +* `path` - (Optional, string) The path for a route as raw text. Paths must be between 2 and 128 characters. Paths must start with a forward slash (/). Paths must not contain a question mark (?). ## Attributes Reference diff --git a/website/source/docs/providers/ibmcloud/d/cf_service_instance.html.markdown b/website/source/docs/providers/ibmcloud/d/cf_service_instance.html.markdown index a9b62411d1cd..218e90855b86 100644 --- a/website/source/docs/providers/ibmcloud/d/cf_service_instance.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cf_service_instance.html.markdown @@ -22,7 +22,7 @@ data "ibmcloud_cf_service_instance" "serviceInstance" { The following arguments are supported: -* `name` - (Required) The name of the service instance. +* `name` - (Required) The name of the service instance. The value can be retrieved by running the `bx service list` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). ## Attributes Reference @@ -30,4 +30,4 @@ The following attributes are exported: * `id` - The unique identifier of the service instance. * `credentials` - The credentials associated with the service instance. -* `service_plan_guid` - The plan of the service offering used by this service instance +* `service_plan_guid` - The plan of the service offering used by this service instance. diff --git a/website/source/docs/providers/ibmcloud/d/cf_service_key.html.markdown b/website/source/docs/providers/ibmcloud/d/cf_service_key.html.markdown index f049abade0ac..721cb976d44b 100644 --- a/website/source/docs/providers/ibmcloud/d/cf_service_key.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cf_service_key.html.markdown @@ -23,8 +23,8 @@ data "ibmcloud_cf_service_key" "serviceKeydata" { The following arguments are supported: -* `name` - (Required) The name of the service key. -* `service_instance_name` - (Required) The name of the service instance that the service key is associated with. +* `name` - (Required) The name of the service key. The value can be retrieved by running the `bx service keys` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). +* `service_instance_name` - (Required) The name of the service instance that the service key is associated with. The value can be retrieved by running the `bx service list` command in the Bluemix CLI. ## Attributes Reference diff --git a/website/source/docs/providers/ibmcloud/d/cf_service_plan.html.markdown b/website/source/docs/providers/ibmcloud/d/cf_service_plan.html.markdown index 71672096aa0b..9e827c724722 100644 --- a/website/source/docs/providers/ibmcloud/d/cf_service_plan.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cf_service_plan.html.markdown @@ -23,8 +23,8 @@ data "ibmcloud_cf_service_plan" "service_plan" { The following arguments are supported: -* `service` - (Required, string) The name of the service offering. Use the `bluemix service offerings` command to find the name and the plan of the service that you require. Installing Bluemix cli can be found [here](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started) -* `plan` - (Required, string) The name of the plan type supported by service. Use the `bluemix service offering` command to find the name and the plan of the service that you require. +* `service` - (Required, string) The name of the service offering. You can run the `bx service offerings` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started) to find the name of the service. +* `plan` - (Required, string) The name of the plan type supported by service. You can run the `bx service offering` command in the Bluemix CLI to retrieve the plan type. ## Attributes Reference diff --git a/website/source/docs/providers/ibmcloud/d/cf_space.html.markdown b/website/source/docs/providers/ibmcloud/d/cf_space.html.markdown index 776289a5d899..8ed610dbd085 100644 --- a/website/source/docs/providers/ibmcloud/d/cf_space.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cf_space.html.markdown @@ -36,8 +36,8 @@ resource "ibmcloud_cf_service_instance" "service_instance" { The following arguments are supported: -* `org` - (Required) The name of your Bluemix org. -* `space` - (Required) The name of your space. +* `org` - (Required) The name of your Bluemix org. The value can be retrieved by running the `bx iam orgs` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). +* `space` - (Required) The name of your space. The value can be retrieved by running the `bx iam spaces` command in the Bluemix CLI. ## Attributes Reference diff --git a/website/source/docs/providers/ibmcloud/d/cs_cluster.html.markdown b/website/source/docs/providers/ibmcloud/d/cs_cluster.html.markdown index f1a0c769bfce..fee8405a0f17 100644 --- a/website/source/docs/providers/ibmcloud/d/cs_cluster.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cs_cluster.html.markdown @@ -28,9 +28,9 @@ data "ibmcloud_cs_cluster" "cluster_foo" { The following arguments are supported: * `cluster_name_id` - (Required) Name or ID of the cluster. -* `org_guid` - (Required) The GUID for the Bluemix organization that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_org` data source. -* `space_guid` - (Required) The GUID for the Bluemix space that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_space` data source. -* `account_guid` - (Required) The GUID for the Bluemix account that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_account` data source. +* `org_guid` - (Required) The GUID for the Bluemix organization that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_org` data source, or by running the `bx iam orgs --guid` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). +* `space_guid` - (Required) The GUID for the Bluemix space that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_space` data source, or by running the `bx iam space --guid` command in the Bluemix CLI. +* `account_guid` - (Required) The GUID for the Bluemix account that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_account` data source, or by running the `bx iam accounts` command in the Bluemix CLI. ## Attributes Reference diff --git a/website/source/docs/providers/ibmcloud/d/cs_cluster_config.html.markdown b/website/source/docs/providers/ibmcloud/d/cs_cluster_config.html.markdown index 6a88f73e7be7..970a7ea12aa7 100644 --- a/website/source/docs/providers/ibmcloud/d/cs_cluster_config.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cs_cluster_config.html.markdown @@ -30,9 +30,9 @@ The following arguments are supported: * `cluster_name_id` - (Required) Name or ID of the cluster. * `config_dir` - (Required) The directory where you want the cluster configuration to download. -* `org_guid` - (Required) The GUID for the Bluemix organization that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_org` data source. -* `space_guid` - (Required) The GUID for the Bluemix space that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_space` data source. -* `account_guid` - (Optional) The GUID for the Bluemix account that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_account` data source. +* `org_guid` - (Required) The GUID for the Bluemix organization that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_org` data source, or by running the `bx iam orgs --guid` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). +* `space_guid` - (Required) The GUID for the Bluemix space that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_space` data source, or by running the `bx iam space --guid` command in the Bluemix CLI. +* `account_guid` - (Optional) The GUID for the Bluemix account that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_account` data source, or by running the `bx iam accounts` command in the Bluemix CLI. ## Attributes Reference @@ -40,4 +40,4 @@ The following arguments are supported: The following attributes are exported: * `id` - The unique identifier of the Cluster config -* `config_file_path` - The path to the cluster config file. Typically the Kubernetes yml config file. +* `config_file_path` - The path to the cluster config file. Typically the Kubernetes yml config file. diff --git a/website/source/docs/providers/ibmcloud/d/cs_worker.html.markdown b/website/source/docs/providers/ibmcloud/d/cs_worker.html.markdown index e23329c78763..61edfb3a2e95 100644 --- a/website/source/docs/providers/ibmcloud/d/cs_worker.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cs_worker.html.markdown @@ -28,9 +28,9 @@ data "ibmcloud_cs_cluster" "cluster_foo" { The following arguments are supported: * `worker_id` - (Required) ID of the worker node attached to the cluster. -* `org_guid` - (Required) The GUID for the Bluemix organization that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_org` data source. -* `space_guid` - (Required) The GUID for the Bluemix space that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_space` data source. -* `account_guid` - (Required) The GUID for the Bluemix account that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_account` data source. +* `org_guid` - (Required) The GUID for the Bluemix organization that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_org` data source, or by running the `bx iam orgs --guid` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started). +* `space_guid` - (Required) The GUID for the Bluemix space that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_space` data source, or by running the `bx iam space --guid` command in the Bluemix CLI. +* `account_guid` - (Required) The GUID for the Bluemix account that the cluster is associated with. The value can be retrieved from the `ibmcloud_cf_account` data source, or by running the `bx iam accounts` command in the Bluemix CLI. ## Attributes Reference diff --git a/website/source/docs/providers/ibmcloud/d/infra_image_template.html.markdown b/website/source/docs/providers/ibmcloud/d/infra_image_template.html.markdown index 0bebc441593b..fcc51c8d5314 100644 --- a/website/source/docs/providers/ibmcloud/d/infra_image_template.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/infra_image_template.html.markdown @@ -32,7 +32,7 @@ resource "ibmcloud_infra_virtual_guest" "vm1" { The following arguments are supported: -* `name` - (Required) The name of the image template as it was defined in Bluemix Infrastructure (SoftLayer). The names can be found in the SoftLayer Customer Portal, by navigating to **Devices > Manage > Images**. +* `name` - (Required) The name of the image template as it was defined in Bluemix Infrastructure (SoftLayer). The names can be found in the [SoftLayer Customer Portal](https://control.softlayer.com), by navigating to **Devices > Manage > Images**. ## Attributes Reference diff --git a/website/source/docs/providers/ibmcloud/d/infra_virtual_guest.html.markdown b/website/source/docs/providers/ibmcloud/d/infra_virtual_guest.html.markdown index 1bb4377a7327..2e8f631417f1 100644 --- a/website/source/docs/providers/ibmcloud/d/infra_virtual_guest.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/infra_virtual_guest.html.markdown @@ -26,15 +26,15 @@ The following arguments are supported: * `hostname` - (Required) The hostname of the virtual guest. * `domain` - (Required) The domain of the virtual guest. -* `most_recent` - (Optional) True or False. If true and multiple entries are found, the most recently created virtual guest is used.If false, an error is returned. +* `most_recent` - (Optional) `True` or `False`. If `true` and multiple entries are found, the most recently created virtual guest is used. If `false`, an error is returned. ## Attributes Reference The following attributes are exported: * `id` - The ID of the virtual guest. -* `datacenter` - Datacenter in which the virtual guest is deployed. +* `datacenter` - Data center in which the virtual guest is deployed. * `cores` - Number of cpu cores. * `status` - The VSI status. * `last_known_power_state` - The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline. -* `power_state` - The current power state of a virtual guest. \ No newline at end of file +* `power_state` - The current power state of a virtual guest. diff --git a/website/source/docs/providers/ibmcloud/d/infra_vlan.html.markdown b/website/source/docs/providers/ibmcloud/d/infra_vlan.html.markdown index c14227150ba2..289b84b3af63 100644 --- a/website/source/docs/providers/ibmcloud/d/infra_vlan.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/infra_vlan.html.markdown @@ -35,7 +35,7 @@ resource "ibmcloud_infra_bare_metal" "bm1" { The following arguments are supported: -* `name` - (Required if the number nor router hostname are provided) The name of the VLAN, as it was defined in Bluemix Infrastructure (SoftLayer). Names can be found in the SoftLayer Customer Portal, by navigating to [Network > IP Management > VLANs](https://control.softlayer.com/network/vlans). +* `name` - (Required if the number nor router hostname are provided) The name of the VLAN, as it was defined in Bluemix Infrastructure (SoftLayer). Names can be found in the [SoftLayer Customer Portal](https://control.softlayer.com/network/vlans), by navigating to **Network > IP Management > VLANs**. * `number` - (Required if the name is not provided) The VLAN number, which can be found in the [SoftLayer Customer Portal](https://control.softlayer.com/network/vlans). * `router_hostname` - (Required if the name is not provided) The primary VLAN router hostname, which can be found in the [SoftLayer Customer Portal](https://control.softlayer.com/network/vlans). diff --git a/website/source/docs/providers/ibmcloud/index.html.markdown b/website/source/docs/providers/ibmcloud/index.html.markdown index e21697c38b3f..348dbd5a9628 100644 --- a/website/source/docs/providers/ibmcloud/index.html.markdown +++ b/website/source/docs/providers/ibmcloud/index.html.markdown @@ -33,7 +33,7 @@ resource "ibmcloud_infra_ssh_key" "test_key_1" { # public_key = "${file(\"C:\ssh\keys\path\id_rsa_test_key_1.pub\")}" } -# Virtual server created with above ssh key +# Create a virtual server with the SSH key. resource "ibmcloud_infra_virtual_guest" "my_server_2" { hostname = "host-b.example.com" domain = "example.com" @@ -51,7 +51,7 @@ data "ibmcloud_cf_space" "space" { org = "${var.org}" } -# Create Cloud Foundry Service Instance +# Create an instance of a Cloud Foundry service. resource "ibmcloud_cf_service_instance" "service" { name = "${var.instance_name}" space_guid = "${data.ibmcloud_cf_space.space.id}" @@ -70,7 +70,7 @@ The IBM Cloud provider offers a flexible means of providing credentials for auth ### Static credentials ### -Static credentials can be provided by adding an `bluemix_api_key`, `softlayer_username`, `softlayer_api_key` in-line in the IBM Cloud provider block: +Static credentials can be provided by adding an `bluemix_api_key`, `softlayer_username`, `softlayer_api_key` in the IBM Cloud provider block. Usage: @@ -86,7 +86,7 @@ provider "ibmcloud" { ### Environment variables -You can provide your credentials via the `BM_API_KEY`, `SL_USERNAME` and `SL_API_KEY` environment variables, representing your Bluemix API Key, SoftLayer Username and SoftLayer API Key respectively. +You can provide your credentials with the `BM_API_KEY`, `SL_USERNAME`, and `SL_API_KEY` environment variables, representing your Bluemix API key, SoftLayer user name, and SoftLayer API key, respectively. ``` provider "ibmcloud" {} @@ -102,10 +102,9 @@ $ terraform plan ``` ### Skip Service Configuration -See `skip_service_configuration` in the Argument Reference below. +See `skip_service_configuration` in the Argument Reference section. -The below configuration will direct the provider to not configure the softlayer client and hence -not complain if softlayer_username and softlayer_api_key are missing in the provider. +You can include the `skip_service_configuration` argument if you want to omit SoftLayer credentials from the requirements to set up the provider. The following example directs the provider to skip the `softlayer_username` and `softlayer_api_key` arguments. ``` provider "ibmcloud" { @@ -118,15 +117,14 @@ provider "ibmcloud" { The following arguments are supported in the `provider` block: -* `bluemix_api_key` - (Optional) The Bluemix API Key. It must be provided, but it can also be sourced from the `BM_API_KEY` or `BLUEMIX_API_KEY` environment variable. The former variable has higher precedence. This key is required to provision any resource which are Cloud Foundry related or IBM Container service related, basically those with _ibmcloud_cf_ or _ibmcloud_cs_ prefix in the them. For example , _ibmcloud_cf_app_ and _ibmcloud_cs_cluster_. +* `bluemix_api_key` - (Optional) The Bluemix API key. It must be provided, but it can also be sourced from the `BM_API_KEY` or `BLUEMIX_API_KEY` environment variable. The former variable has higher precedence. The key is required to provision Cloud Foundry or IBM Container Service resources, such as any resource that begins with `ibmcloud_cf` or `ibmcloud_cs`. -* `bluemix_timeout` - (Optional) The timeout, expressed in seconds, for the SoftLayer API key. It can also be sourced from the `BM_TIMEOUT` or `BLUEMIX_TIMEOUT` environment variable. The former variable has higher precedence. Default value: `60`. +* `bluemix_timeout` - (Optional) The timeout, expressed in seconds, for the SoftLayer API key. It can also be sourced from the `BM_TIMEOUT` or `BLUEMIX_TIMEOUT` environment variable. The former variable has higher precedence. Default value: `60`. * `softlayer_username` - (Optional) The SoftLayer user name. It must be provided, but it can also be sourced from the `SL_USERNAME` or `SOFTLAYER_USERNAME` environment variable. The former variable has higher precedence. -* `softlayer_api_key` - (Optional) The SoftLayer user name. It must be provided, but it can also be sourced from the `SL_API_KEY` or `SOFTLAYER_API_KEY` environment variable. The former variable has higher precedence. This key is required to provision any resource which are SoftLayer related, basically those with _ibmcloud_infra_ prefix in them. For example, _ibmcloud_infra_virtual_guest_. +* `softlayer_api_key` - (Optional) The SoftLayer user name. It must be provided, but it can also be sourced from the `SL_API_KEY` or `SOFTLAYER_API_KEY` environment variable. The former variable has higher precedence. The key is required to provision SoftLayer resources, such as any resource that begins with `ibmcloud_infra`. -* `softlayer_timeout` - (Optional) The timeout, expressed in seconds, for the SoftLayer API key. It can also be sourced from the `SL_TIMEOUT` or `SOFTLAYER_TIMEOUT` environment variable. The former variable has higher precedence. Default value: `60`. +* `softlayer_timeout` - (Optional) The timeout, expressed in seconds, for the SoftLayer API key. It can also be sourced from the `SL_TIMEOUT` or `SOFTLAYER_TIMEOUT` environment variable. The former variable has higher precedence. Default value: `60`. * `region` - (Optional) The Bluemix region. It can also be sourced from the `BM_REGION` or `BLUEMIX_REGION` environment variable. The former variable has higher precedence. Default value: `us-south`. - From b5a7e84ea02d49db34dd0f716a2bfeaf1f1f3928 Mon Sep 17 00:00:00 2001 From: Ashish Kumar Thakur Date: Fri, 2 Jun 2017 22:49:52 +0530 Subject: [PATCH 2/3] Update cf_service_plan.html.markdown --- .../docs/providers/ibmcloud/d/cf_service_plan.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/source/docs/providers/ibmcloud/d/cf_service_plan.html.markdown b/website/source/docs/providers/ibmcloud/d/cf_service_plan.html.markdown index 9e827c724722..5f83c3ba471e 100644 --- a/website/source/docs/providers/ibmcloud/d/cf_service_plan.html.markdown +++ b/website/source/docs/providers/ibmcloud/d/cf_service_plan.html.markdown @@ -24,7 +24,7 @@ data "ibmcloud_cf_service_plan" "service_plan" { The following arguments are supported: * `service` - (Required, string) The name of the service offering. You can run the `bx service offerings` command in the [Bluemix CLI](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html#getting-started) to find the name of the service. -* `plan` - (Required, string) The name of the plan type supported by service. You can run the `bx service offering` command in the Bluemix CLI to retrieve the plan type. +* `plan` - (Required, string) The name of the plan type supported by service. You can run the `bx service offerings` command in the Bluemix CLI to retrieve the plan type. ## Attributes Reference From e822f1ae7ec24f7b93ca45227c92ea4f8eaa0b28 Mon Sep 17 00:00:00 2001 From: Ashish Kumar Thakur Date: Fri, 2 Jun 2017 22:53:52 +0530 Subject: [PATCH 3/3] Remove references to skip_service_configuration --- .../docs/providers/ibmcloud/index.html.markdown | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/website/source/docs/providers/ibmcloud/index.html.markdown b/website/source/docs/providers/ibmcloud/index.html.markdown index 348dbd5a9628..2161b57cf69e 100644 --- a/website/source/docs/providers/ibmcloud/index.html.markdown +++ b/website/source/docs/providers/ibmcloud/index.html.markdown @@ -101,18 +101,6 @@ $ export SL_API_KEY="sl_api_key" $ terraform plan ``` -### Skip Service Configuration -See `skip_service_configuration` in the Argument Reference section. - -You can include the `skip_service_configuration` argument if you want to omit SoftLayer credentials from the requirements to set up the provider. The following example directs the provider to skip the `softlayer_username` and `softlayer_api_key` arguments. - -``` -provider "ibmcloud" { - skip_service_configuration = ["softlayer"] -} -``` - - ## Argument Reference The following arguments are supported in the `provider` block: