kindutils

README

kindutils - KinD: Kubernetes in Docker

Examples

Documentation

Index

• func CreateCluster(ctx context.Context, clusterName string) (kubernetesinterfaces.KubernetesCluster, error)
• func DeleteClusterByName(ctx context.Context, clusterName string) error
• func DeleteClusterByNameIfInContinuousIntegration(ctx context.Context, clusterName string) error
• type CommandExecutorKind
  • func NewCommandExecutorKind() (c *CommandExecutorKind)
  • func (c *CommandExecutorKind) ClusterByNameExists(ctx context.Context, clusterName string) (exists bool, err error)
  • func (c *CommandExecutorKind) CreateClusterByName(ctx context.Context, clusterName string) (cluster kubernetesinterfaces.KubernetesCluster, err error)
  • func (c *CommandExecutorKind) DeleteClusterByName(ctx context.Context, clusterName string) (err error)
  • func (c *CommandExecutorKind) EnsureKubectlConfigPresent(ctx context.Context, clusterName string) error
  • func (c *CommandExecutorKind) GetClusterByName(clusterName string) (cluster kubernetesinterfaces.KubernetesCluster, err error)
  • func (c *CommandExecutorKind) GetCommandExecutor() (commandExecutor commandexecutor.CommandExecutor, err error)
  • func (c *CommandExecutorKind) GetHostDescription() (hostDescription string, err error)
  • func (c *CommandExecutorKind) ListClusterNames(ctx context.Context) (clusterNames []string, err error)
  • func (c *CommandExecutorKind) RunCommand(ctx context.Context, runOptions *parameteroptions.RunCommandOptions) (commandOutput *commandexecutor.CommandOutput, err error)
  • func (c *CommandExecutorKind) RunCommandAndGetStdoutAsLines(ctx context.Context, runOptions *parameteroptions.RunCommandOptions) (lines []string, err error)
  • func (c *CommandExecutorKind) SetCommandExecutor(commandExecutor commandexecutor.CommandExecutor) (err error)
• type CommandExecutorKindCluster
  • func NewCommandExecutorKindCluster() (k *CommandExecutorKindCluster)
  • func (k *CommandExecutorKindCluster) GetKind() (kind Kind, err error)
  • func (k *CommandExecutorKindCluster) MustGetKind() (kind Kind)
  • func (k *CommandExecutorKindCluster) MustSetKind(kind Kind)
  • func (k *CommandExecutorKindCluster) SetKind(kind Kind) (err error)
• type Kind
  • func GetCommandExecutorKind(commandExecutor commandexecutor.CommandExecutor) (kind Kind, err error)
  • func GetLocalCommandExecutorKind() (kind Kind, err error)
  • func MustGetCommandExecutorKind(commandExecutor commandexecutor.CommandExecutor) (kind Kind)
  • func MustGetLocalCommandExecutorKind() (kind Kind)

Functions

func CreateCluster

func CreateCluster(ctx context.Context, clusterName string) (kubernetesinterfaces.KubernetesCluster, error)

func DeleteClusterByName

func DeleteClusterByName(ctx context.Context, clusterName string) error

func DeleteClusterByNameIfInContinuousIntegration

func DeleteClusterByNameIfInContinuousIntegration(ctx context.Context, clusterName string) error

Types

type CommandExecutorKind

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

func NewCommandExecutorKind

func NewCommandExecutorKind() (c *CommandExecutorKind)

func (*CommandExecutorKind) ClusterByNameExists

func (c *CommandExecutorKind) ClusterByNameExists(ctx context.Context, clusterName string) (exists bool, err error)

func (*CommandExecutorKind) CreateClusterByName

func (c *CommandExecutorKind) CreateClusterByName(ctx context.Context, clusterName string) (cluster kubernetesinterfaces.KubernetesCluster, err error)

func (*CommandExecutorKind) DeleteClusterByName

func (c *CommandExecutorKind) DeleteClusterByName(ctx context.Context, clusterName string) (err error)

func (*CommandExecutorKind) EnsureKubectlConfigPresent

func (c *CommandExecutorKind) EnsureKubectlConfigPresent(ctx context.Context, clusterName string) error

func (*CommandExecutorKind) GetClusterByName

func (c *CommandExecutorKind) GetClusterByName(clusterName string) (cluster kubernetesinterfaces.KubernetesCluster, err error)

func (*CommandExecutorKind) GetCommandExecutor

func (c *CommandExecutorKind) GetCommandExecutor() (commandExecutor commandexecutor.CommandExecutor, err error)

func (*CommandExecutorKind) GetHostDescription

func (c *CommandExecutorKind) GetHostDescription() (hostDescription string, err error)

func (*CommandExecutorKind) ListClusterNames

func (c *CommandExecutorKind) ListClusterNames(ctx context.Context) (clusterNames []string, err error)

func (*CommandExecutorKind) RunCommand

func (c *CommandExecutorKind) RunCommand(ctx context.Context, runOptions *parameteroptions.RunCommandOptions) (commandOutput *commandexecutor.CommandOutput, err error)

func (*CommandExecutorKind) RunCommandAndGetStdoutAsLines

func (c *CommandExecutorKind) RunCommandAndGetStdoutAsLines(ctx context.Context, runOptions *parameteroptions.RunCommandOptions) (lines []string, err error)

func (*CommandExecutorKind) SetCommandExecutor

func (c *CommandExecutorKind) SetCommandExecutor(commandExecutor commandexecutor.CommandExecutor) (err error)

type CommandExecutorKindCluster

type CommandExecutorKindCluster struct {
	commandexecutorkubernetes.CommandExecutorKubernetes
	// contains filtered or unexported fields
}

func NewCommandExecutorKindCluster

func NewCommandExecutorKindCluster() (k *CommandExecutorKindCluster)

func (*CommandExecutorKindCluster) GetKind

func (k *CommandExecutorKindCluster) GetKind() (kind Kind, err error)

func (*CommandExecutorKindCluster) MustGetKind

func (k *CommandExecutorKindCluster) MustGetKind() (kind Kind)

func (*CommandExecutorKindCluster) MustSetKind

func (k *CommandExecutorKindCluster) MustSetKind(kind Kind)

func (*CommandExecutorKindCluster) SetKind

func (k *CommandExecutorKindCluster) SetKind(kind Kind) (err error)

type Kind

type Kind interface {
	ClusterByNameExists(ctx context.Context, clusterName string) (exists bool, err error)
	CreateClusterByName(ctx context.Context, clusterName string) (cluster kubernetesinterfaces.KubernetesCluster, err error)
	DeleteClusterByName(ctx context.Context, clusterName string) (err error)
	GetClusterByName(clusterName string) (cluster kubernetesinterfaces.KubernetesCluster, err error)
	ListClusterNames(ctx context.Context) (clusterNames []string, err error)
}

Kubernetes in Docker

func GetCommandExecutorKind

func GetCommandExecutorKind(commandExecutor commandexecutor.CommandExecutor) (kind Kind, err error)

func GetLocalCommandExecutorKind

func GetLocalCommandExecutorKind() (kind Kind, err error)

func MustGetCommandExecutorKind

func MustGetCommandExecutorKind(commandExecutor commandexecutor.CommandExecutor) (kind Kind)

func MustGetLocalCommandExecutorKind

func MustGetLocalCommandExecutorKind() (kind Kind)