inventory

Documentation

Index

• Constants
• type Inventory
  • func NewInventory() *Inventory
  • func (a *Inventory) LoadFromAnnotation(annot map[string]string) error
  • func (a *Inventory) Prune() []resid.ResId
  • func (a *Inventory) UpdateAnnotations(annot map[string]string) error
  • func (a *Inventory) UpdateCurrent(curref Refs) *Inventory
• type Refs
  • func NewRefs() Refs
  • func (rf Refs) Merge(b Refs) Refs
  • func (rf Refs) RemoveIfContains(a, b resid.ResId)

Constants

const (
	// Annotation that contains the inventory content.
	ContentAnnotation = "kustomize.config.k8s.io/Inventory"

	// Annotation for inventory content hash.
	HashAnnotation = "kustomize.config.k8s.io/InventoryHash"
)

Types

type Inventory

type Inventory struct {
	Current  Refs `json:"current,omitempty"`
	Previous Refs `json:"previous,omitempty"`
}

An Inventory allows the Prune method to work.

func NewInventory

func NewInventory() *Inventory

NewInventory returns an Inventory object

func (*Inventory) LoadFromAnnotation

func (a *Inventory) LoadFromAnnotation(annot map[string]string) error

LoadFromAnnotation loads the Inventory date from the annotation map

func (*Inventory) Prune

func (a *Inventory) Prune() []resid.ResId

Prune computes the diff of Current refs and Previous refs and returns a list of Items that can be pruned. An item that can be pruned shows up only in Previous refs. Prune also updates the Previous refs with those items removed

func (*Inventory) UpdateAnnotations

func (a *Inventory) UpdateAnnotations(annot map[string]string) error

UpdateAnnotations update the annotation map

func (*Inventory) UpdateCurrent

func (a *Inventory) UpdateCurrent(curref Refs) *Inventory

UpdateCurrent updates the Inventory given a new current Refs The existing Current refs is merged into the Previous refs

type Refs

type Refs map[resid.ResId][]resid.ResId

References are important in inventory management because one may not delete an object before all objects referencing it have been removed.

func NewRefs

func NewRefs() Refs

func (Refs) Merge

func (rf Refs) Merge(b Refs) Refs

Merge merges a Refs into an existing Refs

func (Refs) RemoveIfContains

func (rf Refs) RemoveIfContains(a, b resid.ResId)

removeIfContains removes the reference relationship

a --> b

from the Refs if it exists