Terraform API reference

Packages:

infra.contrib.fluxcd.io/v1alpha1

Resource Types:

    BackendConfigSpec

    (Appears on: TerraformSpec)

    BackendConfigSpec is for specifying configuration for Terraform’s Kubernetes backend

    Field Description
    disable
    bool     		(Optional)

    Disable is to completely disable the backend configuration.
    secretSuffix
    string     		(Optional)
    inClusterConfig
    bool     		(Optional)
    configPath
    string     		(Optional)
    labels
    map[string]string     		(Optional)

    CrossNamespaceSourceReference

    (Appears on: TerraformSpec)

    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.

    HealthCheck

    (Appears on: TerraformSpec)

    HealthCheck contains configuration needed to perform a health check after terraform is applied.

    Field Description
    name
    string

    Name of the health check.
    type
    string

    Type of the health check, valid values are (‘tcp’, ‘http’). If tcp is specified, address is required. If http is specified, url is required.
    url
    string     		(Optional)

    URL to perform http health check on. Required when http type is specified. Go template can be used to reference values from the terraform output (e.g. https://example.org, {{.output_url}}).
    address
    string     		(Optional)

    Address to perform tcp health check on. Required when tcp type is specified. Go template can be used to reference values from the terraform output (e.g. 127.0.0.1:8080, {{.address}}:{{.port}}).
    timeout
    Kubernetes meta/v1.Duration     		(Optional)

    The timeout period at which the connection should timeout if unable to complete the request. When not specified, default 20s timeout is used.

    PlanStatus

    (Appears on: TerraformStatus)

    Field Description
    lastApplied
    string     		(Optional)
    pending
    string     		(Optional)
    isDestroyPlan
    bool     		(Optional)
    isDriftDetectionPlan
    bool     		(Optional)

    Terraform

    Terraform is the Schema for the terraforms API

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

    approvePlan
    string     		(Optional)

    ApprovePlan specifies name of a plan wanted to approve. If its value is “auto”, the controller will automatically approve every plan.
    destroy
    bool     		(Optional)

    Destroy produces a destroy plan. Applying the plan will destroy all resources.
    backendConfig
    BackendConfigSpec     		(Optional)
    vars
    []Variable     		(Optional)

    List of input variables to set for the Terraform program.
    varsFrom
    []VarsReference     		(Optional)

    List of references to a Secret or a ConfigMap to generate variables for Terraform resources based on its data, selectively by varsKey. Values of the later Secret / ConfigMap with the samek keys will override those of the former.
    interval
    Kubernetes meta/v1.Duration

    The interval at which to reconcile the Terraform.
    retryInterval
    Kubernetes meta/v1.Duration     		(Optional)

    The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the TerraformSpec.Interval value to retry failures.
    path
    string     		(Optional)

    Path to the directory containing Terraform (.tf) files. Defaults to ‘None’, which translates to the root path of the SourceRef.
    sourceRef
    CrossNamespaceSourceReference

    SourceRef is the reference of the source where the Terraform files are stored.
    suspend
    bool     		(Optional)

    Suspend is to tell the controller to suspend subsequent TF executions, it does not apply to already started executions. Defaults to false.
    force
    bool     		(Optional)

    Force instructs the controller to unconditionally re-plan and re-apply TF resources. Defaults to false.
    writeOutputsToSecret
    WriteOutputsToSecretSpec     		(Optional)

    A list of target secrets for the outputs to be written as.
    disableDriftDetection
    bool     		(Optional)

    Disable automatic drift detection. Drift detection may be resource intensive in the context of a large cluster or complex Terraform statefile. Defaults to false.
    cliConfigSecretRef
    Kubernetes core/v1.SecretReference     		(Optional)
    healthChecks
    []HealthCheck     		(Optional)

    List of health checks to be performed.
    destroyResourcesOnDeletion
    bool     		(Optional)

    Create destroy plan and apply it to destroy terraform resources upon deletion of this object. Defaults to false.
    serviceAccountName
    string     		(Optional)

    Name of a ServiceAccount for the runner Pod to provision Terraform resources. Default to tf-runner.
    alwaysCleanupRunnerPod
    bool     		(Optional)

    Clean the runner pod up after each reconciliation cycle
    runnerTerminationGracePeriodSeconds
    int64     		(Optional)

    Configure the termination grace period for the runner pod. Use this parameter to allow the Terraform process to gracefully shutdown. Consider increasing for large, complex or slow-moving Terraform managed resources.
    status
    TerraformStatus

    TerraformSpec

    (Appears on: Terraform)

    TerraformSpec defines the desired state of Terraform

    Field Description
    approvePlan
    string     		(Optional)

    ApprovePlan specifies name of a plan wanted to approve. If its value is “auto”, the controller will automatically approve every plan.
    destroy
    bool     		(Optional)

    Destroy produces a destroy plan. Applying the plan will destroy all resources.
    backendConfig
    BackendConfigSpec     		(Optional)
    vars
    []Variable     		(Optional)

    List of input variables to set for the Terraform program.
    varsFrom
    []VarsReference     		(Optional)

    List of references to a Secret or a ConfigMap to generate variables for Terraform resources based on its data, selectively by varsKey. Values of the later Secret / ConfigMap with the samek keys will override those of the former.
    interval
    Kubernetes meta/v1.Duration

    The interval at which to reconcile the Terraform.
    retryInterval
    Kubernetes meta/v1.Duration     		(Optional)

    The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the TerraformSpec.Interval value to retry failures.
    path
    string     		(Optional)

    Path to the directory containing Terraform (.tf) files. Defaults to ‘None’, which translates to the root path of the SourceRef.
    sourceRef
    CrossNamespaceSourceReference

    SourceRef is the reference of the source where the Terraform files are stored.
    suspend
    bool     		(Optional)

    Suspend is to tell the controller to suspend subsequent TF executions, it does not apply to already started executions. Defaults to false.
    force
    bool     		(Optional)

    Force instructs the controller to unconditionally re-plan and re-apply TF resources. Defaults to false.
    writeOutputsToSecret
    WriteOutputsToSecretSpec     		(Optional)

    A list of target secrets for the outputs to be written as.
    disableDriftDetection
    bool     		(Optional)

    Disable automatic drift detection. Drift detection may be resource intensive in the context of a large cluster or complex Terraform statefile. Defaults to false.
    cliConfigSecretRef
    Kubernetes core/v1.SecretReference     		(Optional)
    healthChecks
    []HealthCheck     		(Optional)

    List of health checks to be performed.
    destroyResourcesOnDeletion
    bool     		(Optional)

    Create destroy plan and apply it to destroy terraform resources upon deletion of this object. Defaults to false.
    serviceAccountName
    string     		(Optional)

    Name of a ServiceAccount for the runner Pod to provision Terraform resources. Default to tf-runner.
    alwaysCleanupRunnerPod
    bool     		(Optional)

    Clean the runner pod up after each reconciliation cycle
    runnerTerminationGracePeriodSeconds
    int64     		(Optional)

    Configure the termination grace period for the runner pod. Use this parameter to allow the Terraform process to gracefully shutdown. Consider increasing for large, complex or slow-moving Terraform managed resources.

    TerraformStatus

    (Appears on: Terraform)

    TerraformStatus defines the observed state of Terraform

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

    The last successfully applied revision. The revision format for Git sources is /.
    lastAttemptedRevision
    string     		(Optional)

    LastAttemptedRevision is the revision of the last reconciliation attempt.
    lastPlannedRevision
    string     		(Optional)

    LastPlannedRevision is the revision used by the last planning process. The result could be either no plan change or a new plan generated.
    lastDriftDetectedAt
    Kubernetes meta/v1.Time     		(Optional)

    LastDriftDetectedAt is the time when the last drift was detected
    lastAppliedByDriftDetectionAt
    Kubernetes meta/v1.Time     		(Optional)

    LastAppliedByDriftDetectionAt is the time when the last drift was detected and terraform apply was performed as a result
    availableOutputs
    []string     		(Optional)
    plan
    PlanStatus     		(Optional)

    Variable

    (Appears on: TerraformSpec)

    Field Description
    name
    string

    Name is the name of the variable
    value
    Kubernetes pkg/apis/apiextensions/v1.JSON     		(Optional)
    valueFrom
    Kubernetes core/v1.EnvVarSource     		(Optional)

    VarsReference

    (Appears on: TerraformSpec)

    VarsReference contain a reference of a Secret or a ConfigMap to generate variables for Terraform resources based on its data, selectively by varsKey.

    Field Description
    kind
    string

    Kind of the values referent, valid values are (‘Secret’, ‘ConfigMap’).
    name
    string

    Name of the values referent. Should reside in the same namespace as the referring resource.
    varsKeys
    []string     		(Optional)

    VarsKeys is the data key where the values.yaml or a specific value can be found at. Defaults to all keys.
    optional
    bool     		(Optional)

    Optional marks this VarsReference as optional. When set, a not found error for the values reference is ignored, but any VarsKey or transient error will still result in a reconciliation failure.

    WriteOutputsToSecretSpec

    (Appears on: TerraformSpec)

    WriteOutputsToSecretSpec defines where to store outputs, and which outputs to be stored.

    Field Description
    name
    string

    Name is the name of the Secret to be written
    outputs
    []string     		(Optional)

    Outputs contain the selected names of outputs to be written to the secret. Empty array means writing all outputs, which is default.

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