k8s

Documentation

Overview

Package k8s contains helpers for setting the IngressRoute status

Index

• Constants
• func KindOf(obj interface{}) string
• type Converter
• type DynamicClientHandler
  • func (d *DynamicClientHandler) OnAdd(obj interface{})
  • func (d *DynamicClientHandler) OnDelete(obj interface{})
  • func (d *DynamicClientHandler) OnUpdate(oldObj, newObj interface{})
• type StatusCacher
  • func (c *StatusCacher) Delete(obj interface{})
  • func (c *StatusCacher) GetStatus(obj interface{}) (*projcontour.Status, error)
  • func (c *StatusCacher) IsCacheable(obj interface{}) bool
  • func (c *StatusCacher) SetStatus(status, desc string, obj interface{}) error
• type StatusClient
• type StatusWriter
  • func (irs *StatusWriter) GetStatus(obj interface{}) (*projcontour.Status, error)
  • func (irs *StatusWriter) SetStatus(status, desc string, existing interface{}) error
• type UnstructuredConverter
  • func NewUnstructuredConverter() *UnstructuredConverter
  • func (c *UnstructuredConverter) CanConvert(obj interface{}) bool
  • func (c *UnstructuredConverter) Convert(obj interface{}) (interface{}, error)

Constants

const (
	StatusValid    = "valid"
	StatusInvalid  = "invalid"
	StatusOrphaned = "orphaned"
)

Functions

func KindOf

func KindOf(obj interface{}) string

KindOf returns the kind string for the given Kubernetes object.

The API machinery doesn't populate the metav1.TypeMeta field for objects, so we have to use a type assertion to detect kinds that we care about.

Types

type Converter

type Converter interface {
	Convert(obj interface{}) (interface{}, error)
	CanConvert(obj interface{}) bool
}

type DynamicClientHandler

type DynamicClientHandler struct {

	// Next is the next handler in the chain.
	Next cache.ResourceEventHandler

	// Converter is the registered converter.
	Converter Converter

	Logger logrus.FieldLogger
}

DynamicClientHandler converts *unstructured.Unstructured from the k8s dynamic client to the types registered with the supplied Converter and forwards them to the next Handler in the chain.

func (*DynamicClientHandler) OnAdd

func (d *DynamicClientHandler) OnAdd(obj interface{})

func (*DynamicClientHandler) OnDelete

func (d *DynamicClientHandler) OnDelete(obj interface{})

func (*DynamicClientHandler) OnUpdate

func (d *DynamicClientHandler) OnUpdate(oldObj, newObj interface{})

type StatusCacher

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

StatusCacher keeps a cache of the latest status updates for Kubernetes objects.

func (*StatusCacher) Delete

func (c *StatusCacher) Delete(obj interface{})

Delete removes an object from the status cache.

func (*StatusCacher) GetStatus

func (c *StatusCacher) GetStatus(obj interface{}) (*projcontour.Status, error)

GetStatus returns the status (if any) for this given object.

func (*StatusCacher) IsCacheable

func (c *StatusCacher) IsCacheable(obj interface{}) bool

IsCacheable returns whether this type of object can be stored in the status cache.

func (*StatusCacher) SetStatus

func (c *StatusCacher) SetStatus(status, desc string, obj interface{}) error

SetStatus sets the IngressRoute status field to an Valid or Invalid status

type StatusClient

type StatusClient interface {
	SetStatus(status string, desc string, obj interface{}) error
	GetStatus(obj interface{}) (*projcontour.Status, error)
}

StatusClient updates the Status on a Kubernetes object.

type StatusWriter

type StatusWriter struct {
	Client dynamic.Interface
}

StatusWriter updates the object's Status field.

func (*StatusWriter) GetStatus

func (irs *StatusWriter) GetStatus(obj interface{}) (*projcontour.Status, error)

GetStatus is not implemented for StatusWriter.

func (*StatusWriter) SetStatus

func (irs *StatusWriter) SetStatus(status, desc string, existing interface{}) error

SetStatus sets the IngressRoute status field to an Valid or Invalid status

type UnstructuredConverter

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

UnstructuredConverter handles conversions between unstructured.Unstructured and Contour types

func NewUnstructuredConverter

func NewUnstructuredConverter() *UnstructuredConverter

NewUnstructuredConverter returns a new UnstructuredConverter initialized

func (*UnstructuredConverter) CanConvert

func (c *UnstructuredConverter) CanConvert(obj interface{}) bool

func (*UnstructuredConverter) Convert

func (c *UnstructuredConverter) Convert(obj interface{}) (interface{}, error)

Convert converts an unstructured.Unstructured to typed struct