← Back to index Esc
Kind
Imageupdateautomation
Group
image.toolkit.fluxcd.io
Version
v1beta2
apiVersion: image.toolkit.fluxcd.io/v1beta2 kind: Imageupdateautomation metadata: name: example
View raw schema
apiVersion string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata object
spec object
ImageUpdateAutomationSpec defines the desired state of ImageUpdateAutomation
git object
GitSpec contains all the git-specific definitions. This is technically optional, but in practice mandatory until there are other kinds of source allowed.
checkout object
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.
ref object required
Reference gives a branch, tag or commit to clone from the Git repository.
branch string
Branch to check out, defaults to 'master' if no other field is defined.
commit string
Commit SHA to check out, takes precedence over all reference fields. This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist.
name string
Name of the reference to check out; takes precedence over Branch, Tag and SemVer. It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: "refs/heads/main", "refs/tags/v0.1.0", "refs/pull/420/head", "refs/merge-requests/1/head"
semver string
SemVer tag expression to check out, takes precedence over Tag.
tag string
Tag to check out, takes precedence over Branch.
commit object required
Commit specifies how to commit to the git repository.
author object required
Author gives the email and optionally the name to use as the author of commits.
email string required
Email gives the email to provide when making a commit.
name string
Name gives the name to provide when making a commit.
messageTemplate string
MessageTemplate provides a template for the commit message, into which will be interpolated the details of the change made.
signingKey object
SigningKey provides the option to sign commits with a GPG key
secretRef object required
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.
name string required
Name of the referent.
push object
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.
branch string
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.
options object
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
refspec string
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
interval string required
Interval gives an lower bound for how often the automation run should be attempted.
pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
policySelector object
PolicySelector allows to filter applied policies based on labels. By default includes all policies in namespace.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key string required
key is the label key that the selector applies to.
operator string required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values []string
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
sourceRef object required
SourceRef refers to the resource giving access details to a git repository.
apiVersion string
API version of the referent.
kind string required
Kind of the referent.
enum: GitRepository
name string required
Name of the referent.
namespace string
Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference.
suspend boolean
Suspend tells the controller to not run this automation, until it is unset (or set to false). Defaults to false.
update object
Update gives the specification for how to update the files in the repository. This can be left empty, to use the default value.
path string
Path to the directory containing the manifests to be updated. Defaults to 'None', which translates to the root path of the GitRepositoryRef.
strategy string required
Strategy names the strategy to be used.
enum: Setters
status object
ImageUpdateAutomationStatus defines the observed state of ImageUpdateAutomation
conditions []object
lastTransitionTime string required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
message string required
message is a human readable message indicating details about the transition. This may be an empty string.
maxLength: 32768
observedGeneration integer
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
format: int64
minimum: 0
reason string required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
minLength: 1
maxLength: 1024
status string required
status of the condition, one of True, False, Unknown.
enum: True, False, Unknown
type string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
maxLength: 316
lastAutomationRunTime string
LastAutomationRunTime records the last time the controller ran this automation through to completion (even if no updates were made).
format: date-time
lastHandledReconcileAt string
LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.
lastPushCommit string
LastPushCommit records the SHA1 of the last commit made by the controller, for this automation object
lastPushTime string
LastPushTime records the time of the last pushed change.
format: date-time
observedGeneration integer
format: int64
observedPolicies object
ObservedPolicies is the list of observed ImagePolicies that were considered by the ImageUpdateAutomation update process.
observedSourceRevision string
ObservedPolicies []ObservedPolicy `json:"observedPolicies,omitempty"` ObservedSourceRevision is the last observed source revision. This can be used to determine if the source has been updated since last observation.
Copied!