Skip to content

Latest commit

 

History

History
1068 lines (1068 loc) · 18.6 KB

cue.md

File metadata and controls

1068 lines (1068 loc) · 18.6 KB

CUE Instance API reference

Packages:

cue.contrib.flux.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the cue v1alpha1 API group

Resource Types:

    CrossNamespaceSourceReference

    (Appears on: CueInstanceSpec)

    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.

    CueInstance

    CueInstance is the Schema for the cueinstances API

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

    interval
    Kubernetes meta/v1.Duration

    The interval at which the instance will be reconciled.
    sourceRef
    CrossNamespaceSourceReference

    A reference to a Flux Source from which an artifact will be downloaded and the CUE instance built.
    root
    string     		(Optional)

    The module root of the CUE instance.
    path
    string     		(Optional)

    The path at which the CUE instance will be built from.
    package
    string     		(Optional)

    The CUE package to use for the CUE instance. This is useful when applying a CUE schema to plain yaml files.
    tags
    []TagVar     		(Optional)

    Tags that will be injected into the CUE instance.
    tagVars
    []TagVar     		(Optional)

    TagVars that will be available to the CUE instance.
    expressions
    []string     		(Optional)

    The CUE expression(s) to execute.
    gates
    []GateExpr     		(Optional)

    A list of CUE expressions that must be true for the CUE instance to be reconciled
    dependsOn
    []github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference     		(Optional)

    Dependencies that must be ready before the CUE instance is reconciled.
    healthChecks
    []github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference     		(Optional)

    A list of resources to be included in the health assessment.
    prune
    bool

    Prune enables garbage collection.
    retryInterval
    Kubernetes meta/v1.Duration     		(Optional)

    The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the CueInstanceSpec.Interval value to retry failures.
    timeout
    Kubernetes meta/v1.Duration     		(Optional)

    Timeout for validation, apply and health checking operations. Defaults to ‘Interval’ duration.
    suspend
    bool     		(Optional)

    This flag tells the controller to suspend subsequent cue executions, it does not apply to already started executions. Defaults to false.
    serviceAccountName
    string     		(Optional)

    The name of the Kubernetes service account to impersonate when reconciling this CueInstance.
    kubeConfig
    KubeConfig     		(Optional)

    The KubeConfig for reconciling the CueInstance on a remote cluster. When specified, KubeConfig takes precedence over ServiceAccountName.
    force
    bool     		(Optional)

    Force instructs the controller to recreate resources when patching fails due to an immutable field change.
    wait
    bool     		(Optional)

    Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false.
    validate
    Validation     		(Optional)

    TODO(maybe): this could be an array of validations in which case the policy may need to apply to all resources would allow for greater flexibility
    status
    CueInstanceStatus

    CueInstanceSpec

    (Appears on: CueInstance)

    CueInstanceSpec defines the desired state of CueInstance

    Field Description
    interval
    Kubernetes meta/v1.Duration

    The interval at which the instance will be reconciled.
    sourceRef
    CrossNamespaceSourceReference

    A reference to a Flux Source from which an artifact will be downloaded and the CUE instance built.
    root
    string     		(Optional)

    The module root of the CUE instance.
    path
    string     		(Optional)

    The path at which the CUE instance will be built from.
    package
    string     		(Optional)

    The CUE package to use for the CUE instance. This is useful when applying a CUE schema to plain yaml files.
    tags
    []TagVar     		(Optional)

    Tags that will be injected into the CUE instance.
    tagVars
    []TagVar     		(Optional)

    TagVars that will be available to the CUE instance.
    expressions
    []string     		(Optional)

    The CUE expression(s) to execute.
    gates
    []GateExpr     		(Optional)

    A list of CUE expressions that must be true for the CUE instance to be reconciled
    dependsOn
    []github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference     		(Optional)

    Dependencies that must be ready before the CUE instance is reconciled.
    healthChecks
    []github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference     		(Optional)

    A list of resources to be included in the health assessment.
    prune
    bool

    Prune enables garbage collection.
    retryInterval
    Kubernetes meta/v1.Duration     		(Optional)

    The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the CueInstanceSpec.Interval value to retry failures.
    timeout
    Kubernetes meta/v1.Duration     		(Optional)

    Timeout for validation, apply and health checking operations. Defaults to ‘Interval’ duration.
    suspend
    bool     		(Optional)

    This flag tells the controller to suspend subsequent cue executions, it does not apply to already started executions. Defaults to false.
    serviceAccountName
    string     		(Optional)

    The name of the Kubernetes service account to impersonate when reconciling this CueInstance.
    kubeConfig
    KubeConfig     		(Optional)

    The KubeConfig for reconciling the CueInstance on a remote cluster. When specified, KubeConfig takes precedence over ServiceAccountName.
    force
    bool     		(Optional)

    Force instructs the controller to recreate resources when patching fails due to an immutable field change.
    wait
    bool     		(Optional)

    Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false.
    validate
    Validation     		(Optional)

    TODO(maybe): this could be an array of validations in which case the policy may need to apply to all resources would allow for greater flexibility

    CueInstanceStatus

    (Appears on: CueInstance)

    CueInstanceStatus defines the observed state of CueInstance

    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.
    inventory
    ResourceInventory     		(Optional)

    Inventory contains the list of Kubernetes resource object references that have been successfully applied.

    GateExpr

    (Appears on: CueInstanceSpec)

    GateExpr defines a CUE expression that must be true for the CUE instance to be reconciled

    Field Description
    expr
    string

    The CUE expression to evaluate.
    name
    string

    The name of the gate.

    KubeConfig

    (Appears on: CueInstanceSpec)

    KubeConfig references a Kubernetes secret that contains a kubeconfig file.

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

    SecretRef holds the name to a secret that contains a ‘value’ key with the kubeconfig file as the value. It must be in the same namespace as the CueInstance. 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 CueInstance.

    ResourceInventory

    (Appears on: CueInstanceStatus)

    ResourceInventory contains a list of Kubernetes resource object references that have been applied by a Kustomization.

    Field Description
    entries
    []ResourceRef

    Entries of Kubernetes resource object references.

    ResourceRef

    (Appears on: ResourceInventory)

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

    Field Description
    id
    string

    ID is the string representation of the Kubernetes resource object’s metadata, in the format ‘_’.
    v
    string

    Version is the API version of the Kubernetes resource object’s kind.

    TagVar

    (Appears on: CueInstanceSpec)

    TagVar is a tag variable with a required name and optional value

    Field Description
    name
    string
    value
    string     		(Optional)

    Validation

    (Appears on: CueInstanceSpec)

    Field Description
    mode
    ValidationMode     		(Optional)
    schema
    string
    type
    string     		(Optional)

    ValidationMode (string alias)

    (Appears on: Validation)

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