package kube

import "github.com/oslokommune/okctl/pkg/kube"

Package kube implements a kubernetes client Parts of this file have been stolen from: - https://github.com/helm/helm/blob/master/pkg/kube/wait.go

Index ¶

• Variables
• type Applier
• type ApplyFn
• type ClientSetProvider
• func NewFromEKSCluster(clusterName, region string, provider v1alpha1.CloudProvider, auth awsauth.Authenticator) ClientSetProvider
• func NewFromKubeConfig(kubeConfigPath string) ClientSetProvider
• type Kube
• func New(provider ClientSetProvider) (*Kube, error)
• func (k *Kube) Apply(fns ...Applier) ([]interface{}, error)
• func (k *Kube) Debug(namespace string) (map[string][]string, error)
• func (k *Kube) Watch(resources []interface{}, timeout time.Duration) error
• func (k *Kube) WatchDeployment(deployment *appsv1.Deployment, timeout time.Duration) error
• func (k *Kube) WithLogger(log *logrus.Logger) *Kube
• type Kuber

Variables ¶

var ErrClusterNotFound = errors.New("cluster not found")

ErrClusterNotFound represents the specified cluster is missing

Types ¶

type Applier ¶

type Applier struct {
	Fn          ApplyFn
	Description string
}

Applier wraps the function to be applied with a brief description

type ApplyFn ¶

type ApplyFn func(clientSet kubernetes.Interface, config *rest.Config) (interface{}, error)

ApplyFn defines the signature of a function that applies some operation to the kubernetes cluster

type ClientSetProvider ¶

type ClientSetProvider interface {
	Get() (*kubernetes.Clientset, *rest.Config, error)
}

ClientSetProvider defines how a Kubernetes clientset may be retrieved

func NewFromEKSCluster ¶

func NewFromEKSCluster(clusterName, region string, provider v1alpha1.CloudProvider, auth awsauth.Authenticator) ClientSetProvider

NewFromEKSCluster returns a client set provider that uses a EKS cluster description to build the client set

func NewFromKubeConfig ¶

func NewFromKubeConfig(kubeConfigPath string) ClientSetProvider

NewFromKubeConfig returns a client set provider that uses a kubeconfig to build the client set

type Kube ¶

type Kube struct {
	Provider   ClientSetProvider
	ClientSet  *kubernetes.Clientset
	RestConfig *rest.Config
	Ctx        context.Context
	Log        *logrus.Logger
}

Kube contains state for communicating with a kubernetes cluster

func New ¶

func New(provider ClientSetProvider) (*Kube, error)

New returns an initialised kubernetes client

func (*Kube) Apply ¶

func (k *Kube) Apply(fns ...Applier) ([]interface{}, error)

Apply all the functions to the cluster

func (*Kube) Debug ¶

func (k *Kube) Debug(namespace string) (map[string][]string, error)

Debug a namespace

func (*Kube) Watch ¶

func (k *Kube) Watch(resources []interface{}, timeout time.Duration) error

Watch a set of resources

func (*Kube) WatchDeployment ¶

func (k *Kube) WatchDeployment(deployment *appsv1.Deployment, timeout time.Duration) error

WatchDeployment and wait until it is ready or we hit the timeout most of this code, together with deploymentReady is taken from: - https://github.com/helm/helm

Luckily we have control over the types of resources we want to watch, so we can simplify a little.

func (*Kube) WithLogger ¶

func (k *Kube) WithLogger(log *logrus.Logger) *Kube

WithLogger sets a logger

type Kuber ¶

type Kuber interface {
	Apply(fn Applier, fns ...Applier)
}

Kuber provides the methods that are available by a concrete implementation

Source Files ¶

errors.go kube.go

Directories ¶