KluctlDeployment API reference

Flux Kluctl Controller documentation.

Packages:

flux.kluctl.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the flux.kluctl.io v1alpha1 API group.

Resource Types:

    FixedImage

    (Appears on: KluctlDeploymentTemplateSpec)

    Field Description
    image
    string
    resultImage
    string
    deployedImage
    string
    registryImage
    string
    namespace
    string
    object
    ObjectRef
    deployment
    string
    container
    string
    versionFilter
    string
    deployTags
    []string
    deploymentDir
    string

    KluctlDeployment

    KluctlDeployment is the Schema for the kluctldeployments API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    KluctlDeploymentSpec


    KluctlProjectSpec
    KluctlProjectSpec

    (Members of KluctlProjectSpec are embedded into this type.)

    KluctlDeploymentTemplateSpec
    KluctlDeploymentTemplateSpec

    (Members of KluctlDeploymentTemplateSpec are embedded into this type.)

    target
    string

    Target specifies the kluctl target to deploy

    status
    KluctlDeploymentStatus

    KluctlDeploymentSpec

    (Appears on: KluctlDeployment)

    KluctlDeploymentSpec defines the desired state of KluctlDeployment

    Field Description
    KluctlProjectSpec
    KluctlProjectSpec

    (Members of KluctlProjectSpec are embedded into this type.)

    KluctlDeploymentTemplateSpec
    KluctlDeploymentTemplateSpec

    (Members of KluctlDeploymentTemplateSpec are embedded into this type.)

    target
    string

    Target specifies the kluctl target to deploy

    KluctlDeploymentStatus

    (Appears on: KluctlDeployment)

    KluctlDeploymentStatus defines the observed state of KluctlDeployment

    Field Description
    KluctlProjectStatus
    KluctlProjectStatus

    (Members of KluctlProjectStatus are embedded into this type.)

    lastDeployResult
    LastCommandResult
    (Optional)

    LastDeployResult is the result of the last deploy command

    lastPruneResult
    LastCommandResult
    (Optional)

    LastDeployResult is the result of the last prune command

    lastValidateResult
    LastValidateResult
    (Optional)

    LastValidateResult is the result of the last validate command

    commonLabels
    map[string]string
    (Optional)

    CommonLabels are the commonLabels found in the deployment project when the last deployment was done. This is used to perform cleanup/deletion in case the KluctlDeployment project is deleted

    rawTarget
    string
    (Optional)

    KluctlDeploymentTemplateSpec

    (Appears on: KluctlDeploymentSpec)

    Field Description
    KluctlTimingSpec
    KluctlTimingSpec

    (Members of KluctlTimingSpec are embedded into this type.)

    registrySecrets
    []github.com/fluxcd/pkg/apis/meta.LocalObjectReference
    (Optional)

    RegistrySecrets is a list of secret references to be used for image registry authentication. The secrets must either have “.dockerconfigjson” included or “registry”, “username” and “password”. Additionally, “caFile” and “insecure” can be specified.

    serviceAccountName
    string
    (Optional)

    The name of the Kubernetes service account to use while deploying. If not specified, the default service account is used.

    kubeConfig
    KubeConfig
    (Optional)

    The KubeConfig for deploying to the target cluster. Specifies the kubeconfig to be used when invoking kluctl. Contexts in this kubeconfig must match the context found in the kluctl target. As an alternative, RenameContexts can be used to fix non-matching context names.

    renameContexts
    []RenameContext
    (Optional)

    RenameContexts specifies a list of context rename operations. This is useful when the kluctl target’s context does not match with the contexts found in the kubeconfig while deploying. This is the case when using kubeconfigs generated from service accounts, in which case the context name is always “default”.

    args
    map[string]string
    (Optional)

    Args specifies dynamic target args. Only arguments defined by ‘dynamicArgs’ of the target are allowed.

    updateImages
    bool
    (Optional)

    UpdateImages instructs kluctl to update dynamic images. Equivalent to using ‘-u’ when calling kluctl.

    images
    []FixedImage
    (Optional)

    Images contains a list of fixed image overrides. Equivalent to using ‘–fixed-images-file’ when calling kluctl.

    dryRun
    bool
    (Optional)

    DryRun instructs kluctl to run everything in dry-run mode. Equivalent to using ‘–dry-run’ when calling kluctl.

    noWait
    bool
    (Optional)

    NoWait instructs kluctl to not wait for any resources to become ready, including hooks. Equivalent to using ‘–no-wait’ when calling kluctl.

    forceApply
    bool
    (Optional)

    ForceApply instructs kluctl to force-apply in case of SSA conflicts. Equivalent to using ‘–force-apply’ when calling kluctl.

    replaceOnError
    bool
    (Optional)

    ReplaceOnError instructs kluctl to replace resources on error. Equivalent to using ‘–replace-on-error’ when calling kluctl.

    forceReplaceOnError
    bool
    (Optional)

    ForceReplaceOnError instructs kluctl to force-replace resources in case a normal replace fails. Equivalent to using ‘–force-replace-on-error’ when calling kluctl.

    abortOnError
    bool
    (Optional)

    ForceReplaceOnError instructs kluctl to abort deployments immediately when something fails. Equivalent to using ‘–abort-on-error’ when calling kluctl.

    includeTags
    []string
    (Optional)

    IncludeTags instructs kluctl to only include deployments with given tags. Equivalent to using ‘–include-tag’ when calling kluctl.

    excludeTags
    []string
    (Optional)

    ExcludeTags instructs kluctl to exclude deployments with given tags. Equivalent to using ‘–exclude-tag’ when calling kluctl.

    includeDeploymentDirs
    []string
    (Optional)

    IncludeDeploymentDirs instructs kluctl to only include deployments with the given dir. Equivalent to using ‘–include-deployment-dir’ when calling kluctl.

    excludeDeploymentDirs
    []string
    (Optional)

    ExcludeDeploymentDirs instructs kluctl to exclude deployments with the given dir. Equivalent to using ‘–exclude-deployment-dir’ when calling kluctl.

    deployMode
    string
    (Optional)

    DeployMode specifies what deploy mode should be used

    prune
    bool
    (Optional)

    Prune enables pruning after deploying.

    deployInterval
    Kubernetes meta/v1.Duration
    (Optional)

    DeployInterval specifies the interval at which to deploy the KluctlDeployment. This is independent of the ‘Interval’ value, which only causes deployments if some deployment objects have changed.

    validateInterval
    Kubernetes meta/v1.Duration
    (Optional)

    ValidateInterval specifies the interval at which to validate the KluctlDeployment. Validation is performed the same way as with ‘kluctl validate -t ’. Defaults to 1m.

    KluctlProjectSpec

    (Appears on: KluctlDeploymentSpec)

    Field Description
    path
    string
    (Optional)

    Path to the directory containing the .kluctl.yaml file, or the Defaults to ‘None’, which translates to the root path of the SourceRef.

    sourceRef
    github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference

    Reference of the source where the kluctl project is. The authentication secrets from the source are also used to authenticate dependent git repositories which are cloned while deploying the kluctl project.

    KluctlProjectStatus

    (Appears on: KluctlDeploymentStatus)

    KluctlProjectStatus defines the observed state of KluctlProjectStatus

    Field Description
    ReconcileRequestStatus
    github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus

    (Members of ReconcileRequestStatus are embedded into this type.)

    observedGeneration
    int64
    (Optional)

    ObservedGeneration is the last reconciled generation.

    conditions
    []Kubernetes meta/v1.Condition
    (Optional)
    lastAttemptedRevision
    string
    (Optional)

    LastAttemptedRevision is the revision of the last reconciliation attempt.

    KluctlTimingSpec

    (Appears on: KluctlDeploymentTemplateSpec)

    Field Description
    interval
    Kubernetes meta/v1.Duration

    The interval at which to reconcile the KluctlDeployment.

    retryInterval
    Kubernetes meta/v1.Duration
    (Optional)

    The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KluctlDeploymentSpec.Interval value to retry failures.

    timeout
    Kubernetes meta/v1.Duration
    (Optional)

    Timeout for all operations. Defaults to ‘Interval’ duration.

    suspend
    bool
    (Optional)

    This flag tells the controller to suspend subsequent kluctl executions, it does not apply to already started executions. Defaults to false.

    KubeConfig

    (Appears on: KluctlDeploymentTemplateSpec)

    KubeConfig references a Kubernetes secret that contains a kubeconfig file.

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

    SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to ‘value’. The secret must be in the same namespace as the Kustomization. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific cmd-path auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling the KluctlDeployment.

    LastCommandResult

    (Appears on: KluctlDeploymentStatus)

    Field Description
    ReconcileResultBase
    ReconcileResultBase

    (Members of ReconcileResultBase are embedded into this type.)

    rawResult
    string
    (Optional)
    error
    string
    (Optional)

    LastValidateResult

    (Appears on: KluctlDeploymentStatus)

    Field Description
    ReconcileResultBase
    ReconcileResultBase

    (Members of ReconcileResultBase are embedded into this type.)

    rawResult
    string
    (Optional)
    error
    string
    (Optional)

    ObjectRef

    (Appears on: FixedImage)

    ObjectRef contains the information necessary to locate a resource within a cluster.

    Field Description
    group
    string
    version
    string
    kind
    string
    name
    string
    namespace
    string

    ReconcileResultBase

    (Appears on: LastCommandResult, LastValidateResult)

    Field Description
    time
    Kubernetes meta/v1.Time

    AttemptedAt is the time when the attempt was performed

    revision
    string
    (Optional)

    Revision is the source revision. Please note that kluctl projects have dependent git repositories which are not considered in the source revision

    targetName
    string

    TargetName is the name of the target

    objectsHash
    string
    (Optional)

    ObjectsHash is the hash of all rendered objects

    RenameContext

    (Appears on: KluctlDeploymentTemplateSpec)

    RenameContext specifies a single rename of a context

    Field Description
    oldContext
    string

    OldContext is the name of the context to be renamed

    newContext
    string

    NewContext is the new name of the context

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