konfigurations.md

Packages:

• jsonnet.io/v1beta1

jsonnet.io/v1beta1

Package v1beta1 file doc.go required for the doc generator to register this as an API

Resource Types:

Konfiguration

Konfiguration is the Schema for the konfigurations API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec KonfigurationSpec	dependsOn []FluxCD runtime/dependency.CrossNamespaceDependencyReference (Optional) DependsOn may contain a dependency.CrossNamespaceDependencyReference slice with references to Konfiguration resources that must be ready before this Konfiguration can be reconciled. interval Kubernetes meta/v1.Duration The interval at which to reconcile the Konfiguration. retryInterval Kubernetes meta/v1.Duration (Optional) The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KonfigurationSpec.Interval value to retry failures. kubeConfig KubeConfig (Optional) The KubeConfig for reconciling the Konfiguration on a remote cluster. Defaults to the in-cluster configuration. path string Path to the jsonnet, json, or yaml that should be applied to the cluster. Defaults to ‘None’, which translates to the root path of the SourceRef. When declared as a file path it is assumed to be from the root path of the SourceRef. You may also define a HTTP(S) link to fetch files from a remote location. jsonnetPaths []string (Optional) Additional search paths to add to the jsonnet importer. These are relative to the root of the sourceRef. jsonnetURLs []string (Optional) Additional HTTP(S) URLs to add to the jsonnet importer. variables Variables (Optional) External variables and top-level arguments to supply to the jsonnet at path. inject string (Optional) Inject raw jsonnet into the evaluation. serviceAccountName string (Optional) The name of the Kubernetes service account to impersonate when reconciling this Konfiguration. sourceRef FluxCD apis/meta.NamespacedObjectKindReference (Optional) Reference of the source where the jsonnet, json, or yaml file(s) are. prune bool Prune enables garbage collection. This means that when newly rendered jsonnet does not contain objects that were applied previously, they will be removed. When a Konfiguration is removed that had this value set to true, all resources created by it will also be removed. healthChecks []FluxCD apis/meta.NamespacedObjectKindReference (Optional) A list of resources to be included in the health assessment. suspend bool (Optional) This flag tells the controller to suspend subsequent reconciliations, it does not apply to already started executions. Defaults to false. timeout Kubernetes meta/v1.Duration (Optional) Timeout for diff, validation, apply, and health checking operations. Defaults to ‘Interval’ duration. validate bool (Optional) Validate input against the server schema, defaults to true. At the moment this just implies a dry-run before patch/create operations. This will be updated to support different methods of validation. force bool (Optional) Force instructs the controller to recreate resources when patching fails due to an immutable field change.
status KonfigurationStatus

KonfigurationSpec

(Appears on:Konfiguration)

KonfigurationSpec defines the desired state of a Konfiguration

Field	Description
dependsOn []FluxCD runtime/dependency.CrossNamespaceDependencyReference	(Optional) DependsOn may contain a dependency.CrossNamespaceDependencyReference slice with references to Konfiguration resources that must be ready before this Konfiguration can be reconciled.
interval Kubernetes meta/v1.Duration	The interval at which to reconcile the Konfiguration.
retryInterval Kubernetes meta/v1.Duration	(Optional) The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KonfigurationSpec.Interval value to retry failures.
kubeConfig KubeConfig	(Optional) The KubeConfig for reconciling the Konfiguration on a remote cluster. Defaults to the in-cluster configuration.
path string	Path to the jsonnet, json, or yaml that should be applied to the cluster. Defaults to ‘None’, which translates to the root path of the SourceRef. When declared as a file path it is assumed to be from the root path of the SourceRef. You may also define a HTTP(S) link to fetch files from a remote location.
jsonnetPaths []string	(Optional) Additional search paths to add to the jsonnet importer. These are relative to the root of the sourceRef.
jsonnetURLs []string	(Optional) Additional HTTP(S) URLs to add to the jsonnet importer.
variables Variables	(Optional) External variables and top-level arguments to supply to the jsonnet at path.
inject string	(Optional) Inject raw jsonnet into the evaluation.
serviceAccountName string	(Optional) The name of the Kubernetes service account to impersonate when reconciling this Konfiguration.
sourceRef FluxCD apis/meta.NamespacedObjectKindReference	(Optional) Reference of the source where the jsonnet, json, or yaml file(s) are.
prune bool	Prune enables garbage collection. This means that when newly rendered jsonnet does not contain objects that were applied previously, they will be removed. When a Konfiguration is removed that had this value set to true, all resources created by it will also be removed.
healthChecks []FluxCD apis/meta.NamespacedObjectKindReference	(Optional) A list of resources to be included in the health assessment.
suspend bool	(Optional) This flag tells the controller to suspend subsequent reconciliations, it does not apply to already started executions. Defaults to false.
timeout Kubernetes meta/v1.Duration	(Optional) Timeout for diff, validation, apply, and health checking operations. Defaults to ‘Interval’ duration.
validate bool	(Optional) Validate input against the server schema, defaults to true. At the moment this just implies a dry-run before patch/create operations. This will be updated to support different methods of validation.
force bool	(Optional) Force instructs the controller to recreate resources when patching fails due to an immutable field change.

KonfigurationStatus

(Appears on:Konfiguration)

KonfigurationStatus defines the observed state of Konfiguration

Field	Description
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 /. For HTTP(S) paths it will just be the URL.
lastAttemptedRevision string	(Optional) LastAttemptedRevision is the revision of the last reconciliation attempt. For HTTP(S) paths it will just be the URL.
snapshot Snapshot	(Optional) The last successfully applied revision metadata.

KubeConfig

(Appears on:KonfigurationSpec)

KubeConfig holds the configuration for where to fetch the contents of a kubeconfig file.

Field

Description

secretRef Kubernetes core/v1.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 Konfiguration. 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 Konfiguration.

Snapshot

(Appears on:KonfigurationStatus)

Snapshot holds the metadata of the Kubernetes objects generated for a source revision

Field	Description
checksum string	The manifests sha1 checksum.
entries []SnapshotEntry	A list of Kubernetes kinds grouped by namespace.

SnapshotEntry

(Appears on:Snapshot)

SnapshotEntry holds the metadata of namespaced Kubernetes objects

Field	Description
namespace string	(Optional) The namespace of this entry.
kinds map[string]string	The list of Kubernetes kinds.

StatusMeta

StatusMeta is a helper struct for setting the status on custom resources.

Field	Description
Revision string
Reason string
Message string

Variables

(Appears on:KonfigurationSpec)

Variables describe code/strings for external variables and top-level arguments.

Field	Description
extStr map[string]string	(Optional) Values of external variables with string values.
extCode map[string]string	(Optional) Values of external variables with values supplied as Jsonnet code.
extVars k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	(Optional) Values for external variables. They will be used as strings or code depending on the types encountered.
tlaStr map[string]string	(Optional) Values of top-level-arguments with string values.
tlaCode map[string]string	(Optional) Values of top-level-arguments with values supplied as Jsonnet code.
tlaVars k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	(Optional) Values for top level arguments. They will be used as strings or code depending on the types encountered.

---

Generated with gen-crd-api-reference-docs on git commit 03dee2e.