resources

Documentation

Index

• Constants
• type PatchFunction
• type ResourceCache
  • func NewResourceCache() ResourceCache
• type ResourceCacheEntry
  • func NewResourceCacheEntry(name common.Name, value interface{}) ResourceCacheEntry

Constants

const RC_KEY_DEPLOYMENT = "DEPLOYMENT"

const RC_KEY_INGRESS = "INGRESS"

const RC_KEY_NETWORK_POLICY = "NETWORK_POLICY"

const RC_KEY_POD_DISRUPTION_BUDGET_V1 = "POD_DISRUPTION_BUDGET_V1"

const RC_KEY_POD_DISRUPTION_BUDGET_V1BETA1 = "POD_DISRUPTION_BUDGET_V1BETA1"

const RC_KEY_ROUTE_OCP = "ROUTE_OCP"

const RC_KEY_SERVICE = "SERVICE"

const RC_KEY_SPEC = "SPEC"

const RC_KEY_STATUS = "STATUS"

const RC_NOT_CREATED_NAME_EMPTY = ""

Types

type PatchFunction

type PatchFunction = func(value interface{}) interface{}

Return a MODIFIED COPY of the given resource. Do not modify or return the original value.

type ResourceCache

type ResourceCache interface {
	// Returns the value and a boolean representing if the value exists
	Get(key string) (ResourceCacheEntry, bool)

	Set(key string, value ResourceCacheEntry) // TODO We may need multi-map in the future (add `type`)

	Remove(key string)

	Clear()
}

func NewResourceCache

func NewResourceCache() ResourceCache

Resource cache is a way for CF to avoid getting & recreating the resources unnecessarily, and do a pseudo-atomic patching It is cleared at the end of reconcilliation cycle, and there must be some CF responsible for filling the values

type ResourceCacheEntry

type ResourceCacheEntry interface {
	// Get the k8s name of the resource, we are not supporting multiple namespaces yet
	// May return null if the resource was just created
	GetName() common.Name

	// get the stored value, it has to be cast using type assertion
	GetValue() interface{}

	GetOriginalValue() interface{}

	ApplyPatch(pf PatchFunction)

	HasChanged() bool
	ResetHasChanged()
}

func NewResourceCacheEntry

func NewResourceCacheEntry(name common.Name, value interface{}) ResourceCacheEntry