donut

README

Donut

donut - Donut (do not delete) on disk format implementation released under Apache license v2.

Documentation

Index

• type Bucket
  • func NewBucket(bucketName, donutName string, nodes map[string]Node) (Bucket, error)
• type Disk
  • func NewDisk(diskPath string, diskOrder int) (Disk, error)
• type Donut
  • func NewDonut(donutName string, nodeDiskMap map[string][]string) (Donut, error)
• type Encoder
  • func NewEncoder(k, m uint8, technique string) (Encoder, error)
• type Node
  • func NewNode(hostname string) (Node, error)
• type Object
  • func NewObject(objectName, p string) (Object, error)

Types

type Bucket

type Bucket interface {
	GetBucketName() string

	ListNodes() (map[string]Node, error)
	ListObjects() (map[string]Object, error)

	GetObject(object string, writer *io.PipeWriter, donutObjectMetadata map[string]string)
	PutObject(object string, contents io.Reader) error

	WriteDonutObjectMetadata(object string, donutMetadata map[string]string) error
	WriteObjectMetadata(object string, objectMetadata map[string]string) error
}

Bucket interface

func NewBucket

func NewBucket(bucketName, donutName string, nodes map[string]Node) (Bucket, error)

NewBucket - instantiate a new bucket

type Disk

type Disk interface {
	MakeDir(dirname string) error

	ListDir(dirname string) ([]os.FileInfo, error)
	ListFiles(dirname string) ([]os.FileInfo, error)

	MakeFile(path string) (*os.File, error)
	OpenFile(path string) (*os.File, error)

	GetName() string
	GetOrder() int
	GetFileSystemType() string
	SaveConfig() ([]byte, error)
	LoadConfig([]byte) error
}

Disk interface

func NewDisk

func NewDisk(diskPath string, diskOrder int) (Disk, error)

NewDisk - instantiate new disk

type Donut

type Donut interface {
	MakeBucket(bucket string) error
	ListBuckets() (map[string]Bucket, error)

	Heal() error
	Rebalance() error
	Info() error

	AttachNode(node Node) error
	DetachNode(node Node) error

	SaveConfig() ([]byte, error)
	LoadConfig([]byte) error
}

Donut interface

func NewDonut

func NewDonut(donutName string, nodeDiskMap map[string][]string) (Donut, error)

NewDonut - instantiate a new donut

type Encoder

type Encoder interface {
	GetEncodedBlockLen(dataLength int) (int, error)
	Encode(data []byte) (encodedData [][]byte, err error)
	Decode(encodedData [][]byte, dataLength int) (data []byte, err error)
}

Encoder interface

func NewEncoder

func NewEncoder(k, m uint8, technique string) (Encoder, error)

NewEncoder - instantiate a new encoder

type Node

type Node interface {
	ListDisks() (map[string]Disk, error)
	AttachDisk(disk Disk) error
	DetachDisk(disk Disk) error

	GetNodeName() string
	SaveConfig() ([]byte, error)
	LoadConfig([]byte) error
}

Node interface

func NewNode

func NewNode(hostname string) (Node, error)

NewNode - instantiates a new node

type Object

type Object interface {
	GetObjectName() string
	GetObjectMetadata() (map[string]string, error)
	GetDonutObjectMetadata() (map[string]string, error)
}

Object interface

func NewObject

func NewObject(objectName, p string) (Object, error)

NewObject - instantiate a new object