API Reference

Packages

• landscaper.gardener.cloud/v1alpha1

landscaper.gardener.cloud/v1alpha1

Package v1alpha1 is a version of the API.

Package v1alpha1 is the v1alpha1 version of the API.

AnyJSON

AnyJSON enhances the json.RawMessages with a dedicated openapi definition so that all it is correctly generated.

Appears in:

• BlueprintStaticDataSource
• Context
• ContextConfiguration
• DataObject
• Default
• InlineBlueprint
• InstallationSpec
• InstallationTemplate
• InstallationTemplateBlueprintDefinition
• StaticDataSource
• TargetSpec
• TargetTemplate
• TemplateExecutor

AutomaticReconcile

AutomaticReconcile allows to configure automatically repeated reconciliations.

Appears in:

• InstallationSpec

Field	Description	Default	Validation
succeededReconcile SucceededReconcile	SucceededReconcile allows to configure automatically repeated reconciliations for succeeded installations. If not set, no such automatically repeated reconciliations are triggered.
failedReconcile FailedReconcile	FailedReconcile allows to configure automatically repeated reconciliations for failed installations. If not set, no such automatically repeated reconciliations are triggered.

AutomaticReconcileStatus

AutomaticReconcileStatus describes the status of automatically triggered reconciles.

Appears in:

• InstallationStatus

Field	Description	Default	Validation
generation integer	Generation describes the generation of the installation for which the status holds.
numberOfReconciles integer	NumberOfReconciles is the number of automatic reconciles for the installation with the stored generation.		Format: int32
lastReconcileTime Time	LastReconcileTime is the time of the last automatically triggered reconcile.
onFailed boolean	OnFailed is true if the last automatically triggered reconcile was done for a failed installation.

BlueprintDefinition

BlueprintDefinition defines the blueprint that should be used for the installation.

Appears in:

• InstallationSpec

Field	Description	Default	Validation
ref RemoteBlueprintReference	Reference defines a remote reference to a blueprint
inline InlineBlueprint	Inline defines a inline yaml filesystem with a blueprint.

ComponentDescriptorDefinition

ComponentDescriptorDefinition defines the component descriptor that should be used for the installation

Appears in:

• InstallationSpec

Field	Description	Default	Validation
ref ComponentDescriptorReference	ComponentDescriptorReference is the reference to a component descriptor
inline ComponentDescriptor	InlineDescriptorReference defines an inline component descriptor		Schemaless: {} Type: object

ComponentDescriptorReference

ComponentDescriptorReference is the reference to a component descriptor. given an optional context.

Appears in:

• ComponentDescriptorDefinition

Field	Description	Default	Validation
repositoryContext UnstructuredTypedObject	RepositoryContext defines the context of the component repository to resolve blueprints.		Schemaless: {} Type: object
componentName string	ComponentName defines the unique of the component containing the resource.
version string	Version defines the version of the component.

ComponentVersionOverwrite

ComponentVersionOverwrite defines an overwrite for a specific component and/or version of a component.

Appears in:

• ComponentVersionOverwriteList

Field	Description	Default	Validation
source ComponentVersionOverwriteReference	Source defines the component that should be replaced.
substitution ComponentVersionOverwriteReference	Substitution defines the replacement target for the component or version.

ComponentVersionOverwriteList

Underlying type: ComponentVersionOverwrite

ComponentVersionOverwriteList is a list of component overwrites.

Appears in:

• ComponentVersionOverwrites

Field	Description	Default	Validation
source ComponentVersionOverwriteReference	Source defines the component that should be replaced.
substitution ComponentVersionOverwriteReference	Substitution defines the replacement target for the component or version.

ComponentVersionOverwriteReference

ComponentVersionOverwriteReference defines a component reference by

Appears in:

• ComponentVersionOverwrite

Field	Description	Default	Validation
repositoryContext UnstructuredTypedObject	RepositoryContext defines the context of the component repository to resolve blueprints.		Schemaless: {}
componentName string	ComponentName defines the unique of the component containing the resource.
version string	Version defines the version of the component.

ComponentVersionOverwrites

ComponentVersionOverwrites contain overwrites for specific (versions of) components.

Appears in:

• ComponentVersionOverwritesList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
overwrites ComponentVersionOverwriteList	Overwrites defines a list of component overwrites

Condition

Condition holds the information about the state of a resource.

Appears in:

• DeployItemStatus
• ExecutionStatus
• InstallationStatus

