Documentation ¶
Overview ¶
Package cluster implements kind kubernetes-in-docker cluster management
Index ¶
- Constants
- func IsKnown(name string) (bool, error)
- type Context
- func (c *Context) CollectLogs(dir string) error
- func (c *Context) Create(options ...create.ClusterOption) error
- func (c *Context) Delete() error
- func (c *Context) KubeConfigPath() string
- func (c *Context) ListInternalNodes() ([]nodes.Node, error)
- 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
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Context ¶
type Context struct {
// contains filtered or unexported fields
}
Context is used to create / manipulate kubernetes-in-docker clusters See: NewContext()
func NewContext ¶
NewContext returns a new cluster management context if name is "" the default name will be used (constants.DefaultClusterName)
func (*Context) CollectLogs ¶
CollectLogs will populate dir with cluster logs and other debug files
func (*Context) Create ¶
func (c *Context) Create(options ...create.ClusterOption) error
Create provisions and starts a kubernetes-in-docker cluster
func (*Context) KubeConfigPath ¶
KubeConfigPath returns the path to where the Kubeconfig would be placed by kind based on the configuration.
func (*Context) ListInternalNodes ¶ added in v0.4.0
ListInternalNodes returns the list of container IDs for the "nodes" in the cluster that are not external
func (*Context) ListNodes ¶
ListNodes returns the list of container IDs for the "nodes" in the cluster
func (*Context) Validate ¶
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.
Directories ¶
Path | Synopsis |
---|---|
Package constants contains well known constants for kind clusters
|
Package constants contains well known constants for kind clusters |
Package nodes contains functionality for Kubernetes-in-Docker nodes It mostly exists to break up functionality from sigs.k8s.io/kind/pkg/cluster
|
Package nodes contains functionality for Kubernetes-in-Docker nodes It mostly exists to break up functionality from sigs.k8s.io/kind/pkg/cluster |