cluster

Documentation

Overview

Package cluster implements kind kubernetes-in-docker cluster management

Index

• Constants
• type Context
  • func List() ([]Context, error)
  • func NewContext(name string) *Context
  • func (c *Context) ClusterName() string
  • func (c *Context) CollectLogs(dir string) error
  • func (c *Context) Create(cfg *config.Config, retain bool, wait time.Duration) error
  • func (c *Context) Delete() error
  • func (c *Context) GetControlPlaneMeta() (*ControlPlaneMeta, error)
  • func (c *Context) ListNodes() ([]nodes.Node, error)
  • func (c *Context) Validate() error
• type ControlPlaneMeta

Constants

const DefaultName = "1"

DefaultName is the default Context name TODO(bentheelder): consider removing automatic prefixing in favor of letting the user specify the full name..

Types

type Context

type Context struct {
	*meta.ClusterMeta
}

Context is used to create / manipulate kubernetes-in-docker clusters See: NewContext()

func List

func List() ([]Context, error)

List returns a list of clusters for which node containers exist

func NewContext

func NewContext(name string) *Context

NewContext returns a new cluster management context if name is "" the default ("1") will be used

func (*Context) ClusterName

func (c *Context) ClusterName() string

ClusterName returns the Kubernetes cluster name based on the context name currently this is .Name prefixed with "kind-"

func (*Context) CollectLogs

func (c *Context) CollectLogs(dir string) error

CollectLogs will populate dir with cluster logs and other debug files

func (*Context) Create

func (c *Context) Create(cfg *config.Config, retain bool, wait time.Duration) error

Create provisions and starts a kubernetes-in-docker cluster

func (*Context) Delete

func (c *Context) Delete() error

Delete tears down a kubernetes-in-docker cluster

func (*Context) GetControlPlaneMeta

func (c *Context) GetControlPlaneMeta() (*ControlPlaneMeta, error)

GetControlPlaneMeta attempts to retreive / compute metadata about the control plane for the context's cluster NOTE: due to refactoring this is currently non-functional (!) TODO(bentheelder): fix this

func (*Context) ListNodes

func (c *Context) ListNodes() ([]nodes.Node, error)

ListNodes returns the list of container IDs for the "nodes" in the cluster

func (*Context) Validate

func (c *Context) Validate() error

Validate will be called before creating new resources using the context It will not be called before deleting or listing resources, so as to allow contexts based around previously valid values to be used in newer versions You can call this early yourself to check validation before creation calls, though it will be called internally.

type ControlPlaneMeta

type ControlPlaneMeta struct {
	// APIServerPort is the port that the container is forwarding to the
	// Kubernetes API server running in the container
	APIServerPort int
}

ControlPlaneMeta tracks various outputs that are relevant to the control plane created with Kind. Here we can define things like ports and listen or bind addresses as needed.