kube

Documentation

Index

• Constants
• Variables
• func ValidateSettings(settings Settings) error
• type Client
  • func NewClient(log log.Logger, ns string, configPath string) (Client, error)
  • func NewPreparedClient(log log.Logger, ns string, configPath string) (Client, error)
• type ContextKey
• type Settings
  • func NewDefaultSettings() Settings

Constants

const SettingsKey = ContextKey("kube-client-settings")

Variables

var (
	ErrLeaseNotFound             = errors.New("kube: lease not found")
	ErrNoDeploymentForLease      = errors.New("kube: no deployments for lease")
	ErrInternalError             = errors.New("kube: internal error")
	ErrNoServiceForLease         = errors.New("no service for that lease")
	ErrInvalidHostnameConnection = errors.New("kube: invalid hostname connection")
	ErrMissingLabel              = errors.New("kube: missing label")
	ErrInvalidLabelValue         = errors.New("kube: invalid label value")
)

Functions

func ValidateSettings

func ValidateSettings(settings Settings) error

Types

type Client

type Client interface {
	cluster.Client
}

Client interface includes cluster client

func NewClient

func NewClient(log log.Logger, ns string, configPath string) (Client, error)

NewClient returns new Kubernetes Client instance with provided logger, host and ns. Returns error incase of failure configPath may be the empty string

func NewPreparedClient

func NewPreparedClient(log log.Logger, ns string, configPath string) (Client, error)

type ContextKey

type ContextKey string

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

	// Global hostname for arbitrary ports
	ClusterPublicHostname string

	// NetworkPoliciesEnabled determines if NetworkPolicies should be installed.
	NetworkPoliciesEnabled bool

	CPUCommitLevel     float64
	MemoryCommitLevel  float64
	StorageCommitLevel float64

	DeploymentRuntimeClass string
}

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