kind

Documentation

Index

• Constants
• func NewFromExisting(name string) (clusters.Cluster, error)
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build(ctx context.Context) (clusters.Cluster, error)
  • func (b *Builder) WithCalicoCNI() *Builder
  • func (b *Builder) WithClusterVersion(version semver.Version) *Builder
  • func (b *Builder) WithConfig(filename string) *Builder
  • func (b *Builder) WithName(name string) *Builder
• type Cluster
  • func New(ctx context.Context) (*Cluster, error)
  • func (c *Cluster) Cleanup(ctx context.Context) error
  • func (c *Cluster) Client() *kubernetes.Clientset
  • func (c *Cluster) Config() *rest.Config
  • func (c *Cluster) DeleteAddon(ctx context.Context, addon clusters.Addon) error
  • func (c *Cluster) DeployAddon(ctx context.Context, addon clusters.Addon) error
  • func (c *Cluster) DumpDiagnostics(ctx context.Context, meta string) (string, error)
  • func (c *Cluster) GetAddon(name clusters.AddonName) (clusters.Addon, error)
  • func (c *Cluster) ListAddons() []clusters.Addon
  • func (c *Cluster) Name() string
  • func (c *Cluster) Type() clusters.Type
  • func (c *Cluster) Version() (semver.Version, error)

Constants

const (
	// KindClusterType indicates that the Kubernetes cluster was provisioned by Kind.
	KindClusterType clusters.Type = "kind"

	// EnvKeepCluster is the environment variable that can be set to "true" in order
	// to circumvent teardown during cleanup of clusters in order to allow a user to inspect them instead.
	EnvKeepCluster = "KIND_KEEP_CLUSTER"

	// DefaultKindDockerNetwork is the Docker network that a kind cluster uses by default.
	DefaultKindDockerNetwork = "kind"
)

Functions

func NewFromExisting

func NewFromExisting(name string) (clusters.Cluster, error)

NewFromExisting provides a Cluster object for a given kind cluster by name.

Types

type Builder

type Builder struct {
	Name string
	// contains filtered or unexported fields
}

Builder generates clusters.Cluster objects backed by Kind given provided configuration options.

func NewBuilder

func NewBuilder() *Builder

NewBuilder provides a new *Builder object.

func (*Builder) Build

func (b *Builder) Build(ctx context.Context) (clusters.Cluster, error)

Build creates and configures clients for a Kind-based Kubernetes clusters.Cluster.

func (*Builder) WithCalicoCNI

func (b *Builder) WithCalicoCNI() *Builder

WithCalicoCNI disables the default CNI for the kind cluster and instead deploys Calico (https://projectcalico.docs.tigera.io/about/about-calico) which includes deep features including NetworkPolicy enforcement.

func (*Builder) WithClusterVersion

func (b *Builder) WithClusterVersion(version semver.Version) *Builder

WithClusterVersion configures the Kubernetes cluster version for the Builder to use when building the Kind cluster.

func (*Builder) WithConfig

func (b *Builder) WithConfig(filename string) *Builder

WithConfig sets a filename containing a KIND config See: https://kind.sigs.k8s.io/docs/user/configuration/

func (*Builder) WithName

func (b *Builder) WithName(name string) *Builder

WithName indicates a custom name to use for the cluster.

type Cluster

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

Cluster is a clusters.Cluster implementation backed by Kubernetes In Docker (KIND)

func New

func New(ctx context.Context) (*Cluster, error)

New provides a new clusters.Cluster backed by a Kind based Kubernetes Cluster.

func (*Cluster) Cleanup

func (c *Cluster) Cleanup(ctx context.Context) error

func (*Cluster) Client

func (c *Cluster) Client() *kubernetes.Clientset

func (*Cluster) Config

func (c *Cluster) Config() *rest.Config

func (*Cluster) DeleteAddon

func (c *Cluster) DeleteAddon(ctx context.Context, addon clusters.Addon) error

func (*Cluster) DeployAddon

func (c *Cluster) DeployAddon(ctx context.Context, addon clusters.Addon) error

func (*Cluster) DumpDiagnostics

func (c *Cluster) DumpDiagnostics(ctx context.Context, meta string) (string, error)

DumpDiagnostics produces diagnostics data for the cluster at a given time. It uses the provided meta string to write to meta.txt file which will allow for diagnostics identification. It returns the path to directory containing all the diagnostic files and an error.

func (*Cluster) GetAddon

func (c *Cluster) GetAddon(name clusters.AddonName) (clusters.Addon, error)

func (*Cluster) ListAddons

func (c *Cluster) ListAddons() []clusters.Addon

func (*Cluster) Name

func (c *Cluster) Name() string

func (*Cluster) Type

func (c *Cluster) Type() clusters.Type

func (*Cluster) Version

func (c *Cluster) Version() (semver.Version, error)