Field	Description	Default	Validation
type ConditionType	DataType of the Shoot condition.
lastTransitionTime Time	Last time the condition transitioned from one status to another.
lastUpdateTime Time	Last time the condition was updated.
reason string	The reason for the condition's last transition.
message string	A human readable message indicating details about the transition.
codes ErrorCode array	Well-defined error codes in case the condition reports a problem.

ConditionType

Underlying type: string

ConditionType is a string alias.

Appears in:

• Condition

Field	Description
DeployItemValidation
ReconcileDeployItems
EnsureSubInstallations
ReconcileExecution
ValidateImports
CreateImports
CreateExports
EnsureExecutions
ValidateExport
ComponentReferenceOverwrite

Context

Context is a resource that contains shared information of installations. This includes information about the repository context like the context itself or secrets to access the oci artifacts. But it can also contain deployer specific config.

Appears in:

• ContextList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
repositoryContext UnstructuredTypedObject	RepositoryContext defines the context of the component repository to resolve blueprints.		Schemaless: {}
ocmConfig LocalObjectReference	OCMConfig references a k8s config map object that contains the ocm configuration data in the format of an ocm configfile. For more info see: https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_configfile.md
registryPullSecrets LocalObjectReference array	RegistryPullSecrets defines a list of registry credentials that are used to pull blueprints, component descriptors and jsonschemas from the respective registry. For more info see: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ Note that the type information is used to determine the secret key and the type of the secret.
configurations object (keys:string, values:AnyJSON)	Configurations contains arbitrary configuration information for dedicated purposes given by a string key. The key should use a dns-like syntax to express the purpose and avoid conflicts.		Schemaless: {} Type: object
componentVersionOverwrites string	ComponentVersionOverwritesReference is a reference to a ComponentVersionOverwrites object The overwrites object has to be in the same namespace as the context. If the string is empty, no overwrites will be used.
verificationSignatures object (keys:string, values:VerificationSignature)	VerificationSignatures maps a signature name to the trusted verification information

ContextConfiguration

Appears in:

• Context

Field	Description	Default	Validation
repositoryContext UnstructuredTypedObject	RepositoryContext defines the context of the component repository to resolve blueprints.		Schemaless: {}
ocmConfig LocalObjectReference	OCMConfig references a k8s config map object that contains the ocm configuration data in the format of an ocm configfile. For more info see: https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_configfile.md
registryPullSecrets LocalObjectReference array	RegistryPullSecrets defines a list of registry credentials that are used to pull blueprints, component descriptors and jsonschemas from the respective registry. For more info see: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ Note that the type information is used to determine the secret key and the type of the secret.
configurations object (keys:string, values:AnyJSON)	Configurations contains arbitrary configuration information for dedicated purposes given by a string key. The key should use a dns-like syntax to express the purpose and avoid conflicts.		Schemaless: {} Type: object
componentVersionOverwrites string	ComponentVersionOverwritesReference is a reference to a ComponentVersionOverwrites object The overwrites object has to be in the same namespace as the context. If the string is empty, no overwrites will be used.
verificationSignatures object (keys:string, values:VerificationSignature)	VerificationSignatures maps a signature name to the trusted verification information

CriticalProblem

CriticalProblem contains information about one critical problem.

Appears in:

• CriticalProblemsSpec

Field	Description	Default	Validation
podName string	PodName contains the name of the pod where the problem occurred
creationTime Time	CreationTime contains the timestamp when the problem occurred
description string	Description contains an error description

CriticalProblems

CriticalProblems contains a list of critical landscaper problems.

Appears in:

• CriticalProblemsList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec CriticalProblemsSpec	Spec contains the specification

CriticalProblemsSpec

CriticalProblemsSpec contains the specification for a CriticalProblems object.

Appears in:

• CriticalProblems

Field	Description	Default	Validation
criticalProblem CriticalProblem array

DataExport

DataExport is a data object export.

Appears in:

• InstallationExports

Field	Description	Default	Validation
name string	Name the internal name of the imported/exported data.
dataRef string	DataRef is the name of the in-cluster data object.

DataImport

DataImport is a data object import.

Appears in:

• InstallationImports

