kube

Documentation

Index

• func New(ctx api.Context) (resource.Environment, error)
• type Environment
  • func (e *Environment) Apply(namespace, ymlFile string) error
  • func (e *Environment) ApplyContents(namespace, yml string) error
  • func (e *Environment) Case(name environment.Name, fn func())
  • func (e *Environment) Delete(namespace, ymlFile string) error
  • func (e *Environment) DeleteContents(namespace, yml string) error
  • func (e *Environment) DeployYaml(namespace, yamlFile string) (*deployment.Instance, error)
  • func (e *Environment) EnvironmentName() environment.Name
  • func (e *Environment) ID() resource.ID
  • func (e *Environment) Settings() *Settings
• type Settings
  • func (s *Settings) String() string

Functions

func New

func New(ctx api.Context) (resource.Environment, error)

New returns a new Kubernetes environment

Types

type Environment

type Environment struct {
	*kube.Accessor
	// contains filtered or unexported fields
}

Environment is the implementation of a kubernetes environment. It implements environment.Environment, and also hosts publicly accessible methods that are specific to cluster environment.

func (*Environment) Apply

func (e *Environment) Apply(namespace, ymlFile string) error

Applies the config in the given filename to the namespace.

func (*Environment) ApplyContents

func (e *Environment) ApplyContents(namespace, yml string) error

ApplyContents applies the given yaml contents to the namespace.

func (*Environment) Case

func (e *Environment) Case(name environment.Name, fn func())

EnvironmentName implements environment.Instance

func (*Environment) Delete

func (e *Environment) Delete(namespace, ymlFile string) error

Deletes the config in the given filename from the namespace.

func (*Environment) DeleteContents

func (e *Environment) DeleteContents(namespace, yml string) error

Deletes the given yaml contents from the namespace.

func (*Environment) DeployYaml

func (e *Environment) DeployYaml(namespace, yamlFile string) (*deployment.Instance, error)

func (*Environment) EnvironmentName

func (e *Environment) EnvironmentName() environment.Name

EnvironmentName implements environment.Instance

func (*Environment) ID

func (e *Environment) ID() resource.ID

ID implements resource.Instance

func (*Environment) Settings

func (e *Environment) Settings() *Settings

type Settings

type Settings struct {
	// Path to kube config file. Required if the environment is kubernetes.
	KubeConfig string

	// Indicates that the Ingress Gateway is not available. This typically happens in Minikube. The Ingress
	// component will fall back to node-port in this case.
	Minikube bool
}

Settings provide kube-specific Settings from flags.

func (*Settings) String

func (s *Settings) String() string

String implements fmt.Stringer