Gophercloud: an OpenStack SDK for Go
Go Shell
Latest commit 6b86705 Feb 23, 2017 @jrperritt jrperritt committed on GitHub internal package (#270)
Permalink
Failed to load latest commit information.
.github Issue/PR templates (#180) Nov 3, 2016
acceptance ImageService v2: Fixing Create Properties (#264) Feb 20, 2017
internal internal package (#270) Feb 24, 2017
openstack omit empty AdminPass in 'Rebuild' req body (#267) Feb 20, 2017
pagination fix images 'AllPages' paging (#266) Feb 20, 2017
script fix coverage script from masking unit test failures (#265) Feb 20, 2017
testhelper images service v2 port from rackpsace/gophercloud (#171) Nov 4, 2016
testing Refactor WaitFor (#221) Feb 14, 2017
.gitignore vim swp file (#46) Aug 11, 2016
.travis.yml aggregate coverage metrics of unit tests across packages (#115) Oct 11, 2016
CHANGELOG.md merge lbaasv2, portsbinding, volumes v2; remove 'rackspace' refs; upd… Jul 12, 2016
FAQ.md documenting example usage of a custom HTTP client (#231) Jan 20, 2017
LICENSE Added missing license, contributors file Aug 13, 2013
MIGRATING.md create trusts.TokenExt response object (#29) Aug 3, 2016
README.md documenting example usage of a custom HTTP client (#231) Jan 20, 2017
STYLEGUIDE.md add item about dependent PRs to style guide (#239) Jan 20, 2017
auth_options.go Identity v3 Authentication With TrustID (#24) Jul 27, 2016
doc.go Comments and missing words. Oct 31, 2014
endpoint_search.go initial migration from rackspace/gophercloud Feb 11, 2016
errors.go Identity v3 Authentication With TrustID (#24) Jul 27, 2016
params.go Update how isZero handles Pointers (#181) Nov 5, 2016
provider_client.go move HTTP action methods to ServiceClient (for microversions) Mar 10, 2016
results.go check for http response error in ExtractInto*Ptr methods Nov 14, 2016
service_client.go dsl struct tags; wip Mar 13, 2016
util.go Refactor WaitFor (#221) Feb 14, 2017

README.md

Gophercloud: an OpenStack SDK for Go

Build Status Coverage Status

Gophercloud is an OpenStack Go SDK.

Useful links

How to install

Before installing, you need to ensure that your GOPATH environment variable is pointing to an appropriate directory where you want to install Gophercloud:

mkdir $HOME/go
export GOPATH=$HOME/go

To protect yourself against changes in your dependencies, we highly recommend choosing a dependency management solution for your projects, such as godep. Once this is set up, you can install Gophercloud as a dependency like so:

go get github.com/gophercloud/gophercloud

# Edit your code to import relevant packages from "github.com/gophercloud/gophercloud"

godep save ./...

This will install all the source files you need into a Godeps/_workspace directory, which is referenceable from your own source files when you use the godep go command.

Getting started

Credentials

Because you'll be hitting an API, you will need to retrieve your OpenStack credentials and either store them as environment variables or in your local Go files. The first method is recommended because it decouples credential information from source code, allowing you to push the latter to your version control system without any security risk.

You will need to retrieve the following:

  • username
  • password
  • a valid Keystone identity URL

For users that have the OpenStack dashboard installed, there's a shortcut. If you visit the project/access_and_security path in Horizon and click on the "Download OpenStack RC File" button at the top right hand corner, you will download a bash file that exports all of your access details to environment variables. To execute the file, run source admin-openrc.sh and you will be prompted for your password.

Authentication

Once you have access to your credentials, you can begin plugging them into Gophercloud. The next step is authentication, and this is handled by a base "Provider" struct. To get one, you can either pass in your credentials explicitly, or tell Gophercloud to use environment variables:

import (
  "github.com/gophercloud/gophercloud"
  "github.com/gophercloud/gophercloud/openstack"
  "github.com/gophercloud/gophercloud/openstack/utils"
)

// Option 1: Pass in the values yourself
opts := gophercloud.AuthOptions{
  IdentityEndpoint: "https://my-openstack.com:5000/v2.0",
  Username: "{username}",
  Password: "{password}",
}

// Option 2: Use a utility function to retrieve all your environment variables
opts, err := openstack.AuthOptionsFromEnv()

Once you have the opts variable, you can pass it in and get back a ProviderClient struct:

provider, err := openstack.AuthenticatedClient(opts)

The ProviderClient is the top-level client that all of your OpenStack services derive from. The provider contains all of the authentication details that allow your Go code to access the API - such as the base URL and token ID.

Provision a server

Once we have a base Provider, we inject it as a dependency into each OpenStack service. In order to work with the Compute API, we need a Compute service client; which can be created like so:

client, err := openstack.NewComputeV2(provider, gophercloud.EndpointOpts{
  Region: os.Getenv("OS_REGION_NAME"),
})

We then use this client for any Compute API operation we want. In our case, we want to provision a new server - so we invoke the Create method and pass in the flavor ID (hardware specification) and image ID (operating system) we're interested in:

import "github.com/gophercloud/gophercloud/openstack/compute/v2/servers"

server, err := servers.Create(client, servers.CreateOpts{
  Name:      "My new server!",
  FlavorRef: "flavor_id",
  ImageRef:  "image_id",
}).Extract()

The above code sample creates a new server with the parameters, and embodies the new resource in the server variable (a servers.Server struct).

Advanced Usage

Have a look at the FAQ for some tips on customizing the way Gophercloud works.

Backwards-Compatibility Guarantees

None. Vendor it and write tests covering the parts you use.

Contributing

See the contributing guide.

Help and feedback

If you're struggling with something or have spotted a potential bug, feel free to submit an issue to our bug tracker.