kind

Documentation

Overview

Package kind provides utilities for ensuring the presence and correct version of the Kind binary, as well as functions for installing and managing the Kind binary in a local project.

Index

• func CreateCluster(ctx context.Context, provider *cluster.Provider, name string, ...) error
• func IsClusterRunning(provider *cluster.Provider, clusterName string) (bool, error)
• type CreateClusterOption
  • func WithConfigFile(configFile string) CreateClusterOption
  • func WithK8sVersion(k8sVersion string) CreateClusterOption
  • func WithNetworks(networks []string) CreateClusterOption
• type CreateClusterOptions

Functions

func CreateCluster

func CreateCluster(ctx context.Context, provider *cluster.Provider, name string, opts ...CreateClusterOption) error

CreateCluster creates a Kind cluster with the given name.

func IsClusterRunning

func IsClusterRunning(provider *cluster.Provider, clusterName string) (bool, error)

IsClusterRunning checks if a Kind cluster with the given name is running.

Types

type CreateClusterOption

type CreateClusterOption func(*CreateClusterOptions)

CreateClusterOption is the option for creating a Kind cluster.

func WithConfigFile

func WithConfigFile(configFile string) CreateClusterOption

WithConfigFile sets the config file for creating a Kind cluster.

func WithK8sVersion

func WithK8sVersion(k8sVersion string) CreateClusterOption

WithK8sVersion sets the Kubernetes version for creating a Kind cluster.

func WithNetworks

func WithNetworks(networks []string) CreateClusterOption

WithNetworks sets the network for creating a Kind cluster.

type CreateClusterOptions

type CreateClusterOptions struct {
	ConfigFile string
	K8sVersion string
	Networks   []string
}

CreateClusterOptions are the options for creating a Kind cluster.