Last generated September 5, 2025
Konfiguration
Konfiguration is the Schema for the konfigurations API.
Version v1alpha1
Example CR
apiVersion: konfigure.giantswarm.io/v1alpha1
kind: Konfiguration
metadata:
name: konfiguration-sample
namespace: default
spec:
targets:
schema:
reference:
name: konfigurationschema-sample
namespace: default
defaults:
variables:
- name: installation
value: golem
iterations:
app-operator:
variables:
- name: app
value: app-operator
chart-operator:
variables:
- name: app
value: chart-operator
dex-operator:
variables:
- name: app
value: dex-operator
destination:
namespace: default
naming:
suffix: sample
reconciliation:
interval: 1m
retryInterval: 10s
sources:
flux:
gitRepository:
name: config-sample
namespace: default
Properties
.apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
.kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
.metadata
.spec
KonfigurationSpec defines the desired state of the Konfiguration.
.spec.destination
Defines where and how to store the rendered konfigurations.
.spec.destination.namespace
Defines the namespace where the rendered Kubernetes manifests will be applied.
.spec.destination.naming
Defines rules on how to name the rendered Kubernetes manifests.
.spec.destination.naming.prefix
Prefix is prepended at the beginning of the iteration name.
.spec.destination.naming.suffix
Suffix is appended to the end of the iteration name.
.spec.destination.naming.useSeparator
UseSeparator indicates whether to separate the iteration name
from the prefix and/or suffix with a single - character.
.spec.reconciliation
Defines how to reconcile the Konfiguration.
.spec.reconciliation.interval
The interval at which to reconcile the Konfiguration.
.spec.reconciliation.retryInterval
The interval at which to retry a previously failed reconciliation.
.spec.reconciliation.suspend
This flag tells the controller to suspend rendering the Konfiguration. It does not apply to already started executions. Default is false.
.spec.sources
Defines where to find the source of the konfiguration that needs to be rendered.
.spec.sources.flux
Defines to locate the source of the konfiguration structure as a Flux source.
.spec.sources.flux.gitRepository
Defines the source as a Flux GitRepository manifest.
.spec.sources.flux.gitRepository.name
Name of the referenced Flux GitRepository resource.
.spec.sources.flux.gitRepository.namespace
Namespace of the referenced Flux GitRepository resource.
.spec.targets
Define what konfigurations to render.
.spec.targets.defaults
Define default inputs to be used for every single iteration. Individual iterations may override default inputs.
.spec.targets.defaults.variables
Defines default variable inputs to be used for every single iteration.
.spec.targets.defaults.variables[*]
NameValuePair is a simple structure for defining input fields by name and value.
.spec.targets.defaults.variables[*].name
Name of the input.
.spec.targets.defaults.variables[*].value
Value of the input.
.spec.targets.iterations
Defines what konfigurations to render. A single reconciliation loop iterates over each entry and renders the konfiguration, wraps them to Kubernetes manifests and enforces the state of those in the cluster.
.spec.targets.schema
Defines where to locate the KonfigurationSchema.
.spec.targets.schema.reference
Defines where to locate the KonfigurationSchema as a Kubernetes manifest.
.spec.targets.schema.reference.name
Defines the .metadata.name of the KonfigurationSchema Kubernetes manifest to fetch.
.spec.targets.schema.reference.namespace
Defines the .metadata.namespace of the KonfigurationSchema Kubernetes manifest to fetch.
.status
KonfigurationStatus defines the observed state of Konfiguration.
.status.conditions
.status.conditions[*]
Condition contains details for one aspect of the current state of this API Resource.
.status.conditions[*].lastTransitionTime
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
.status.conditions[*].message
message is a human readable message indicating details about the transition. This may be an empty string.
.status.conditions[*].observedGeneration
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
.status.conditions[*].reason
reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
.status.conditions[*].status
status of the condition, one of True, False, Unknown.
.status.conditions[*].type
type of condition in CamelCase or in foo.example.com/CamelCase.
.status.disabled
The list of rendered manifests that were not applied during the last full reconciliation,
because their reconciliation is disabled via the configuration.giantswarm.io/reconcile: disabled label.
.status.disabled[*]
DisabledIteration defines information on managed Kubernetes manifests whose state is not currently enforced because they are disabled for reconciliation.
.status.disabled[*].appName
The name of the iteration, that is the map key under .spec.targets.iterations.
.status.disabled[*].kind
The kind of the iteration from the schema, generally ConfigMap or Secret.
.status.disabled[*].target
Reference to the target manifest.
.status.disabled[*].target.name
Name of the resource.
.status.disabled[*].target.namespace
Namespace of the resource.
.status.failed
The list of failed iterations during the last full reconciliation.
.status.failed[*]
FailedIteration defines information of a single failed iteration.
.status.failed[*].appName
The name of the iteration, that is the map key under .spec.targets.iterations.
.status.failed[*].message
Informational message on the cause of the failure.
.status.lastAppliedRevision
The last successfully applied revision. Equals the Revision of the applied artifact from the referenced source.
.status.lastAttemptedRevision
The last revision that was attempted for reconciliation. Equals the Revision of the last attempted artifact from the referenced source.
.status.lastReconciledAt
The last time the Konfiguration attempted reconciliation.
.status.observedGeneration
ObservedGeneration is the last observed generation.
This documentation page shows information based on konfigure-operator v1.0.1.
Need help with the platform API?
We listen in your Slack support channel. And of course, we welcome your pull requests to improve these docs!