fluxcd
/
image-automation-controller
mirror of https://github.com/fluxcd/image-automation-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
image-automation-controller/docs/api/image-automation.md

9.3 KiB
Raw Blame History

Image update automation API reference

Packages:

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

    Branch gives the branch to clone from the git repository.

    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. This can be left empty, to use the default value.
    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. This can be left empty, to use the default value.
    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).
    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.)

    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.

    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