package
0.27.0-alpha
Repository: https://github.com/kubernetes-sigs/kind.git
Documentation: pkg.go.dev

# Packages

Package constants contains well known constants for kind clusters.
Package nodes provides a kind specific definition of a cluster node.
Package nodeutils contains functionality for Kubernetes-in-Docker nodes It mostly exists to break up functionality from sigs.k8s.io/kind/pkg/cluster.

# Functions

CreateWithConfigFile configures the config file path to use.
CreateWithDisplaySalutation enables display a salutation at the end of create cluster if displaySalutation is true.
CreateWithDisplayUsage enables displaying usage if displayUsage is true.
CreateWithKubeconfigPath sets the explicit --kubeconfig path.
CreateWithNodeImage overrides the image on all nodes in config as an easy way to change the Kubernetes version.
CreateWithRawConfig configures the config to use from raw (yaml) bytes.
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.
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.
CreateWithV1Alpha4Config configures the cluster with a v1alpha4 config.
CreateWithWaitForReady configures a maximum wait time for the control plane node(s) to be ready.
DetectNodeProvider allows callers to autodetect the node provider *without* fallback to the default.
NewProvider returns a new provider based on the supplied options.
ProviderWithDocker configures the provider to use docker runtime.
ProviderWithLogger configures the provider to use Logger logger.
ProviderWithNerdctl configures the provider to use the nerdctl runtime.
ProviderWithPodman configures the provider to use podman runtime.

# Constants

DefaultName is the default cluster name.

# Variables

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

# Structs

Provider is used to perform cluster operations.

# Interfaces

CreateOption is a Provider.Create option.
ProviderOption is an option for configuring a provider.