deployer

Documentation

Index

• type Deployer
  • func NewKindDeployer(config string, image string) (Deployer, error)
• type KindDeployer
  • func (deployer *KindDeployer) Down() ([]byte, error)
  • func (deployer *KindDeployer) IsUp() bool
  • func (deployer *KindDeployer) Kubeconfig() string
  • func (deployer *KindDeployer) Name() string
  • func (deployer *KindDeployer) NodeName() string
  • func (deployer *KindDeployer) Up() ([]byte, error)

Types

type Deployer

type Deployer interface {
	// Up will create a k8s cluster and return any output and errors that occurred while provisioning, or if there is already a running cluster.
	Up() ([]byte, error)

	// IsUp will return true if this deployer has a running cluster, or false is not.
	IsUp() bool

	// Down will attempt to stop a running cluster and return any output and errors that occurred while deleting, or if there is no running cluster.
	Down() ([]byte, error)

	// Kubeconfig returns the path to the kubeconfig file used / generated by the cluster.
	Kubeconfig() string

	// Name returns the name of the cluster to be deployed.
	Name() string

	// NodeName returns the name of the deployed node.s
	NodeName() string
}

func NewKindDeployer

func NewKindDeployer(config string, image string) (Deployer, error)

NewKindDeployer create and return a Deployer along with any errors encountered.

type KindDeployer

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

func (*KindDeployer) Down

func (deployer *KindDeployer) Down() ([]byte, error)

func (*KindDeployer) IsUp

func (deployer *KindDeployer) IsUp() bool

func (*KindDeployer) Kubeconfig

func (deployer *KindDeployer) Kubeconfig() string

func (*KindDeployer) Name

func (deployer *KindDeployer) Name() string

func (*KindDeployer) NodeName

func (deployer *KindDeployer) NodeName() string

func (*KindDeployer) Up

func (deployer *KindDeployer) Up() ([]byte, error)