Skip to content

IBM-Cloud/bluemix-go

Repository files navigation

IBM Cloud SDK for Go

Build Status GoDoc

bluemix-go provides the Go implementation for operating the IBM Cloud platform, which is based on the Cloud Foundry API.

Installing

  1. Install the SDK using the following command
go get github.com/IBM-Cloud/bluemix-go
  1. Update the SDK to the latest version using the following command
go get -u github.com/IBM-Cloud/bluemix-go

Using the SDK

You must have a working IBM Cloud account to use the APIs. Sign up if you don't have one.

The SDK has examples folder which cites few examples on how to use the SDK. First you need to create a session.

import "github.com/IBM-Cloud/bluemix-go/session"

func main(){

    s := session.New()
    .....
}

Creating session in this way creates a default configuration which reads the value from the environment variables. You must export the following environment variables.

  • IBMID - This is the IBM ID
  • IBMID_PASSWORD - This is the password for the above ID

OR

  • IC_API_KEY/IBMCLOUD_API_KEY - This is the Bluemix API Key. Login to IBMCloud to create one if you don't already have one. See instructions below for creating an API Key.

The default region is us_south. You can override it in the Config struct. You can also provide the value via environment variables; either via IC_REGION or IBMCLOUD_REGION. Valid regions are -

  • us-south
  • us-east
  • eu-gb
  • eu-de
  • au-syd
  • jp-tok

The maximum retries is 3. You can override it in the Config struct. You can also provide the value via environment variable; via MAX_RETRIES

Creating an IBM Cloud API Key

First, navigate to the IBM Cloud console and use the Manage toolbar to access IAM.

Access IAM from the Manage toolbar

On the left, click "IBM Cloud API Keys"

Click IBM Cloud API Keys

Press "Create API Key"

Press Create API Key

Pick a name and description for your key

Set name and description

You have created a key! Press the eyeball to show the key. Copy or save it because keys can't be displayed or downloaded twice.

Your key is now created