Image update automation API reference v1beta1

Packages:

image.toolkit.fluxcd.io/v1beta1

Package v1beta1 contains API types for the image API group, version v1beta1. The types here are concerned with automated updates to git, based on metadata from OCI image registries gathered by the image-reflector-controller. v1alpha2 did some rearrangement from v1alpha1 to make room for future enhancements; v1beta1 does not change the schema from v1alpha2.

Resource Types:

CommitSpec

(Appears on: GitSpec)

CommitSpec specifies how to commit changes to the git repository

Field Description
author
CommitUser

Author gives the email and optionally the name to use as the author of commits.
signingKey
SigningKey 		(Optional)

SigningKey provides the option to sign commits with a GPG key
messageTemplate
string 		(Optional)

MessageTemplate provides a template for the commit message, into which will be interpolated the details of the change made.

CommitUser

(Appears on: CommitSpec)

Field Description
name
string 		(Optional)

Name gives the name to provide when making a commit.
email
string

Email gives the email to provide when making a commit.

CrossNamespaceSourceReference

(Appears on: ImageUpdateAutomationSpec)

CrossNamespaceSourceReference contains enough information to let you locate the typed Kubernetes resource object at cluster level.

Field Description
apiVersion
string 		(Optional)

API version of the referent.
kind
string

Kind of the referent.
name
string

Name of the referent.
namespace
string 		(Optional)

Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference.

GitCheckoutSpec

(Appears on: GitSpec)

Field Description
ref
Source /v1.GitRepositoryRef

Reference gives a branch, tag or commit to clone from the Git repository.

GitSpec

(Appears on: ImageUpdateAutomationSpec)

Field Description
checkout
GitCheckoutSpec 		(Optional)

Checkout gives the parameters for cloning the git repository, ready to make changes. If not present, the spec.ref field from the referenced GitRepository or its default will be used.
commit
CommitSpec

Commit specifies how to commit to the git repository.
push
PushSpec 		(Optional)

Push specifies how and where to push commits made by the automation. If missing, commits are pushed (back) to .spec.checkout.branch or its default.

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

sourceRef
CrossNamespaceSourceReference

SourceRef refers to the resource giving access details to a git repository.
git
GitSpec 		(Optional)

GitSpec contains all the git-specific definitions. This is technically optional, but in practice mandatory until there are other kinds of source allowed.
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. This can be left empty, to use the default value.
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
sourceRef
CrossNamespaceSourceReference

SourceRef refers to the resource giving access details to a git repository.
git
GitSpec 		(Optional)

GitSpec contains all the git-specific definitions. This is technically optional, but in practice mandatory until there are other kinds of source allowed.
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. This can be left empty, to use the default value.
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).
lastPushCommit
string 		(Optional)

LastPushCommit records the SHA1 of the last commit made by the controller, for this automation object
lastPushTime
Kubernetes meta/v1.Time 		(Optional)

LastPushTime records the time of the last pushed change.
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.)

PushSpec

(Appears on: GitSpec)

PushSpec specifies how and where to push commits.

Field Description
branch
string 		(Optional)

Branch specifies that commits should be pushed to the branch named. The branch is created using .spec.checkout.branch as the starting point, if it doesn’t already exist.
refspec
string 		(Optional)

Refspec specifies the Git Refspec to use for a push operation. If both Branch and Refspec are provided, then the commit is pushed to the branch and also using the specified refspec. For more details about Git Refspecs, see: https://git-scm.com/book/en/v2/Git-Internals-The-Refspec
options
map[string]string 		(Optional)

Options specifies the push options that are sent to the Git server when performing a push operation. For details, see: https://git-scm.com/docs/git-push#Documentation/git-push.txt—push-optionltoptiongt

SigningKey

(Appears on: CommitSpec)

SigningKey references a Kubernetes secret that contains a GPG keypair

Field Description
secretRef
github.com/fluxcd/pkg/apis/meta.LocalObjectReference

SecretRef holds the name to a secret that contains a ‘git.asc’ key corresponding to the ASCII Armored file containing the GPG signing keypair as the value. It must be in the same namespace as the ImageUpdateAutomation.

UpdateStrategy

(Appears on: ImageUpdateAutomationSpec)

UpdateStrategy is a union of the various strategies for updating the Git repository. Parameters for each strategy (if any) can be inlined here.

Field Description
strategy
UpdateStrategyName

Strategy names the strategy to be used.
path
string 		(Optional)

Path to the directory containing the manifests to be updated. Defaults to ‘None’, which translates to the root path of the GitRepositoryRef.

UpdateStrategyName (string alias)

(Appears on: UpdateStrategy)

UpdateStrategyName is the type for names that go in .update.strategy. NB the value in the const immediately below.

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