forked from TrueCloudLab/distribution
107 lines
2.3 KiB
Markdown
107 lines
2.3 KiB
Markdown
|
Swift
|
||
|
|
=====
|
||
|
|
|
||
|
|
This package provides an easy to use library for interfacing with
|
||
|
|
Swift / Openstack Object Storage / Rackspace cloud files from the Go
|
||
|
|
Language
|
||
|
|
|
||
|
|
See here for package docs
|
||
|
|
|
||
|
|
http://godoc.org/github.com/ncw/swift
|
||
|
|
|
||
|
|
[](https://travis-ci.org/ncw/swift)
|
||
|
|
|
||
|
|
Install
|
||
|
|
-------
|
||
|
|
|
||
|
|
Use go to install the library
|
||
|
|
|
||
|
|
go get github.com/ncw/swift
|
||
|
|
|
||
|
|
Usage
|
||
|
|
-----
|
||
|
|
|
||
|
|
See here for full package docs
|
||
|
|
|
||
|
|
- http://godoc.org/github.com/ncw/swift
|
||
|
|
|
||
|
|
Here is a short example from the docs
|
||
|
|
|
||
|
|
import "github.com/ncw/swift"
|
||
|
|
|
||
|
|
// Create a connection
|
||
|
|
c := swift.Connection{
|
||
|
|
UserName: "user",
|
||
|
|
ApiKey: "key",
|
||
|
|
AuthUrl: "auth_url",
|
||
|
|
}
|
||
|
|
// Authenticate
|
||
|
|
err := c.Authenticate()
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
// List all the containers
|
||
|
|
containers, err := c.ContainerNames(nil)
|
||
|
|
fmt.Println(containers)
|
||
|
|
// etc...
|
||
|
|
|
||
|
|
Additions
|
||
|
|
---------
|
||
|
|
|
||
|
|
The `rs` sub project contains a wrapper for the Rackspace specific CDN Management interface.
|
||
|
|
|
||
|
|
Testing
|
||
|
|
-------
|
||
|
|
|
||
|
|
To run the tests you can either use an embedded fake Swift server
|
||
|
|
either use a real Openstack Swift server or a Rackspace Cloud files account.
|
||
|
|
|
||
|
|
When using a real Swift server, you need to set these environment variables
|
||
|
|
before running the tests
|
||
|
|
|
||
|
|
export SWIFT_API_USER='user'
|
||
|
|
export SWIFT_API_KEY='key'
|
||
|
|
export SWIFT_AUTH_URL='https://url.of.auth.server/v1.0'
|
||
|
|
|
||
|
|
And optionally these if using v2 authentication
|
||
|
|
|
||
|
|
export SWIFT_TENANT='TenantName'
|
||
|
|
export SWIFT_TENANT_ID='TenantId'
|
||
|
|
|
||
|
|
Then run the tests with `go test`
|
||
|
|
|
||
|
|
License
|
||
|
|
-------
|
||
|
|
|
||
|
|
This is free software under the terms of MIT license (check COPYING file
|
||
|
|
included in this package).
|
||
|
|
|
||
|
|
Contact and support
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
The project website is at:
|
||
|
|
|
||
|
|
- https://github.com/ncw/swift
|
||
|
|
|
||
|
|
There you can file bug reports, ask for help or contribute patches.
|
||
|
|
|
||
|
|
Authors
|
||
|
|
-------
|
||
|
|
|
||
|
|
- Nick Craig-Wood <nick@craig-wood.com>
|
||
|
|
|
||
|
|
Contributors
|
||
|
|
------------
|
||
|
|
|
||
|
|
- Brian "bojo" Jones <mojobojo@gmail.com>
|
||
|
|
- Janika Liiv <janika@toggl.com>
|
||
|
|
- Yamamoto, Hirotaka <ymmt2005@gmail.com>
|
||
|
|
- Stephen <yo@groks.org>
|
||
|
|
- platformpurple <stephen@platformpurple.com>
|
||
|
|
- Paul Querna <pquerna@apache.org>
|
||
|
|
- Livio Soares <liviobs@gmail.com>
|
||
|
|
- thesyncim <thesyncim@gmail.com>
|
||
|
|
- lsowen <lsowen@s1network.com>
|
||
|
|
- Sylvain Baubeau <sbaubeau@redhat.com>
|
||
|
|
- Chris Kastorff <encryptio@gmail.com>
|