github.com/ncw/swift/v2

Swift

This package provides an easy to use library for interfacing with Swift / Openstack Object Storage / Rackspace cloud files from the Go Language

Install

Use go to install the library

go get github.com/ncw/swift/v2

Usage

See here for full package docs

• https://pkg.go.dev/github.com/ncw/swift/v2

Here is a short example from the docs

import "github.com/ncw/swift/v2"

// Create a connection
c := swift.Connection{
UserName: "user",
ApiKey:   "key",
AuthUrl:  "auth_url",
Domain:   "domain", // Name of the domain (v3 auth only)
Tenant:   "tenant", // Name of the tenant (v2 auth only)
}
// Authenticate
err := c.Authenticate()
if err != nil {
panic(err)
}
// List all the containers
containers, err := c.ContainerNames(nil)
fmt.Println(containers)
// etc...

Migrating from v1

The library has current major version v2. If you want to migrate from the first version of library github.com/ncw/swift you have to explicitly add the /v2 suffix to the imports.

Most of the exported functions were added a new context.Context parameter in the v2, which you will have to provide when migrating.

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'

And optionally these if using v3 authentication

export SWIFT_TENANT='TenantName'
export SWIFT_TENANT_ID='TenantId'
export SWIFT_API_DOMAIN_ID='domain id'
export SWIFT_API_DOMAIN='domain name'

And optionally these if using v3 trust

export SWIFT_TRUST_ID='TrustId'

And optionally this if you want to skip server certificate validation

export SWIFT_AUTH_INSECURE=1

And optionally this to configure the connect channel timeout, in seconds

export SWIFT_CONNECTION_CHANNEL_TIMEOUT=60

And optionally this to configure the data channel timeout, in seconds

export SWIFT_DATA_CHANNEL_TIMEOUT=60

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 [e-mail]

Contributors

• Brian "bojo" Jones [e-mail]
• Janika Liiv [e-mail]
• Yamamoto, Hirotaka [e-mail]
• Stephen [e-mail]
• platformpurple [e-mail]
• Paul Querna [e-mail]
• Livio Soares [e-mail]
• thesyncim [e-mail]
• lsowen [e-mail] [e-mail]
• Sylvain Baubeau [e-mail]
• Chris Kastorff [e-mail]
• Dai HaoJun [e-mail]
• Hua Wang [e-mail]
• Fabian Ruff [e-mail] [e-mail]
• Arturo Reuschenbach Puncernau [e-mail]
• Petr Kotek [e-mail]
• Stefan Majewsky [e-mail] [e-mail]
• Cezar Sa Espinola [e-mail]
• Sam Gunaratne [e-mail]
• Richard Scothern [e-mail]
• Michel Couillard [e-mail]
• Christopher Waldon [e-mail]
• dennis [e-mail]
• hag [e-mail]
• Alexander Neumann [e-mail]
• eclipseo [e-mail]
• Yuri Per [e-mail]
• Falk Reimann [e-mail]
• Arthur Paim Arnold [e-mail]
• Bruno Michel [e-mail]
• Charles Hsu [e-mail]
• Omar Ali [e-mail]
• Andreas Andersen [e-mail]
• kayrus [e-mail]
• CodeLingo Bot [e-mail]
• Jérémy Clerc [e-mail]
• 4xicom [e-mail]
• Bo [e-mail]
• Thiago da Silva [e-mail]
• Brandon WELSCH [e-mail]
• Damien Tournoud [e-mail]
• Pedro Kiefer [e-mail]
• Martin Chodur [e-mail]
• Devendra [e-mail]
• timss [e-mail]
• Jos Houtman [e-mail]
• Paul Collins [e-mail]
• Joe Cai [e-mail]