kube

Documentation

Index

• Variables
• type Client
  • func NewClient(log log.Logger, host, ns string, settings Settings) (Client, error)
• type Settings
  • func NewDefaultSettings() Settings

Variables

var (
	ErrNoDeploymentForLease     = errors.New("kube: no deployments for lease")
	ErrNoGlobalServicesForLease = errors.New("kube: no global services for lease")
	ErrInternalError            = errors.New("kube: internal error")
)

Types

type Client

type Client interface {
	cluster.Client
}

Client interface includes cluster client

func NewClient

func NewClient(log log.Logger, host, ns string, settings Settings) (Client, error)

NewClient returns new Kubernetes Client instance with provided logger, host and ns. Returns error incase of failure

type Settings

type Settings struct {
	// gcp:    NodePort
	// others: ClusterIP
	DeploymentServiceType corev1.ServiceType

	// gcp:    false
	// others: true
	DeploymentIngressStaticHosts bool
	// Ingress domain to map deployments to
	DeploymentIngressDomain string

	// Return load balancer host in lease status command ?
	// gcp:    true
	// others: optional
	DeploymentIngressExposeLBHosts bool
}

settings configures k8s object generation such that it is customized to the cluster environment that is being used. For instance, GCP requires a different service type than minikube.

func NewDefaultSettings

func NewDefaultSettings() Settings