Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrNotImplemented errors.AutoscalerError = errors.NewAutoscalerError(errors.InternalError, "Not implemented")
ErrNotImplemented is returned if a method is not implemented.
Functions ¶
This section is empty.
Types ¶
type CloudProvider ¶
type CloudProvider interface { // Name returns name of the cloud provider. Name() string // NodeGroups returns all node groups configured for this cloud provider. NodeGroups() []NodeGroup // NodeGroupForNode returns the node group for the given node, nil if the node // should not be processed by cluster autoscaler, or non-nil error if such // occurred. NodeGroupForNode(*apiv1.Node) (NodeGroup, error) // Pricing returns pricing model for this cloud provider or error if not available. Pricing() (PricingModel, errors.AutoscalerError) }
CloudProvider contains configuration info and functions for interacting with cloud provider (GCE, AWS, etc).
type NodeGroup ¶
type NodeGroup interface { // MaxSize returns maximum size of the node group. MaxSize() int // MinSize returns minimum size of the node group. MinSize() int // TargetSize returns the current target size of the node group. It is possible that the // number of nodes in Kubernetes is different at the moment but should be equal // to Size() once everything stabilizes (new nodes finish startup and registration or // removed nodes are deleted completely) TargetSize() (int, error) // IncreaseSize increases the size of the node group. To delete a node you need // to explicitly name it and use DeleteNode. This function should wait until // node group size is updated. IncreaseSize(delta int) error // DeleteNodes deletes nodes from this node group. Error is returned either on // failure or if the given node doesn't belong to this node group. This function // should wait until node group size is updated. DeleteNodes([]*apiv1.Node) error // DecreaseTargetSize decreases the target size of the node group. This function // doesn't permit to delete any existing node and can be used only to reduce the // request for new nodes that have not been yet fulfilled. Delta should be negative. // It is assumed that cloud provider will not delete the existing nodes if the size // when there is an option to just decrease the target. DecreaseTargetSize(delta int) error // Id returns an unique identifier of the node group. Id() string // Debug returns a string containing all information regarding this node group. Debug() string // Nodes returns a list of all nodes that belong to this node group. Nodes() ([]string, error) // TemplateNodeInfo returns a schedulercache.NodeInfo structure of an empty // (as if just started) node. This will be used in scale-up simulations to // predict what would a new node look like if a node group was expanded. The returned // NodeInfo is expected to have a fully populated Node object, with all of the labels, // capacity and allocatable information as well as all pods that are started on // the node by default, using manifest (most likely only kube-proxy). TemplateNodeInfo() (*schedulercache.NodeInfo, error) }
NodeGroup contains configuration info and functions to control a set of nodes that have the same capacity and set of labels.
type NodeGroupDiscoveryOptions ¶
type NodeGroupDiscoveryOptions struct { // NodeGroupSpecs is specified to statically discover node groups listed in it NodeGroupSpecs []string // NodeGroupAutoDiscoverySpec is specified for automatically discovering node groups according to the specs NodeGroupAutoDiscoverySpec string }
NodeGroupDiscoveryOptions contains various options to configure how a cloud provider discovers node groups
func (NodeGroupDiscoveryOptions) AutoDiscoverySpecified ¶
func (o NodeGroupDiscoveryOptions) AutoDiscoverySpecified() bool
AutoDiscoverySpecified returns true only when there is --node-group-auto-discovery specified
func (NodeGroupDiscoveryOptions) StaticDiscoverySpecified ¶
func (o NodeGroupDiscoveryOptions) StaticDiscoverySpecified() bool
StaticDiscoverySpecified returns true only when there are 1 or more --nodes flags are specified
func (NodeGroupDiscoveryOptions) Validate ¶
func (o NodeGroupDiscoveryOptions) Validate() error
Validate returns and error when both --nodes and --node-group-auto-discovery are specified
type PricingModel ¶
type PricingModel interface { // NodePrice returns a price of running the given node for a given period of time. // All prices returned by the structure should be in the same currency. NodePrice(node *apiv1.Node, startTime time.Time, endTime time.Time) (float64, error) // PodePrice returns a theoretical minimum priece of running a pod for a given // period of time on a perfectly matching machine. PodPrice(pod *apiv1.Pod, startTime time.Time, endTime time.Time) (float64, error) }
PricingModel contains information about the node price and how it changes in time.