Field	Description	Default	Validation
name string	Name the internal name of the imported/exported data.
dataRef string	DataRef is the name of the in-cluster data object. The reference can also be a namespaces name. E.g. "default/mydataref"
version string	Version specifies the imported data version. defaults to "v1"
secretRef LocalSecretReference	SecretRef defines a data reference from a secret. This method is not allowed in installation templates.
configMapRef LocalConfigMapReference	ConfigMapRef defines a data reference from a configmap. This method is not allowed in installation templates.

DataObject

DataObject are resources that can hold any kind json or yaml data.

Appears in:

• DataObjectList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
data AnyJSON	Data contains the data of the object as string.		Schemaless: {}

Default

Default defines a default value (future idea: also reference?).

Appears in:

• ImportDefinition

Field	Description	Default	Validation
value AnyJSON

DependentToTrigger

Appears in:

• InstallationStatus

Field	Description	Default	Validation
name string	Name is the name of the dependent installation

DeployItem

DeployItem defines a resource that should be processed by a external deployer

Appears in:

• DeployItemList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec DeployItemSpec

DeployItemCache

DeployItemCache contains the existing deploy items

Appears in:

• ExecutionStatus

Field	Description	Default	Validation
activeDIs DiNamePair array
orphanedDIs string array

DeployItemPhase

Underlying type: string

Appears in:

• DeployItemStatus

DeployItemSpec

DeployItemSpec contains the definition of a deploy item.

Appears in:

• DeployItem

Field	Description	Default	Validation
type DeployItemType	Type is the type of the deployer that should handle the item.
target ObjectReference	Target specifies an optional target of the deploy item. In most cases it contains the secrets to access a evironment. It is also used by the deployers to determine the ownernship.
context string	Context defines the current context of the deployitem.
config RawExtension	Configuration contains the deployer type specific configuration.		EmbeddedResource: {}
timeout Duration	Timeout specifies how long the deployer may take to apply the deploy item. When the time is exceeded, the deploy item fails. Value has to be parsable by time.ParseDuration (or 'none' to deactivate the timeout). Defaults to ten minutes if not specified.		Type: string
updateOnChangeOnly boolean	UpdateOnChangeOnly specifies if redeployment is executed only if the specification of the deploy item has changed.
onDelete OnDeleteConfig	OnDelete specifies particular setting when deleting a deploy item

DeployItemTemplate

DeployItemTemplate defines a execution element that is translated into a deploy item.

Appears in:

• DeployItemTemplateList

Field	Description	Default	Validation
name string	Name is the unique name of the execution.
type DeployItemType	DataType is the DeployItem type of the execution.
target ObjectReference	Target is the object reference to the target that the deploy item should deploy to.
labels object (keys:string, values:string)	Labels is the map of labels to be added to the deploy item.
config RawExtension	ProviderConfiguration contains the type specific configuration for the execution.		EmbeddedResource: {}
dependsOn string array	DependsOn lists deploy items that need to be executed before this one
timeout Duration	Timeout specifies how long the deployer may take to apply the deploy item. When the time is exceeded, the deploy item fails. Value has to be parsable by time.ParseDuration (or 'none' to deactivate the timeout). Defaults to ten minutes if not specified.		Type: string
updateOnChangeOnly boolean	UpdateOnChangeOnly specifies if redeployment is executed only if the specification of the deploy item has changed.
onDelete OnDeleteConfig	OnDelete specifies particular setting when deleting a deploy item

DeployItemTemplateList

Underlying type: DeployItemTemplate

DeployItemTemplateList is a list of deploy item templates

Appears in:

• ExecutionSpec

Field	Description	Default	Validation
name string	Name is the unique name of the execution.
type DeployItemType	DataType is the DeployItem type of the execution.
target ObjectReference	Target is the object reference to the target that the deploy item should deploy to.
labels object (keys:string, values:string)	Labels is the map of labels to be added to the deploy item.
config RawExtension	ProviderConfiguration contains the type specific configuration for the execution.		EmbeddedResource: {}
dependsOn string array	DependsOn lists deploy items that need to be executed before this one
timeout Duration	Timeout specifies how long the deployer may take to apply the deploy item. When the time is exceeded, the deploy item fails. Value has to be parsable by time.ParseDuration (or 'none' to deactivate the timeout). Defaults to ten minutes if not specified.		Type: string
updateOnChangeOnly boolean	UpdateOnChangeOnly specifies if redeployment is executed only if the specification of the deploy item has changed.
onDelete OnDeleteConfig	OnDelete specifies particular setting when deleting a deploy item

DeployItemType

Underlying type: string

DeployItemType defines the type of the deploy item

