volume

type DeviceMapperStatus struct {
	Driver     DriverType
	DriverType string
	DriverPath string
	PoolName   string

	PoolDataTotal     uint64
	PoolDataAvailable uint64
	PoolDataUsed      uint64

	PoolMetadataTotal     uint64
	PoolMetadataAvailable uint64
	PoolMetadataUsed      uint64

	DriverData map[string]string
	UsageData  UsageData
	Tenants    []TenantStorageStats

	Errors []string
}

type Driver interface {
	// Root returns the filesystem root this driver acts on
	Root() string
	// DriverType returns the string describing the driver
	DriverType() DriverType
	// Create creates a volume with the given name and returns it. The volume
	// must not exist already.
	Create(volumeName string) (Volume, error)
	// Remove removes an existing device. If the device doesn't exist, the
	// removal is a no-op
	Remove(volumeName string) error
	// Resize resizes an existing volume.
	Resize(volumeName string, size uint64) error
	// GetTenant returns the parent volume or the volume if it is the
	// parent.
	GetTenant(volumeName string) (Volume, error)
	// Get returns the volume with the given name. The volume must exist.
	Get(volumeName string) (Volume, error)
	// Release releases any runtime resources associated with a volume (e.g.,
	// unmounts a device)
	Release(volumeName string) error
	// List returns the names of all volumes managed by this driver
	List() []string
	// Exists returns whether or not a volume managed by this driver exists
	// with the given name
	Exists(volumeName string) bool
	// Cleanup releases any runtime resources held by the driver itself.
	Cleanup() error
	// Status gets the status of the volume
	Status() (Status, error)
}

type DriverInit func(root string, args []string) (Driver, error)

type DriverType string

type FileInfoSlice []os.FileInfo

type SimpleStatus struct {
	Driver     DriverType
	DriverData map[string]string
	UsageData  UsageData
}

type SnapshotInfo struct {
	Name     string
	TenantID string
	Label    string
	Tags     []string
	Message  string
	Created  time.Time
}

type Status interface {
	String() string
	GetUsageData() UsageData
}

type Statuses struct {
	DeviceMapperStatusMap map[string]*DeviceMapperStatus
	SimpleStatusMap       map[string]*SimpleStatus
}

type TenantStorageStats struct {
	TenantID            string
	VolumePath          string
	PoolAvailableBlocks uint64

	DeviceName string

	DeviceTotalBlocks       uint64
	DeviceAllocatedBlocks   uint64
	DeviceUnallocatedBlocks uint64

	FilesystemTotal     uint64
	FilesystemUsed      uint64
	FilesystemAvailable uint64

	Errors []string

	NumberSnapshots         int
	SnapshotAllocatedBlocks uint64
}

type Usage interface {
	GetMetricName() string
	GetLabel() string
	GetType() string
	GetValueUInt64() (uint64, error)
	GetValueFloat64() (float64, error)
}

type UsageData []Usage

type UsageFloat struct {
	MetricName string
	Label      string
	Type       string
	Value      float64
}

type UsageInt struct {
	MetricName string
	Label      string
	Type       string
	Value      uint64
}

type Volume interface {
	// Name returns the name of this volume
	Name() string
	// Path returns the filesystem path to this volume
	Path() string
	// Driver returns the driver managing this volume
	Driver() Driver
	// Snapshot snapshots the current state of this volume and stores it
	// using the name <label>
	Snapshot(label, message string, tags []string) (err error)
	// SnapshotInfo returns general information about a particular snapshot
	SnapshotInfo(label string) (*SnapshotInfo, error)
	// WriteMetadata returns a handle to write metadata to a snapshot
	WriteMetadata(label, name string) (io.WriteCloser, error)
	// ReadMetadata returns a handle to read metadata from a snapshot
	ReadMetadata(label, name string) (io.ReadCloser, error)
	// Snapshots lists all snapshots of this volume
	Snapshots() ([]string, error)
	// RemoveSnapshot removes the snapshot with name <label>
	RemoveSnapshot(label string) error
	// Rollback replaces the current state of the volume with that snapshotted
	// as <label>
	Rollback(label string) error
	// TagSnapshot adds a tagName to the snapshot's tag list
	TagSnapshot(label string, tagName string) error
	// UntagSnapshot removes a tagName from the snapshot's tag list
	UntagSnapshot(tagName string) (string, error)
	// GetSnapshotWithTag returns info about the snapshot with the given tag, or nil if there isn't one
	GetSnapshotWithTag(tagName string) (*SnapshotInfo, error)
	// Export exports the snapshot stored as <label> to <filename>
	Export(label, parent string, writer io.Writer, excludes []string) error
	// Import imports the exported snapshot at <filename> as <label>
	Import(label string, reader io.Reader) error
	// Tenant returns the base tenant of this volume
	Tenant() string
}