sabakan

Documentation

Index

• Constants
• Variables
• func MachineToNode(m *Machine, tmpl *cke.Node) *cke.Node
• func NewIntegrator(etcd *clientv3.Client) server.Integrator
• func Repairer(machines []Machine, repairEntries []*cke.RepairQueueEntry, ...) []*cke.RepairQueueEntry
• func ValidateTemplate(tmpl *cke.Cluster) error
• type BMC
• type Generator
  • func NewGenerator(template *cke.Cluster, cstr *cke.Constraints, machines []Machine, ...) *Generator
  • func (g *Generator) Generate() (*cke.Cluster, error)
  • func (g *Generator) Regenerate(current *cke.Cluster) (*cke.Cluster, error)
  • func (g *Generator) SetWaitSeconds(secs float64)
  • func (g *Generator) Update(current *cke.Cluster) (*cke.Cluster, error)
• type Machine
  • func QueryAvailable(ctx context.Context, storage cke.Storage) ([]Machine, error)
  • func QueryNonHealthy(ctx context.Context, storage cke.Storage) ([]Machine, error)
• type MachineParams
  • func (mp MachineParams) IsValid() error
• type MachineSpec
• type MachineStatus
• type QueryVariables
  • func (v QueryVariables) IsValid() error
• type State
  • func (s State) IsValid() bool

Constants

const (
	// CKELabelRole is the label name to specify node's role
	CKELabelRole = "cke.cybozu.com/role"
	// CKELabelWeight is the label name to specify node's weight
	CKELabelWeight = "cke.cybozu.com/weight"
)

const (
	StateUninitialized = State("UNINITIALIZED")
	StateHealthy       = State("HEALTHY")
	StateUnhealthy     = State("UNHEALTHY")
	StateUnreachable   = State("UNREACHABLE")
	StateUpdating      = State("UPDATING")
	StateRetiring      = State("RETIRING")
	StateRetired       = State("RETIRED")
)

SabakanState list defined in GraphQL schema.

const GraphQLQuery = `` /* 499-byte string literal not displayed */

GraphQLQuery is GraphQL query to retrieve machine information from sabakan.

const (
	// WaitSecs is a context key to pass to change the wait seconds
	// before removing retired nodes from the cluster.
	WaitSecs = sabakanContextKey("wait secs")
)

Variables

var (

	// DefaultWaitRetiredSeconds before removing retired nodes from the cluster.
	DefaultWaitRetiredSeconds = 300.0
)

Functions

func MachineToNode

func MachineToNode(m *Machine, tmpl *cke.Node) *cke.Node

MachineToNode converts sabakan.Machine to cke.Node. Add taints, labels, and annotations according to the rules:

• https://github.com/cybozu-go/cke/blob/main/docs/sabakan-integration.md#taint-nodes
• https://github.com/cybozu-go/cke/blob/main/docs/sabakan-integration.md#node-labels
• https://github.com/cybozu-go/cke/blob/main/docs/sabakan-integration.md#node-annotations

func NewIntegrator

func NewIntegrator(etcd *clientv3.Client) server.Integrator

NewIntegrator returns server.Integrator to add sabakan integration feature to CKE.

func Repairer

func Repairer(machines []Machine, repairEntries []*cke.RepairQueueEntry, rebootEntries []*cke.RebootQueueEntry, nodeStatuses map[string]*cke.NodeStatus, constraints *cke.Constraints) []*cke.RepairQueueEntry

func ValidateTemplate

func ValidateTemplate(tmpl *cke.Cluster) error

ValidateTemplate validates cluster template.

Types

type BMC

type BMC struct {
	Type string `json:"bmcType"`
}

BMC represents the BMC of a machine registered with sabakan.

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator generates cluster configuration.

func NewGenerator

func NewGenerator(template *cke.Cluster, cstr *cke.Constraints, machines []Machine, clusterStatus *cke.ClusterStatus, currentTime time.Time) *Generator

NewGenerator creates a new Generator. template must have been validated with ValidateTemplate().

func (*Generator) Generate

func (g *Generator) Generate() (*cke.Cluster, error)

Generate generates a new *Cluster that satisfies constraints.

func (*Generator) Regenerate

func (g *Generator) Regenerate(current *cke.Cluster) (*cke.Cluster, error)

Regenerate regenerates *Cluster using the same set of nodes in the current configuration. This method should be used only when the template is updated and no other changes happen.

func (*Generator) SetWaitSeconds

func (g *Generator) SetWaitSeconds(secs float64)

SetWaitSeconds set seconds before removing retired nodes from the cluster.

func (*Generator) Update

func (g *Generator) Update(current *cke.Cluster) (*cke.Cluster, error)

Update updates the current configuration when necessary. If the generator decides no updates are necessary, it returns (nil, nil).

type Machine

type Machine struct {
	Spec   MachineSpec   `json:"spec"`
	Status MachineStatus `json:"status"`
}

Machine represents a machine registered with sabakan.

func QueryAvailable

func QueryAvailable(ctx context.Context, storage cke.Storage) ([]Machine, error)

QueryAvailable sends a GraphQL query to sabakan to retrieve available machines information. If sabakan URL is not set, this returns (nil, cke.ErrNotFound).

func QueryNonHealthy

func QueryNonHealthy(ctx context.Context, storage cke.Storage) ([]Machine, error)

QueryNonHealthy sends a GraphQL query to sabakan to retrieve non-healthy machines information. If sabakan URL is not set, this returns (nil, cke.ErrNotFound).

type MachineParams

type MachineParams struct {
	Labels []struct {
		Name  string `json:"name"`
		Value string `json:"value"`
	} `json:"labels"`
	Racks               []int    `json:"racks"`
	Roles               []string `json:"roles"`
	States              []State  `json:"states"`
	MinDaysBeforeRetire *int     `json:"minDaysBeforeRetire,omitempty"`
}

MachineParams is the query parameter type.

func (MachineParams) IsValid

func (mp MachineParams) IsValid() error

IsValid returns non-nil error if mp is not valid.

type MachineSpec

type MachineSpec struct {
	Serial string `json:"serial"`
	Labels []struct {
		Name  string `json:"name"`
		Value string `json:"value"`
	} `json:"labels"`
	Rack         int       `json:"rack"`
	IndexInRack  int       `json:"indexInRack"`
	Role         string    `json:"role"`
	IPv4         []string  `json:"ipv4"`
	RegisterDate time.Time `json:"registerDate"`
	RetireDate   time.Time `json:"retireDate"`
	BMC          BMC       `json:"bmc"`
}

MachineSpec represents the spec of a machine registered with sabakan.

type MachineStatus

type MachineStatus struct {
	State    State   `json:"state"`
	Duration float64 `json:"duration"`
}

MachineStatus represents the status of a machine registered with sabakan.

type QueryVariables

type QueryVariables struct {
	Having    *MachineParams `json:"having"`
	NotHaving *MachineParams `json:"notHaving"`
}

QueryVariables represents the JSON object of the query variables.

func (QueryVariables) IsValid

func (v QueryVariables) IsValid() error

IsValid returns non-nil error if v is not valid.

type State

type State string

State is the enum type for sabakan states.

func (State) IsValid

func (s State) IsValid() bool

IsValid returns true if s is vaild.