k8s

type ClientsetGetter ¶

type ClientsetGetter interface {
	Get() (*kubernetes.Clientset, error)
}

ClientsetGetter abstracts fetching of kubernetes clientset

type ClientsetStruct ¶

type ClientsetStruct struct{}

ClientsetStruct is used to export a kuberneter Clientset

func Clientset() *ClientsetStruct

func (c *ClientsetStruct) Get() (*kubernetes.Clientset, error)

type ConfigGetter ¶

type ConfigGetter interface {
	Get() (*rest.Config, error)
	Name() string
}

ConfigGetter abstracts fetching of kubernetes client config

func Config() ConfigGetter

type ConfigGetters ¶

type ConfigGetters []ConfigGetter

ConfigGetters holds a list of ConfigGetter instances

NOTE:

This is an implementation of ConfigGetter

func (c ConfigGetters) Get() (config *rest.Config, err error)

func (c ConfigGetters) Name() string

type ConfigMapGetter ¶

type ConfigMapGetter interface {
	Get(options metav1.GetOptions) (*corev1.ConfigMap, error)
}

ConfigMapGetter abstracts fetching of ConfigMap instance from kubernetes cluster

type Configmap ¶

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

Configmap is used to initialise a kubernetes Configmap struct

func ConfigMap(namespace, name string) *Configmap

func (c *Configmap) Get(options metav1.GetOptions) (cm *corev1.ConfigMap, err error)

type Delete ¶

type Delete struct {
	*ResourceStruct
	// contains filtered or unexported fields
}

Delete is a resource that is suitable to be executed as a Delete operation

func DeleteResource(gvr schema.GroupVersionResource, namespace string) *Delete

func (d *Delete) Delete(obj *unstructured.Unstructured, subresources ...string) error

type DynamicProvider ¶

type DynamicProvider interface {
	Provide() (k8sdynamic.Interface, error)
}

DynamicProvider abstracts providing kubernetes dynamic client interface

type DynamicStruct ¶

type DynamicStruct struct{}

DynamicStruct is used to initialise a kuberenets dynamic interface

func Dynamic() *DynamicStruct

func (d *DynamicStruct) Provide() (k8sdynamic.Interface, error)

type Get ¶

type Get struct {
	*ResourceStruct
	// contains filtered or unexported fields
}

Get is resource that is suitable to be executed as Get operation

func GetResource(gvr schema.GroupVersionResource, namespace string) *Get

func (g *Get) Get(name string, opts metav1.GetOptions, subresources ...string) (u *unstructured.Unstructured, err error)

type List ¶

type List struct {
	*ResourceStruct
	// contains filtered or unexported fields
}

List is a resource resource that is suitable to be executed as a List operation

func ListResource(gvr schema.GroupVersionResource, namespace string) *List

func (l *List) List(options metav1.ListOptions) (u *unstructured.UnstructuredList, err error)

type NamespaceGetter ¶

type NamespaceGetter interface {
	Get(name string, options metav1.GetOptions) (*corev1.Namespace, error)
}

NamespaceGetter abstracts fetching of Namespace from kubernetes cluster

type NamespaceLister ¶

type NamespaceLister interface {
	List(options metav1.ListOptions) (*corev1.NamespaceList, error)
}

NamespaceLister abstracts fetching of a list of namespaces from kubernetes cluster

type NamespaceStruct ¶

type NamespaceStruct struct{}

NamespaceStruct is used to initialise kubernetes namespace instnaces

func Namespace() *NamespaceStruct

func (ns *NamespaceStruct) Get(name string, options metav1.GetOptions) (*corev1.Namespace, error)

func (ns *NamespaceStruct) List(options metav1.ListOptions) (*corev1.NamespaceList, error)

type NodeGetter ¶

type NodeGetter interface {
	Get(name string, options metav1.GetOptions) (*corev1.Node, error)
}

NodeGetter abstracts fetching of Node details from kubernetes cluster

type NodeLister ¶

type NodeLister interface {
	List(options metav1.ListOptions) (*corev1.NodeList, error)
}

NodeLister abstracts fetching of Nodes from kubernetes cluster

type NodeStruct ¶

type NodeStruct struct{}

NodeStruct returns a struct used to instantiate a kubernetes Node

func Node() *NodeStruct

func (n *NodeStruct) Get(name string, options metav1.GetOptions) (*corev1.Node, error)

func (n *NodeStruct) List(options metav1.ListOptions) (*corev1.NodeList, error)