Appears in:

• DeployItemSpec
• DeployItemTemplate

DeployerInformation

DeployerInformation holds additional information about the deployer that has reconciled or is reconciling the deploy item.

Appears in:

• DeployItemStatus

Field	Description	Default	Validation
identity string	Identity describes the unique identity of the deployer.
name string	Name is the name of the deployer.
version string	Version is the version of the deployer.

DiNamePair

DiNamePair contains the spec name and the real name of a deploy item

Appears in:

• DeployItemCache

Field	Description	Default	Validation
specName string
objectName string

Duration

Duration is a wrapper for time.Duration that implements JSON marshalling and openapi scheme.

Validation:

• Type: string

Appears in:

• DeployItemSpec
• DeployItemTemplate
• FailedReconcile
• SucceededReconcile

Error

Error holds information about an error that occurred.

Appears in:

• DeployItemStatus
• ExecutionStatus
• InstallationStatus

Field	Description	Default	Validation
operation string	Operation describes the operator where the error occurred.
lastTransitionTime Time	Last time the condition transitioned from one status to another.
lastUpdateTime Time	Last time the condition was updated.
reason string	The reason for the condition's last transition.
message string	A human readable message indicating details about the transition.
codes ErrorCode array	Well-defined error codes in case the condition reports a problem.

ErrorCode

Underlying type: string

ErrorCode is a string alias.

Appears in:

• Condition
• Error

Field	Description
ERR_UNAUTHORIZED	ErrorUnauthorized indicates that the last error occurred due to invalid credentials.
ERR_CLEANUP	ErrorCleanupResources indicates that the last error occurred due to resources are stuck in deletion.
ERR_CONFIGURATION_PROBLEM	ErrorConfigurationProblem indicates that the last error occurred due a configuration problem.
ERR_INTERNAL_PROBLEM	ErrorInternalProblem indicates that the last error occurred due to a servere internal error
ERR_TIMEOUT	ErrorTimeout indicates that an operation timed out.
ERR_CYCLIC_DEPENDENCIES	ErrorCyclicDependencies indicates that there are cyclic dependencies between multiple installations/deployitems.
ERR_WEBHOOK	ErrorWebhook indicates that there is an intermediate problem with the webhook.
ERR_UNFINISHED	ErrorUnfinished indicates that there are unfinished sub-objects.
ERR_FOR_INFO_ONLY	ErrorForInfoOnly indicates that the error is no real error but an info and should be logged only on infor level.
ERR_NO_RETRY	ErrorNoRetry indicates that no retry is required.

Execution

Execution contains the configuration of a execution and deploy item

Appears in:

• ExecutionList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ExecutionSpec	Spec defines a execution and its items

ExecutionPhase

Underlying type: string

Appears in:

• ExecutionStatus

ExecutionSpec

ExecutionSpec defines a execution plan.

Appears in:

• Execution

Field	Description	Default	Validation
context string	Context defines the current context of the execution.
deployItems DeployItemTemplateList	DeployItems defines all execution items that need to be scheduled.
deployItemsCompressed integer array	DeployItemsCompressed as zipped byte array

ExportDefinition

ExportDefinition defines a exported value

Appears in:

• ExportDefinitionList

Field	Description	Default	Validation
name string	Name defines the field name to search for the value and map to exports. Ref: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#selecting-fields
schema JSONSchemaDefinition	Schema defines the imported value as jsonschema.
targetType string	TargetType defines the type of the imported target.
type ExportType	Type specifies which kind of object is being exported. This field should be set and will likely be mandatory in future.

ExportDefinitionList

Underlying type: ExportDefinition

ExportDefinitionList defines a list of export definitions.

Appears in:

• Blueprint

Field	Description	Default	Validation
name string	Name defines the field name to search for the value and map to exports. Ref: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#selecting-fields
schema JSONSchemaDefinition	Schema defines the imported value as jsonschema.
targetType string	TargetType defines the type of the imported target.
type ExportType	Type specifies which kind of object is being exported. This field should be set and will likely be mandatory in future.

ExportType

Underlying type: string

ExportType is a string alias

Appears in:

• ExportDefinition

FailedReconcile

FailedReconcile allows to configure automatically repeated reconciliations for failed installations

Appears in:

• AutomaticReconcile

