OpenStack API client for golang
Go to file
Dean Troyer d6e0b326e1 Makefile with unit tests
Skip examples in unit tests

Change-Id: I4e5673a33d45acaf13e3b08ff7b18d6bbf59a973
2016-12-14 18:26:53 -06:00
examples Makefile with unit tests 2016-12-14 18:26:53 -06:00
identity/middleware Fix up unit tests 2016-12-14 18:26:35 -06:00
image/v1 change from stackforge to openstack 2016-04-21 20:08:28 -07:00
objectstorage/v1 Fix up unit tests 2016-12-14 18:26:35 -06:00
openstack Authorization failed with project id 2016-09-21 16:19:44 +08:00
testUtil Add auth package 2015-04-19 16:44:51 -05:00
util Added support 206 http code 2016-08-08 17:25:13 +00:00
volume/v2 Fix up unit tests 2016-12-14 18:26:35 -06:00
.gitignore change from stackforge to openstack 2016-04-21 20:08:28 -07:00
.gitreview change from stackforge to openstack 2016-04-21 20:08:28 -07:00 Workflow documentation is now in infra-manual 2014-12-05 03:30:45 +00:00
LICENSE All tests passed. Initial commit. 2013-07-14 21:12:30 +07:00
Makefile Makefile with unit tests 2016-12-14 18:26:53 -06:00 Final StackForge cleanups 2016-05-04 16:51:37 -05:00

OpenStack Golang Client

NOTE(dtroyer) Apr 2015: This repo is under heavy revision as it is being revived.

openstack/golang-client is an implementation of [OpenStack] ( API client in Go language. The code follows OpenStack licensing and uses its CI infrastructure for hosting. It currently implements [Identity Service v2] ( and [Object Storage v1] (

The initial focus is on building a solid core REST Session and OpenStack authentication on which to build the usual API interfaces. The architecture if the Session and authentication is similar to that used in the current Python Keystone client library: The Session object contains the HTTP interface methods and an authentication object that provides access to the auth token and service catalog.

Current State

Code maturity is considered experimental.

  • The new Session object is functional and used by most of the code now.
  • The examples work.
  • The image tests work.
  • The obejct store tests do not work.
  • identity/v2/auth.go is now unused, will be kept around for a short time for easier reference.


Use go get Or alternatively, download or clone the repository.

The lib was developed and tested on go 1.3. No external dependencies, so far.


The examples directory contains examples for using the SDK using real world working code. Each example starts with a two digit number followed by a name (e.g., 00-authentication.go). If you have a config.json file in the examples directory following the format of config.json.dist the example can be executed using go run [example name] setup.go. Or, all the examples can be executed running the script from the examples directory.


There are two types of test files. The *_test.go are standard golang unit test files. The examples can be run as integration tests.

The tests were written against the [OpenStack API specifications] ( The integration test were successful against the following:

If you use another provider and successfully completed the tests, please email the maintainer(s) so your service can be mentioned here. Alternatively, if you are a service provider and can arrange a free (temporary) account, a quick test can be arranged.


Apache v2.


The code repository utilizes the OpenStack CI infrastructure. Please use the [recommended workflow] ( If you are not a member yet, please consider joining as an [OpenStack contributor] ( If you have questions or comments, you can email the maintainer(s).

Coding Style

The source code is automatically formatted to follow go fmt by the [IDE] ( And where pragmatic, the source code follows this general [coding style] (