Skip to content

Commit

Permalink
Merge pull request #136 from knlyons/docs_edits
Browse files Browse the repository at this point in the history
Docs team -- edits for clarity
  • Loading branch information
ashishth09 authored Jun 2, 2017
2 parents 5855f4c + e822f1a commit eb1c7fe
Show file tree
Hide file tree
Showing 15 changed files with 47 additions and 61 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 8 additions & 8 deletions website/source/docs/providers/ibmcloud/d/cf_app.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 <space_name> --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.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <space_name> --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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ 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

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.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 offerings` command in the Bluemix CLI to retrieve the plan type.

## Attributes Reference

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <space_name> --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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ 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.
* `admin` - (Optional) Set it to true to download config for the admin. Default false.
* `download` - (Optional) Set it to false to skip downloading the config for the admin. Default true. Since it is part of a data source it means by default the config is downloaded for every `terraform` call. For a particular cluster name/id the config is guaranteed to be downloaded to the same path for a given `config_dir`
* `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.
* `admin` - (Optional) Set to `true` to download config for the admin. Default value: `false`.
* `download` - (Optional) Set to `false` to skip downloading the config for the admin. Default value: `true`. Since it is part of a data source, the config is downloaded for every `terraform` call by default. For a particular cluster name/ID, the config is guaranteed to be downloaded to the same path for a given `config_dir`.
* `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 <space_name> --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

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.
Original file line number Diff line number Diff line change
Expand Up @@ -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 <space_name> --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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* `power_state` - The current power state of a virtual guest.
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Loading

0 comments on commit eb1c7fe

Please sign in to comment.