api

Documentation

Index

• type Cluster

Types

type Cluster

type Cluster interface {
	// GetService ...
	GetService(task concurrency.Task) iaas.Service
	// GetIdentity returns the identity of the cluster (name, flavor, complexity)
	GetIdentity(task concurrency.Task) identity.Identity
	// GetNetworkConfig returns network configuration of the cluster
	GetNetworkConfig(concurrency.Task) (propsv2.Network, error)
	// GetProperties returns the extension of the cluster
	GetProperties(concurrency.Task) *serialize.JSONProperties

	// Start starts the cluster
	Start(concurrency.Task) error
	// Stop stops the cluster
	Stop(concurrency.Task) error
	// GetState returns the current state of the cluster
	GetState(concurrency.Task) (ClusterState.Enum, error)
	// AddNode adds a node
	AddNode(concurrency.Task, *pb.HostDefinition) (string, error)
	// AddNodes adds several nodes
	AddNodes(concurrency.Task, int, *pb.HostDefinition) ([]string, error)
	// DeleteLastNode deletes a node
	DeleteLastNode(concurrency.Task, string) error
	// DeleteSpecificNode deletes a node identified by its ID
	DeleteSpecificNode(concurrency.Task, string, string) error
	// ListMasters lists the masters (if there is such masters in the flavor...)
	ListMasters(concurrency.Task) []*propsv1.Node
	// ListMasterNames lists the names of masters (if there is such masters in the flavor...)
	ListMasterNames(concurrency.Task) []string
	// ListMasterIDs lists the IDs of masters (if there is such masters in the flavor...)
	ListMasterIDs(concurrency.Task) []string
	// ListMasterIPs lists the IPs of masters (if there is such masters in the flavor...)
	ListMasterIPs(concurrency.Task) []string
	// FindAvailableMaster returns ID of the first master available to execute order
	FindAvailableMaster(concurrency.Task) (string, error)
	// ListNodes lists Nodes in the cluster
	ListNodes(concurrency.Task) []*propsv1.Node
	// ListNodeNames lists IDs of the nodes in the cluster
	ListNodeNames(concurrency.Task) []string
	// ListNodeIDs lists IDs of the nodes in the cluster
	ListNodeIDs(concurrency.Task) []string
	// ListNodeIPs lists the IPs of the nodes in the cluster
	ListNodeIPs(concurrency.Task) []string
	// FindAvailableNode returns ID of the first node available to execute order
	FindAvailableNode(concurrency.Task) (string, error)
	// SearchNode tells if the ID of the host passed as parameter is a node
	SearchNode(concurrency.Task, string) bool
	// GetNode returns a node based on its ID
	GetNode(concurrency.Task, string) (*pb.Host, error)
	// CountNodes counts the nodes of the cluster
	CountNodes(concurrency.Task) (uint, error)

	// Delete allows to destroy infrastructure of cluster
	Delete(concurrency.Task) error
}

Cluster is an interface of methods associated to Cluster-like structs