rexray

README

REX-Ray

REX-Ray provides visibility and management of external/underlying storage via guest storage introspection. Available as a Go package, CLI tool, and Linux service, and with built-in third-party support for tools such as Docker, REX-Ray is easily integrated into any workflow.

Documentation for REX-Ray

You will find complete documentation for REX-Ray, including licensing and support information at rexray.readthedocs.org

Documentation

Overview

Package rexray provides visibility and management of external/underlying storage via guest storage introspection. Available as a Go package, CLI tool, and Linux service, and with built-in third-party support for tools such as Docker, REX-Ray is easily integrated into any workflow. For example, here's how to list storage for a guest hosted on Amazon Web Services (AWS) with REX-Ray:

[0]akutz@pax:~$ export REXRAY_STORAGEDRIVERS=ec2
[0]akutz@pax:~$ export AWS_ACCESS_KEY=access_key
[0]akutz@pax:~$ export AWS_SECRET_KEY=secret_key
[0]akutz@pax:~$ rexray volume get

- providername: ec2
  instanceid: i-695bb6ab
  volumeid: vol-dedbadc3
  devicename: /dev/sda1
  region: us-west-1
  status: attached
- providername: ec2
  instanceid: i-695bb6ab
  volumeid: vol-04c4b219
  devicename: /dev/xvdb
  region: us-west-1
  status: attached

[0]akutz@pax:~$

Using REX-Ray as a library is easy too. To perform the same volume listing as above, simply use the following snippet:

import "github.com/emccode/rexray"

r := rexray.NewWithEnv(map[string]string{
    "REXRAY_STORAGEDRIVERS": "ec2",
    "AWS_ACCESS_KEY": "access_key",
    "AWS_SECRET_KEY": "secret_key"})

r.InitDrivers()

volumes, err := r.Storage.GetVolumeMapping()

Index

• func New() (*core.RexRay, error)
• func NewWithConfigFile(path string) (*core.RexRay, error)
• func NewWithConfigReader(in io.Reader) (*core.RexRay, error)
• func NewWithEnv(env map[string]string) (*core.RexRay, error)

Functions

func New

func New() (*core.RexRay, error)

New creates a new REX-Ray instance and configures using the standard configuration workflow: environment variables followed by global and user configuration files.

func NewWithConfigFile

func NewWithConfigFile(path string) (*core.RexRay, error)

NewWithConfigFile creates a new REX-Ray instance and configures it with a custom configuration file.

func NewWithConfigReader

func NewWithConfigReader(in io.Reader) (*core.RexRay, error)

NewWithConfigReader creates a new REX-Ray instance and configures it with a custom configuration stream.

func NewWithEnv

func NewWithEnv(env map[string]string) (*core.RexRay, error)

NewWithEnv creates a new REX-Ray instance and configures it with a a custom environment.