type ResourceApplier ¶

type ResourceApplier interface {
	Apply(obj *unstructured.Unstructured, subresources ...string) (*unstructured.Unstructured, error)
}

ResourceApplier abstracts applying an unstructured instance that may or may not be available in kubernetes cluster

type ResourceCreateOrUpdater ¶

type ResourceCreateOrUpdater struct {
	*ResourceStruct

	// Various executors required to perform Apply
	// This is how this instance decouples its dependencies
	Getter  ResourceGetter
	Creator ResourceCreator
	Updater ResourceUpdater

	// IsSkipUpdate will not update this resource if set to true.
	// In other words, enabling this flag can only create the
	// resource in the cluster if not created previously
	IsSkipUpdate bool
}

ResourceCreateOrUpdater as the name suggests manages to either create or update a given resource. It does so by implementing ResourceApplier interface

func NewResourceCreateOrUpdater(
	gvr schema.GroupVersionResource,
	namespace string,
	options ...ResourceCreateOrUpdaterOption,
) *ResourceCreateOrUpdater

func (r *ResourceCreateOrUpdater) Apply(
	obj *unstructured.Unstructured,
	subresources ...string,
) (resource *unstructured.Unstructured, err error)

func (r *ResourceCreateOrUpdater) String() string

type ResourceCreateOrUpdaterOption ¶

type ResourceCreateOrUpdaterOption func(*ResourceCreateOrUpdater)

ResourceCreateOrUpdaterOption is a typed function used to build an instance of ResourceCreateOrUpdater

NOTE:

This follows the pattern known as "functional options". It

is a function that operates on a given structure as a value to build (initialise, configure, sensible defaults, etc) this same structure.

func ResourceCreateOrUpdaterSkipUpdate(skip bool) ResourceCreateOrUpdaterOption

type ResourceCreator ¶

type ResourceCreator interface {
	Create(obj *unstructured.Unstructured, subresources ...string) (*unstructured.Unstructured, error)
}

ResourceCreator abstracts creating an unstructured instance in kubernetes cluster

type ResourceDeleteOptions ¶

type ResourceDeleteOptions struct {
	Deleter ResourceDeleter
}

ResourceDeleteOptions is a utility instance used during the resource's delete operations

type ResourceDeleter ¶

type ResourceDeleter interface {
	Delete(obj *unstructured.Unstructured, subresources ...string) error
}

ResourceDeleter abstracts deletes an unstructured instance that is available in kubernetes cluster

type ResourceGetOptions ¶

type ResourceGetOptions struct {
	Getter ResourceGetter
}

ResourceGetOptions is a utility instance used during the resource's get operations

type ResourceGetter ¶

type ResourceGetter interface {
	Get(name string, options metav1.GetOptions, subresources ...string) (*unstructured.Unstructured, error)
}

ResourceGetter abstracts fetching an unstructured instance from kubernetes cluster

type ResourceListOptions ¶

type ResourceListOptions struct {
	Lister ResourceLister
}

ResourceListOptions is a utility instance used during the resource's list operations

type ResourceLister ¶

type ResourceLister interface {
	List(options metav1.ListOptions) (*unstructured.UnstructuredList, error)
}

ResourceLister abstracts fetching an unstructured list of instance from kubernetes cluster

type ResourceStruct ¶

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

ResourceStruct is used to abstract a kubernetes struct

func Resource(gvr schema.GroupVersionResource, namespace string) *ResourceStruct

func (r *ResourceStruct) Create(obj *unstructured.Unstructured, subresources ...string) (u *unstructured.Unstructured, err error)

func (r *ResourceStruct) Delete(obj *unstructured.Unstructured, subresources ...string) error

func (r *ResourceStruct) Get(name string, opts metav1.GetOptions, subresources ...string) (u *unstructured.Unstructured, err error)

func (r *ResourceStruct) List(opts metav1.ListOptions) (u *unstructured.UnstructuredList, err error)

func (r *ResourceStruct) String() string

func (r *ResourceStruct) Update(oldobj, newobj *unstructured.Unstructured, subresources ...string) (u *unstructured.Unstructured, err error)

type ResourceUpdater ¶

type ResourceUpdater interface {
	Update(oldobj, newobj *unstructured.Unstructured, subresources ...string) (u *unstructured.Unstructured, err error)
}

ResourceUpdater abstracts updating an unstructured instance found in kubernetes cluster