cluster

Documentation

Overview

Package cluster implements kind kubernetes-in-docker cluster management

Index

• Constants
• func IsKnown(name string) (bool, error)
• type Context
  • func List() ([]Context, error)
  • func NewContext(name string) *Context
  • func (c *Context) CollectLogs(dir string) error
  • func (c *Context) Create(cfg *config.Cluster, options ...create.ClusterOption) error
  • func (c *Context) Delete() error
  • func (c *Context) KubeConfigPath() string
  • func (c *Context) ListNodes() ([]nodes.Node, error)
  • func (c *Context) Name() string
  • func (c *Context) Validate() error

Constants

const DefaultName = constants.DefaultClusterName

DefaultName is the default cluster name

Functions

func IsKnown

func IsKnown(name string) (bool, error)

IsKnown return true if a cluster exists with the given name. If obtaining the list of known clusters fails the function returns an error.

Types

type Context

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

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 name will be used (constants.DefaultClusterName)

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.Cluster, options ...create.ClusterOption) 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) KubeConfigPath

func (c *Context) KubeConfigPath() string

KubeConfigPath returns the path to where the Kubeconfig would be placed by kind based on the configuration.

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) Name

func (c *Context) Name() string

Name returns context name / cluster name

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.