Field	Description	Default	Validation
numberOfReconciles integer	NumberOfReconciles specifies the maximal number of automatically repeated reconciliations. If not set, no upper limit exists.		Format: int32
interval Duration	Interval specifies the interval between two subsequent repeated reconciliations. If not set, a default of 5 minutes is used.		Type: string
cronSpec string	CronSpec describes the reconcile intervals according to the cron syntax "https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format". If not empty, this specification is used instead of Interval.

FieldValueDefinition

FieldValueDefinition defines a im- or exported field. Either schema or target type have to be defined

Appears in:

• ExportDefinition
• ImportDefinition

Field	Description	Default	Validation
name string	Name defines the field name to search for the value and map to exports. Ref: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#selecting-fields
schema JSONSchemaDefinition	Schema defines the imported value as jsonschema.
targetType string	TargetType defines the type of the imported target.

ImportDefinition

ImportDefinition defines a imported value

Appears in:

• ImportDefinitionList

Field	Description	Default	Validation
name string	Name defines the field name to search for the value and map to exports. Ref: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#selecting-fields
schema JSONSchemaDefinition	Schema defines the imported value as jsonschema.
targetType string	TargetType defines the type of the imported target.
type ImportType	Type specifies which kind of object is being imported. This field should be set and will likely be mandatory in future.
required boolean	Required specifies whether the import is required for the component to run. Defaults to true.
default Default	Default sets a default value for the current import that is used if the key is not set.
imports ImportDefinitionList	ConditionalImports are Imports that are only valid if this imports is satisfied. Does only make sense for optional imports.

ImportDefinitionList

Underlying type: ImportDefinition

ImportDefinitionList defines a list of import defiinitions.

Appears in:

• Blueprint
• ImportDefinition

Field	Description	Default	Validation
name string	Name defines the field name to search for the value and map to exports. Ref: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#selecting-fields
schema JSONSchemaDefinition	Schema defines the imported value as jsonschema.
targetType string	TargetType defines the type of the imported target.
type ImportType	Type specifies which kind of object is being imported. This field should be set and will likely be mandatory in future.
required boolean	Required specifies whether the import is required for the component to run. Defaults to true.
default Default	Default sets a default value for the current import that is used if the key is not set.
imports ImportDefinitionList	ConditionalImports are Imports that are only valid if this imports is satisfied. Does only make sense for optional imports.

ImportType

Underlying type: string

ImportType is a string alias

Appears in:

• ImportDefinition

InlineBlueprint

InlineBlueprint defines a inline blueprint with component descriptor and filesystem.

Appears in:

• BlueprintDefinition

Field	Description	Default	Validation
filesystem AnyJSON	Filesystem defines a inline yaml filesystem with a blueprint.		Schemaless: {}

Installation

Installation contains the configuration of a component

Appears in:

• InstallationList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec InstallationSpec	Spec contains the specification for a installation.

InstallationExports

InstallationExports defines exports of data objects and targets.

Appears in:

• InstallationSpec
• InstallationTemplate

Field	Description	Default	Validation
data DataExport array	Data defines all data object exports.
targets TargetExport array	Targets defines all target exports.

InstallationImports

InstallationImports defines import of data objects and targets.

Appears in:

• InstallationSpec
• InstallationTemplate

Field	Description	Default	Validation
data DataImport array	Data defines all data object imports.
targets TargetImport array	Targets defines all target imports.

InstallationPhase

Underlying type: string

Appears in:

• InstallationStatus

InstallationSpec

InstallationSpec defines a component installation.

Appears in:

• Installation

Field	Description	Default	Validation
context string	Context defines the current context of the installation.
verification Verification	Verification defines the necessary data to verify the signature of the refered component
componentDescriptor ComponentDescriptorDefinition	ComponentDescriptor is a reference to the installation's component descriptor
blueprint BlueprintDefinition	Blueprint is the resolved reference to the definition.
imports InstallationImports	Imports define the imported data objects and targets.
importDataMappings object (keys:string, values:AnyJSON)	ImportDataMappings contains a template for restructuring imports. It is expected to contain a key for every blueprint-defined data import. Missing keys will be defaulted to their respective data import. Example: namespace: (( installation.imports.namespace ))		Schemaless: {} Type: object
exports InstallationExports	Exports define the exported data objects and targets.
exportDataMappings object (keys:string, values:AnyJSON)	ExportDataMappings contains a template for restructuring exports. It is expected to contain a key for every blueprint-defined data export. Missing keys will be defaulted to their respective data export. Example: namespace: (( blueprint.exports.namespace ))		Schemaless: {} Type: object
automaticReconcile AutomaticReconcile	AutomaticReconcile allows to configure automatically repeated reconciliations.
optimization Optimization	Optimization contains settings to improve execution performance.

