Go bindings for Ceph
Go to file
Ye Yin 80e3e9ea7f Add rbd_get_parent_info
Signed-off-by: Ye Yin <eyniy@qq.com>
2015-07-20 11:34:47 +08:00
cephfs gofmt all the source files 2015-07-08 14:04:54 +05:30
ci ci: Allow local tests to run in a docker 2015-05-24 11:12:54 +05:30
rados gofmt all the source files 2015-07-08 14:04:54 +05:30
rbd Add rbd_get_parent_info 2015-07-20 11:34:47 +08:00
.travis.yml travis: check for go fmt violations for patches 2015-07-08 14:07:55 +05:30
Dockerfile ci: Allow local tests to run in a docker 2015-05-24 11:12:54 +05:30
LICENSE license: add MIT license 2014-11-27 10:53:04 -08:00
Makefile Add a simple makefile 2015-05-24 13:43:05 +05:30
README.md fix go-rados -> go-ceph renames 2015-01-14 17:30:46 -08:00
doc.go run gofmt on all sources 2015-02-11 22:21:05 +01:00
package_test.go run gofmt on all sources 2015-02-11 22:21:05 +01:00

README.md

go-ceph - Go bindings for Ceph APIs (RBD, RADOS, CephFS)

Build Status Godoc license

This project uses Semantic Versioning (http://semver.org/).

Installation

go get github.com/noahdesu/go-ceph

The native RADOS library and development headers are expected to be installed.

Documentation

Detailed documentation is available at http://godoc.org/github.com/noahdesu/go-ceph.

Connecting to a cluster

Connect to a Ceph cluster using a configuration file located in the default search paths.

conn, _ := rados.NewConn()
conn.ReadDefaultConfigFile()
conn.Connect()

A connection can be shutdown by calling the Shutdown method on the connection object (e.g. conn.Shutdown()). There are also other methods for configuring the connection. Specific configuration options can be set:

conn.SetConfigOption("log_file", "/dev/null")

and command line options can also be used using the ParseCmdLineArgs method.

args := []string{ "--mon-host", "1.1.1.1" }
err := conn.ParseCmdLineArgs(args)

For other configuration options see the full documentation.

Object I/O

Object in RADOS can be written to and read from with through an interface very similar to a standard file I/O interface:

// open a pool handle
ioctx, err := conn.OpenIOContext("mypool")

// write some data
bytes_in := []byte("input data")
err = ioctx.Write("obj", bytes_in, 0)

// read the data back out
bytes_out := make([]byte, len(bytes_in))
n_out, err := ioctx.Read("obj", bytes_out, 0)

if bytes_in != bytes_out {
    fmt.Println("Output is not input!")
}

Pool maintenance

The list of pools in a cluster can be retreived using the ListPools method on the connection object. On a new cluster the following code snippet:

pools, _ := conn.ListPools()
fmt.Println(pools)

will produce the output [data metadata rbd], along with any other pools that might exist in your cluster. Pools can also be created and destroyed. The following creates a new, empty pool with default settings.

conn.MakePool("new_pool")

Deleting a pool is also easy. Call DeletePool(name string) on a connection object to delete a pool with the given name. The following will delete the pool named new_pool and remove all of the pool's data.

conn.DeletePool("new_pool")