cloudops.go

//go:generate mockgen --package=mock -destination=mock/cloudops.mock.go github.com/libopenstorage/cloudops Ops

package cloudops

import "time"

const (
	// SetIdentifierNone is a default identifier to group all disks from a
	// particular set
	SetIdentifierNone = "None"
)

// ProviderType is an enum indicating the different cloud provider supported by cloudops
type ProviderType string

const (
	// List of supported cloud providers

	// AWS provider
	AWS ProviderType = "aws"
	// Azure provider
	Azure = "azure"
	// Vsphere provider
	Vsphere = "vsphere"
	// GCE provider
	GCE = "gce"
	// CSI provider
	CSI = "csi"
	// IBM provider
	IBM = "ibm"
	// Pure provider
	Pure = "pure"
	// Oracle provider
	Oracle = "oracle"

	// DryRunOption is the key to tell if dry run the request
	DryRunOption = "dry-run"
)

// CloudResourceInfo provides metadata information on a cloud resource.
type CloudResourceInfo struct {
	// Name of the cloud resource.
	Name string
	// ID of the cloud resource.
	ID string
	// Labels on the cloud resource.
	Labels map[string]string
	// Zone where the resource exists.
	Zone string
	// Region where the resource exists.
	Region string
}

// InstanceGroupInfo encapsulates info for a cloud instance group. In AWS this
// maps to ASG.
type InstanceGroupInfo struct {
	CloudResourceInfo
	// AutoscalingEnabled is true if auto scaling is turned on
	AutoscalingEnabled bool
	// Min number of nodes in the instance group
	Min *int64
	// Max number of nodes in the instance group
	Max *int64
	// Zones that the instance group is part of
	Zones []string
}

// InstanceInfo encapsulates info for a cloud instance
type InstanceInfo struct {
	CloudResourceInfo
	// State is the current state of the instance
	State InstanceState
}

// InstanceState is an enum for the current state of a compute instance
type InstanceState uint64

const (
	// InstanceStateUnknown unknown instance state
	InstanceStateUnknown InstanceState = iota
	// InstanceStateOnline instance is online
	InstanceStateOnline
	// InstanceStateOffline instance is offline
	InstanceStateOffline
	// InstanceStateTerminating instance is terminating
	InstanceStateTerminating
	// InstanceStateStarting instance is starting
	InstanceStateStarting
)

// Compute interface to manage compute instances.
type Compute interface {
	// DeleteInstance deletes the instance
	DeleteInstance(instanceID string, zone string, timeout time.Duration) error
	// InstanceID of instance where command is executed.
	InstanceID() string
	// InspectInstance inspects the node with the given instance ID
	// TODO: Add support for taking zone as input to inspect instance in any zone
	InspectInstance(instanceID string) (*InstanceInfo, error)
	// InspectInstanceGroupForInstance inspects the instance group to which the
	// cloud instance with given ID belongs
	InspectInstanceGroupForInstance(instanceID string) (*InstanceGroupInfo, error)
	// GetInstance returns cloud provider specific instance details
	GetInstance(displayName string) (interface{}, error)
	// SetInstanceGroupSize sets desired node count per availability zone
	// for given instance group
	SetInstanceGroupSize(instanceGroupID string,
		count int64,
		timeout time.Duration) error
	// GetInstanceGroupSize returns current node count of given instance group
	GetInstanceGroupSize(instanceGroupID string) (int64, error)
	// GetClusterSizeForInstance returns current node count in given cluster
	// This count is total node count across all availability zones
	GetClusterSizeForInstance(instanceID string) (int64, error)
	// SetClusterVersion sets desired version for the cluster
	SetClusterVersion(version string, timeout time.Duration) error
	// SetInstanceGroupVersion sets desired node group version
	SetInstanceGroupVersion(instanceGroupID string,
		version string,
		timeout time.Duration) error
	// SetInstanceUpgradeStrategy sets desired Upgrade strategy & respective parameters for the node group
	SetInstanceUpgradeStrategy(instanceGroupID string,
		upgradeStrategy string,
		timeout time.Duration,
		surgeSetting string) error
}

// Storage interface to manage storage operations.
type Storage interface {
	// Create volume based on input template volume and also apply given labels.
	Create(template interface{}, labels map[string]string, options map[string]string) (interface{}, error)
	// GetDeviceID returns ID/Name of the given device/disk or snapshot
	GetDeviceID(template interface{}) (string, error)
	// Attach volumeID, accepts attachoOptions as opaque data
	// Return attach path.
	Attach(volumeID string, options map[string]string) (string, error)
	// IsVolumeReadyToExpand pre-checks if a pool of volumes are in a state that can
	// be modified. Should be called before sending an expand request to the cloud provider.
	AreVolumesReadyToExpand(volumeIDs []*string) (bool, error)
	// Expand expands the provided device from the existing size to the new size
	// It returns the new size of the device. It is a blocking API where it will
	// only return once the requested size is validated with the cloud provider or
	// the number of retries prescribed by the cloud provider are exhausted.
	Expand(volumeID string, newSizeInGiB uint64, options map[string]string) (uint64, error)
	// Detach volumeID.
	Detach(volumeID string, options map[string]string) error
	// DetachFrom detaches the disk/volume with given ID from the given instance ID
	DetachFrom(volumeID, instanceID string) error
	// Delete volumeID.
	Delete(volumeID string, options map[string]string) error
	// DeleteFrom deletes the given volume/disk from the given instanceID
	DeleteFrom(volumeID, instanceID string) error
	// Desribe an instance
	Describe() (interface{}, error)
	// FreeDevices returns free block devices on the instance.
	// blockDeviceMappings is a data structure that contains all block devices on
	// the instance and where they are mapped to
	FreeDevices() ([]string, error)
	// Inspect volumes specified by volumeID
	Inspect(volumeIds []*string, options map[string]string) ([]interface{}, error)
	// DeviceMappings returns map[local_attached_volume_path]->volume ID/NAME
	DeviceMappings() (map[string]string, error)
	// Enumerate volumes that match given filters. Organize them into
	// sets identified by setIdentifier.
	// labels can be nil, setIdentifier can be empty string.
	Enumerate(volumeIds []*string,
		labels map[string]string,
		setIdentifier string,
	) (map[string][]interface{}, error)
	// DevicePath for the given volume i.e path where it's attached
	DevicePath(volumeID string) (string, error)
	// Snapshot the volume with given volumeID
	Snapshot(volumeID string, readonly bool, options map[string]string) (interface{}, error)
	// SnapshotDelete deletes the snapshot with given ID
	SnapshotDelete(snapID string, options map[string]string) error
	// ApplyTags will apply given labels/tags on the given volume
	ApplyTags(volumeID string, labels map[string]string, options map[string]string) error
	// RemoveTags removes labels/tags from the given volume
	RemoveTags(volumeID string, labels map[string]string, options map[string]string) error
	// Tags will list the existing labels/tags on the given volume
	Tags(volumeID string) (map[string]string, error)
}

// Ops interface to perform basic cloud operations.
type Ops interface {
	// Name returns name of the cloud operations driver
	Name() string
	// Storage operations in the cloud
	Storage
	// Compute operations in the cloud
	Compute
}