InstallationTemplate

InstallationTemplate defines a subinstallation in a blueprint.

Appears in:

• InstallationTemplateList
• SubinstallationTemplate

Field	Description	Default	Validation
name string	Name is the unique name of the step
blueprint InstallationTemplateBlueprintDefinition	Reference defines a reference to a Blueprint. The blueprint can reside in an OCI or other supported location.
imports InstallationImports	Imports define the imported data objects and targets.
importDataMappings object (keys:string, values:AnyJSON)	ImportDataMappings contains a template for restructuring imports. It is expected to contain a key for every blueprint-defined data import. Missing keys will be defaulted to their respective data import. Example: namespace: (( installation.imports.namespace ))		Schemaless: {} Type: object
exports InstallationExports	Exports define the exported data objects and targets.
exportDataMappings object (keys:string, values:AnyJSON)	ExportDataMappings contains a template for restructuring exports. It is expected to contain a key for every blueprint-defined data export. Missing keys will be defaulted to their respective data export. Example: namespace: (( blueprint.exports.namespace ))		Schemaless: {} Type: object
optimization Optimization	Optimization contains settings to improve execution performance.

InstallationTemplateBlueprintDefinition

InstallationTemplateBlueprintDefinition contains either a reference to a blueprint or an inline definition.

Appears in:

• InstallationTemplate

Field	Description	Default	Validation
ref string	Ref is a reference to a blueprint. Only blueprints that are defined by the component descriptor of the current blueprint can be referenced here. Example: cd://componentReference/dns/resources/blueprint
filesystem AnyJSON	Filesystem defines a virtual filesystem with all files needed for a blueprint. The filesystem must be a YAML filesystem.		Schemaless: {}

JSONSchemaDefinition

JSONSchemaDefinition defines a jsonschema.

Appears in:

• Blueprint
• ExportDefinition
• FieldValueDefinition
• ImportDefinition

LocalConfigMapReference

Underlying type: struct{Name string "json:"name""; Key string "json:"key""}

LocalConfigMapReference is a reference to data in a configmap.

Appears in:

• DataImport

LocalSecretReference

Underlying type: struct{Name string "json:"name""; Key string "json:"key""}

LocalSecretReference is a reference to data in a secret.

Appears in:

• DataImport
• TargetSpec
• TargetSyncSpec
• TargetTemplate

LsHealthCheck

LsHealthCheck is a resource containing information about problems with the landscaper installation

Appears in:

• LsHealthCheckList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
lastUpdateTime Time	LastUpdateTime contains last time the check was updated.
description string	Description contains description of the problem(s)

ObjectReference

ObjectReference is the reference to a kubernetes object.

Appears in:

• ConfigMapReference
• DeployItemSpec
• DeployItemStatus
• DeployItemTemplate
• ExecutionStatus
• InstallationStatus
• NamedObjectReference
• SecretReference
• TargetSelector
• TypedObjectReference
• VersionedObjectReference

Field	Description	Default	Validation
name string	Name is the name of the kubernetes object.
namespace string	Namespace is the namespace of kubernetes object.

OnDeleteConfig

OnDeleteConfig specifies particular setting when deleting a deploy item

Appears in:

• DeployItemSpec
• DeployItemTemplate

Field	Description	Default	Validation
skipUninstallIfClusterRemoved boolean	SkipUninstallIfClusterRemoved specifies that uninstall is skipped if the target cluster is already deleted. Works only in the context of an existing target sync object which is used to check the Garden project with the shoot cluster resources

Optimization

Optimization contains settings to improve execution preformance

Appears in:

• InstallationSpec
• InstallationTemplate

Field	Description	Default	Validation
hasNoSiblingImports boolean	set this on true if the installation does not import data from its siblings or has no siblings at all
hasNoSiblingExports boolean	set this on true if the installation does not export data to its siblings or has no siblings at all

RemoteBlueprintReference

RemoteBlueprintReference describes a reference to a blueprint defined by a component descriptor.

Appears in:

• BlueprintDefinition

Field	Description	Default	Validation
resourceName string	ResourceName is the name of the blueprint as defined by a component descriptor.

Requirement

