Skip to content

Fixed variable name for ibmcloud api key #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VaishnaviGopal wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed variable name for ibmcloud api key #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# SSH key template

An [IBM Cloud Schematics](https://console.bluemix.net/docs/services/schematics/index.html) template that creates an [IBM Cloud SSH Key](https://ibm-bluemix.github.io/tf-ibm-docs/v0.4.0/r/compute_ssh_key.html) (`ibm_compute_ssh_key`). This template creates am SSH key in the specified IBM Cloud account. This is not a module, it is a Terraform configuration that should be cloned or forked to be used.
An [IBM Cloud Schematics](https://cloud.ibm.com/docs/services/schematics/) template that creates an [IBM Cloud SSH Key](https://ibm-cloud.github.io/tf-ibm-docs/v0.17.3/r/compute_ssh_key.html) (`ibm_compute_ssh_key`). This template creates am SSH key in the specified IBM Cloud account. This is not a module, it is a Terraform configuration that should be cloned or forked to be used.

Schematics uses [Terraform](https://www.terraform.io/) as the infrastructure as code engine. With this template, you can provision and manage infrastructure as a single unit. **Note**: To create the resources that this template requests, your [IBM Cloud Infrastructure (Softlayer) account](https://console.bluemix.net/docs/iam/mnginfra.html#managing-infrastructure-access) and [IBM Cloud account](https://console.bluemix.net/docs/iam/mngiam.html#iammanidaccser) must have sufficient permissions.
Schematics uses [Terraform](https://www.terraform.io/) as the infrastructure as code engine. With this template, you can provision and manage infrastructure as a single unit. **Note**: To create the resources that this template requests, your [IBM Cloud Infrastructure (Softlayer) account](https://cloud.ibm.com/docs/iam?topic=iam-mngclassicinfra#managing-infrastructure-access) and [IBM Cloud account](https://cloud.ibm.com/docs/iam?topic=iam-iammanidaccser#iammanidaccser) must have sufficient permissions.

See the [Terraform provider docs](https://ibm-bluemix.github.io/tf-ibm-docs/) for available resources for the IBM Cloud.
See the [Terraform provider docs](https://ibm-cloud.github.io/tf-ibm-docs/) for available resources for the IBM Cloud.

**This configuration template is written for IBM Cloud provider version `v0.4.0`**

## Create an environment with this template

Environments can be used to separate software components into development tiers (e.g. staging, QA, and production).

1. In IBM Cloud, go to the menu and select the [Schematics dashboard](https://console.bluemix.net/schematics).
1. In IBM Cloud, go to the menu and select the [Schematics dashboard](https://cloud.ibm.com/schematics).
2. In the left navigation menu, select **Templates** to access the template catalog.
3. Click **Create** on the SSH key template. You are taken to a configuration page where you can define metadata about your environment.
4. Define values for your variables according to the following table.
Expand All @@ -21,8 +21,8 @@ Environments can be used to separate software components into development tiers

|Variable Name|Description|Default Value|
|-------------|-----------|-------------|
|bxapikey|Your IBM Cloud API key. You can get the value by running `bx iam api-key-create <key name>`.||
|datacenter|The data center for the SSH key. You can run `bluemix cs locations` to see a list of all data centers in your region.||
|icapikey|Your IBM Cloud API key. You can get the value by running `ic iam api-key-create <key name>`.||
|datacenter|The data center for the SSH key. You can run `ic cs zones` to see a list of all data centers in your region.||
|key_label|An identifying label to assign to the SSH key.||
|key_note|Notes to store with the SSH key. | |
|public_key|The public key contents for the SSH keypair. | |
Expand All @@ -34,7 +34,7 @@ Environments can be used to separate software components into development tiers
After setting up your environment with this template, you can run **Plan** to preview how Schematics will deploy resources to your environment. When you are ready to deploy the cluster, run **Apply**.

## Using the Terraform binary on your local workstation
You will need to [set up up IBM Cloud provider credentials](#setting-up-provider-credentials) on your local machine. Then you will need the [Terraform binary](https://www.terraform.io/intro/getting-started/install.html) and the [IBM Cloud Provider Plugin](https://github.com/IBM-Bluemix/terraform/releases). Then follow the instructions at [https://ibm-bluemix.github.io/tf-ibm-docs/v0.4.0/#developing-locally](https://ibm-bluemix.github.io/tf-ibm-docs/v0.4.0/#developing-locally).
You will need to [set up up IBM Cloud provider credentials](#setting-up-provider-credentials) on your local machine. Then you will need the [Terraform binary](https://www.terraform.io/intro/getting-started/install.html) and the [IBM Cloud Provider Plugin](https://github.com/IBM-Cloud/terraform-provider-ibm/releases/). Then follow the instructions at [https://github.com/IBM-Cloud/terraform-provider-ibm.git](https://github.com/IBM-Cloud/terraform-provider-ibm.git).

To run this project locally, complete the following steps:

Expand All @@ -44,11 +44,11 @@ To run this project locally, complete the following steps:
- `terraform plan`: This command performs a dry run to show what infrastructure Terraform intends to create.
- `terraform apply`: This command creates actual infrastructure.
- Infrastructure can be seen in IBM Cloud under the following URLs:
- SSH keys: https://control.bluemix.net/devices/sshkeys
- SSH keys: https://cloud.ibm.com/classic/devices/sshkeys
- `terraform destroy`: This command destroy all infrastructure that has been created.

### Available data centers
You can run `bluemix cs locations` to see a list of all data centers in your region.
You can run `ic cs zones` to see a list of all data centers in your region.

### Running in multiple data centers
You can run `terraform plan -var 'datacenter=lon02' -state=lon02.tfstate` or whatever your preferred data center is (replace `lon02` for both arguments), and repeat for `terraform apply` with the same arguments.
Expand All @@ -59,15 +59,15 @@ To set up the IBM Cloud provider to work with this example there are a few optio
### Exporting environment variables using IBMid credentials
You'll need to export the following environment variables:

- `TF_VAR_bxapikey` - Your IBM Cloud API Key
- `TF_VAR_slusername` - Your IBM Cloud Infrastructure (SoftLayer) username
- `TF_VAR_slapikey` - Your IBM Cloud Infrastructure user name.
- `IC_API_KEY` - Your IBM Cloud API Key
- `SL_USERNAME` - Your IBM Cloud Infrastructure (SoftLayer) username
- `SL_API_KEY` - Your IBM Cloud Infrastructure user name.

On OS X, you can enter the following commands into your terminal:

- `export TF_VAR_bxapikey=<value>`
- `export TF_VAR_slusername=<value>`
- `export TF_VAR_slapikey=<value>`
- `export IC_API_KEY=<value>`
- `export SL_USERNAME=<value>`
- `export SL_API_KEY=<value>`

This is only temporary to your current terminal session. To make this permanent, add these export statements to your `~/.profile`, `~/.bashrc`, `~/.bash_profile` or preferred terminal configuration file. If you go this route without running `export ...` in your command prompt, you'll need to source your terminal configuration file from the command prompt like so: `source ~/.bashrc` (or your preferred config file).

Expand Down
14 changes: 11 additions & 3 deletions main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@
terraform {
required_version = ">= 0.9.3"
}

##############################################################################
# IBM Cloud Provider
##############################################################################
# See the README for details on ways to supply these values
provider "ibm" {
bluemix_api_key = "${var.bxapikey}"
ibmcloud_api_key = "${var.icapikey}"
softlayer_username = "${var.slusername}"
softlayer_api_key = "${var.slapikey}"
softlayer_api_key = "${var.slapikey}"
}

##############################################################################
Expand All @@ -20,31 +21,38 @@ provider "ibm" {
resource "ibm_compute_ssh_key" "ssh_key" {
label = "${var.key_label}"
notes = "${var.key_note}"

# Public key, so this is completely safe
public_key = "${var.public_key}"
}

##############################################################################
# Variables
##############################################################################
variable bxapikey {
variable icapikey {
description = "Your IBM Cloud API key. You can create an API key by running bx iam api-key-create <key name>."
}

variable slusername {
description = "Your IBM Cloud Infrastructure (SoftLayer) user name."
}

variable slapikey {
description = "Your IBM Cloud Infrastructure (SoftLayer) API key."
}

variable datacenter {
description = "The data center that you want to create resources in. You can run bluemix cs locations to see a list of all data centers in your region."
}

variable public_key {
description = "The public key material for the SSH keypair."
}

variable key_label {
description = "An identifying label to assign to the SSH key."
}

variable key_note {
description = "Notes to store with the SSH key."
}
Expand Down