image-automation-controller/docs/api/image-automation.md

Image update automation API reference

Packages:

• image.toolkit.fluxcd.io/v1alpha1

image.toolkit.fluxcd.io/v1alpha1

Package v1alpha1 contains API types for the image v1alpha1 API group. The types here are concerned with automated updates to git, based on metadata from OCI image registries gathered by the image-reflector-controller.

Resource Types:

CommitSpec

(Appears on: ImageUpdateAutomationSpec)

CommitSpec specifies how to commit changes to the git repository

Field	Description
authorName string	AuthorName gives the name to provide when making a commit
authorEmail string	AuthorEmail gives the email to provide when making a commit
messageTemplate string	(Optional) MessageTemplate provides a template for the commit message, into which will be interpolated the details of the change made.

GitCheckoutSpec

(Appears on: ImageUpdateAutomationSpec)

Field	Description
gitRepositoryRef Kubernetes core/v1.LocalObjectReference	GitRepositoryRef refers to the resource giving access details to a git repository to update files in.
branch string	(Optional) Branch gives the branch to clone from the git repository. If missing, it will be left to default; be aware this may give indeterminate results.

ImageUpdateAutomation

ImageUpdateAutomation is the Schema for the imageupdateautomations API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ImageUpdateAutomationSpec	checkout GitCheckoutSpec Checkout gives the parameters for cloning the git repository, ready to make changes. interval Kubernetes meta/v1.Duration Interval gives an lower bound for how often the automation run should be attempted. update UpdateStrategy Update gives the specification for how to update the files in the repository commit CommitSpec Commit specifies how to commit to the git repo suspend bool (Optional) Suspend tells the controller to not run this automation, until it is unset (or set to false). Defaults to false.
status ImageUpdateAutomationStatus

ImageUpdateAutomationSpec

(Appears on: ImageUpdateAutomation)

ImageUpdateAutomationSpec defines the desired state of ImageUpdateAutomation

Field	Description
checkout GitCheckoutSpec	Checkout gives the parameters for cloning the git repository, ready to make changes.
interval Kubernetes meta/v1.Duration	Interval gives an lower bound for how often the automation run should be attempted.
update UpdateStrategy	Update gives the specification for how to update the files in the repository
commit CommitSpec	Commit specifies how to commit to the git repo
suspend bool	(Optional) Suspend tells the controller to not run this automation, until it is unset (or set to false). Defaults to false.

ImageUpdateAutomationStatus

(Appears on: ImageUpdateAutomation)

ImageUpdateAutomationStatus defines the observed state of ImageUpdateAutomation

Field	Description
lastAutomationRunTime Kubernetes meta/v1.Time	(Optional) LastAutomationRunTime records the last time the controller ran this automation through to completion (even if no updates were made).
observedGeneration int64	(Optional)
conditions []Kubernetes meta/v1.Condition	(Optional)
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus	(Members of ReconcileRequestStatus are embedded into this type.)

SettersStrategy

(Appears on: UpdateStrategy)

SettersStrategy specifies how to use kyaml setters to update the git repository.

Field	Description
paths []string	(Optional) Paths gives all paths that should be subject to updates using setters. If missing, the path . (the root of the git repository) is assumed.

UpdateStrategy

(Appears on: ImageUpdateAutomationSpec)

UpdateStrategy is a union of the various strategies for updating the git repository.

Field	Description
setters SettersStrategy	(Optional) Setters if present means update workloads using setters, via fields marked in the files themselves.

This page was automatically generated with gen-crd-api-reference-docs