update

type Change ¶ added in v0.38.0

type Change struct {
	OldValue string
	NewValue string
	Setter   string
}

Change contains the setter that resulted in a Change, the old and the new value after the Change.

type FileResult ¶ added in v0.7.0

type FileResult struct {
	Objects map[ObjectIdentifier][]ImageRef
}

FileResult gives the updates in a particular file.

type ImageRef ¶ added in v0.7.0

type ImageRef interface {
	// String returns a string representation of the image ref as it
	// is used in the update; e.g., "helloworld:v1.0.1"
	String() string
	// Identifier returns the tag or digest; e.g., "v1.0.1"
	Identifier() string
	// Repository returns the repository component of the ImageRef,
	// with an implied defaults, e.g., "library/helloworld"
	Repository() string
	// Registry returns the registry component of the ImageRef, e.g.,
	// "index.docker.io"
	Registry() string
	// Name gives the fully-qualified reference name, e.g.,
	// "index.docker.io/library/helloworld:v1.0.1"
	Name() string
	// Policy gives the namespaced name of the image policy that led
	// to the update.
	Policy() types.NamespacedName
}

ImageRef represents the image reference used to replace a field value in an update.

type ObjectChanges ¶ added in v0.38.0

type ObjectChanges map[ObjectIdentifier][]Change

ObjectChanges contains all the changes made to objects.

type ObjectIdentifier ¶ added in v0.7.0

type ObjectIdentifier struct {
	yaml.ResourceIdentifier
}

ObjectIdentifier holds the identifying data for a particular object. This won't always have a name (e.g., a kustomization.yaml).

type Result ¶ added in v0.7.0

type Result struct {
	Files map[string]FileResult
}

Result reports the outcome of an automated update. It has a nested structure file->objects->images. Different projections (e.g., all the images, regardless of object) are available via methods.

func UpdateWithSetters(tracelog logr.Logger, inpath, outpath string, policies []imagev1_reflect.ImagePolicy) (Result, error)

func (r Result) Images() []ImageRef

func (r Result) Objects() map[ObjectIdentifier][]ImageRef

type ResultV2 ¶ added in v0.38.0

type ResultV2 struct {
	ImageResult Result
	FileChanges map[string]ObjectChanges
}

ResultV2 contains Result of update and also the file changes made during the update. This extends the Result to include details about the exact changes made to the files and the objects in them. It has a nested structure file->objects->changes.

func UpdateV2WithSetters(tracelog logr.Logger, inpath, outpath string, policies []imagev1_reflect.ImagePolicy) (ResultV2, error)

func (r *ResultV2) AddChange(file string, objectID ObjectIdentifier, changes ...Change)

func (r ResultV2) Changes() []Change

func (r ResultV2) Objects() ObjectChanges

type ScreeningLocalReader ¶ added in v0.2.0

type ScreeningLocalReader struct {
	Token string
	Path  string

	Trace logr.Logger

	// This records the relative path of each file that passed
	// screening (i.e., contained the token), but couldn't be parsed.
	ProblemFiles []string
}

ScreeningReader is a kio.Reader that includes only files that are pertinent to automation. In practice this means looking for a particular token in each file, and ignoring those files without the token. This avoids most problematic cases -- e.g., templates in a Helm chart, which won't parse as YAML -- and cheaply filters for only those files that need processing.

func (r *ScreeningLocalReader) Read() ([]*yaml.RNode, error)

type SetAllCallback ¶ added in v0.8.0

type SetAllCallback struct {
	SettersSchema *spec.Schema
	Callback      func(setter, oldValue, newValue string)
	Trace         logr.Logger
}

func (s *SetAllCallback) Filter(object *yaml.RNode) (*yaml.RNode, error)

func (s *SetAllCallback) TraceOrDiscard() logr.Logger