Kluctl Controller API reference

Kluctl Controller API reference

Packages:

flux.kluctl.io/v1alpha1

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

Resource Types:

    Decryption

    (Appears on: KluctlDeploymentSpec)

    Decryption defines how decryption is handled for Kubernetes manifests.

    Field Description
    provider
    string

    Provider is the name of the decryption engine.

    secretRef
    github.com/fluxcd/pkg/apis/meta.LocalObjectReference
    (Optional)

    The secret name containing the private OpenPGP keys used for decryption.

    serviceAccount
    string
    (Optional)

    ServiceAccount specifies the service account used to authenticate against cloud providers. This is currently only usable for AWS KMS keys. The specified service account will be used to authenticate to AWS by signing a token in an IRSA compliant way.

    DurationOrNever

    (Appears on: KluctlDeploymentSpec)

    Field Description
    Duration
    Kubernetes meta/v1.Duration
    Never
    bool

    FixedImage

    (Appears on: KluctlDeploymentSpec)

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

    GitRef

    (Appears on: ProjectSource)

    Field Description
    branch
    string
    (Optional)

    Branch to filter for. Can also be a regex.

    tag
    string
    (Optional)

    Branch to filter for. Can also be a regex.

    HelmCredentials

    (Appears on: KluctlDeploymentSpec)

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

    SecretRef holds the name of a secret that contains the Helm credentials. The secret must either contain the fields credentialsId which refers to the credentialsId found in https://kluctl.io/docs/reference/deployments/helm/#private-chart-repositories or an url used to match the credentials found in Kluctl projects helm-chart.yaml files. The secret can either container basic authentication credentials via username and password or TLS authentication via certFile and keyFile. caFile can be specified to override the CA to use while contacting the repository. The secret can also contain insecureSkipTlsVerify: "true", which will disable TLS verification. passCredentialsAll: "true" can be specified to make the controller pass credentials to all requests, even if the hostname changes in-between.

    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


    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. Deprecated: Use source.path instead

    sourceRef
    github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
    (Optional)

    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. Deprecated: Use source instead

    source
    ProjectSource
    (Optional)

    Specifies the project source location

    decryption
    Decryption
    (Optional)

    Decrypt Kubernetes secrets before applying them on the cluster.

    interval
    Kubernetes meta/v1.Duration

    The interval at which to reconcile the KluctlDeployment. By default, the controller will re-deploy and validate the deployment on each reconciliation. To override this behavior, change the DeployInterval and/or ValidateInterval values.

    retryInterval
    Kubernetes meta/v1.Duration
    (Optional)

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

    deployInterval
    DurationOrNever
    (Optional)

    DeployInterval specifies the interval at which to deploy the KluctlDeployment. It defaults to the Interval value, meaning that it will re-deploy on every reconciliation. If you set DeployInterval to a different value,

    deployOnChanges
    bool
    (Optional)

    DeployOnChanges will cause a re-deployment whenever the rendered resources change in the deployment. This check is performed on every reconciliation. This means that a deployment will be triggered even before the DeployInterval has passed in case something has changed in the rendered resources.

    validateInterval
    DurationOrNever
    (Optional)

    ValidateInterval specifies the interval at which to validate the KluctlDeployment. Validation is performed the same way as with ‘kluctl validate -t ’. Defaults to the same value as specified in Interval. Validate is also performed whenever a deployment is performed, independent of the value of ValidateInterval

    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.

    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.

    helmCredentials
    []HelmCredentials
    (Optional)

    HelmCredentials is a list of Helm credentials used when non pre-pulled Helm Charts are used inside a Kluctl deployment.

    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, specify the context to be used via ‘context’

    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”.

    target
    string
    (Optional)

    Target specifies the kluctl target to deploy. If not specified, an empty target is used that has no name and no context. Use ‘TargetName’ and ‘Context’ to specify the name and context in that case.

    targetNameOverride
    string
    (Optional)

    TargetNameOverride sets or overrides the target name. This is especially useful when deployment without a target.

    context
    string
    (Optional)

    If specified, overrides the context to be used. This will effectively make kluctl ignore the context specified in the target.

    args
    k8s.io/apimachinery/pkg/runtime.RawExtension
    (Optional)

    Args specifies dynamic target args.

    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

    validate
    bool
    (Optional)

    Validate enables validation after deploying

    prune
    bool
    (Optional)

    Prune enables pruning after deploying.

    status
    KluctlDeploymentStatus

    KluctlDeploymentSpec

    (Appears on: KluctlDeployment)

    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. Deprecated: Use source.path instead

    sourceRef
    github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
    (Optional)

    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. Deprecated: Use source instead

    source
    ProjectSource
    (Optional)

    Specifies the project source location

    decryption
    Decryption
    (Optional)

    Decrypt Kubernetes secrets before applying them on the cluster.

    interval
    Kubernetes meta/v1.Duration

    The interval at which to reconcile the KluctlDeployment. By default, the controller will re-deploy and validate the deployment on each reconciliation. To override this behavior, change the DeployInterval and/or ValidateInterval values.

    retryInterval
    Kubernetes meta/v1.Duration
    (Optional)

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

    deployInterval
    DurationOrNever
    (Optional)

    DeployInterval specifies the interval at which to deploy the KluctlDeployment. It defaults to the Interval value, meaning that it will re-deploy on every reconciliation. If you set DeployInterval to a different value,

    deployOnChanges
    bool
    (Optional)

    DeployOnChanges will cause a re-deployment whenever the rendered resources change in the deployment. This check is performed on every reconciliation. This means that a deployment will be triggered even before the DeployInterval has passed in case something has changed in the rendered resources.

    validateInterval
    DurationOrNever
    (Optional)

    ValidateInterval specifies the interval at which to validate the KluctlDeployment. Validation is performed the same way as with ‘kluctl validate -t ’. Defaults to the same value as specified in Interval. Validate is also performed whenever a deployment is performed, independent of the value of ValidateInterval

    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.

    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.

    helmCredentials
    []HelmCredentials
    (Optional)

    HelmCredentials is a list of Helm credentials used when non pre-pulled Helm Charts are used inside a Kluctl deployment.

    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, specify the context to be used via ‘context’

    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”.

    target
    string
    (Optional)

    Target specifies the kluctl target to deploy. If not specified, an empty target is used that has no name and no context. Use ‘TargetName’ and ‘Context’ to specify the name and context in that case.

    targetNameOverride
    string
    (Optional)

    TargetNameOverride sets or overrides the target name. This is especially useful when deployment without a target.

    context
    string
    (Optional)

    If specified, overrides the context to be used. This will effectively make kluctl ignore the context specified in the target.

    args
    k8s.io/apimachinery/pkg/runtime.RawExtension
    (Optional)

    Args specifies dynamic target args.

    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

    validate
    bool
    (Optional)

    Validate enables validation after deploying

    prune
    bool
    (Optional)

    Prune enables pruning after deploying.

    KluctlDeploymentStatus

    (Appears on: KluctlDeployment)

    KluctlDeploymentStatus defines the observed state of KluctlDeployment

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

    (Members of ReconcileRequestStatus are embedded into this type.)

    lastHandledDeployAt
    string
    (Optional)
    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.

    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)

    KubeConfig

    (Appears on: KluctlDeploymentSpec)

    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

    ProjectSource

    (Appears on: KluctlDeploymentSpec)

    Field Description
    url
    string

    Url specifies the Git url where the project source is located

    ref
    GitRef
    (Optional)

    Ref specifies the branch, tag or commit that should be used. If omitted, the default branch of the repo is used.

    path
    string
    (Optional)

    Path specifies the sub-directory to be used as project directory

    secretRef
    github.com/fluxcd/pkg/apis/meta.LocalObjectReference
    (Optional)

    SecretRef specifies the Secret containing authentication credentials for the git repository. For HTTPS repositories the Secret must contain ‘username’ and ‘password’ fields. For SSH repositories the Secret must contain ‘identity’ and ‘known_hosts’ fields.

    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

    target
    string
    (Optional)
    targetNameOverride
    string
    (Optional)
    objectsHash
    string
    (Optional)

    ObjectsHash is the hash of all rendered objects

    RenameContext

    (Appears on: KluctlDeploymentSpec)

    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