cluster

Documentation

Overview

Package cluster implements kind kubernetes-in-docker cluster management

Index

• Constants
• Variables
• type CreateOption
  • func CreateWithConfigFile(path string) CreateOption
  • func CreateWithDisplaySalutation(displaySalutation bool) CreateOption
  • func CreateWithDisplayUsage(displayUsage bool) CreateOption
  • func CreateWithKubeconfigPath(explicitPath string) CreateOption
  • func CreateWithNodeImage(nodeImage string) CreateOption
  • func CreateWithRawConfig(raw []byte) CreateOption
  • func CreateWithRetain(retain bool) CreateOption
  • func CreateWithStopBeforeSettingUpKubernetes(stopBeforeSettingUpKubernetes bool) CreateOption
  • func CreateWithV1Alpha4Config(config *v1alpha4.Cluster) CreateOption
  • func CreateWithWaitForReady(waitTime time.Duration) CreateOption
• type Provider
  • func NewProvider(options ...ProviderOption) *Provider
  • func (p *Provider) CollectLogs(name, dir string) error
  • func (p *Provider) Create(name string, options ...CreateOption) error
  • func (p *Provider) Delete(name, explicitKubeconfigPath string) error
  • func (p *Provider) ExportKubeConfig(name string, explicitPath string, internal bool) error
  • func (p *Provider) KubeConfig(name string, internal bool) (string, error)
  • func (p *Provider) List() ([]string, error)
  • func (p *Provider) ListInternalNodes(name string) ([]nodes.Node, error)
  • func (p *Provider) ListNodes(name string) ([]nodes.Node, error)
• type ProviderOption
  • func DetectNodeProvider() (ProviderOption, error)
  • func ProviderWithDocker() ProviderOption
  • func ProviderWithLogger(logger log.Logger) ProviderOption
  • func ProviderWithNerdctl(binaryName string) ProviderOption
  • func ProviderWithPodman() ProviderOption

Constants

const DefaultName = constants.DefaultClusterName

DefaultName is the default cluster name

Variables

var NoNodeProviderDetectedError = errors.NewWithoutStack("failed to detect any supported node provider")

NoNodeProviderDetectedError indicates that we could not autolocate an available NodeProvider backend on the host

Types

type CreateOption

type CreateOption interface {
	// contains filtered or unexported methods
}

CreateOption is a Provider.Create option

func CreateWithConfigFile

func CreateWithConfigFile(path string) CreateOption

CreateWithConfigFile configures the config file path to use

func CreateWithDisplaySalutation

func CreateWithDisplaySalutation(displaySalutation bool) CreateOption

CreateWithDisplaySalutation enables display a salutation at the end of create cluster if displaySalutation is true

func CreateWithDisplayUsage

func CreateWithDisplayUsage(displayUsage bool) CreateOption

CreateWithDisplayUsage enables displaying usage if displayUsage is true

func CreateWithKubeconfigPath

func CreateWithKubeconfigPath(explicitPath string) CreateOption

CreateWithKubeconfigPath sets the explicit --kubeconfig path

func CreateWithNodeImage

func CreateWithNodeImage(nodeImage string) CreateOption

CreateWithNodeImage overrides the image on all nodes in config as an easy way to change the Kubernetes version

func CreateWithRawConfig

func CreateWithRawConfig(raw []byte) CreateOption

CreateWithRawConfig configures the config to use from raw (yaml) bytes

func CreateWithRetain

func CreateWithRetain(retain bool) CreateOption

CreateWithRetain disables deletion of nodes and any other cleanup that would normally occur after a failure to create This is mainly used for debugging purposes

func CreateWithStopBeforeSettingUpKubernetes

func CreateWithStopBeforeSettingUpKubernetes(stopBeforeSettingUpKubernetes bool) CreateOption

CreateWithStopBeforeSettingUpKubernetes enables skipping setting up kubernetes (kubeadm init etc.) after creating node containers This generally shouldn't be used and is only lightly supported, but allows provisioning node containers for experimentation

func CreateWithV1Alpha4Config

func CreateWithV1Alpha4Config(config *v1alpha4.Cluster) CreateOption

CreateWithV1Alpha4Config configures the cluster with a v1alpha4 config

func CreateWithWaitForReady

func CreateWithWaitForReady(waitTime time.Duration) CreateOption

CreateWithWaitForReady configures a maximum wait time for the control plane node(s) to be ready. By default no waiting is performed

type Provider

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

Provider is used to perform cluster operations

func NewProvider

func NewProvider(options ...ProviderOption) *Provider

NewProvider returns a new provider based on the supplied options

func (*Provider) CollectLogs

func (p *Provider) CollectLogs(name, dir string) error

CollectLogs will populate dir with cluster logs and other debug files

func (*Provider) Create

func (p *Provider) Create(name string, options ...CreateOption) error

Create provisions and starts a kubernetes-in-docker cluster

func (*Provider) Delete

func (p *Provider) Delete(name, explicitKubeconfigPath string) error

Delete tears down a kubernetes-in-docker cluster

func (*Provider) ExportKubeConfig

func (p *Provider) ExportKubeConfig(name string, explicitPath string, internal bool) error

ExportKubeConfig exports the KUBECONFIG for the cluster, merging it into the selected file, following the rules from https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#config where explicitPath is the --kubeconfig value.

func (*Provider) KubeConfig

func (p *Provider) KubeConfig(name string, internal bool) (string, error)

KubeConfig returns the KUBECONFIG for the cluster If internal is true, this will contain the internal IP etc. If internal is false, this will contain the host IP etc.

func (*Provider) List

func (p *Provider) List() ([]string, error)

List returns a list of clusters for which nodes exist

func (*Provider) ListInternalNodes

func (p *Provider) ListInternalNodes(name string) ([]nodes.Node, error)

ListInternalNodes returns the list of container IDs for the "nodes" in the cluster that are not external

func (*Provider) ListNodes

func (p *Provider) ListNodes(name string) ([]nodes.Node, error)

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

type ProviderOption

type ProviderOption interface {
	// contains filtered or unexported methods
}

ProviderOption is an option for configuring a provider

func DetectNodeProvider

func DetectNodeProvider() (ProviderOption, error)

DetectNodeProvider allows callers to autodetect the node provider *without* fallback to the default.

Pass the returned ProviderOption to NewProvider to pass the auto-detect Docker or Podman option explicitly (in the future there will be more options)

NOTE: The kind *cli* also checks `KIND_EXPERIMENTAL_PROVIDER` for "podman", "nerctl" or "docker" currently and does not auto-detect / respects this if set.

This will be replaced with some other mechanism in the future (likely when podman support is GA), in the meantime though your tool may wish to match this.

In the future when this is not considered experimental, that logic will be in a public API as well.

func ProviderWithDocker

func ProviderWithDocker() ProviderOption

ProviderWithDocker configures the provider to use docker runtime

func ProviderWithLogger

func ProviderWithLogger(logger log.Logger) ProviderOption

ProviderWithLogger configures the provider to use Logger logger

func ProviderWithNerdctl

func ProviderWithNerdctl(binaryName string) ProviderOption

ProviderWithNerdctl configures the provider to use the nerdctl runtime

func ProviderWithPodman

func ProviderWithPodman() ProviderOption

ProviderWithPodman configures the provider to use podman runtime