provider.go

package api

import (
	"net/url"
	"time"
)

// Modified version from https://github.com/codedellemc/libstorage as an example.
// This is a minimal definition.  Ultimately, this will be the simplest and
// most concise definition that consolidates the goodness from muliple
// service management drivers.

// Service definition. (TBD)
type Service struct {
}

// ServiceSpec are options when creating a new data service.
type ServiceSpec struct {
	AvailabilityZone *string
	IOPS             *int64
	Size             *int64
	Encrypted        *bool
	EncryptionKey    *string
	Options          map[string]string
}

type Capability int

const (
	CapabilityEncryption Capability = iota
	CapabilityCompresssion
	CapabilityDeduplication
	CapabilityReplication
	CapabilityDR
	CapabilityMulitAZ
	CapabilityConverged
)

type DataService struct {
	// ServiceType could be a string such as object, block, file.
	ServiceType  string
	Size         uint64
	Iops         uint64
	Capabilities []Capability
}

type CreateOptions struct {
	// SrcID Create service from source ID
	SrcID string
	// LateBinding allow creation of volume but defers resource allocation
	// to when the service is instantiated.
	LateBinding bool
}

// Provder implements a data service provider.  This interface implements the
// union of the the data service's CRUD commands as well as it's
// lifecycle operations.
type Provider interface {
	// Type returns the type of storage the driver provides.
	Type() (string, error)

	// ServiceType advertises the type of service (block, object, file etc)
	// offered by this provider on a given node.
	ServiceType() (DataService, error)

	// SchedulerQuery returns a list of nodes (IPs) that are preferred nodes
	// to run a container on, given a set of opts.
	SchedulerQuery(
		opts map[string]string,
	) ([]string, error)

	// Enumerate all services that satisfy contraints defined by opts.
	Enumerate(opts map[string]string) ([]*Service, error)

	// Inspect inspects a single service.
	Inspect(
		ID string,
		opts map[string]string,
	) (*Service, error)

	// Create creates a new service.
	Create(
		name string,
		spec *ServiceSpec,
		createOpts *CreateOptions,
		opts map[string]string,
	) (*Service, error)

	// Backup to provider.
	Backup(ID string, provider Provider)

	// Snapshot snapshots a service.
	Snapshot(
		ID, snapshotName string,
		opts map[string]string,
	) (*Service, error)

	// Remove removes a service.
	Remove(
		ID string,
		opts map[string]string,
	) error

	// Attach attaches a service and provides a token clients can use
	// to validate that device has appeared locally.
	Attach(
		ID string,
		opts map[string]string,
	) (*Service, string, error)

	// Detach detaches a service.
	Detach(
		ID string,
		opts map[string]string,
	) (*Service, error)

	// Mount service to specific path.
	Mount(
		ID, mountpoint string,
		opts map[string]string,
	) error

	// Unmount service to specific path.
	Unmount(
		ID, mountpoint string,
		opts map[string]string,
	) error

	// Stat returns the service and network statistics for this provider
	// on a given node.
	Stat() (ServiceStat, NetStat, error)

	// LogStats provides an logging URL for the provider dump
	// service stats to.  An interval of 0 stops the logging.
	LogStats(url url.URL, interval time.Duration) error

	// Alerts returns the alerts for this provider on a given node.
	Alerts() ([]Alert, error)

	// LogAlerts provides an alerting URL for the provider dump
	// service alerts to.  An interval of 0 stops the logging.
	LogAlerts(url url.URL, interval time.Duration) error
}