drivercore

type Driver interface {
	// Name returns the unique name for a Driver. It should be short.
	Name() string
	// Description returns a short description of the Driver.
	Description() string
	// UsesPerClusterNetworking should return true if the Driver supports
	// creation of isolated Networks (NAT or routed) per cluster.
	UsesPerClusterNetworking() bool
	// UsesNATNetworking should return true if the networking used by the
	// Driver implements NAT, and therefore Machine ports need forwarding.
	UsesNATNetworking() bool
	// Status returns the current status of the Driver.
	Status() string
	// Error returns the last error reported by the Driver.
	Error() string

	// QualifiedNetworkName returns a unique Network name for a cluster.
	QualifiedNetworkName(clustername string) string
	// DeleteNetwork deletes the Network for a cluster.
	DeleteNetwork(clustername string) error
	// NewNetwork creates a new Network for a cluster.
	NewNetwork(clustername string) (Network, error)

	// QualifiedMachineName returns a unique name for a Machine in a cluster.
	// This name is usually used internally by a Driver.
	QualifiedMachineName(machinename string, clustername string) string
	// GetMachine returns a Machine in a cluster.
	GetMachine(machinename string, clustername string) (Machine, error)
	// DeleteMachine deletes a Machine in a cluster.
	DeleteMachine(machinename string, clustername string) error
	// NewMachine creates a new Machine in a cluster, usually using an Image
	// for the supplied Kubernetes version.
	NewMachine(machinename string, clustername string, k8sversion string) (Machine, error)

	// UpdateImageList fetches the latest list of Images from a driver-defined
	// source, and stores it locally.
	UpdateImageList() error
	// ValidK8sVersion returns true if the specified Kubernetes version is
	// available in the local list.
	ValidK8sVersion(k8sversion string) bool
	// K8sVersions returns all Kubernetes versions currently supported by a
	// Driver. This should come from the local list.
	K8sVersions() []string
	// ListImages returns the currently available Images from the local list.
	ListImages() ([]Image, error)
	// GetImage returns the Image for a Kubernetes version, or an error.
	GetImage(k8sversion string) (Image, error)
}

type Image interface {
	// K8sVersion returns the version of Kubernetes components in the image.
	K8sVersion() string
	// Status can be Notdownloaded, Downloaded or Unknown.
	Status() ImageStatus
	// Deprecated returns true if the image is no longer supported.
	Deprecated() bool

	// Fetch downloads the image from the driver repository into the local cache.
	Fetch() error
	// FetchWithProgress downloads the image from the driver repository into the
	// local cache, and reports progress via the supplied callback. The callback
	// reports current and total in bytes.
	FetchWithProgress(progress func(current int64, total int64)) error
	// FromFile imports the image from the local filesystem into the local cache.
	FromFile(filepath string) error
	// PurgeLocal removes the image from the local cache.
	PurgeLocal() error
}

type ImageStatus string

type Machine interface {
	// Name is the name of the machine.
	// The operating system hostname should match this.
	Name() string
	// Status can be drivercore.MachineStatusRunning, drivercore.MachineStatusStopped
	// drivercore.MachineStatusUnknown or drivercore.MachineStatusError.
	Status() MachineStatus
	// Error returns the last error caused when manipulating this machine.
	// A valid value can be expected only when Status() returns
	// drivercore.MachineStatusError.
	Error() string

	// IPAddress returns the current IP Address of this Machine.
	// A valid value can be expected only when Status() returns
	// drivercore.MachineStatusRunning.
	IPAddress() string
	// SSHAddress returns the host address and port number to SSH into this Machine.
	// For drivers that use NAT netwoking, the host address will be 'localhost'.
	SSHAddress() string

	// Start starts a Machine.
	// Note that a Machine may not be ready for further operations at the end of this,
	// and therefore its status may not change immediately.
	// See WaitForStateChange().
	Start() error
	// Stop stops a Machine.
	// Note that a Machine may not be ready for further operations at the end of this,
	// and therefore its status will not change immediately.
	// See WaitForStateChange().
	Stop() error
	// ForceStop stops a Machine forcibly.
	// This operation should set the status to drivercore.MachineStatusStopped.
	ForceStop() error
	// WaitForStateChange waits the specified number of seconds, or until the Machine
	// status changes.
	// WaitForStateChange should be called after calls to Start() or Stop(), before
	// any other operation. It should not be called _before_ Stop().
	WaitForStateChange(timeoutinseconds int)

	// ForwardPort creates a rule to forward the specified Machine port to the
	// specified physical host port.
	ForwardPort(hostport int, machineport int) error
	// UnforwardPort removes the rule which forwarded the specified Machine port.
	UnforwardPort(machineport int) error
	// ForwardSSHPort forwards the SSH port of this Machine to the specified
	// physical host port.
	ForwardSSHPort(hostport int) error

	// ImplementsCommand returns true if the driver implements the specified
	// predefined operation.
	ImplementsCommand(command PredefinedCommand) bool
	// ExecuteCommand executes the specified predefined operation.
	ExecuteCommand(command PredefinedCommand, params ...string) error
}

type MachineStatus string

type Network interface {
	// Name is the name of the network.
	Name() string
	// CIDR is the network's IPv4 address range.
	CIDR() string

	// SetCIDR sets a new IPv4 address range, in CIDR format.
	SetCIDR(cidr string)
}

type PredefinedCommand string