api

type Alerts struct {
}

type Cluster struct {
	Status Status
	Id     string
	Nodes  []Node
}

type ClusterActionParam int

type ClusterResponse struct {
	// Error is "" on success or contains the error message on failure.
	Error string `json:"error"`
}

type ClusterStateAction struct {
	// Remove a node or a set of nodes
	Remove ClusterActionParam `json:"remove"`

	// Shutdown a node or a set of nodes
	Shutdown ClusterActionParam `json:"shutdown"`
}

type ClusterStateResponse struct {
	// VolumeStateRequest the current state of the volume
	ClusterStateAction
	ClusterResponse
}

type DriverType int

type Filesystem string

type GraphDriverChanges struct {
	Path string // "/some/path"
	Kind int
}

type Labels map[string]string

type MachineID string

type Node struct {
	Id         string
	Cpu        float64 // percentage.
	Memory     float64 // percentage.
	Luns       map[string]systemutils.Lun
	Avgload    int
	Ip         string
	Timestamp  time.Time
	Status     Status
	Containers []docker.APIContainers
	NodeData   map[string]interface{}
	GenNumber  uint64
}

type OptionKey string

type SnapCreateRequest struct {
	ID       VolumeID      `json:"id"`
	Locator  VolumeLocator `json:"locator"`
	Readonly bool          `json:"readonly"`
}

type SnapCreateResponse struct {
	VolumeCreateResponse
}

type Source struct {
	// Parent if specified will create a clone of Parent.
	Parent VolumeID
	// Seed will seed the volume from the specified URI. Any
	// additional config for the source comes from the labels in the spec.
	Seed string
}

type Stats struct {
	// Reads completed successfully.
	Reads int64
	// ReadMs time spent in reads in ms.
	ReadMs int64
	// ReadBytes
	ReadBytes int64
	// Writes completed successfully.
	Writes int64
	// WriteBytes
	WriteBytes int64
	// WriteMs time spent in writes in ms.
	WriteMs int64
	// IOProgress I/Os curently in progress.
	IOProgress int64
	// IOMs time spent doing I/Os ms.
	IOMs int64
}

type Status int

type Volume struct {
	// ID Self referential VolumeID
	ID VolumeID
	// Source
	Source *Source
	// Readonly
	Readonly bool
	// Locator User specified locator
	Locator VolumeLocator
	// Ctime Volume creation time
	Ctime time.Time
	// Spec User specified VolumeSpec
	Spec *VolumeSpec
	// Usage Volume usage
	Usage uint64
	// LastScan time when an integrity check for run
	LastScan time.Time
	// Format Filesystem type if any
	Format Filesystem
	// Status see VolumeStatus
	Status VolumeStatus
	// State see VolumeState
	State VolumeState
	// AttachedOn - Node on which this volume is attached.
	AttachedOn MachineID
	// DevicePath
	DevicePath string
	// AttachPath
	AttachPath string
	// ReplicaSet Set of nodes no which this Volume is erasure coded - for clustered storage arrays
	ReplicaSet []MachineID
	// Error Last recorded error
	Error string
}

type VolumeActionParam int

type VolumeCos int

type VolumeCreateRequest struct {
	// Locator user specified volume name and labels.
	Locator VolumeLocator `json:"locator"`
	// Source to create volume
	Source *Source `json:"source,omitempty"`
	// Spec is the storage spec for the volume
	Spec *VolumeSpec `json:"spec,omitempty"`
}

type VolumeCreateResponse struct {
	// ID of the newly created volume
	ID VolumeID `json:"id"`
	VolumeResponse
}

type VolumeID string

type VolumeInfo struct {
	Path     string
	Storage  *VolumeSpec
	VolumeID VolumeID
}

type VolumeLocator struct {
	// Name user friendly identifier
	Name string
	// VolumeLabels set of name-value pairs that acts as search filters.
	VolumeLabels Labels
}

type VolumeResponse struct {
	// Error is "" on success or contains the error message on failure.
	Error string `json:"error"`
}

type VolumeSetRequest struct {
	// Locator user specified volume name and labels.
	Locator *VolumeLocator `json:"locator,omitempty"`
	// Spec is the storage spec for the volume
	Spec *VolumeSpec `json:"spec,omitempty"`
	// Action state modification on this volume.
	Action *VolumeStateAction `json:"action,omitempty"`
}

type VolumeSetResponse struct {
	// Volume updated volume
	Volume
	// VolumeResponse error status
	VolumeResponse
}

type VolumeSpec struct {
	// Ephemeral storage
	Ephemeral bool
	// Thin provisioned volume size in bytes
	Size uint64
	// Format disk with this FileSystem
	Format Filesystem
	// BlockSize for file system
	BlockSize int
	// HA Level specifies the number of nodes that are
	// allowed to fail, and yet data is availabel.
	// A value of 0 implies that data is not erasure coded,
	// a failure of a node will lead to data loss.
	HALevel int
	// This disk's CoS
	Cos VolumeCos
	// Perform dedupe on this disk
	Dedupe bool
	// SnapshotInterval in minutes, set to 0 to disable Snapshots
	SnapshotInterval int
	// Volume configuration labels
	ConfigLabels Labels
}

type VolumeState int

type VolumeStateAction struct {
	// Attach or Detach volume
	Attach VolumeActionParam `json:"attach"`
	// Mount or unmount volume
	Mount VolumeActionParam `json:"mount"`
	// MountPath
	MountPath string `json:"mount_path"`
	// DevicePath returned in Attach
	DevicePath string `json:"device_path"`
}

type VolumeStatus string