Requirement contains values, a key, and an operator that relates the key and values. The zero value of Requirement is invalid. Requirement implements both set based match and exact match Requirement should be initialized via NewRequirement constructor for creating a valid Requirement.

Appears in:

• TargetSelector

Field	Description	Default	Validation
key string
operator Operator
values string array	In huge majority of cases we have at most one value here. It is generally faster to operate on a single-element slice than on a single-element map, so we have a slice here.

ResourceReference

ResourceReference defines the reference to a resource defined in a component descriptor.

Appears in:

• VersionedResourceReference

Field	Description	Default	Validation
componentName string	ComponentName defines the unique of the component containing the resource.
resourceName string	ResourceName defines the name of the resource.

SecretLabelSelectorRef

SecretLabelSelectorRef selects secrets with the given label and key.

Appears in:

• StaticDataValueFrom

Field	Description	Default	Validation
selector object (keys:string, values:string)	Selector is a map of labels to select specific secrets.
key string	The key of the secret to select from. Must be a valid secret key.

SecretReference

SecretReference is reference to data in a secret. The secret can also be in a different namespace.

Appears in:

• VerificationSignature

Field	Description	Default	Validation
name string	Name is the name of the kubernetes object.
namespace string	Namespace is the namespace of kubernetes object.
key string	Key is the name of the key in the secret that holds the data.

StaticDataValueFrom

StaticDataValueFrom defines a static data that is read from a external resource.

Appears in:

• BlueprintStaticDataSource
• StaticDataSource

Field	Description	Default	Validation
secretKeyRef SecretKeySelector	Selects a key of a secret in the installations's namespace
secretLabelSelector SecretLabelSelectorRef	Selects a key from multiple secrets in the installations's namespace that matches the given labels.

SubInstCache

SubInstCache contains the existing sub installations

Appears in:

• InstallationStatus

Field	Description	Default	Validation
activeSubs SubNamePair array
orphanedSubs string array

SubNamePair

DiNamePair contains the spec name and the real name of a deploy item

Appears in:

• SubInstCache

Field	Description	Default	Validation
specName string
objectName string

SubinstallationTemplate

SubinstallationTemplate defines a subinstallation template.

Appears in:

• SubinstallationTemplateList

Field	Description	Default	Validation
file string	File references a subinstallation template stored in another file.

SubinstallationTemplateList

Underlying type: SubinstallationTemplate

SubinstallationTemplateList is a list of installation templates

Appears in:

• Blueprint

Field	Description	Default	Validation
file string	File references a subinstallation template stored in another file.

SucceededReconcile

SucceededReconcile allows to configure automatically repeated reconciliations for succeeded installations

Appears in:

• AutomaticReconcile

Field	Description	Default	Validation
interval Duration	Interval specifies the interval between two subsequent repeated reconciliations. If not set, a default of 24 hours is used.		Type: string
cronSpec string	CronSpec describes the reconcile intervals according to the cron syntax "https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format". If not empty, this specification is used instead of Interval.

SyncObject

The SyncObject helps to sync access to deploy items.

Appears in:

• SyncObjectList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec SyncObjectSpec	Spec contains the specification

SyncObjectSpec

SyncObjectSpec contains the specification.

Appears in:

• SyncObject

Field	Description	Default	Validation
podName string	PodName describes the name of the pod of the responsible deployer
kind string	Kind describes the kind of object that is being locked by this SyncObject
name string	Name is the name of the object that is being locked by this SyncObject
lastUpdateTime Time	LastUpdateTime contains last time the object was updated.
prefix string	Prefix is the prefix of the name of the object.

Target

Target defines a specific data object that defines target environment. Every deploy item can have a target which is used by the deployer to install the specific application.

Appears in:

• ResolvedTarget
• TargetList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TargetSpec

TargetExport

TargetExport is a single target export.

Appears in:

• InstallationExports

Field	Description	Default	Validation
name string	Name the internal name of the exported target.
target string	Target is the name of the in-cluster target object.

TargetImport

TargetImport is either a single target or a target list import.

Appears in:

• InstallationImports

Field	Description	Default	Validation
name string	Name the internal name of the imported target.
target string	Target is the name of the in-cluster target object. Exactly one of Target, Targets, and TargetListReference has to be specified.
targets string array	Targets is a list of in-cluster target objects. Exactly one of Target, Targets, and TargetListReference has to be specified.
targetListRef string	TargetListReference can (only) be used to import a targetlist that has been imported by the parent installation. Exactly one of Target, Targets, and TargetListReference has to be specified.
targetMap object (keys:string, values:string)
targetMapRef string

