reftracker

Documentation

Overview

Package reftracker contains structs used for tracking secret and configmap referenced by the app. Tracking these references allows us to trigger an app reconcile when the resources are updated.

Index

• type AppRefTracker
  • func NewAppRefTracker() *AppRefTracker
  • func (a *AppRefTracker) AppsForRef(refKey RefKey) (map[RefKey]struct{}, error)
  • func (a *AppRefTracker) ReconcileRefs(currentRefs map[RefKey]struct{}, appKey RefKey)
  • func (a *AppRefTracker) RefsForApp(appKey RefKey) (map[RefKey]struct{}, error)
  • func (a *AppRefTracker) RemoveAppFromAllRefs(appKey RefKey)
  • func (a *AppRefTracker) RemoveRef(refKey RefKey)
• type AppUpdateStatus
  • func NewAppUpdateStatus() *AppUpdateStatus
  • func (a *AppUpdateStatus) IsUpdateNeeded(appKey RefKey) bool
  • func (a *AppUpdateStatus) MarkNeedsUpdate(appKey RefKey)
  • func (a *AppUpdateStatus) MarkUpdated(appKey RefKey)
• type RefKey
  • func NewAppKey(refName, namespace string) RefKey
  • func NewConfigMapKey(refName, namespace string) RefKey
  • func NewPackageRepositoryKey(refName, namespace string) RefKey
  • func NewRefKey(kind, refName, namespace string) RefKey
  • func NewSecretKey(refName, namespace string) RefKey
  • func (r RefKey) Description() string
  • func (r RefKey) Kind() string
  • func (r RefKey) Namespace() string
  • func (r RefKey) RefName() string

Types

type AppRefTracker

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

func NewAppRefTracker

func NewAppRefTracker() *AppRefTracker

TODO: Rename since this doesn't only work with Apps

func (*AppRefTracker) AppsForRef

func (a *AppRefTracker) AppsForRef(refKey RefKey) (map[RefKey]struct{}, error)

func (*AppRefTracker) ReconcileRefs

func (a *AppRefTracker) ReconcileRefs(currentRefs map[RefKey]struct{}, appKey RefKey)

func (*AppRefTracker) RefsForApp

func (a *AppRefTracker) RefsForApp(appKey RefKey) (map[RefKey]struct{}, error)

func (*AppRefTracker) RemoveAppFromAllRefs

func (a *AppRefTracker) RemoveAppFromAllRefs(appKey RefKey)

func (*AppRefTracker) RemoveRef

func (a *AppRefTracker) RemoveRef(refKey RefKey)

type AppUpdateStatus

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

func NewAppUpdateStatus

func NewAppUpdateStatus() *AppUpdateStatus

func (*AppUpdateStatus) IsUpdateNeeded

func (a *AppUpdateStatus) IsUpdateNeeded(appKey RefKey) bool

IsUpdateNeeded returns true iff the provided RefKey has a mark indicating it needs an update

func (*AppUpdateStatus) MarkNeedsUpdate

func (a *AppUpdateStatus) MarkNeedsUpdate(appKey RefKey)

MarkNeedsUpdate creates an entry (mark) to update the provided RefKey

func (*AppUpdateStatus) MarkUpdated

func (a *AppUpdateStatus) MarkUpdated(appKey RefKey)

MarkUpdated removes any existing "needs update" mark

type RefKey

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

func NewAppKey

func NewAppKey(refName, namespace string) RefKey

func NewConfigMapKey

func NewConfigMapKey(refName, namespace string) RefKey

func NewPackageRepositoryKey

func NewPackageRepositoryKey(refName, namespace string) RefKey

func NewRefKey

func NewRefKey(kind, refName, namespace string) RefKey

func NewSecretKey

func NewSecretKey(refName, namespace string) RefKey

func (RefKey) Description

func (r RefKey) Description() string

func (RefKey) Kind

func (r RefKey) Kind() string

func (RefKey) Namespace

func (r RefKey) Namespace() string

func (RefKey) RefName

func (r RefKey) RefName() string