Packages:
Resource Types:
- BackupBucket
- BackupEntry
- CloudProfile
- ControllerDeployment
- ControllerInstallation
- ControllerRegistration
- ExposureClass
- InternalSecret
- NamespacedCloudProfile
- Project
- Quota
- SecretBinding
- Seed
- SeedTemplate
- Shoot
- ShootState
- ShootTemplate
(Appears on:KubeAPIServerConfig)
APIServerLogging contains configuration for the logs level and http access logs
| Field | Description |
|---|---|
verbosityinteger |
(Optional)
Verbosity is the kube-apiserver log verbosity level |
httpAccessVerbosityinteger |
(Optional)
HTTPAccessVerbosity is the kube-apiserver access logs level |
(Appears on:KubeAPIServerConfig)
APIServerRequests contains configuration for request-specific settings for the kube-apiserver.
| Field | Description |
|---|---|
maxNonMutatingInflightinteger |
(Optional)
MaxNonMutatingInflight is the maximum number of non-mutating requests in flight at a given time. When the server |
maxMutatingInflightinteger |
(Optional)
MaxMutatingInflight is the maximum number of mutating requests in flight at a given time. When the server |
(Appears on:AccessRestrictionWithOptions, Region, SeedSpec)
AccessRestriction describes an access restriction for a Kubernetes cluster (e.g., EU access-only).
| Field | Description |
|---|---|
namestring |
Name is the name of the restriction. |
(Appears on:ShootSpec)
AccessRestrictionWithOptions describes an access restriction for a Kubernetes cluster (e.g., EU access-only) and allows to specify additional options.
| Field | Description |
|---|---|
namestring |
Name is the name of the restriction. |
optionsobject (keys:string, values:string) |
(Optional)
Options is a map of additional options for the access restriction. |
(Appears on:KubernetesDashboard, NginxIngress)
Addon allows enabling or disabling a specific addon and is used to derive from.
| Field | Description |
|---|---|
enabledboolean |
Enabled indicates whether the addon is enabled or not. |
(Appears on:ShootSpec)
Addons is a collection of configuration for specific addons which are managed by the Gardener.
| Field | Description |
|---|---|
kubernetesDashboardKubernetesDashboard |
(Optional)
KubernetesDashboard holds configuration settings for the kubernetes dashboard addon. |
nginxIngressNginxIngress |
(Optional)
NginxIngress holds configuration settings for the nginx-ingress addon. |
(Appears on:KubeAPIServerConfig)
AdmissionPlugin contains information about a specific admission plugin and its corresponding configuration.
| Field | Description |
|---|---|
namestring |
Name is the name of the plugin. |
configRawExtension |
(Optional)
Config is the configuration of the plugin. |
disabledboolean |
(Optional)
Disabled specifies whether this plugin should be disabled. |
kubeconfigSecretNamestring |
(Optional)
KubeconfigSecretName specifies the name of a secret containing the kubeconfig for this admission plugin. |
(Appears on:Monitoring)
Alerting contains information about how alerting will be done (i.e. who will receive alerts and how).
| Field | Description |
|---|---|
emailReceiversstring array |
(Optional)
MonitoringEmailReceivers is a list of recipients for alerts |
(Appears on:KubeAPIServerConfig)
AuditConfig contains settings for audit of the api server
| Field | Description |
|---|---|
auditPolicyAuditPolicy |
(Optional)
AuditPolicy contains configuration settings for audit policy of the kube-apiserver. |
(Appears on:AuditConfig)
AuditPolicy contains audit policy for kube-apiserver
| Field | Description |
|---|---|
configMapRefObjectReference |
(Optional)
ConfigMapRef is a reference to a ConfigMap object in the same namespace, |
(Appears on:StructuredAuthorization)
AuthorizerKubeconfigReference is a reference for a kubeconfig for a authorization webhook.
| Field | Description |
|---|---|
authorizerNamestring |
AuthorizerName is the name of a webhook authorizer. |
secretNamestring |
SecretName is the name of a secret containing the kubeconfig. |
(Appears on:Region)
AvailabilityZone is an availability zone.
| Field | Description |
|---|---|
namestring |
Name is an availability zone name. |
unavailableMachineTypesstring array |
(Optional)
UnavailableMachineTypes is a list of machine type names that are not availability in this zone. |
unavailableVolumeTypesstring array |
(Optional)
UnavailableVolumeTypes is a list of volume type names that are not availability in this zone. |
(Appears on:SeedSpec, WorkerControlPlane)
Backup contains the object store configuration for backups for shoot (currently only etcd).
| Field | Description |
|---|---|
providerstring |
Provider is a provider name. This field is immutable. |
providerConfigRawExtension |
(Optional)
ProviderConfig is the configuration passed to BackupBucket resource. |
regionstring |
(Optional)
Region is a region name. This field is immutable. |
credentialsRefObjectReference |
(Optional)
CredentialsRef is reference to a resource holding the credentials used for |
BackupBucket holds details about backup bucket
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specBackupBucketSpec |
Specification of the Backup Bucket. |
statusBackupBucketStatus |
Most recently observed status of the Backup Bucket. |
(Appears on:BackupBucketSpec)
BackupBucketProvider holds the details of cloud provider of the object store.
| Field | Description |
|---|---|
typestring |
Type is the type of provider. |
regionstring |
Region is the region of the bucket. |
(Appears on:BackupBucket)
BackupBucketSpec is the specification of a Backup Bucket.
| Field | Description |
|---|---|
providerBackupBucketProvider |
Provider holds the details of cloud provider of the object store. This field is immutable. |
providerConfigRawExtension |
(Optional)
ProviderConfig is the configuration passed to BackupBucket resource. |
seedNamestring |
(Optional)
SeedName is the name of the Seed this BackupBucket is associated with. Mutually exclusive with ShootRef. |
credentialsRefObjectReference |
(Optional)
CredentialsRef is reference to a resource holding the credentials used for |
shootRefObjectReference |
(Optional)
ShootRef is the reference of the Shoot this BackupBucket is associated with. Mutually exclusive with SeedName. |
(Appears on:BackupBucket)
BackupBucketStatus holds the most recently observed status of the Backup Bucket.
| Field | Description |
|---|---|
providerStatusRawExtension |
(Optional)
ProviderStatus is the configuration passed to BackupBucket resource. |
lastOperationLastOperation |
(Optional)
LastOperation holds information about the last operation on the BackupBucket. |
lastErrorLastError |
(Optional)
LastError holds information about the last occurred error during an operation. |
observedGenerationinteger |
(Optional)
ObservedGeneration is the most recent generation observed for this BackupBucket. It corresponds to the |
generatedSecretRefSecretReference |
(Optional)
GeneratedSecretRef is reference to the secret generated by backup bucket, which |
BackupEntry holds details about shoot backup.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specBackupEntrySpec |
(Optional)
Spec contains the specification of the Backup Entry. |
statusBackupEntryStatus |
(Optional)
Status contains the most recently observed status of the Backup Entry. |
(Appears on:BackupEntry)
BackupEntrySpec is the specification of a Backup Entry.
| Field | Description |
|---|---|
bucketNamestring |
BucketName is the name of backup bucket for this Backup Entry. |
seedNamestring |
(Optional)
SeedName is the name of the Seed this BackupEntry is associated with. Mutually exclusive with ShootRef. |
shootRefObjectReference |
(Optional)
ShootRef is the reference of the Shoot this BackupBucket is associated with. Mutually exclusive with SeedName. |
(Appears on:BackupEntry)
BackupEntryStatus holds the most recently observed status of the Backup Entry.
| Field | Description |
|---|---|
lastOperationLastOperation |
(Optional)
LastOperation holds information about the last operation on the BackupEntry. |
lastErrorLastError |
(Optional)
LastError holds information about the last occurred error during an operation. |
observedGenerationinteger |
(Optional)
ObservedGeneration is the most recent generation observed for this BackupEntry. It corresponds to the |
seedNamestring |
(Optional)
SeedName is the name of the seed to which this BackupEntry is currently scheduled. This field is populated |
migrationStartTimeTime |
(Optional)
MigrationStartTime is the time when a migration to a different seed was initiated. |
(Appears on:CloudProfileSpec)
Bastion contains the bastions creation info
| Field | Description |
|---|---|
machineImageBastionMachineImage |
(Optional)
MachineImage contains the bastions machine image properties |
machineTypeBastionMachineType |
(Optional)
MachineType contains the bastions machine type properties |
(Appears on:Bastion)
BastionMachineImage contains the bastions machine image properties
| Field | Description |
|---|---|
namestring |
Name of the machine image |
versionstring |
(Optional)
Version of the machine image |
(Appears on:Bastion)
BastionMachineType contains the bastions machine type properties
| Field | Description |
|---|---|
namestring |
Name of the machine type |
(Appears on:ShootCredentialsRotation)
CARotation contains information about the certificate authority credential rotation.
| Field | Description |
|---|---|
phaseCredentialsRotationPhase |
Phase describes the phase of the certificate authority credential rotation. |
lastCompletionTimeTime |
(Optional)
LastCompletionTime is the most recent time when the certificate authority credential rotation was successfully |
lastInitiationTimeTime |
(Optional)
LastInitiationTime is the most recent time when the certificate authority credential rotation was initiated. |
lastInitiationFinishedTimeTime |
(Optional)
LastInitiationFinishedTime is the recent time when the certificate authority credential rotation initiation was |
lastCompletionTriggeredTimeTime |
(Optional)
LastCompletionTriggeredTime is the recent time when the certificate authority credential rotation completion was |
pendingWorkersRolloutsPendingWorkersRollout array |
(Optional)
PendingWorkersRollouts contains the name of a worker pool and the initiation time of their last rollout due to |
(Appears on:MachineImageVersion, Worker)
CRI contains information about the Container Runtimes.
| Field | Description |
|---|---|
nameCRIName |
The name of the CRI library. Supported values are `containerd`. |
containerRuntimesContainerRuntime array |
(Optional)
ContainerRuntimes is the list of the required container runtimes supported for a worker pool. |
Underlying type: string
(Appears on:CRI)
CRIName is a type alias for the CRI name string.
Underlying type: object (keys:string, values:CapabilityValues)
(Appears on:MachineType)
Capabilities of a machine type or machine image.
(Appears on:CloudProfileSpec)
CapabilityDefinition contains the Name and Values of a capability.
| Field | Description |
|---|---|
namestring |
|
valuesCapabilityValues |
Underlying type: string array
(Appears on:Capabilities, CapabilityDefinition)
CapabilityValues contains capability values. This is a workaround as the Protobuf generator can't handle a map with slice values.
CloudProfile represents certain properties about a provider environment.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specCloudProfileSpec |
(Optional)
Spec defines the provider environment properties. |
statusCloudProfileStatus |
Status contains the current status of the cloud profile. |
(Appears on:MachineType)
CloudProfileMachineControllerManagerSettings contains a subset of the MachineControllerManagerSettings which can be defaulted for a machine type in a CloudProfile.
| Field | Description |
|---|---|
machineCreationTimeoutDuration |
(Optional)
MachineCreationTimeout is the period after which creation of a machine of this machine type is declared failed. |
(Appears on:NamespacedCloudProfileSpec, ShootSpec)
CloudProfileReference holds the information about a CloudProfile or a NamespacedCloudProfile.
| Field | Description |
|---|---|
kindstring |
Kind contains a CloudProfile kind. |
namestring |
Name contains the name of the referenced CloudProfile. |
(Appears on:CloudProfile, NamespacedCloudProfileStatus)
CloudProfileSpec is the specification of a CloudProfile. It must contain exactly one of its defined keys.
| Field | Description |
|---|---|
caBundlestring |
(Optional)
CABundle is a certificate bundle which will be installed onto every host machine of shoot cluster targeting this profile. |
kubernetesKubernetesSettings |
Kubernetes contains constraints regarding allowed values of the 'kubernetes' block in the Shoot specification. |
machineImagesMachineImage array |
MachineImages contains constraints regarding allowed values for machine images in the Shoot specification. |
machineTypesMachineType array |
MachineTypes contains constraints regarding allowed values for machine types in the 'workers' block in the Shoot specification. |
providerConfigRawExtension |
(Optional)
ProviderConfig contains provider-specific configuration for the profile. |
regionsRegion array |
Regions contains constraints regarding allowed values for regions and zones. |
seedSelectorSeedSelector |
(Optional)
SeedSelector contains an optional list of labels on `Seed` resources that marks those seeds whose shoots may use this provider profile. |
typestring |
Type is the name of the provider. |
volumeTypesVolumeType array |
(Optional)
VolumeTypes contains constraints regarding allowed values for volume types in the 'workers' block in the Shoot specification. |
bastionBastion |
(Optional)
Bastion contains the machine and image properties |
limitsLimits |
(Optional)
Limits configures operational limits for Shoot clusters using this CloudProfile. |
machineCapabilitiesCapabilityDefinition array |
(Optional)
MachineCapabilities contains the definition of all possible capabilities in the CloudProfile. |
(Appears on:CloudProfile)
CloudProfileStatus contains the status of the cloud profile.
| Field | Description |
|---|---|
kubernetesKubernetesStatus |
(Optional)
Kubernetes contains the status information for kubernetes. |
machineImagesMachineImageStatus array |
(Optional)
MachineImages contains the statuses of the machine image versions. |
(Appears on:Kubernetes)
ClusterAutoscaler contains the configuration flags for the Kubernetes cluster autoscaler.
| Field | Description |
|---|---|
scaleDownDelayAfterAddDuration |
(Optional)
ScaleDownDelayAfterAdd defines how long after scale up that scale down evaluation resumes (default: 1 hour). |
scaleDownDelayAfterDeleteDuration |
(Optional)
ScaleDownDelayAfterDelete how long after node deletion that scale down evaluation resumes, defaults to scanInterval (default: 0 secs). |
scaleDownDelayAfterFailureDuration |
(Optional)
ScaleDownDelayAfterFailure how long after scale down failure that scale down evaluation resumes (default: 3 mins). |
scaleDownUnneededTimeDuration |
(Optional)
ScaleDownUnneededTime defines how long a node should be unneeded before it is eligible for scale down (default: 30 mins). |
scaleDownUtilizationThresholdfloat |
(Optional)
ScaleDownUtilizationThreshold defines the threshold in fraction (0.0 - 1.0) under which a node is being removed (default: 0.5). |
scanIntervalDuration |
(Optional)
ScanInterval how often cluster is reevaluated for scale up or down (default: 10 secs). |
expanderExpanderMode |
(Optional)
Expander defines the algorithm to use during scale up (default: least-waste). |
maxNodeProvisionTimeDuration |
(Optional)
MaxNodeProvisionTime defines how long CA waits for node to be provisioned (default: 20 mins). |
maxGracefulTerminationSecondsinteger |
(Optional)
MaxGracefulTerminationSeconds is the number of seconds CA waits for pod termination when trying to scale down a node (default: 600). |
ignoreTaintsstring array |
(Optional)
IgnoreTaints specifies a list of taint keys to ignore in node templates when considering to scale a node group. |
newPodScaleUpDelayDuration |
(Optional)
NewPodScaleUpDelay specifies how long CA should ignore newly created pods before they have to be considered for scale-up (default: 0s). |
maxEmptyBulkDeleteinteger |
(Optional)
MaxEmptyBulkDelete specifies the maximum number of empty nodes that can be deleted at the same time (default: MaxScaleDownParallelism when that is set). |
ignoreDaemonsetsUtilizationboolean |
(Optional)
IgnoreDaemonsetsUtilization allows CA to ignore DaemonSet pods when calculating resource utilization for scaling down (default: false). |
verbosityinteger |
(Optional)
Verbosity allows CA to modify its log level (default: 2). |
startupTaintsstring array |
(Optional)
StartupTaints specifies a list of taint keys to ignore in node templates when considering to scale a node group. |
statusTaintsstring array |
(Optional)
StatusTaints specifies a list of taint keys to ignore in node templates when considering to scale a node group. |
maxScaleDownParallelisminteger |
(Optional)
MaxScaleDownParallelism specifies the maximum number of nodes (both empty and needing drain) that can be deleted in parallel. |
maxDrainParallelisminteger |
(Optional)
MaxDrainParallelism specifies the maximum number of nodes needing drain, that can be drained and deleted in parallel. |
initialNodeGroupBackoffDurationDuration |
(Optional)
InitialNodeGroupBackoffDuration is the duration of first backoff after a new node failed to start (default: 5m). |
maxNodeGroupBackoffDurationDuration |
(Optional)
MaxNodeGroupBackoffDuration is the maximum backoff duration for a NodeGroup after new nodes failed to start (default: 30m). |
nodeGroupBackoffResetTimeoutDuration |
(Optional)
NodeGroupBackoffResetTimeout is the time after last failed scale-up when the backoff duration is reset (default: 3h). |
emitPerNodeGroupMetricsboolean |
(Optional)
EmitPerNodeGroupMetrics emits additional per node group metrics (default: false). |
(Appears on:Worker)
ClusterAutoscalerOptions contains the cluster autoscaler configurations for a worker pool.
| Field | Description |
|---|---|
scaleDownUtilizationThresholdfloat |
(Optional)
ScaleDownUtilizationThreshold defines the threshold in fraction (0.0 - 1.0) under which a node is being removed. |
scaleDownGpuUtilizationThresholdfloat |
(Optional)
ScaleDownGpuUtilizationThreshold defines the threshold in fraction (0.0 - 1.0) of gpu resources under which a node is being removed. |
scaleDownUnneededTimeDuration |
(Optional)
ScaleDownUnneededTime defines how long a node should be unneeded before it is eligible for scale down. |
scaleDownUnreadyTimeDuration |
(Optional)
ScaleDownUnreadyTime defines how long an unready node should be unneeded before it is eligible for scale down. |
maxNodeProvisionTimeDuration |
(Optional)
MaxNodeProvisionTime defines how long CA waits for node to be provisioned. |
Underlying type: string
(Appears on:ControllerResource)
ClusterType defines the type of cluster.
(Appears on:ControllerInstallationStatus, ProjectStatus, SeedStatus, ShootStatus)
Condition holds the information about the state of a resource.
| Field | Description |
|---|---|
typeConditionType |
Type of the condition. |
statusConditionStatus |
Status of the condition, one of True, False, Unknown. |
lastTransitionTimeTime |
Last time the condition transitioned from one status to another. |
lastUpdateTimeTime |
Last time the condition was updated. |
reasonstring |
The reason for the condition's last transition. |
messagestring |
A human readable message indicating details about the transition. |
codesErrorCode array |
(Optional)
Well-defined error codes in case the condition reports a problem. |
Underlying type: string
(Appears on:Condition)
ConditionStatus is the status of a condition.
Underlying type: string
(Appears on:Condition)
ConditionType is a string alias.
(Appears on:CRI)
ContainerRuntime contains information about worker's available container runtime
| Field | Description |
|---|---|
typestring |
Type is the type of the Container Runtime. |
providerConfigRawExtension |
(Optional)
ProviderConfig is the configuration passed to container runtime resource. |
(Appears on:ShootSpec)
ControlPlane holds information about the general settings for the control plane of a shoot.
| Field | Description |
|---|---|
highAvailabilityHighAvailability |
(Optional)
HighAvailability holds the configuration settings for high availability of the |
(Appears on:ETCDConfig, KubeAPIServerConfig)
ControlPlaneAutoscaling contains auto-scaling configuration options for control-plane components.
ControllerDeployment contains information about how this controller is deployed.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
typestring |
Type is the deployment type. |
providerConfigRawExtension |
ProviderConfig contains type-specific configuration. It contains assets that deploy the controller. |
injectGardenKubeconfigboolean |
(Optional)
InjectGardenKubeconfig controls whether a kubeconfig to the garden cluster should be injected into workload |
Underlying type: string
(Appears on:ControllerRegistrationDeployment)
ControllerDeploymentPolicy is a string alias.
ControllerInstallation represents an installation request for an external controller.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specControllerInstallationSpec |
Spec contains the specification of this installation. |
statusControllerInstallationStatus |
Status contains the status of this installation. |
(Appears on:ControllerInstallation)
ControllerInstallationSpec is the specification of a ControllerInstallation.
| Field | Description |
|---|---|
registrationRefObjectReference |
RegistrationRef is used to reference a ControllerRegistration resource. |
seedRefObjectReference |
(Optional)
SeedRef is used to reference a Seed resource. The name field of the SeedRef is immutable. |
shootRefObjectReference |
(Optional)
ShootRef is used to reference a Shoot resource. The name and namespace fields of the ShootRef are immutable. |
deploymentRefObjectReference |
(Optional)
DeploymentRef is used to reference a ControllerDeployment resource. |
(Appears on:ControllerInstallation)
ControllerInstallationStatus is the status of a ControllerInstallation.
| Field | Description |
|---|---|
conditionsCondition array |
(Optional)
Conditions represents the latest available observations of a ControllerInstallations's current state. |
providerStatusRawExtension |
(Optional)
ProviderStatus contains type-specific status. |
ControllerRegistration represents a registration of an external controller.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specControllerRegistrationSpec |
Spec contains the specification of this registration. |
(Appears on:ControllerRegistrationSpec)
ControllerRegistrationDeployment contains information for how this controller is deployed.
| Field | Description |
|---|---|
policyControllerDeploymentPolicy |
(Optional)
Policy controls how the controller is deployed. It defaults to 'OnDemand'. |
seedSelectorLabelSelector |
(Optional)
SeedSelector contains an optional label selector for seeds. Only if the labels match then this controller will be |
deploymentRefsDeploymentRef array |
(Optional)
DeploymentRefs holds references to `ControllerDeployments`. Only one element is supported currently. |
(Appears on:ControllerRegistration)
ControllerRegistrationSpec is the specification of a ControllerRegistration.
| Field | Description |
|---|---|
resourcesControllerResource array |
(Optional)
Resources is a list of combinations of kinds (DNSProvider, Infrastructure, Generic, ...) and their actual types |
deploymentControllerRegistrationDeployment |
(Optional)
Deployment contains information for how this controller is deployed. |
(Appears on:ControllerRegistrationSpec)
ControllerResource is a combination of a kind (DNSProvider, Infrastructure, Generic, ...) and the actual type for this kind (aws-route53, gcp, auditlog, ...).
| Field | Description |
|---|---|
kindstring |
Kind is the resource kind, for example "OperatingSystemConfig". |
typestring |
Type is the resource type, for example "coreos" or "ubuntu". |
reconcileTimeoutDuration |
(Optional)
ReconcileTimeout defines how long Gardener should wait for the resource reconciliation. |
primaryboolean |
(Optional)
Primary determines if the controller backed by this ControllerRegistration is responsible for the extension |
lifecycleControllerResourceLifecycle |
(Optional)
Lifecycle defines a strategy that determines when different operations on a ControllerResource should be performed. |
workerlessSupportedboolean |
(Optional)
WorkerlessSupported specifies whether this ControllerResource supports Workerless Shoot clusters. |
autoEnableClusterType array |
(Optional)
AutoEnable determines if this resource is automatically enabled for shoot or seed clusters, or both. |
clusterCompatibilityClusterType array |
(Optional)
ClusterCompatibility defines the compatibility of this resource with different cluster types. |
(Appears on:ControllerResource)
ControllerResourceLifecycle defines the lifecycle of a controller resource.
| Field | Description |
|---|---|
reconcileControllerResourceLifecycleStrategy |
(Optional)
Reconcile defines the strategy during reconciliation. |
deleteControllerResourceLifecycleStrategy |
(Optional)
Delete defines the strategy during deletion. |
migrateControllerResourceLifecycleStrategy |
(Optional)
Migrate defines the strategy during migration. |
Underlying type: string
(Appears on:ControllerResourceLifecycle)
ControllerResourceLifecycleStrategy is a string alias.
(Appears on:SystemComponents)
CoreDNS contains the settings of the Core DNS components running in the data plane of the Shoot cluster.
| Field | Description |
|---|---|
autoscalingCoreDNSAutoscaling |
(Optional)
Autoscaling contains the settings related to autoscaling of the Core DNS components running in the data plane of the Shoot cluster. |
rewritingCoreDNSRewriting |
(Optional)
Rewriting contains the setting related to rewriting of requests, which are obviously incorrect due to the unnecessary application of the search path. |
(Appears on:CoreDNS)
CoreDNSAutoscaling contains the settings related to autoscaling of the Core DNS components running in the data plane of the Shoot cluster.
| Field | Description |
|---|---|
modeCoreDNSAutoscalingMode |
The mode of the autoscaling to be used for the Core DNS components running in the data plane of the Shoot cluster. |
Underlying type: string
(Appears on:CoreDNSAutoscaling)
CoreDNSAutoscalingMode is a type alias for the Core DNS autoscaling mode string.
(Appears on:CoreDNS)
CoreDNSRewriting contains the setting related to rewriting requests, which are obviously incorrect due to the unnecessary application of the search path.
| Field | Description |
|---|---|
commonSuffixesstring array |
(Optional)
CommonSuffixes are expected to be the suffix of a fully qualified domain name. Each suffix should contain at least one or two dots ('.') to prevent accidental clashes. |
Underlying type: string
(Appears on:CARotation, ETCDEncryptionKeyRotation, ServiceAccountKeyRotation)
CredentialsRotationPhase is a string alias.
(Appears on:ShootSpec)
DNS holds information about the provider, the hosted zone id and the domain.
| Field | Description |
|---|---|
domainstring |
(Optional)
Domain is the external available domain of the Shoot cluster. This domain will be written into the |
providersDNSProvider array |
(Optional)
Providers is a list of DNS providers that shall be enabled for this shoot cluster. Only relevant if |
Underlying type: struct{}
(Appears on:Exposure)
DNSExposure specifies that this shoot will be exposed by DNS. There is no specific configuration currently, for future extendability.
(Appears on:DNSProvider)
DNSIncludeExclude contains information about which domains shall be included/excluded.
| Field | Description |
|---|---|
includestring array |
(Optional)
Include is a list of domains that shall be included. |
excludestring array |
(Optional)
Exclude is a list of domains that shall be excluded. |
(Appears on:DNS)
DNSProvider contains information about a DNS provider.
| Field | Description |
|---|---|
domainsDNSIncludeExclude |
(Optional)
Domains contains information about which domains shall be included/excluded for this provider. |
primaryboolean |
(Optional)
Primary indicates that this DNSProvider is used for shoot related domains. |
secretNamestring |
(Optional)
SecretName is a name of a secret containing credentials for the stated domain and the |
typestring |
(Optional)
Type is the DNS provider type. |
zonesDNSIncludeExclude |
(Optional)
Zones contains information about which hosted zones shall be included/excluded for this provider. |
credentialsRefCrossVersionObjectReference |
(Optional)
CredentialsRef is a reference to a resource providing credentials for the DNS provider. |
(Appears on:Worker)
DataVolume contains information about a data volume.
| Field | Description |
|---|---|
namestring |
Name of the volume to make it referenceable. |
typestring |
(Optional)
Type is the type of the volume. |
sizestring |
VolumeSize is the size of the volume. |
encryptedboolean |
(Optional)
Encrypted determines if the volume should be encrypted. |
(Appears on:ControllerRegistrationDeployment)
DeploymentRef contains information about `ControllerDeployment` references.
| Field | Description |
|---|---|
namestring |
Name is the name of the `ControllerDeployment` that is being referred to. |
(Appears on:ProjectSpec)
DualApprovalForDeletion contains configuration for the dual approval concept for resource deletion.
| Field | Description |
|---|---|
resourcestring |
Resource is the name of the resource this applies to. |
selectorLabelSelector |
Selector is the label selector for the resources. |
includeServiceAccountsboolean |
(Optional)
IncludeServiceAccounts specifies whether the concept also applies when deletion is triggered by ServiceAccounts. |
(Appears on:Kubernetes)
ETCD contains configuration for etcds of the shoot cluster.
| Field | Description |
|---|---|
mainETCDConfig |
(Optional)
Main contains configuration for the main etcd. |
eventsETCDConfig |
(Optional)
Events contains configuration for the events etcd. |
(Appears on:ETCD)
ETCDConfig contains etcd configuration.
| Field | Description |
|---|---|
autoscalingControlPlaneAutoscaling |
(Optional)
Autoscaling contains auto-scaling configuration options for etcd. |
(Appears on:ShootCredentialsRotation)
ETCDEncryptionKeyRotation contains information about the ETCD encryption key credential rotation.
| Field | Description |
|---|---|
phaseCredentialsRotationPhase |
Phase describes the phase of the ETCD encryption key credential rotation. |
lastCompletionTimeTime |
(Optional)
LastCompletionTime is the most recent time when the ETCD encryption key credential rotation was successfully |
lastInitiationTimeTime |
(Optional)
LastInitiationTime is the most recent time when the ETCD encryption key credential rotation was initiated. |
lastInitiationFinishedTimeTime |
(Optional)
LastInitiationFinishedTime is the recent time when the ETCD encryption key credential rotation initiation was |
lastCompletionTriggeredTimeTime |
(Optional)
LastCompletionTriggeredTime is the recent time when the ETCD encryption key credential rotation completion was |
autoCompleteAfterPreparedboolean |
(Optional)
AutoCompleteAfterPrepared indicates whether the current ETCD encryption key rotation should be auto completed after the preparation phase has finished. |
(Appears on:ShootCredentials)
EncryptionAtRest contains information about Shoot data encryption at rest.
| Field | Description |
|---|---|
resourcesstring array |
(Optional)
Resources is the list of resources in the Shoot which are currently encrypted. |
providerEncryptionProviderStatus |
Provider contains information about Shoot encryption provider. |
(Appears on:KubeAPIServerConfig)
EncryptionConfig contains customizable encryption configuration of the API server.
| Field | Description |
|---|---|
resourcesstring array |
(Optional)
Resources contains the list of resources that shall be encrypted in addition to secrets. |
providerEncryptionProvider |
Provider contains information about the encryption provider. |
(Appears on:EncryptionConfig)
EncryptionProvider contains information about the encryption provider.
| Field | Description |
|---|---|
typeEncryptionProviderType |
(Optional)
Type contains the type of the encryption provider. |
(Appears on:EncryptionAtRest)
EncryptionProviderStatus contains information about Shoot encryption provider.
| Field | Description |
|---|---|
typeEncryptionProviderType |
Type is the used encryption provider type. |
Underlying type: string
(Appears on:EncryptionProvider, EncryptionProviderStatus)
EncryptionProviderType is a type alias for the encryption provider type string.
Underlying type: string
(Appears on:Condition, LastError)
ErrorCode is a string alias.
Underlying type: string
(Appears on:ClusterAutoscaler)
ExpanderMode is type used for Expander values
(Appears on:KubernetesSettings, MachineImageVersion)
ExpirableVersion contains a version with associated lifecycle information.
| Field | Description |
|---|---|
versionstring |
Version is the version identifier. |
expirationDateTime |
(Optional)
ExpirationDate defines the time at which this version expires. |
classificationVersionClassification |
(Optional)
Classification defines the state of a version (preview, supported, deprecated). |
lifecycleLifecycleStage array |
(Optional)
Lifecycle defines the lifecycle stages for this version. |
(Appears on:KubernetesStatus, MachineImageStatus)
ExpirableVersionStatus defines the current status of an expirable version.
| Field | Description |
|---|---|
versionstring |
Version is the version identifier. |
classificationVersionClassification |
Classification reflects the current state in the classification lifecycle. |
(Appears on:WorkerControlPlane)
Exposure holds the exposure configuration for the shoot (either `extension` or `dns` or omitted/empty).
| Field | Description |
|---|---|
extensionExtensionExposure |
(Optional)
Extension holds the type and provider config of the exposure extension. |
dnsDNSExposure |
(Optional)
DNS specifies that this shoot will be exposed by DNS. |
ExposureClass represents a control plane endpoint exposure strategy.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
handlerstring |
Handler is the name of the handler which applies the control plane endpoint exposure strategy. |
schedulingExposureClassScheduling |
(Optional)
Scheduling holds information how to select applicable Seed's for ExposureClass usage. |
(Appears on:ExposureClass)
ExposureClassScheduling holds information to select applicable Seed's for ExposureClass usage.
| Field | Description |
|---|---|
seedSelectorSeedSelector |
(Optional)
SeedSelector is an optional label selector for Seed's which are suitable to use the ExposureClass. |
tolerationsToleration array |
(Optional)
Tolerations contains the tolerations for taints on Seed clusters. |
(Appears on:SeedSpec, ShootSpec)
Extension contains type and provider information for extensions.
| Field | Description |
|---|---|
typestring |
Type is the type of the extension resource. |
providerConfigRawExtension |
(Optional)
ProviderConfig is the configuration passed to extension resource. |
disabledboolean |
(Optional)
Disabled allows to disable extensions that were marked as 'automatically enabled' by Gardener administrators. |
(Appears on:Exposure)
ExtensionExposure holds the type and provider config of the exposure extension.
(Appears on:ShootStateSpec)
ExtensionResourceState contains the kind of the extension custom resource and its last observed state in the Shoot's namespace on the Seed cluster.
| Field | Description |
|---|---|
kindstring |
Kind (type) of the extension custom resource |
namestring |
(Optional)
Name of the extension custom resource |
purposestring |
(Optional)
Purpose of the extension custom resource |
stateRawExtension |
(Optional)
State of the extension resource |
resourcesNamedResourceReference array |
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
(Appears on:HighAvailability)
FailureTolerance describes information about failure tolerance level of a highly available resource.
| Field | Description |
|---|---|
typeFailureToleranceType |
Type specifies the type of failure that the highly available resource can tolerate |
Underlying type: string
(Appears on:FailureTolerance)
FailureToleranceType specifies the type of failure that a highly available shoot control plane that can tolerate.
(Appears on:SeedStatus, ShootStatus)
Gardener holds the information about the Gardener version that operated a resource.
| Field | Description |
|---|---|
idstring |
ID is the container id of the Gardener which last acted on a resource. |
namestring |
Name is the hostname (pod name) of the Gardener which last acted on a resource. |
versionstring |
Version is the version of the Gardener which last acted on a resource. |
(Appears on:ShootStateSpec)
GardenerResourceData holds the data which is used to generate resources, deployed in the Shoot's control plane.
| Field | Description |
|---|---|
namestring |
Name of the object required to generate resources |
typestring |
Type of the object |
dataRawExtension |
Data contains the payload required to generate resources |
labelsobject (keys:string, values:string) |
(Optional)
Labels are labels of the object |
HelmControllerDeployment configures how an extension controller is deployed using helm. This is the legacy structure that used to be defined in gardenlet's ControllerInstallation controller for ControllerDeployment's with type=helm. While this is not a proper API type, we need to define the structure in the API package so that we can convert it to the internal API version in the new representation.
| Field | Description |
|---|---|
chartinteger array |
Chart is a Helm chart tarball. |
valuesJSON |
Values is a map of values for the given chart. |
ociRepositoryOCIRepository |
(Optional)
OCIRepository defines where to pull the chart. |
(Appears on:ShootSpec)
Hibernation contains information whether the Shoot is suspended or not.
| Field | Description |
|---|---|
enabledboolean |
(Optional)
Enabled specifies whether the Shoot needs to be hibernated or not. If it is true, the Shoot's desired state is to be hibernated. |
schedulesHibernationSchedule array |
(Optional)
Schedules determine the hibernation schedules. |
(Appears on:Hibernation)
HibernationSchedule determines the hibernation schedule of a Shoot. A Shoot will be regularly hibernated at each start time and will be woken up at each end time. Start or End can be omitted, though at least one of each has to be specified.
| Field | Description |
|---|---|
startstring |
(Optional)
Start is a Cron spec at which time a Shoot will be hibernated. |
endstring |
(Optional)
End is a Cron spec at which time a Shoot will be woken up. |
locationstring |
(Optional)
Location is the time location in which both start and shall be evaluated. |
(Appears on:ControlPlane)
HighAvailability specifies the configuration settings for high availability for a resource. Typical usages could be to configure HA for shoot control plane or for seed system components.
| Field | Description |
|---|---|
failureToleranceFailureTolerance |
FailureTolerance holds information about failure tolerance level of a highly available resource. |
(Appears on:KubeControllerManagerConfig)
HorizontalPodAutoscalerConfig contains horizontal pod autoscaler configuration settings for the kube-controller-manager. Note: Descriptions were taken from the Kubernetes documentation.
| Field | Description |
|---|---|
cpuInitializationPeriodDuration |
(Optional)
The period after which a ready pod transition is considered to be the first. |
downscaleStabilizationDuration |
(Optional)
The configurable window at which the controller will choose the highest recommendation for autoscaling. |
initialReadinessDelayDuration |
(Optional)
The configurable period at which the horizontal pod autoscaler considers a Pod “not yet ready” given that it’s unready and it has transitioned to unready during that time. |
syncPeriodDuration |
(Optional)
The period for syncing the number of pods in horizontal pod autoscaler. |
tolerancefloat |
(Optional)
The minimum change (from 1.0) in the desired-to-actual metrics ratio for the horizontal pod autoscaler to consider scaling. |
Underlying type: string
(Appears on:Networking, SeedNetworks)
IPFamily is a type for specifying an IP protocol version to use in Gardener clusters.
(Appears on:MachineImageVersion)
InPlaceUpdates contains the configuration for in-place updates for a machine image version.
| Field | Description |
|---|---|
supportedboolean |
Supported indicates whether in-place updates are supported for this machine image version. |
minVersionForUpdatestring |
(Optional)
MinVersionForInPlaceUpdate specifies the minimum supported version from which an in-place update to this machine image version can be performed. |
(Appears on:ShootStatus)
InPlaceUpdatesStatus contains information about in-place updates for the Shoot workers.
| Field | Description |
|---|---|
pendingWorkerUpdatesPendingWorkerUpdates |
(Optional)
PendingWorkerUpdates contains information about worker pools pending in-place updates. |
(Appears on:SeedSpec)
Ingress configures the Ingress specific settings of the cluster
| Field | Description |
|---|---|
domainstring |
Domain specifies the IngressDomain of the cluster pointing to the ingress controller endpoint. It will be used |
controllerIngressController |
Controller configures a Gardener managed Ingress Controller listening on the ingressDomain |
(Appears on:Ingress)
IngressController enables a Gardener managed Ingress Controller listening on the ingressDomain
| Field | Description |
|---|---|
kindstring |
Kind defines which kind of IngressController to use. At the moment only `nginx` is supported |
providerConfigRawExtension |
(Optional)
ProviderConfig specifies infrastructure specific configuration for the ingressController |
InternalSecret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
immutableboolean |
(Optional)
Immutable, if set to true, ensures that data stored in the Secret cannot |
dataobject (keys:string, values:integer array) |
(Optional)
Data contains the secret data. Each key must consist of alphanumeric |
stringDataobject (keys:string, values:string) |
(Optional)
stringData allows specifying non-binary secret data in string form. |
typeSecretType |
(Optional)
Used to facilitate programmatic handling of secret data. |
(Appears on:Kubernetes)
KubeAPIServerConfig contains configuration settings for the kube-apiserver.
| Field | Description |
|---|---|
featureGatesobject (keys:string, values:boolean) |
(Optional)
FeatureGates contains information about enabled feature gates. |
admissionPluginsAdmissionPlugin array |
(Optional)
AdmissionPlugins contains the list of user-defined admission plugins (additional to those managed by Gardener), and, if desired, the corresponding |
apiAudiencesstring array |
(Optional)
APIAudiences are the identifiers of the API. The service account token authenticator will |
auditConfigAuditConfig |
(Optional)
AuditConfig contains configuration settings for the audit of the kube-apiserver. |
oidcConfigOIDCConfig |
(Optional)
OIDCConfig contains configuration settings for the OIDC provider. |
runtimeConfigobject (keys:string, values:boolean) |
(Optional)
RuntimeConfig contains information about enabled or disabled APIs. |
serviceAccountConfigServiceAccountConfig |
(Optional)
ServiceAccountConfig contains configuration settings for the service account handling |
watchCacheSizesWatchCacheSizes |
(Optional)
WatchCacheSizes contains configuration of the API server's watch cache sizes. |
requestsAPIServerRequests |
(Optional)
Requests contains configuration for request-specific settings for the kube-apiserver. |
enableAnonymousAuthenticationboolean |
(Optional)
EnableAnonymousAuthentication defines whether anonymous requests to the secure port |
eventTTLDuration |
(Optional)
EventTTL controls the amount of time to retain events. |
loggingAPIServerLogging |
(Optional)
Logging contains configuration for the log level and HTTP access logs. |
defaultNotReadyTolerationSecondsinteger |
(Optional)
DefaultNotReadyTolerationSeconds indicates the tolerationSeconds of the toleration for notReady:NoExecute |
defaultUnreachableTolerationSecondsinteger |
(Optional)
DefaultUnreachableTolerationSeconds indicates the tolerationSeconds of the toleration for unreachable:NoExecute |
encryptionConfigEncryptionConfig |
(Optional)
EncryptionConfig contains customizable encryption configuration of the Kube API server. |
structuredAuthenticationStructuredAuthentication |
(Optional)
StructuredAuthentication contains configuration settings for structured authentication for the kube-apiserver. |
structuredAuthorizationStructuredAuthorization |
(Optional)
StructuredAuthorization contains configuration settings for structured authorization for the kube-apiserver. |
autoscalingControlPlaneAutoscaling |
(Optional)
Autoscaling contains auto-scaling configuration options for the kube-apiserver. |
(Appears on:Kubernetes)
KubeControllerManagerConfig contains configuration settings for the kube-controller-manager.
| Field | Description |
|---|---|
featureGatesobject (keys:string, values:boolean) |
(Optional)
FeatureGates contains information about enabled feature gates. |
horizontalPodAutoscalerHorizontalPodAutoscalerConfig |
(Optional)
HorizontalPodAutoscalerConfig contains horizontal pod autoscaler configuration settings for the kube-controller-manager. |
nodeCIDRMaskSizeinteger |
(Optional)
NodeCIDRMaskSize defines the mask size for node cidr in cluster (default is 24). This field is immutable. |
podEvictionTimeoutDuration |
(Optional)
PodEvictionTimeout defines the grace period for deleting pods on failed nodes. Defaults to 2m. |
nodeMonitorGracePeriodDuration |
(Optional)
NodeMonitorGracePeriod defines the grace period before an unresponsive node is marked unhealthy. |
nodeCIDRMaskSizeIPv6integer |
(Optional)
NodeCIDRMaskSizeIPv6 defines the mask size for node cidr in cluster (default is 64). This field is immutable. |
(Appears on:Kubernetes)
KubeProxyConfig contains configuration settings for the kube-proxy.
| Field | Description |
|---|---|
featureGatesobject (keys:string, values:boolean) |
(Optional)
FeatureGates contains information about enabled feature gates. |
modeProxyMode |
(Optional)
Mode specifies which proxy mode to use. |
enabledboolean |
(Optional)
Enabled indicates whether kube-proxy should be deployed or not. |
(Appears on:Kubernetes)
KubeSchedulerConfig contains configuration settings for the kube-scheduler.
| Field | Description |
|---|---|
featureGatesobject (keys:string, values:boolean) |
(Optional)
FeatureGates contains information about enabled feature gates. |
kubeMaxPDVolsstring |
(Optional)
KubeMaxPDVols is not respected anymore by kube-scheduler. |
profileSchedulingProfile |
(Optional)
Profile configures the scheduling profile for the cluster. |
(Appears on:Kubernetes, WorkerKubernetes)
KubeletConfig contains configuration settings for the kubelet.
| Field | Description |
|---|---|
featureGatesobject (keys:string, values:boolean) |
(Optional)
FeatureGates contains information about enabled feature gates. |
cpuCFSQuotaboolean |
(Optional)
CPUCFSQuota allows you to disable/enable CPU throttling for Pods. |
cpuManagerPolicystring |
(Optional)
CPUManagerPolicy allows to set alternative CPU management policies (default: none). |
evictionHardKubeletConfigEviction |
(Optional)
EvictionHard describes a set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a Pod eviction. |
evictionMaxPodGracePeriodinteger |
(Optional)
EvictionMaxPodGracePeriod describes the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. |
evictionMinimumReclaimKubeletConfigEvictionMinimumReclaim |
(Optional)
EvictionMinimumReclaim configures the amount of resources below the configured eviction threshold that the kubelet attempts to reclaim whenever the kubelet observes resource pressure. |
evictionPressureTransitionPeriodDuration |
(Optional)
EvictionPressureTransitionPeriod is the duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. |
evictionSoftKubeletConfigEviction |
(Optional)
EvictionSoft describes a set of eviction thresholds (e.g. memory.available<1.5Gi) that if met over a corresponding grace period would trigger a Pod eviction. |
evictionSoftGracePeriodKubeletConfigEvictionSoftGracePeriod |
(Optional)
EvictionSoftGracePeriod describes a set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a Pod eviction. |
maxPodsinteger |
(Optional)
MaxPods is the maximum number of Pods that are allowed by the Kubelet. |
podPidsLimitinteger |
(Optional)
PodPIDsLimit is the maximum number of process IDs per pod allowed by the kubelet. |
failSwapOnboolean |
(Optional)
FailSwapOn makes the Kubelet fail to start if swap is enabled on the node. (default true). |
kubeReservedKubeletConfigReserved |
(Optional)
KubeReserved is the configuration for resources reserved for kubernetes node components (mainly kubelet and container runtime). |
imageGCHighThresholdPercentinteger |
(Optional)
ImageGCHighThresholdPercent describes the percent of the disk usage which triggers image garbage collection. |
imageGCLowThresholdPercentinteger |
(Optional)
ImageGCLowThresholdPercent describes the percent of the disk to which garbage collection attempts to free. |
serializeImagePullsboolean |
(Optional)
SerializeImagePulls describes whether the images are pulled one at a time. |
registryPullQPSinteger |
(Optional)
RegistryPullQPS is the limit of registry pulls per second. The value must not be a negative number. |
registryBurstinteger |
(Optional)
RegistryBurst is the maximum size of bursty pulls, temporarily allows pulls to burst to this number, |
seccompDefaultboolean |
(Optional)
SeccompDefault enables the use of `RuntimeDefault` as the default seccomp profile for all workloads. |
containerLogMaxSizeQuantity |
(Optional)
A quantity defines the maximum size of the container log file before it is rotated. For example: "5Mi" or "256Ki". |
containerLogMaxFilesinteger |
(Optional)
Maximum number of container log files that can be present for a container. |
protectKernelDefaultsboolean |
(Optional)
ProtectKernelDefaults ensures that the kernel tunables are equal to the kubelet defaults. |
streamingConnectionIdleTimeoutDuration |
(Optional)
StreamingConnectionIdleTimeout is the maximum time a streaming connection can be idle before the connection is automatically closed. |
memorySwapMemorySwapConfiguration |
(Optional)
MemorySwap configures swap memory available to container workloads. |
maxParallelImagePullsinteger |
(Optional)
MaxParallelImagePulls describes the maximum number of image pulls in parallel. The value must be a positive number. |
imageMinimumGCAgeDuration |
(Optional)
ImageMinimumGCAge is the minimum age of an unused image before it can be garbage collected. |
imageMaximumGCAgeDuration |
(Optional)
ImageMaximumGCAge is the maximum age of an unused image before it can be garbage collected. |
(Appears on:KubeletConfig)
KubeletConfigEviction contains kubelet eviction thresholds supporting either a resource.Quantity or a percentage based value.
| Field | Description |
|---|---|
memoryAvailablestring |
(Optional)
MemoryAvailable is the threshold for the free memory on the host server. |
imageFSAvailablestring |
(Optional)
ImageFSAvailable is the threshold for the free disk space in the imagefs filesystem (docker images and container writable layers). |
imageFSInodesFreestring |
(Optional)
ImageFSInodesFree is the threshold for the available inodes in the imagefs filesystem. |
nodeFSAvailablestring |
(Optional)
NodeFSAvailable is the threshold for the free disk space in the nodefs filesystem (docker volumes, logs, etc). |
nodeFSInodesFreestring |
(Optional)
NodeFSInodesFree is the threshold for the available inodes in the nodefs filesystem. |
(Appears on:KubeletConfig)
KubeletConfigEvictionMinimumReclaim contains configuration for the kubelet eviction minimum reclaim.
| Field | Description |
|---|---|
memoryAvailableQuantity |
(Optional)
MemoryAvailable is the threshold for the memory reclaim on the host server. |
imageFSAvailableQuantity |
(Optional)
ImageFSAvailable is the threshold for the disk space reclaim in the imagefs filesystem (docker images and container writable layers). |
imageFSInodesFreeQuantity |
(Optional)
ImageFSInodesFree is the threshold for the inodes reclaim in the imagefs filesystem. |
nodeFSAvailableQuantity |
(Optional)
NodeFSAvailable is the threshold for the disk space reclaim in the nodefs filesystem (docker volumes, logs, etc). |
nodeFSInodesFreeQuantity |
(Optional)
NodeFSInodesFree is the threshold for the inodes reclaim in the nodefs filesystem. |
(Appears on:KubeletConfig)
KubeletConfigEvictionSoftGracePeriod contains grace periods for kubelet eviction thresholds.
| Field | Description |
|---|---|
memoryAvailableDuration |
(Optional)
MemoryAvailable is the grace period for the MemoryAvailable eviction threshold. |
imageFSAvailableDuration |
(Optional)
ImageFSAvailable is the grace period for the ImageFSAvailable eviction threshold. |
imageFSInodesFreeDuration |
(Optional)
ImageFSInodesFree is the grace period for the ImageFSInodesFree eviction threshold. |
nodeFSAvailableDuration |
(Optional)
NodeFSAvailable is the grace period for the NodeFSAvailable eviction threshold. |
nodeFSInodesFreeDuration |
(Optional)
NodeFSInodesFree is the grace period for the NodeFSInodesFree eviction threshold. |
(Appears on:KubeletConfig)
KubeletConfigReserved contains reserved resources for daemons
| Field | Description |
|---|---|
cpuQuantity |
(Optional)
CPU is the reserved cpu. |
memoryQuantity |
(Optional)
Memory is the reserved memory. |
ephemeralStorageQuantity |
(Optional)
EphemeralStorage is the reserved ephemeral-storage. |
pidQuantity |
(Optional)
PID is the reserved process-ids. |
(Appears on:ShootSpec)
Kubernetes contains the version and configuration variables for the Shoot control plane.
| Field | Description |
|---|---|
clusterAutoscalerClusterAutoscaler |
(Optional)
ClusterAutoscaler contains the configuration flags for the Kubernetes cluster autoscaler. |
kubeAPIServerKubeAPIServerConfig |
(Optional)
KubeAPIServer contains configuration settings for the kube-apiserver. |
kubeControllerManagerKubeControllerManagerConfig |
(Optional)
KubeControllerManager contains configuration settings for the kube-controller-manager. |
kubeSchedulerKubeSchedulerConfig |
(Optional)
KubeScheduler contains configuration settings for the kube-scheduler. |
kubeProxyKubeProxyConfig |
(Optional)
KubeProxy contains configuration settings for the kube-proxy. |
kubeletKubeletConfig |
(Optional)
Kubelet contains configuration settings for the kubelet. |
versionstring |
(Optional)
Version is the semantic Kubernetes version to use for the Shoot cluster. |
verticalPodAutoscalerVerticalPodAutoscaler |
(Optional)
VerticalPodAutoscaler contains the configuration flags for the Kubernetes vertical pod autoscaler. |
etcdETCD |
(Optional)
ETCD contains configuration for etcds of the shoot cluster. |
(Appears on:KubeAPIServerConfig, KubeControllerManagerConfig, KubeProxyConfig, KubeSchedulerConfig, KubeletConfig)
KubernetesConfig contains common configuration fields for the control plane components.
This is a legacy type that should not be used in new API fields or resources. Instead of embedding this type, consider using inline map for feature gates definitions.
| Field | Description |
|---|---|
featureGatesobject (keys:string, values:boolean) |
(Optional)
FeatureGates contains information about enabled feature gates. |
(Appears on:Addons)
KubernetesDashboard describes configuration values for the kubernetes-dashboard addon.
| Field | Description |
|---|---|
enabledboolean |
Enabled indicates whether the addon is enabled or not. |
authenticationModestring |
(Optional)
AuthenticationMode defines the authentication mode for the kubernetes-dashboard. |
(Appears on:CloudProfileSpec, NamespacedCloudProfileSpec)
KubernetesSettings contains constraints regarding allowed values of the 'kubernetes' block in the Shoot specification.
| Field | Description |
|---|---|
versionsExpirableVersion array |
(Optional)
Versions is the list of allowed Kubernetes versions with optional expiration dates for Shoot clusters. |
(Appears on:CloudProfileStatus)
KubernetesStatus contains the status information for kubernetes.
| Field | Description |
|---|---|
versionsExpirableVersionStatus array |
(Optional)
Versions contains the statuses of the kubernetes versions. |
(Appears on:BackupBucketStatus, BackupEntryStatus, ShootStatus)
LastError indicates the last occurred error for an operation on a resource.
| Field | Description |
|---|---|
descriptionstring |
A human readable message indicating details about the last error. |
taskIDstring |
(Optional)
ID of the task which caused this last error |
codesErrorCode array |
(Optional)
Well-defined error codes of the last error(s). |
lastUpdateTimeTime |
(Optional)
Last time the error was reported |
(Appears on:ShootStatus)
LastMaintenance holds information about a maintenance operation on the Shoot.
| Field | Description |
|---|---|
descriptionstring |
A human-readable message containing details about the operations performed in the last maintenance. |
triggeredTimeTime |
TriggeredTime is the time when maintenance was triggered. |
stateLastOperationState |
Status of the last maintenance operation, one of Processing, Succeeded, Error. |
failureReasonstring |
(Optional)
FailureReason holds the information about the last maintenance operation failure reason. |
(Appears on:BackupBucketStatus, BackupEntryStatus, SeedStatus, ShootStatus)
LastOperation indicates the type and the state of the last operation, along with a description message and a progress indicator.
| Field | Description |
|---|---|
descriptionstring |
A human readable message indicating details about the last operation. |
lastUpdateTimeTime |
Last time the operation state transitioned from one to another. |
progressinteger |
The progress in percentage (0-100) of the last operation. |
stateLastOperationState |
Status of the last operation, one of Aborted, Processing, Succeeded, Error, Failed. |
typeLastOperationType |
Type of the last operation, one of Create, Reconcile, Delete, Migrate, Restore. |
Underlying type: string
(Appears on:LastMaintenance, LastOperation)
LastOperationState is a string alias.
Underlying type: string
(Appears on:LastOperation)
LastOperationType is a string alias.
(Appears on:ExpirableVersion, MachineImageVersion)
LifecycleStage describes a stage in the versions lifecycle. Each stage defines the classification of the version (e.g. unavailable, preview, supported, deprecated, expired) and the time at which this classification becomes effective.
| Field | Description |
|---|---|
classificationVersionClassification |
Classification is the category of this lifecycle stage (unavailable, preview, supported, deprecated, expired). |
startTimeTime |
(Optional)
StartTime defines when this lifecycle stage becomes active. |
(Appears on:CloudProfileSpec, NamespacedCloudProfileSpec)
Limits configures operational limits for Shoot clusters using this CloudProfile. See https://github.com/gardener/gardener/blob/master/docs/usage/shoot/shoot_limits.md.
| Field | Description |
|---|---|
maxNodesTotalinteger |
(Optional)
MaxNodesTotal configures the maximum node count a Shoot cluster can have during runtime. |
(Appears on:SeedSettingLoadBalancerServices, SeedSettingLoadBalancerServicesZones)
LoadBalancerServicesProxyProtocol controls whether ProxyProtocol is (optionally) allowed for the load balancer services.
| Field | Description |
|---|---|
allowedboolean |
Allowed controls whether the ProxyProtocol is optionally allowed for the load balancer services. |
(Appears on:Worker)
Machine contains information about the machine type and image.
| Field | Description |
|---|---|
typestring |
Type is the machine type of the worker group. |
imageShootMachineImage |
(Optional)
Image holds information about the machine image to use for all nodes of this pool. It will default to the |
architecturestring |
(Optional)
Architecture is CPU architecture of machines in this worker pool. |
(Appears on:Worker)
MachineControllerManagerSettings contains configurations for different worker-pools. Eg. MachineDrainTimeout, MachineHealthTimeout.
| Field | Description |
|---|---|
machineDrainTimeoutDuration |
(Optional)
MachineDrainTimeout is the period after which machine is forcefully deleted. |
machineHealthTimeoutDuration |
(Optional)
MachineHealthTimeout is the period after which machine is declared failed. |
machineCreationTimeoutDuration |
(Optional)
MachineCreationTimeout is the period after which creation of the machine is declared failed. |
maxEvictRetriesinteger |
(Optional)
MaxEvictRetries are the number of eviction retries on a pod after which drain is declared failed, and forceful deletion is triggered. |
nodeConditionsstring array |
(Optional)
NodeConditions are the set of conditions if set to true for the period of MachineHealthTimeout, machine will be declared failed. |
inPlaceUpdateTimeoutDuration |
(Optional)
MachineInPlaceUpdateTimeout is the timeout after which in-place update is declared failed. |
disableHealthTimeoutboolean |
(Optional)
DisableHealthTimeout if set to true, health timeout will be ignored. Leading to machine never being declared failed. |
(Appears on:CloudProfileSpec, NamespacedCloudProfileSpec)
MachineImage defines the name and multiple versions of the machine image in any environment.
| Field | Description |
|---|---|
namestring |
Name is the name of the image. |
versionsMachineImageVersion array |
Versions contains versions, expiration dates and container runtimes of the machine image |
updateStrategyMachineImageUpdateStrategy |
(Optional)
UpdateStrategy is the update strategy to use for the machine image. Possible values are: |
(Appears on:MachineImageVersion)
MachineImageFlavor is a wrapper for Capabilities. This is a workaround as the Protobuf generator can't handle a slice of maps.
(Appears on:CloudProfileStatus)
MachineImageStatus contains the status of a machine image and its version classifications.
| Field | Description |
|---|---|
namestring |
Name matches the name of the MachineImage the status is represented of. |
versionsExpirableVersionStatus array |
(Optional)
Versions contains the statuses of the machine image versions. |
Underlying type: string
(Appears on:MachineImage)
MachineImageUpdateStrategy is the update strategy to use for a machine image
(Appears on:MachineImage)
MachineImageVersion is an expirable version with list of supported container runtimes and interfaces
| Field | Description |
|---|---|
versionstring |
Version is the version identifier. |
expirationDateTime |
(Optional)
ExpirationDate defines the time at which this version expires. |
classificationVersionClassification |
(Optional)
Classification defines the state of a version (preview, supported, deprecated). |
lifecycleLifecycleStage array |
(Optional)
Lifecycle defines the lifecycle stages for this version. |
criCRI array |
(Optional)
CRI list of supported container runtime and interfaces supported by this version |
architecturesstring array |
(Optional)
Architectures is the list of CPU architectures of the machine image in this version. |
kubeletVersionConstraintstring |
(Optional)
KubeletVersionConstraint is a constraint describing the supported kubelet versions by the machine image in this version. |
inPlaceUpdatesInPlaceUpdates |
(Optional)
InPlaceUpdates contains the configuration for in-place updates for this machine image version. |
capabilityFlavorsMachineImageFlavor array |
(Optional)
CapabilityFlavors is an array of MachineImageFlavor. Each entry represents a combination of capabilities that is provided by |
(Appears on:CloudProfileSpec, NamespacedCloudProfileSpec)
MachineType contains certain properties of a machine type.
| Field | Description |
|---|---|
cpuQuantity |
CPU is the number of CPUs for this machine type. |
gpuQuantity |
GPU is the number of GPUs for this machine type. |
memoryQuantity |
Memory is the amount of memory for this machine type. |
namestring |
Name is the name of the machine type. |
storageMachineTypeStorage |
(Optional)
Storage is the amount of storage associated with the root volume of this machine type. |
usableboolean |
(Optional)
Usable defines if the machine type can be used for shoot clusters. |
architecturestring |
(Optional)
Architecture is the CPU architecture of this machine type. |
capabilitiesCapabilities |
(Optional)
Capabilities contains the machine type capabilities. |
machineControllerManagerCloudProfileMachineControllerManagerSettings |
(Optional)
MachineControllerManagerSettings contains a subset of the MachineControllerManagerSettings which can be defaulted for a machine type in a CloudProfile. |
(Appears on:MachineType)
MachineTypeStorage is the amount of storage associated with the root volume of this machine type.
| Field | Description |
|---|---|
classstring |
Class is the class of the storage type. |
sizeQuantity |
(Optional)
StorageSize is the storage size. |
typestring |
Type is the type of the storage. |
minSizeQuantity |
(Optional)
MinSize is the minimal supported storage size. |
Underlying type: string
(Appears on:Worker)
MachineUpdateStrategy specifies the machine update strategy for the worker pool.
(Appears on:ShootSpec)
Maintenance contains information about the time window for maintenance operations and which operations should be performed.
| Field | Description |
|---|---|
autoUpdateMaintenanceAutoUpdate |
(Optional)
AutoUpdate contains information about which constraints should be automatically updated. |
timeWindowMaintenanceTimeWindow |
(Optional)
TimeWindow contains information about the time window for maintenance operations. |
confineSpecUpdateRolloutboolean |
(Optional)
ConfineSpecUpdateRollout prevents that changes/updates to the shoot specification will be rolled out immediately. |
autoRotationMaintenanceAutoRotation |
(Optional)
AutoRotation contains information about which rotations should be automatically performed. |
(Appears on:Maintenance)
MaintenanceAutoRotation contains information about which rotations should be automatically performed.
| Field | Description |
|---|---|
credentialsMaintenanceCredentialsAutoRotation |
(Optional)
Credentials contains information about which credentials should be automatically rotated. |
(Appears on:Maintenance)
MaintenanceAutoUpdate contains information about which constraints should be automatically updated.
| Field | Description |
|---|---|
kubernetesVersionboolean |
KubernetesVersion indicates whether the patch Kubernetes version may be automatically updated (default: true). |
machineImageVersionboolean |
(Optional)
MachineImageVersion indicates whether the machine image version may be automatically updated (default: true). |
(Appears on:MaintenanceAutoRotation)
MaintenanceCredentialsAutoRotation contains information about which credentials should be automatically rotated.
| Field | Description |
|---|---|
observabilityMaintenanceRotationConfig |
(Optional)
Observability configures the automatic rotation for the observability credentials. |
sshKeypairMaintenanceRotationConfig |
(Optional)
SSHKeypair configures the automatic rotation for the ssh keypair for worker nodes. |
etcdEncryptionKeyMaintenanceRotationConfig |
(Optional)
ETCDEncryptionKey configures the automatic rotation for the etcd encryption key. |
(Appears on:MaintenanceCredentialsAutoRotation)
MaintenanceRotationConfig contains configuration for automatic rotation.
| Field | Description |
|---|---|
rotationPeriodDuration |
(Optional)
RotationPeriod is the period between a completed rotation and the start of a new rotation (default: 7d). |
(Appears on:Maintenance)
MaintenanceTimeWindow contains information about the time window for maintenance operations.
| Field | Description |
|---|---|
beginstring |
Begin is the beginning of the time window in the format HHMMSS+ZONE, e.g. "220000+0100". |
endstring |
End is the end of the time window in the format HHMMSS+ZONE, e.g. "220000+0100". |
(Appears on:ShootStatus)
ManualWorkerPoolRollout contains information about the worker pool rollout progress that has been initiated via the gardener.cloud/operation=rollout-workers annotation.
| Field | Description |
|---|---|
pendingWorkersRolloutsPendingWorkersRollout array |
(Optional)
PendingWorkersRollouts contains the names of the worker pools that are still pending rollout. |
(Appears on:KubeletConfig)
MemorySwapConfiguration contains kubelet swap configuration For more information, please see KEP: 2400-node-swap
| Field | Description |
|---|---|
swapBehaviorSwapBehavior |
(Optional)
SwapBehavior configures swap memory available to container workloads. May be one of \{"NoSwap", "LimitedSwap"\} |
(Appears on:ShootSpec)
Monitoring contains information about the monitoring configuration for the shoot.
| Field | Description |
|---|---|
alertingAlerting |
(Optional)
Alerting contains information about the alerting configuration for the shoot cluster. |
(Appears on:ExtensionResourceState, SeedSpec, ShootSpec)
NamedResourceReference is a named reference to a resource.
| Field | Description |
|---|---|
namestring |
Name of the resource reference. |
resourceRefCrossVersionObjectReference |
ResourceRef is a reference to a resource. |
NamespacedCloudProfile represents certain properties about a provider environment.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specNamespacedCloudProfileSpec |
Spec defines the provider environment properties. |
statusNamespacedCloudProfileStatus |
Most recently observed status of the NamespacedCloudProfile. |
(Appears on:NamespacedCloudProfile)
NamespacedCloudProfileSpec is the specification of a NamespacedCloudProfile.
| Field | Description |
|---|---|
caBundlestring |
(Optional)
CABundle is a certificate bundle which will be installed onto every host machine of shoot cluster targeting this profile. |
kubernetesKubernetesSettings |
(Optional)
Kubernetes contains constraints regarding allowed values of the 'kubernetes' block in the Shoot specification. |
machineImagesMachineImage array |
(Optional)
MachineImages contains constraints regarding allowed values for machine images in the Shoot specification. |
machineTypesMachineType array |
(Optional)
MachineTypes contains constraints regarding allowed values for machine types in the 'workers' block in the Shoot specification. |
volumeTypesVolumeType array |
(Optional)
VolumeTypes contains constraints regarding allowed values for volume types in the 'workers' block in the Shoot specification. |
parentCloudProfileReference |
Parent contains a reference to a CloudProfile it inherits from. |
providerConfigRawExtension |
(Optional)
ProviderConfig contains provider-specific configuration for the profile. |
limitsLimits |
(Optional)
Limits configures operational limits for Shoot clusters using this NamespacedCloudProfile. |
(Appears on:NamespacedCloudProfile)
NamespacedCloudProfileStatus holds the most recently observed status of the NamespacedCloudProfile.
| Field | Description |
|---|---|
cloudProfileSpecCloudProfileSpec |
CloudProfile is the most recently generated CloudProfile of the NamespacedCloudProfile. |
observedGenerationinteger |
(Optional)
ObservedGeneration is the most recent generation observed for this NamespacedCloudProfile. |
(Appears on:ShootSpec)
Networking defines networking parameters for the shoot cluster.
| Field | Description |
|---|---|
typestring |
(Optional)
Type identifies the type of the networking plugin. This field is immutable. |
providerConfigRawExtension |
(Optional)
ProviderConfig is the configuration passed to network resource. |
podsstring |
(Optional)
Pods is the CIDR of the pod network. This field is immutable. |
nodesstring |
(Optional)
Nodes is the CIDR of the entire node network. |
servicesstring |
(Optional)
Services is the CIDR of the service network. This field is immutable. |
ipFamiliesIPFamily array |
(Optional)
IPFamilies specifies the IP protocol versions to use for shoot networking. |
(Appears on:ShootStatus)
NetworkingStatus contains information about cluster networking such as CIDRs.
| Field | Description |
|---|---|
podsstring array |
(Optional)
Pods are the CIDRs of the pod network. |
nodesstring array |
(Optional)
Nodes are the CIDRs of the node network. |
servicesstring array |
(Optional)
Services are the CIDRs of the service network. |
egressCIDRsstring array |
(Optional)
EgressCIDRs is a list of CIDRs used by the shoot as the source IP for egress traffic as reported by the used |
(Appears on:Addons)
NginxIngress describes configuration values for the nginx-ingress addon.
| Field | Description |
|---|---|
enabledboolean |
Enabled indicates whether the addon is enabled or not. |
loadBalancerSourceRangesstring array |
(Optional)
LoadBalancerSourceRanges is list of allowed IP sources for NginxIngress |
configobject (keys:string, values:string) |
(Optional)
Config contains custom configuration for the nginx-ingress-controller configuration. |
externalTrafficPolicyServiceExternalTrafficPolicy |
(Optional)
ExternalTrafficPolicy controls the `.spec.externalTrafficPolicy` value of the load balancer `Service` |
(Appears on:SystemComponents)
NodeLocalDNS contains the settings of the node local DNS components running in the data plane of the Shoot cluster.
| Field | Description |
|---|---|
enabledboolean |
Enabled indicates whether node local DNS is enabled or not. |
forceTCPToClusterDNSboolean |
(Optional)
ForceTCPToClusterDNS indicates whether the connection from the node local DNS to the cluster DNS (Core DNS) will be forced to TCP or not. |
forceTCPToUpstreamDNSboolean |
(Optional)
ForceTCPToUpstreamDNS indicates whether the connection from the node local DNS to the upstream DNS (infrastructure DNS) will be forced to TCP or not. |
disableForwardToUpstreamDNSboolean |
(Optional)
DisableForwardToUpstreamDNS indicates whether requests from node local DNS to upstream DNS should be disabled. |
(Appears on:HelmControllerDeployment)
OCIRepository configures where to pull an OCI Artifact, that could contain for example a Helm Chart.
| Field | Description |
|---|---|
refstring |
(Optional)
Ref is the full artifact Ref and takes precedence over all other fields. |
repositorystring |
(Optional)
Repository is a reference to an OCI artifact repository. |
tagstring |
(Optional)
Tag is the image tag to pull. |
digeststring |
(Optional)
Digest of the image to pull, takes precedence over tag. |
pullSecretRefLocalObjectReference |
(Optional)
PullSecretRef is a reference to a secret containing the pull secret. |
caBundleSecretRefLocalObjectReference |
(Optional)
CABundleSecretRef is a reference to a secret containing a PEM-encoded certificate authority bundle. |
(Appears on:KubeAPIServerConfig)
OIDCConfig contains configuration settings for the OIDC provider. Note: Descriptions were taken from the Kubernetes documentation.
| Field | Description |
|---|---|
caBundlestring |
(Optional)
If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used. |
clientIDstring |
(Optional)
The client ID for the OpenID Connect client, must be set. |
groupsClaimstring |
(Optional)
If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details. |
groupsPrefixstring |
(Optional)
If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies. |
issuerURLstring |
(Optional)
The URL of the OpenID issuer, only HTTPS scheme will be accepted. Used to verify the OIDC JSON Web Token (JWT). |
requiredClaimsobject (keys:string, values:string) |
(Optional)
key=value pairs that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. |
signingAlgsstring array |
(Optional)
List of allowed JOSE asymmetric signing algorithms. JWTs with a 'alg' header value not in this list will be rejected. Values are defined by RFC 7518 https://tools.ietf.org/html/rfc7518#section-3.1 |
usernameClaimstring |
(Optional)
The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details. (default "sub") |
usernamePrefixstring |
(Optional)
If provided, all usernames will be prefixed with this value. If not provided, username claims other than 'email' are prefixed by the issuer URL to avoid clashes. To skip any prefixing, provide the value '-'. |
(Appears on:ShootCredentialsRotation)
ObservabilityRotation contains information about the observability credential rotation.
| Field | Description |
|---|---|
lastInitiationTimeTime |
(Optional)
LastInitiationTime is the most recent time when the observability credential rotation was initiated. |
lastCompletionTimeTime |
(Optional)
LastCompletionTime is the most recent time when the observability credential rotation was successfully completed. |
OpenIDConnectClientAuthentication contains configuration for OIDC clients.
| Field | Description |
|---|---|
extraConfigobject (keys:string, values:string) |
(Optional)
Extra configuration added to kubeconfig's auth-provider. |
secretstring |
(Optional)
The client Secret for the OpenID Connect client. |
(Appears on:InPlaceUpdatesStatus)
PendingWorkerUpdates contains information about worker pools pending in-place update.
| Field | Description |
|---|---|
autoInPlaceUpdatestring array |
(Optional)
AutoInPlaceUpdate contains the names of the pending worker pools with strategy AutoInPlaceUpdate. |
manualInPlaceUpdatestring array |
(Optional)
ManualInPlaceUpdate contains the names of the pending worker pools with strategy ManualInPlaceUpdate. |
(Appears on:CARotation, ManualWorkerPoolRollout, ServiceAccountKeyRotation)
PendingWorkersRollout contains the name of a worker pool and the initiation time of their last rollout.
| Field | Description |
|---|---|
namestring |
Name is the name of a worker pool. |
lastInitiationTimeTime |
(Optional)
LastInitiationTime is the most recent time when the worker rollout was initiated. |
Project holds certain properties about a Gardener project.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specProjectSpec |
(Optional)
Spec defines the project properties. |
statusProjectStatus |
(Optional)
Most recently observed status of the Project. |
(Appears on:ProjectSpec)
ProjectMember is a member of a project.
| Field | Description |
|---|---|
kindstring |
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". |
apiGroupstring |
(Optional)
APIGroup holds the API group of the referenced subject. |
namestring |
Name of the object being referenced. |
namespacestring |
(Optional)
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty |
rolestring |
Role represents the role of this member. |
rolesstring array |
(Optional)
Roles represents the list of roles of this member. |
Underlying type: string
(Appears on:ProjectStatus)
ProjectPhase is a label for the condition of a project at the current time.
(Appears on:Project)
ProjectSpec is the specification of a Project.
| Field | Description |
|---|---|
createdBySubject |
(Optional)
CreatedBy is a subject representing a user name, an email address, or any other identifier of a user |
descriptionstring |
(Optional)
Description is a human-readable description of what the project is used for. |
ownerSubject |
(Optional)
Owner is a subject representing a user name, an email address, or any other identifier of a user owning |
purposestring |
(Optional)
Purpose is a human-readable explanation of the project's purpose. |
membersProjectMember array |
(Optional)
Members is a list of subjects representing a user name, an email address, or any other identifier of a user, |
namespacestring |
(Optional)
Namespace is the name of the namespace that has been created for the Project object. |
tolerationsProjectTolerations |
(Optional)
Tolerations contains the tolerations for taints on seed clusters. |
dualApprovalForDeletionDualApprovalForDeletion array |
(Optional)
DualApprovalForDeletion contains configuration for the dual approval concept for resource deletion. |
(Appears on:Project)
ProjectStatus holds the most recently observed status of the project.
| Field | Description |
|---|---|
observedGenerationinteger |
(Optional)
ObservedGeneration is the most recent generation observed for this project. |
phaseProjectPhase |
Phase is the current phase of the project. |
staleSinceTimestampTime |
(Optional)
StaleSinceTimestamp contains the timestamp when the project was first discovered to be stale/unused. |
staleAutoDeleteTimestampTime |
(Optional)
StaleAutoDeleteTimestamp contains the timestamp when the project will be garbage-collected/automatically deleted |
lastActivityTimestampTime |
(Optional)
LastActivityTimestamp contains the timestamp from the last activity performed in this project. |
conditionsCondition array |
(Optional)
Conditions represents the latest available observations of a Project's current state. |
(Appears on:ProjectSpec)
ProjectTolerations contains the tolerations for taints on seed clusters.
| Field | Description |
|---|---|
defaultsToleration array |
(Optional)
Defaults contains a list of tolerations that are added to the shoots in this project by default. |
whitelistToleration array |
(Optional)
Whitelist contains a list of tolerations that are allowed to be added to the shoots in this project. Please note |
(Appears on:ShootSpec)
Provider contains provider-specific information that are handed-over to the provider-specific extension controller.
| Field | Description |
|---|---|
typestring |
Type is the type of the provider. This field is immutable. |
controlPlaneConfigRawExtension |
(Optional)
ControlPlaneConfig contains the provider-specific control plane config blob. Please look up the concrete |
infrastructureConfigRawExtension |
(Optional)
InfrastructureConfig contains the provider-specific infrastructure config blob. Please look up the concrete |
workersWorker array |
(Optional)
Workers is a list of worker groups. |
workersSettingsWorkersSettings |
(Optional)
WorkersSettings contains settings for all workers. |
Underlying type: string
(Appears on:KubeProxyConfig)
ProxyMode available in Linux platform: 'userspace' (older, going to be EOL), 'iptables' (newer, faster), 'nftables', and 'ipvs' (deprecated starting with Kubernetes 1.35). As of now only 'iptables', 'nftables' and 'ipvs' (deprecated starting with Kubernetes 1.35) is supported by Gardener. In Linux platform, if the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy.
Quota represents a quota on resources consumed by shoot clusters either per project or per provider secret.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specQuotaSpec |
(Optional)
Spec defines the Quota constraints. |
(Appears on:Quota)
QuotaSpec is the specification of a Quota.
| Field | Description |
|---|---|
clusterLifetimeDaysinteger |
(Optional)
ClusterLifetimeDays is the lifetime of a Shoot cluster in days before it will be terminated automatically. |
scopeObjectReference |
Scope is the scope of the Quota object, either 'project', 'secret' or 'workloadidentity'. This field is immutable. |
(Appears on:CloudProfileSpec)
Region contains certain properties of a region.
| Field | Description |
|---|---|
namestring |
Name is a region name. |
zonesAvailabilityZone array |
(Optional)
Zones is a list of availability zones in this region. |
labelsobject (keys:string, values:string) |
(Optional)
Labels is an optional set of key-value pairs that contain certain administrator-controlled labels for this region. |
accessRestrictionsAccessRestriction array |
(Optional)
AccessRestrictions describe a list of access restrictions that can be used for Shoots using this region. |
(Appears on:ShootStateSpec)
ResourceData holds the data of a resource referred to by an extension controller state.
| Field | Description |
|---|---|
kindstring |
kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
namestring |
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
apiVersionstring |
(Optional)
apiVersion is the API version of the referent |
dataRawExtension |
Data of the resource |
(Appears on:WatchCacheSizes)
ResourceWatchCacheSize contains configuration of the API server's watch cache size for one specific resource.
| Field | Description |
|---|---|
apiGroupstring |
(Optional)
APIGroup is the API group of the resource for which the watch cache size should be configured. |
resourcestring |
Resource is the name of the resource for which the watch cache size should be configured |
sizeinteger |
CacheSize specifies the watch cache size that should be configured for the specified resource. |
(Appears on:WorkersSettings)
SSHAccess contains settings regarding ssh access to the worker nodes.
| Field | Description |
|---|---|
enabledboolean |
Enabled indicates whether the SSH access to the worker nodes is ensured to be enabled or disabled in systemd. |
Underlying type: string
(Appears on:KubeSchedulerConfig)
SchedulingProfile is a string alias used for scheduling profile values.
SecretBinding represents a binding to a secret in the same or another namespace.
Deprecated: Use CredentialsBinding instead. See https://github.com/gardener/gardener/blob/master/docs/usage/shoot-operations/secretbinding-to-credentialsbinding-migration.md for migration instructions.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
secretRefSecretReference |
SecretRef is a reference to a secret object in the same or another namespace. |
quotasObjectReference array |
(Optional)
Quotas is a list of references to Quota objects in the same or another namespace. |
providerSecretBindingProvider |
(Optional)
Provider defines the provider type of the SecretBinding. |
(Appears on:SecretBinding)
SecretBindingProvider defines the provider type of the SecretBinding.
Deprecated: Use CredentialsBindingProvider instead. See https://github.com/gardener/gardener/blob/master/docs/usage/shoot-operations/secretbinding-to-credentialsbinding-migration.md for migration instructions.
| Field | Description |
|---|---|
typestring |
Type is the type of the provider. |
Seed represents an installation request for an external controller.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specSeedSpec |
Spec contains the specification of this installation. |
statusSeedStatus |
Status contains the status of this installation. |
(Appears on:SeedSpec)
SeedDNS contains DNS-relevant information about this seed cluster.
| Field | Description |
|---|---|
providerSeedDNSProvider |
(Optional)
Provider configures a DNSProvider |
internalSeedDNSProviderConfig |
(Optional)
Internal configures DNS settings related to seed internal domain. |
defaultsSeedDNSProviderConfig array |
(Optional)
Defaults configures DNS settings related to seed default domains. |
(Appears on:SeedDNS)
SeedDNSProvider configures a DNSProvider for Seeds
| Field | Description |
|---|---|
typestring |
Type describes the type of the dns-provider, for example `aws-route53` |
credentialsRefObjectReference |
(Optional)
CredentialsRef is a reference to a resource holding the credentials used for |
(Appears on:SeedDNS)
SeedDNSProviderConfig configures a DNS provider.
| Field | Description |
|---|---|
typestring |
Type is the type of the DNS provider. |
domainstring |
Domain is the domain name to be used by the DNS provider. |
zonestring |
(Optional)
Zone is the zone where the DNS records are managed. |
credentialsRefObjectReference |
CredentialsRef is a reference to a resource holding the credentials used for |
(Appears on:SeedSpec)
SeedNetworks contains CIDRs for the pod, service and node networks of a Kubernetes cluster.
| Field | Description |
|---|---|
nodesstring |
(Optional)
Nodes is the CIDR of the node network. This field is immutable. |
podsstring |
Pods is the CIDR of the pod network. This field is immutable. |
servicesstring |
Services is the CIDR of the service network. This field is immutable. |
shootDefaultsShootNetworks |
(Optional)
ShootDefaults contains the default networks CIDRs for shoots. |
blockCIDRsstring array |
(Optional)
BlockCIDRs is a list of network addresses that should be blocked for shoot control plane components running |
ipFamiliesIPFamily array |
(Optional)
IPFamilies specifies the IP protocol versions to use for seed networking. This field is immutable. |
(Appears on:SeedSpec)
SeedProvider defines the provider-specific information of this Seed cluster.
| Field | Description |
|---|---|
typestring |
Type is the name of the provider. |
providerConfigRawExtension |
(Optional)
ProviderConfig is the configuration passed to Seed resource. |
regionstring |
Region is a name of a region. |
zonesstring array |
(Optional)
Zones is the list of availability zones the seed cluster is deployed to. |
(Appears on:CloudProfileSpec, ExposureClassScheduling, ShootSpec)
SeedSelector contains constraints for selecting seed to be usable for shoots using a profile
| Field | Description |
|---|---|
matchLabelsobject (keys:string, values:string) |
(Optional)
matchLabels is a map of \{key,value\} pairs. A single \{key,value\} in the matchLabels |
matchExpressionsLabelSelectorRequirement array |
(Optional)
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
providerTypesstring array |
(Optional)
Providers is optional and can be used by restricting seeds by their provider type. '*' can be used to enable seeds regardless of their provider type. |
(Appears on:SeedSettings)
SeedSettingDependencyWatchdog controls the dependency-watchdog settings for the seed.
| Field | Description |
|---|---|
weederSeedSettingDependencyWatchdogWeeder |
(Optional)
Weeder controls the weeder settings for the dependency-watchdog for the seed. |
proberSeedSettingDependencyWatchdogProber |
(Optional)
Prober controls the prober settings for the dependency-watchdog for the seed. |
(Appears on:SeedSettingDependencyWatchdog)
SeedSettingDependencyWatchdogProber controls the prober settings for the dependency-watchdog for the seed.
| Field | Description |
|---|---|
enabledboolean |
Enabled controls whether the probe controller(prober) of the dependency-watchdog should be enabled. This controller |
(Appears on:SeedSettingDependencyWatchdog)
SeedSettingDependencyWatchdogWeeder controls the weeder settings for the dependency-watchdog for the seed.
| Field | Description |
|---|---|
enabledboolean |
Enabled controls whether the endpoint controller(weeder) of the dependency-watchdog should be enabled. This controller |
(Appears on:SeedSettings)
SeedSettingExcessCapacityReservation controls the excess capacity reservation for shoot control planes in the seed.
| Field | Description |
|---|---|
enabledboolean |
(Optional)
Enabled controls whether the default excess capacity reservation should be enabled. When not specified, the functionality is enabled. |
configsSeedSettingExcessCapacityReservationConfig array |
(Optional)
Configs configures excess capacity reservation deployments for shoot control planes in the seed. |
(Appears on:SeedSettingExcessCapacityReservation)
SeedSettingExcessCapacityReservationConfig configures excess capacity reservation deployments for shoot control planes in the seed.
| Field | Description |
|---|---|
nodeSelectorobject (keys:string, values:string) |
(Optional)
NodeSelector specifies the node where the excess-capacity-reservation pod should run. |
tolerationsToleration array |
(Optional)
Tolerations specify the tolerations for the the excess-capacity-reservation pod. |
(Appears on:SeedSettings)
SeedSettingLoadBalancerServices controls certain settings for services of type load balancer that are created in the seed.
| Field | Description |
|---|---|
annotationsobject (keys:string, values:string) |
(Optional)
Annotations is a map of annotations that will be injected/merged into every load balancer service object. |
externalTrafficPolicyServiceExternalTrafficPolicy |
(Optional)
ExternalTrafficPolicy describes how nodes distribute service traffic they |
zonesSeedSettingLoadBalancerServicesZones array |
(Optional)
Zones controls settings, which are specific to the single-zone load balancers in a multi-zonal setup. |
proxyProtocolLoadBalancerServicesProxyProtocol |
(Optional)
ProxyProtocol controls whether ProxyProtocol is (optionally) allowed for the load balancer services. |
zonalIngressSeedSettingLoadBalancerServicesZonalIngress |
(Optional)
ZonalIngress controls whether ingress gateways are deployed per availability zone. |
classstring |
(Optional)
Class configures the Service.spec.loadBalancerClass field for the load balancer services on the seed. |
(Appears on:SeedSettingLoadBalancerServices)
SeedSettingLoadBalancerServicesZonalIngress controls the deployment of ingress gateways per availability zone.
| Field | Description |
|---|---|
enabledboolean |
(Optional)
Enabled controls whether seed ingress gateways are deployed in each availability zone. |
(Appears on:SeedSettingLoadBalancerServices)
SeedSettingLoadBalancerServicesZones controls settings, which are specific to the single-zone load balancers in a multi-zonal setup.
| Field | Description |
|---|---|
namestring |
Name is the name of the zone as specified in seed.spec.provider.zones. |
annotationsobject (keys:string, values:string) |
(Optional)
Annotations is a map of annotations that will be injected/merged into the zone-specific load balancer service object. |
externalTrafficPolicyServiceExternalTrafficPolicy |
(Optional)
ExternalTrafficPolicy describes how nodes distribute service traffic they |
proxyProtocolLoadBalancerServicesProxyProtocol |
(Optional)
ProxyProtocol controls whether ProxyProtocol is (optionally) allowed for the load balancer services. |
(Appears on:SeedSettings)
SeedSettingScheduling controls settings for scheduling decisions for the seed.
| Field | Description |
|---|---|
visibleboolean |
Visible controls whether the gardener-scheduler shall consider this seed when scheduling shoots. Invisible seeds |
(Appears on:SeedSettings)
SeedSettingTopologyAwareRouting controls certain settings for topology-aware traffic routing in the seed. See https://github.com/gardener/gardener/blob/master/docs/operations/topology_aware_routing.md.
| Field | Description |
|---|---|
enabledboolean |
Enabled controls whether certain Services deployed in the seed cluster should be topology-aware. |
(Appears on:SeedSettings)
SeedSettingVerticalPodAutoscaler controls certain settings for the vertical pod autoscaler components deployed in the seed.
| Field | Description |
|---|---|
enabledboolean |
Enabled controls whether the VPA components shall be deployed into the garden namespace in the seed cluster. It |
featureGatesobject (keys:string, values:boolean) |
(Optional)
FeatureGates contains information about enabled feature gates. |
(Appears on:SeedSettings)
SeedSettingZoneSelection controls whether shoot control plane zone placement is derived from the shoot's worker pool zones rather than randomly selected from seed zones.
| Field | Description |
|---|---|
modeZoneSelectionMode |
Mode controls the zone selection behavior. |
(Appears on:SeedSpec)
SeedSettings contains certain settings for this seed cluster.
| Field | Description |
|---|---|
excessCapacityReservationSeedSettingExcessCapacityReservation |
(Optional)
ExcessCapacityReservation controls the excess capacity reservation for shoot control planes in the seed. |
schedulingSeedSettingScheduling |
(Optional)
Scheduling controls settings for scheduling decisions for the seed. |
loadBalancerServicesSeedSettingLoadBalancerServices |
(Optional)
LoadBalancerServices controls certain settings for services of type load balancer that are created in the seed. |
verticalPodAutoscalerSeedSettingVerticalPodAutoscaler |
(Optional)
VerticalPodAutoscaler controls certain settings for the vertical pod autoscaler components deployed in the seed. |
dependencyWatchdogSeedSettingDependencyWatchdog |
(Optional)
DependencyWatchdog controls certain settings for the dependency-watchdog components deployed in the seed. |
topologyAwareRoutingSeedSettingTopologyAwareRouting |
(Optional)
TopologyAwareRouting controls certain settings for topology-aware traffic routing in the seed. |
zoneSelectionSeedSettingZoneSelection |
(Optional)
ZoneSelection controls whether shoot control plane zone placement is derived from the shoot's worker pool zones |
(Appears on:Seed, SeedTemplate)
SeedSpec is the specification of a Seed.
| Field | Description |
|---|---|
backupBackup |
(Optional)
Backup holds the object store configuration for the backups of shoot (currently only etcd). |
dnsSeedDNS |
DNS contains DNS-relevant information about this seed cluster. |
networksSeedNetworks |
Networks defines the pod, service and worker network of the Seed cluster. |
providerSeedProvider |
Provider defines the provider type and region for this Seed cluster. |
taintsSeedTaint array |
(Optional)
Taints describes taints on the seed. |
volumeSeedVolume |
(Optional)
Volume contains settings for persistentvolumes created in the seed cluster. |
settingsSeedSettings |
(Optional)
Settings contains certain settings for this seed cluster. |
ingressIngress |
(Optional)
Ingress configures Ingress specific settings of the Seed cluster. This field is immutable. |
accessRestrictionsAccessRestriction array |
(Optional)
AccessRestrictions describe a list of access restrictions for this seed cluster. |
extensionsExtension array |
(Optional)
Extensions contain type and provider information for Seed extensions. |
resourcesNamedResourceReference array |
(Optional)
Resources holds a list of named resource references that can be referred to in extension configs by their names. |
(Appears on:Seed)
SeedStatus is the status of a Seed.
| Field | Description |
|---|---|
gardenerGardener |
(Optional)
Gardener holds information about the Gardener which last acted on the Shoot. |
kubernetesVersionstring |
(Optional)
KubernetesVersion is the Kubernetes version of the seed cluster. |
conditionsCondition array |
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
observedGenerationinteger |
(Optional)
ObservedGeneration is the most recent generation observed for this Seed. It corresponds to the |
clusterIdentitystring |
(Optional)
ClusterIdentity is the identity of the Seed cluster. This field is immutable. |
clientCertificateExpirationTimestampTime |
(Optional)
ClientCertificateExpirationTimestamp is the timestamp at which gardenlet's client certificate expires. |
lastOperationLastOperation |
(Optional)
LastOperation holds information about the last operation on the Seed. |
(Appears on:SeedSpec)
SeedTaint describes a taint on a seed.
| Field | Description |
|---|---|
keystring |
Key is the taint key to be applied to a seed. |
valuestring |
(Optional)
Value is the taint value corresponding to the taint key. |
SeedTemplate is a template for creating a Seed object.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specSeedSpec |
(Optional)
Specification of the desired behavior of the Seed. |
(Appears on:SeedSpec)
SeedVolume contains settings for persistentvolumes created in the seed cluster.
| Field | Description |
|---|---|
minimumSizeQuantity |
(Optional)
MinimumSize defines the minimum size that should be used for PVCs in the seed. |
providersSeedVolumeProvider array |
(Optional)
Providers is a list of storage class provisioner types for the seed. |
(Appears on:SeedVolume)
SeedVolumeProvider is a storage class provisioner type.
| Field | Description |
|---|---|
purposestring |
Purpose is the purpose of this provider. |
namestring |
Name is the name of the storage class provisioner type. |
(Appears on:KubeAPIServerConfig)
ServiceAccountConfig is the kube-apiserver configuration for service accounts.
| Field | Description |
|---|---|
issuerstring |
(Optional)
Issuer is the identifier of the service account token issuer. The issuer will assert this |
extendTokenExpirationboolean |
(Optional)
ExtendTokenExpiration turns on projected service account expiration extension during token generation, which |
maxTokenExpirationDuration |
(Optional)
MaxTokenExpiration is the maximum validity duration of a token created by the service account token issuer. If an |
acceptedIssuersstring array |
(Optional)
AcceptedIssuers is an additional set of issuers that are used to determine which service account tokens are accepted. |
(Appears on:ShootCredentialsRotation)
ServiceAccountKeyRotation contains information about the service account key credential rotation.
| Field | Description |
|---|---|
phaseCredentialsRotationPhase |
Phase describes the phase of the service account key credential rotation. |
lastCompletionTimeTime |
(Optional)
LastCompletionTime is the most recent time when the service account key credential rotation was successfully |
lastInitiationTimeTime |
(Optional)
LastInitiationTime is the most recent time when the service account key credential rotation was initiated. |
lastInitiationFinishedTimeTime |
(Optional)
LastInitiationFinishedTime is the recent time when the service account key credential rotation initiation was |
lastCompletionTriggeredTimeTime |
(Optional)
LastCompletionTriggeredTime is the recent time when the service account key credential rotation completion was |
pendingWorkersRolloutsPendingWorkersRollout array |
(Optional)
PendingWorkersRollouts contains the name of a worker pool and the initiation time of their last rollout due to |
Shoot represents a Shoot cluster created and managed by Gardener.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specShootSpec |
(Optional)
Specification of the Shoot cluster. |
statusShootStatus |
(Optional)
Most recently observed status of the Shoot cluster. |
(Appears on:ShootStatus)
ShootAdvertisedAddress contains information for the shoot's Kube API server.
| Field | Description |
|---|---|
namestring |
Name of the advertised address. e.g. external |
urlstring |
The URL of the API Server. e.g. https://api.foo.bar or https://1.2.3.4 |
applicationstring |
(Optional)
Application is the name of the application this address belongs to. Used by UI clients. |
(Appears on:ShootStatus)
ShootCredentials contains information about the shoot credentials.
| Field | Description |
|---|---|
rotationShootCredentialsRotation |
(Optional)
Rotation contains information about the credential rotations. |
encryptionAtRestEncryptionAtRest |
(Optional)
EncryptionAtRest contains information about Shoot data encryption at rest. |
(Appears on:ShootCredentials)
ShootCredentialsRotation contains information about the rotation of credentials.
| Field | Description |
|---|---|
certificateAuthoritiesCARotation |
(Optional)
CertificateAuthorities contains information about the certificate authority credential rotation. |
sshKeypairShootSSHKeypairRotation |
(Optional)
SSHKeypair contains information about the ssh-keypair credential rotation. |
observabilityObservabilityRotation |
(Optional)
Observability contains information about the observability credential rotation. |
serviceAccountKeyServiceAccountKeyRotation |
(Optional)
ServiceAccountKey contains information about the service account key credential rotation. |
etcdEncryptionKeyETCDEncryptionKeyRotation |
(Optional)
ETCDEncryptionKey contains information about the ETCD encryption key credential rotation. |
ShootKubeconfigRotation contains information about the kubeconfig credential rotation.
| Field | Description |
|---|---|
lastInitiationTimeTime |
(Optional)
LastInitiationTime is the most recent time when the kubeconfig credential rotation was initiated. |
lastCompletionTimeTime |
(Optional)
LastCompletionTime is the most recent time when the kubeconfig credential rotation was successfully completed. |
(Appears on:Machine)
ShootMachineImage defines the name and the version of the shoot's machine image in any environment. Has to be defined in the respective CloudProfile.
| Field | Description |
|---|---|
namestring |
Name is the name of the image. |
providerConfigRawExtension |
(Optional)
ProviderConfig is the shoot's individual configuration passed to an extension resource. |
versionstring |
(Optional)
Version is the version of the shoot's image. |
(Appears on:SeedNetworks)
ShootNetworks contains the default networks CIDRs for shoots.
| Field | Description |
|---|---|
podsstring |
(Optional)
Pods is the CIDR of the pod network. |
servicesstring |
(Optional)
Services is the CIDR of the service network. |
Underlying type: string
(Appears on:ShootSpec)
ShootPurpose is a type alias for string.
(Appears on:ShootCredentialsRotation)
ShootSSHKeypairRotation contains information about the ssh-keypair credential rotation.
| Field | Description |
|---|---|
lastInitiationTimeTime |
(Optional)
LastInitiationTime is the most recent time when the ssh-keypair credential rotation was initiated. |
lastCompletionTimeTime |
(Optional)
LastCompletionTime is the most recent time when the ssh-keypair credential rotation was successfully completed. |
(Appears on:Shoot, ShootTemplate)
ShootSpec is the specification of a Shoot.
| Field | Description |
|---|---|
addonsAddons |
(Optional)
Addons contains information about enabled/disabled addons and their configuration. |
cloudProfileNamestring |
(Optional)
CloudProfileName is a name of a CloudProfile object. |
dnsDNS |
(Optional)
DNS contains information about the DNS settings of the Shoot. |
extensionsExtension array |
(Optional)
Extensions contain type and provider information for Shoot extensions. |
hibernationHibernation |
(Optional)
Hibernation contains information whether the Shoot is suspended or not. |
kubernetesKubernetes |
Kubernetes contains the version and configuration settings of the control plane components. |
networkingNetworking |
(Optional)
Networking contains information about cluster networking such as CNI Plugin type, CIDRs, ...etc. |
maintenanceMaintenance |
(Optional)
Maintenance contains information about the time window for maintenance operations and which |
monitoringMonitoring |
(Optional)
Monitoring contains information about custom monitoring configurations for the shoot. |
providerProvider |
Provider contains all provider-specific and provider-relevant information. |
purposeShootPurpose |
(Optional)
Purpose is the purpose class for this cluster. |
regionstring |
Region is a name of a region. This field is immutable. |
secretBindingNamestring |
(Optional)
SecretBindingName is the name of a SecretBinding that has a reference to the provider secret. |
seedNamestring |
(Optional)
SeedName is the name of the seed cluster that runs the control plane of the Shoot. |
seedSelectorSeedSelector |
(Optional)
SeedSelector is an optional selector which must match a seed's labels for the shoot to be scheduled on that seed. |
resourcesNamedResourceReference array |
(Optional)
Resources holds a list of named resource references that can be referred to in extension configs by their names. |
tolerationsToleration array |
(Optional)
Tolerations contains the tolerations for taints on seed clusters. |
exposureClassNamestring |
(Optional)
ExposureClassName is the optional name of an exposure class to apply a control plane endpoint exposure strategy. |
systemComponentsSystemComponents |
(Optional)
SystemComponents contains the settings of system components in the control or data plane of the Shoot cluster. |
controlPlaneControlPlane |
(Optional)
ControlPlane contains general settings for the control plane of the shoot. |
schedulerNamestring |
(Optional)
SchedulerName is the name of the responsible scheduler which schedules the shoot. |
cloudProfileCloudProfileReference |
(Optional)
CloudProfile contains a reference to a CloudProfile or a NamespacedCloudProfile. |
credentialsBindingNamestring |
(Optional)
CredentialsBindingName is the name of a CredentialsBinding that has a reference to the provider credentials. |
accessRestrictionsAccessRestrictionWithOptions array |
(Optional)
AccessRestrictions describe a list of access restrictions for this shoot cluster. |
ShootState contains a snapshot of the Shoot's state required to migrate the Shoot's control plane to a new Seed.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specShootStateSpec |
(Optional)
Specification of the ShootState. |
(Appears on:ShootState)
ShootStateSpec is the specification of the ShootState.
| Field | Description |
|---|---|
gardenerGardenerResourceData array |
(Optional)
Gardener holds the data required to generate resources deployed by the gardenlet |
extensionsExtensionResourceState array |
(Optional)
Extensions holds the state of custom resources reconciled by extension controllers in the seed |
resourcesResourceData array |
(Optional)
Resources holds the data of resources referred to by extension controller states |
(Appears on:Shoot)
ShootStatus holds the most recently observed status of the Shoot cluster.
| Field | Description |
|---|---|
conditionsCondition array |
(Optional)
Conditions represents the latest available observations of a Shoots's current state. |
constraintsCondition array |
(Optional)
Constraints represents conditions of a Shoot's current state that constraint some operations on it. |
gardenerGardener |
Gardener holds information about the Gardener which last acted on the Shoot. |
hibernatedboolean |
IsHibernated indicates whether the Shoot is currently hibernated. |
lastOperationLastOperation |
(Optional)
LastOperation holds information about the last operation on the Shoot. |
lastErrorsLastError array |
(Optional)
LastErrors holds information about the last occurred error(s) during an operation. |
observedGenerationinteger |
(Optional)
ObservedGeneration is the most recent generation observed for this Shoot. It corresponds to the |
retryCycleStartTimeTime |
(Optional)
RetryCycleStartTime is the start time of the last retry cycle (used to determine how often an operation |
seedNamestring |
(Optional)
SeedName is the name of the seed cluster that runs the control plane of the Shoot. This value is only written |
technicalIDstring |
TechnicalID is a unique technical ID for this Shoot. It is used for the infrastructure resources, and |
uidUID |
UID is a unique identifier for the Shoot cluster to avoid portability between Kubernetes clusters. |
clusterIdentitystring |
(Optional)
ClusterIdentity is the identity of the Shoot cluster. This field is immutable. |
advertisedAddressesShootAdvertisedAddress array |
(Optional)
List of addresses that are relevant to the shoot. |
migrationStartTimeTime |
(Optional)
MigrationStartTime is the time when a migration to a different seed was initiated. |
credentialsShootCredentials |
(Optional)
Credentials contains information about the shoot credentials. |
lastHibernationTriggerTimeTime |
(Optional)
LastHibernationTriggerTime indicates the last time when the hibernation controller |
lastMaintenanceLastMaintenance |
(Optional)
LastMaintenance holds information about the last maintenance operations on the Shoot. |
networkingNetworkingStatus |
(Optional)
Networking contains information about cluster networking such as CIDRs. |
inPlaceUpdatesInPlaceUpdatesStatus |
(Optional)
InPlaceUpdates contains information about in-place updates for the Shoot workers. |
manualWorkerPoolRolloutManualWorkerPoolRollout |
(Optional)
ManualWorkerPoolRollout contains information about the worker pool rollout progress. |
ShootTemplate is a template for creating a Shoot object.
| Field | Description |
|---|---|
metadataObjectMeta |
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
specShootSpec |
(Optional)
Specification of the desired behavior of the Shoot. |
(Appears on:KubeAPIServerConfig)
StructuredAuthentication contains authentication config for kube-apiserver.
| Field | Description |
|---|---|
configMapNamestring |
ConfigMapName is the name of the ConfigMap in the project namespace which contains AuthenticationConfiguration |
(Appears on:KubeAPIServerConfig)
StructuredAuthorization contains authorization config for kube-apiserver.
| Field | Description |
|---|---|
configMapNamestring |
ConfigMapName is the name of the ConfigMap in the project namespace which contains AuthorizationConfiguration for |
kubeconfigsAuthorizerKubeconfigReference array |
Kubeconfigs is a list of references for kubeconfigs for the authorization webhooks. |
Underlying type: string
(Appears on:MemorySwapConfiguration)
SwapBehavior configures swap memory available to container workloads
(Appears on:ShootSpec)
SystemComponents contains the settings of system components in the control or data plane of the Shoot cluster.
| Field | Description |
|---|---|
coreDNSCoreDNS |
(Optional)
CoreDNS contains the settings of the Core DNS components running in the data plane of the Shoot cluster. |
nodeLocalDNSNodeLocalDNS |
(Optional)
NodeLocalDNS contains the settings of the node local DNS components running in the data plane of the Shoot cluster. |
(Appears on:ExposureClassScheduling, ProjectTolerations, ShootSpec)
Toleration is a toleration for a seed taint.
| Field | Description |
|---|---|
keystring |
Key is the toleration key to be applied to a project or shoot. |
valuestring |
(Optional)
Value is the toleration value corresponding to the toleration key. |
Underlying type: string
(Appears on:ExpirableVersion, ExpirableVersionStatus, LifecycleStage, MachineImageVersion)
VersionClassification is the logical state of a version.
(Appears on:Kubernetes)
VerticalPodAutoscaler contains the configuration flags for the Kubernetes vertical pod autoscaler.
| Field | Description |
|---|---|
enabledboolean |
Enabled specifies whether the Kubernetes VPA shall be enabled for the shoot cluster. |
evictAfterOOMThresholdDuration |
(Optional)
EvictAfterOOMThreshold defines the threshold that will lead to pod eviction in case it OOMed in less than the given |
evictionRateBurstinteger |
(Optional)
EvictionRateBurst defines the burst of pods that can be evicted (default: 1) |
evictionRateLimitfloat |
(Optional)
EvictionRateLimit defines the number of pods that can be evicted per second. A rate limit set to 0 or -1 will |
evictionTolerancefloat |
(Optional)
EvictionTolerance defines the fraction of replica count that can be evicted for update in case more than one |
recommendationMarginFractionfloat |
(Optional)
RecommendationMarginFraction is the fraction of usage added as the safety margin to the recommended request |
updaterIntervalDuration |
(Optional)
UpdaterInterval is the interval how often the updater should run (default: 1m0s). |
recommenderIntervalDuration |
(Optional)
RecommenderInterval is the interval how often metrics should be fetched (default: 1m0s). |
targetCPUPercentilefloat |
(Optional)
TargetCPUPercentile is the usage percentile that will be used as a base for CPU target recommendation. |
recommendationLowerBoundCPUPercentilefloat |
(Optional)
RecommendationLowerBoundCPUPercentile is the usage percentile that will be used for the lower bound on CPU recommendation. |
recommendationUpperBoundCPUPercentilefloat |
(Optional)
RecommendationUpperBoundCPUPercentile is the usage percentile that will be used for the upper bound on CPU recommendation. |
targetMemoryPercentilefloat |
(Optional)
TargetMemoryPercentile is the usage percentile that will be used as a base for memory target recommendation. |
recommendationLowerBoundMemoryPercentilefloat |
(Optional)
RecommendationLowerBoundMemoryPercentile is the usage percentile that will be used for the lower bound on memory recommendation. |
recommendationUpperBoundMemoryPercentilefloat |
(Optional)
RecommendationUpperBoundMemoryPercentile is the usage percentile that will be used for the upper bound on memory recommendation. |
cpuHistogramDecayHalfLifeDuration |
(Optional)
CPUHistogramDecayHalfLife is the amount of time it takes a historical CPU usage sample to lose half of its weight. |
memoryHistogramDecayHalfLifeDuration |
(Optional)
MemoryHistogramDecayHalfLife is the amount of time it takes a historical memory usage sample to lose half of its weight. |
memoryAggregationIntervalDuration |
(Optional)
MemoryAggregationInterval is the length of a single interval, for which the peak memory usage is computed. |
memoryAggregationIntervalCountinteger |
(Optional)
MemoryAggregationIntervalCount is the number of consecutive memory-aggregation-intervals which make up the |
featureGatesobject (keys:string, values:boolean) |
(Optional)
FeatureGates contains information about enabled feature gates. |
recommenderUpdateWorkerCountinteger |
(Optional)
RecommenderUpdateWorkerCount is the number of workers used in the vpa-recommender for updating VPAs and VPACheckpoints in parallel. |
(Appears on:Worker)
Volume contains information about the volume type, size, and encryption.
| Field | Description |
|---|---|
namestring |
(Optional)
Name of the volume to make it referenceable. |
typestring |
(Optional)
Type is the type of the volume. |
sizestring |
VolumeSize is the size of the volume. |
encryptedboolean |
(Optional)
Encrypted determines if the volume should be encrypted. |
(Appears on:CloudProfileSpec, NamespacedCloudProfileSpec)
VolumeType contains certain properties of a volume type.
| Field | Description |
|---|---|
classstring |
Class is the class of the volume type. |
namestring |
Name is the name of the volume type. |
usableboolean |
(Optional)
Usable defines if the volume type can be used for shoot clusters. |
minSizeQuantity |
(Optional)
MinSize is the minimal supported storage size. |
(Appears on:KubeAPIServerConfig)
WatchCacheSizes contains configuration of the API server's watch cache sizes.
| Field | Description |
|---|---|
defaultinteger |
(Optional)
Default is not respected anymore by kube-apiserver. |
resourcesResourceWatchCacheSize array |
(Optional)
Resources configures the watch cache size of the kube-apiserver per resource |
(Appears on:Provider)
Worker is the base definition of a worker group.
| Field | Description |
|---|---|
annotationsobject (keys:string, values:string) |
(Optional)
Annotations is a map of key/value pairs for annotations for all the `Node` objects in this worker pool. |
caBundlestring |
(Optional)
CABundle is a certificate bundle which will be installed onto every machine of this worker pool. |
criCRI |
(Optional)
CRI contains configurations of CRI support of every machine in the worker pool. |
kubernetesWorkerKubernetes |
(Optional)
Kubernetes contains configuration for Kubernetes components related to this worker pool. |
labelsobject (keys:string, values:string) |
(Optional)
Labels is a map of key/value pairs for labels for all the `Node` objects in this worker pool. |
namestring |
Name is the name of the worker group. |
machineMachine |
Machine contains information about the machine type and image. |
maximuminteger |
Maximum is the maximum number of machines to create. |
minimuminteger |
Minimum is the minimum number of machines to create. |
maxSurgeIntOrString |
(Optional)
MaxSurge is maximum number of machines that are created during an update. |
maxUnavailableIntOrString |
(Optional)
MaxUnavailable is the maximum number of machines that can be unavailable during an update. |
providerConfigRawExtension |
(Optional)
ProviderConfig is the provider-specific configuration for this worker pool. |
taintsTaint array |
(Optional)
Taints is a list of taints for all the `Node` objects in this worker pool. |
volumeVolume |
(Optional)
Volume contains information about the volume type and size. |
dataVolumesDataVolume array |
(Optional)
DataVolumes contains a list of additional worker volumes. |
kubeletDataVolumeNamestring |
(Optional)
KubeletDataVolumeName contains the name of a dataVolume that should be used for storing kubelet state. |
zonesstring array |
(Optional)
Zones is a list of availability zones that are used to evenly distribute this worker pool. Optional |
systemComponentsWorkerSystemComponents |
(Optional)
SystemComponents contains configuration for system components related to this worker pool |
machineControllerManagerMachineControllerManagerSettings |
(Optional)
MachineControllerManagerSettings contains configurations for different worker-pools. Eg. MachineDrainTimeout, MachineHealthTimeout. |
sysctlsobject (keys:string, values:string) |
(Optional)
Sysctls is a map of kernel settings to apply on all machines in this worker pool. |
clusterAutoscalerClusterAutoscalerOptions |
(Optional)
ClusterAutoscaler contains the cluster autoscaler configurations for the worker pool. |
priorityinteger |
(Optional)
Priority (or weight) is the importance by which this worker group will be scaled by cluster autoscaling. |
updateStrategyMachineUpdateStrategy |
(Optional)
UpdateStrategy specifies the machine update strategy for the worker pool. |
controlPlaneWorkerControlPlane |
(Optional)
ControlPlane specifies that the shoot cluster control plane components should be running in this worker pool. |
(Appears on:Worker)
WorkerControlPlane specifies that the shoot cluster control plane components should be running in this worker pool.
| Field | Description |
|---|---|
backupBackup |
(Optional)
Backup holds the object store configuration for the backups of shoot (currently only etcd). |
exposureExposure |
(Optional)
Exposure holds the exposure configuration for the shoot (either `extension` or `dns` or omitted/empty). |
(Appears on:Worker)
WorkerKubernetes contains configuration for Kubernetes components related to this worker pool.
| Field | Description |
|---|---|
kubeletKubeletConfig |
(Optional)
Kubelet contains configuration settings for all kubelets of this worker pool. |
versionstring |
(Optional)
Version is the semantic Kubernetes version to use for the Kubelet in this Worker Group. |
(Appears on:Worker)
WorkerSystemComponents contains configuration for system components related to this worker pool
| Field | Description |
|---|---|
allowboolean |
Allow determines whether the pool should be allowed to host system components or not (defaults to true) |
(Appears on:Provider)
WorkersSettings contains settings for all workers.
| Field | Description |
|---|---|
sshAccessSSHAccess |
(Optional)
SSHAccess contains settings regarding ssh access to the worker nodes. |
Underlying type: string
(Appears on:SeedSettingZoneSelection)
ZoneSelectionMode is the mode for zone selection.