TargetSpec

TargetSpec contains the definition of a target.

Appears in:

• Target
• TargetTemplate

Field	Description	Default	Validation
type TargetType	Type is the type of the target that defines its data structure. The actual schema may be defined by a target type crd in the future.
config AnyJSON	Configuration contains the target type specific configuration. Exactly one of the fields Configuration and SecretRef must be set		Schemaless: {}
secretRef LocalSecretReference	Reference to a secret containing the target type specific configuration. Exactly one of the fields Configuration and SecretRef must be set

TargetSync

The TargetSync is created targets from secrets.

Appears in:

• TargetSyncList

Field	Description	Default	Validation
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TargetSyncSpec	Spec contains the specification

TargetSyncSpec

TargetSyncSpec contains the specification for a TargetSync.

Appears in:

• TargetSync

Field	Description	Default	Validation
sourceNamespace string	SourceNamespace describes the namespace from where the secrets should be synced
secretRef LocalSecretReference	SecretRef references the secret that contains the kubeconfig to the namespace of the secrets to be synced.
createTargetToSource boolean	CreateTargetToSource specifies if set on true, that also a target is created, which references the secret in SecretRef
targetToSourceName string	TargetToSourceName is the name of the target referencing the secret defined in SecretRef if CreateTargetToSource is set on true. If TargetToSourceName is empty SourceNamespace is used instead.
secretNameExpression string	SecretNameExpression defines the names of the secrets which should be synced via a regular expression according to https://github.com/google/re2/wiki/Syntax with the extension that * is also a valid expression and matches all names. if not set no secrets are synced
shootNameExpression string	ShootNameExpression defines the names of shoot clusters for which targets with short living access data to the shoots are created via a regular expression according to https://github.com/google/re2/wiki/Syntax with the extension that * is also a valid expression and matches all names. if not set no targets for the shoots are created
tokenRotation TokenRotation	TokenRotation defines the data to perform an automatic rotation of the token to access the source cluster with the secrets to sync. The token expires after 90 days and will be rotated every 60 days.

TargetType

Underlying type: string

TargetType defines the type of the target.

Appears in:

• TargetSpec
• TargetTemplate

TemplateExecutor

TemplateExecutor describes a templating mechanism and configuration.

Appears in:

• Blueprint

Field	Description	Default	Validation
name string	Name is the unique name of the template
type TemplateType	Type describes the templating mechanism.
file string	File is the path to the template in the blueprint's content.
template AnyJSON	Template contains an optional inline template. The template has to be of string for go template and either a string or valid yaml/json for spiff.

TemplateType

Underlying type: string

TemplateType describes the template mechanism.

Appears in:

• TemplateExecutor

Field	Description
GoTemplate
Spiff

TokenRotation

Appears in:

• TargetSyncSpec

Field	Description	Default	Validation
enabled boolean	Enabled defines if automatic token is executed

TransitionTimes

Appears in:

• DeployItemStatus
• ExecutionStatus
• InstallationStatus

Field	Description	Default	Validation
triggerTime Time	TriggerTime is the time when the jobID is set.
initTime Time	InitTime is the time when the Init phase starts.
waitTime Time	WaitTime is the time when the work is done.
finishedTime Time	FinishedTime is the time when the finished phase is set.

Verification

Verification defines the necessary data to verify the signature of the refered component

Appears in:

• InstallationSpec

Field	Description	Default	Validation
signatureName string	SignatureName defines the name of the signature that is verified

VerificationSignature

VerificationSignatures contains the trusted verification information

Appears in:

• Context
• ContextConfiguration

Field	Description	Default	Validation
publicKeySecretReference SecretReference	PublicKeySecretReference contains a secret reference to a public key in PEM format that is used to verify the component signature
caCertificateSecretReference SecretReference	CaCertificateSecretReference contains a secret reference to one or more certificates in PEM format that are used to verify the compnent signature

VersionedObjectReference

VersionedObjectReference is a reference to a object with its last observed resource generation. This struct is used by status fields.

Appears in:

• VersionedNamedObjectReference

Field	Description	Default	Validation
name string	Name is the name of the kubernetes object.
namespace string	Namespace is the namespace of kubernetes object.
observedGeneration integer	ObservedGeneration defines the last observed generation of the referenced resource.