Extensions ​
Packages:
extensions.gardener.cloud/v1alpha1
Resource Types:
- BackupBucket
- BackupEntry
- Bastion
- Cluster
- ContainerRuntime
- ControlPlane
- DNSRecord
- Extension
- Infrastructure
- Network
- OperatingSystemConfig
- SelfHostedShootExposure
- Worker
BackupBucket
BackupBucket is a specification for backup bucket.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
BackupBucketSpec
|
Specification of the BackupBucket. |
status
BackupBucketStatus
|
(Optional) |
BackupBucketSpec
(Appears on:BackupBucket)
BackupBucketSpec is the spec for an BackupBucket resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
region
string
|
Region is the region of this bucket. This field is immutable. |
secretRef
SecretReference
|
SecretRef is a reference to a secret that contains the credentials to access object store. |
BackupBucketStatus
(Appears on:BackupBucket)
BackupBucketStatus is the status for an BackupBucket resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
generatedSecretRef
SecretReference
|
(Optional)
GeneratedSecretRef is reference to the secret generated by backup bucket, which |
BackupEntry
BackupEntry is a specification for backup Entry.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
BackupEntrySpec
|
Specification of the BackupEntry. |
status
BackupEntryStatus
|
(Optional) |
BackupEntrySpec
(Appears on:BackupEntry)
BackupEntrySpec is the spec for an BackupEntry resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
backupBucketProviderStatus
RawExtension
|
(Optional)
BackupBucketProviderStatus contains the provider status that has |
region
string
|
Region is the region of this Entry. This field is immutable. |
bucketName
string
|
BucketName is the name of backup bucket for this Backup Entry. |
secretRef
SecretReference
|
SecretRef is a reference to a secret that contains the credentials to access object store. |
BackupEntryStatus
(Appears on:BackupEntry)
BackupEntryStatus is the status for an BackupEntry resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
Bastion
Bastion is a bastion or jump host that is dynamically created to provide SSH access to shoot nodes.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
BastionSpec
|
Spec is the specification of this Bastion. |
status
BastionStatus
|
(Optional)
Status is the bastion's status. |
BastionIngressPolicy
(Appears on:BastionSpec)
BastionIngressPolicy represents an ingress policy for SSH bastion hosts.
| Field | Description |
|---|---|
ipBlock
IPBlock
|
IPBlock defines an IP block that is allowed to access the bastion. |
BastionSpec
(Appears on:Bastion)
BastionSpec contains the specification for an SSH bastion host.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
userData
integer array
|
UserData is the base64-encoded user data for the bastion instance. This should |
ingress
BastionIngressPolicy array
|
Ingress controls from where the created bastion host should be reachable. |
BastionStatus
(Appears on:Bastion)
BastionStatus holds the most recently observed status of the Bastion.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
ingress
LoadBalancerIngress
|
(Optional)
Ingress is the external IP and/or hostname of the bastion host. |
CARotation
(Appears on:CredentialsRotation)
CARotation contains information about the certificate authority credential rotation.
| Field | Description |
|---|---|
lastInitiationTime
Time
|
(Optional)
LastInitiationTime is the most recent time when the certificate authority credential rotation was initiated. |
CRIConfig
(Appears on:OperatingSystemConfigSpec)
CRIConfig contains configurations of the CRI library.
| Field | Description |
|---|---|
name
CRIName
|
Name is a mandatory string containing the name of the CRI library. Supported values are `containerd`. |
cgroupDriver
CgroupDriverName
|
(Optional)
CgroupDriver configures the CRI's cgroup driver. Supported values are `cgroupfs` or `systemd`. |
containerd
ContainerdConfig
|
(Optional)
ContainerdConfig is the containerd configuration. |
CRIName
Underlying type: string
(Appears on:CRIConfig)
CRIName is a type alias for the CRI name string.
CgroupDriverName
Underlying type: string
(Appears on:CRIConfig)
CgroupDriverName is a string denoting the CRI cgroup driver.
CloudConfig
(Appears on:OperatingSystemConfigStatus)
CloudConfig contains the generated output for the given operating system config spec. It contains a reference to a secret as the result may contain confidential data.
| Field | Description |
|---|---|
secretRef
SecretReference
|
SecretRef is a reference to a secret that contains the actual result of the generated cloud config. |
Cluster
Cluster is a specification for a Cluster resource.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
ClusterSpec
|
ClusterAutoscalerOptions
(Appears on:WorkerPool)
ClusterAutoscalerOptions contains the cluster autoscaler configurations for a worker pool.
| Field | Description |
|---|---|
scaleDownUtilizationThreshold
string
|
(Optional)
ScaleDownUtilizationThreshold defines the threshold in fraction (0.0 - 1.0) under which a node is being removed. |
scaleDownGpuUtilizationThreshold
string
|
(Optional)
ScaleDownGpuUtilizationThreshold defines the threshold in fraction (0.0 - 1.0) of gpu resources under which a node is being removed. |
scaleDownUnneededTime
Duration
|
(Optional)
ScaleDownUnneededTime defines how long a node should be unneeded before it is eligible for scale down. |
scaleDownUnreadyTime
Duration
|
(Optional)
ScaleDownUnreadyTime defines how long an unready node should be unneeded before it is eligible for scale down. |
maxNodeProvisionTime
Duration
|
(Optional)
MaxNodeProvisionTime defines how long cluster autoscaler should wait for a node to be provisioned. |
ClusterSpec
(Appears on:Cluster)
ClusterSpec is the spec for a Cluster resource.
| Field | Description |
|---|---|
cloudProfile
RawExtension
|
CloudProfile is a raw extension field that contains the cloudprofile resource referenced |
seed
RawExtension
|
Seed is a raw extension field that contains the seed resource referenced by the shoot that |
shoot
RawExtension
|
Shoot is a raw extension field that contains the shoot resource that has to be reconciled. |
ContainerRuntime
ContainerRuntime is a specification for a container runtime resource.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
ContainerRuntimeSpec
|
Specification of the ContainerRuntime. |
status
ContainerRuntimeStatus
|
(Optional) |
ContainerRuntimeSpec
(Appears on:ContainerRuntime)
ContainerRuntimeSpec is the spec for a ContainerRuntime resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
binaryPath
string
|
BinaryPath is the Worker's machine path where container runtime extensions should copy the binaries to. |
workerPool
ContainerRuntimeWorkerPool
|
WorkerPool identifies the worker pool of the Shoot. |
ContainerRuntimeStatus
(Appears on:ContainerRuntime)
ContainerRuntimeStatus is the status for a ContainerRuntime resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
ContainerRuntimeWorkerPool
(Appears on:ContainerRuntimeSpec)
ContainerRuntimeWorkerPool identifies a Shoot worker pool by its name and selector.
| Field | Description |
|---|---|
name
string
|
Name specifies the name of the worker pool the container runtime should be available for. |
selector
LabelSelector
|
Selector is the label selector used by the extension to match the nodes belonging to the worker pool. |
ContainerdConfig
(Appears on:CRIConfig)
ContainerdConfig contains configuration options for containerd.
| Field | Description |
|---|---|
registries
RegistryConfig array
|
(Optional)
Registries configures the registry hosts for containerd. |
sandboxImage
string
|
SandboxImage configures the sandbox image for containerd. |
plugins
PluginConfig array
|
(Optional)
Plugins configures the plugins section in containerd's config.toml. |
ControlPlane
ControlPlane is a specification for a ControlPlane resource.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
ControlPlaneSpec
|
Specification of the ControlPlane. |
status
ControlPlaneStatus
|
(Optional) |
ControlPlaneEndpoint
(Appears on:SelfHostedShootExposureSpec)
ControlPlaneEndpoint is an endpoint that should be exposed.
| Field | Description |
|---|---|
nodeName
string
|
NodeName is the name of the node to expose. |
addresses
NodeAddress array
|
Addresses is a list of addresses of type NodeAddress to expose. |
ControlPlaneSpec
(Appears on:ControlPlane)
ControlPlaneSpec is the spec of a ControlPlane resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
infrastructureProviderStatus
RawExtension
|
(Optional)
InfrastructureProviderStatus contains the provider status that has |
region
string
|
Region is the region of this control plane. This field is immutable. |
secretRef
SecretReference
|
SecretRef is a reference to a secret that contains the cloud provider specific credentials. |
ControlPlaneStatus
(Appears on:ControlPlane)
ControlPlaneStatus is the status of a ControlPlane resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
CredentialsRotation
(Appears on:InPlaceUpdates)
CredentialsRotation is a structure containing information about the last initiation time of the certificate authority and service account key rotation.
| Field | Description |
|---|---|
certificateAuthorities
CARotation
|
(Optional)
CertificateAuthorities contains information about the certificate authority credential rotation. |
serviceAccountKey
ServiceAccountKeyRotation
|
(Optional)
ServiceAccountKey contains information about the service account key credential rotation. |
DNSRecord
DNSRecord is a specification for a DNSRecord resource.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
DNSRecordSpec
|
Specification of the DNSRecord. |
status
DNSRecordStatus
|
(Optional) |
DNSRecordSpec
(Appears on:DNSRecord)
DNSRecordSpec is the spec of a DNSRecord resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
secretRef
SecretReference
|
SecretRef is a reference to a secret that contains the cloud provider specific credentials. |
region
string
|
(Optional)
Region is the region of this DNS record. If not specified, the region specified in SecretRef will be used. |
zone
string
|
(Optional)
Zone is the DNS hosted zone of this DNS record. If not specified, it will be determined automatically by |
name
string
|
Name is the fully qualified domain name, e.g. "api. |
recordType
DNSRecordType
|
RecordType is the DNS record type. Only A, CNAME, and TXT records are currently supported. This field is immutable. |
values
string array
|
Values is a list of IP addresses for A records, a single hostname for CNAME records, or a list of texts for TXT records. |
ttl
integer
|
(Optional)
TTL is the time to live in seconds. Defaults to 120. |
DNSRecordStatus
(Appears on:DNSRecord)
DNSRecordStatus is the status of a DNSRecord resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
zone
string
|
(Optional)
Zone is the DNS hosted zone of this DNS record. |
DNSRecordType
Underlying type: string
(Appears on:DNSRecordSpec)
DNSRecordType is a string alias.
DataVolume
(Appears on:WorkerPool)
DataVolume contains information about a data volume.
| Field | Description |
|---|---|
name
string
|
Name of the volume to make it referenceable. |
type
string
|
(Optional)
Type is the type of the volume. |
size
string
|
Size is the of the root volume. |
encrypted
boolean
|
(Optional)
Encrypted determines if the volume should be encrypted. |
DefaultSpec
(Appears on:BackupBucketSpec, BackupEntrySpec, BastionSpec, ContainerRuntimeSpec, ControlPlaneSpec, DNSRecordSpec, ExtensionSpec, InfrastructureSpec, NetworkSpec, OperatingSystemConfigSpec, SelfHostedShootExposureSpec, WorkerSpec)
DefaultSpec contains common status fields for every extension resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
DefaultStatus
(Appears on:BackupBucketStatus, BackupEntryStatus, BastionStatus, ContainerRuntimeStatus, ControlPlaneStatus, DNSRecordStatus, ExtensionStatus, InfrastructureStatus, NetworkStatus, OperatingSystemConfigStatus, SelfHostedShootExposureStatus, WorkerStatus)
DefaultStatus contains common status fields for every extension resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
DropIn
(Appears on:Unit)
DropIn is a drop-in configuration for a systemd unit.
| Field | Description |
|---|---|
name
string
|
Name is the name of the drop-in. |
content
string
|
Content is the content of the drop-in. |
Extension
Extension is a specification for a Extension resource.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
ExtensionSpec
|
Specification of the Extension. |
status
ExtensionStatus
|
(Optional) |
ExtensionClass
Underlying type: string
(Appears on:BackupBucketSpec, BackupEntrySpec, BastionSpec, ContainerRuntimeSpec, ControlPlaneSpec, DNSRecordSpec, DefaultSpec, ExtensionSpec, InfrastructureSpec, NetworkSpec, OperatingSystemConfigSpec, SelfHostedShootExposureSpec, WorkerSpec)
ExtensionClass is a string alias for an extension class.
ExtensionSpec
(Appears on:Extension)
ExtensionSpec is the spec for a Extension resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
ExtensionStatus
(Appears on:Extension)
ExtensionStatus is the status for a Extension resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
File
(Appears on:OperatingSystemConfigSpec, OperatingSystemConfigStatus)
File is a file that should get written to the host's file system. The content can either be inlined or referenced from a secret in the same namespace.
| Field | Description |
|---|---|
path
string
|
Path is the path of the file system where the file should get written to. |
permissions
integer
|
(Optional)
Permissions describes with which permissions the file should get written to the file system. |
content
FileContent
|
Content describe the file's content. |
hostName
string
|
(Optional)
HostName contains the name of the host for host-specific configurations. |
FileCodecID
Underlying type: string
FileCodecID is the id of a FileCodec for cloud-init scripts.
FileContent
(Appears on:File)
FileContent can either reference a secret or contain inline configuration.
| Field | Description |
|---|---|
secretRef
FileContentSecretRef
|
(Optional)
SecretRef is a struct that contains information about the referenced secret. |
inline
FileContentInline
|
(Optional)
Inline is a struct that contains information about the inlined data. |
transmitUnencoded
boolean
|
(Optional)
TransmitUnencoded set to true will ensure that the os-extension does not encode the file content when sent to the node. |
imageRef
FileContentImageRef
|
(Optional)
ImageRef describes a container image which contains a file. |
FileContentImageRef
(Appears on:FileContent)
FileContentImageRef describes a container image which contains a file
| Field | Description |
|---|---|
image
string
|
Image contains the container image repository with tag. |
filePathInImage
string
|
FilePathInImage contains the path in the image to the file that should be extracted. |
FileContentInline
(Appears on:FileContent)
FileContentInline contains keys for inlining a file content's data and encoding.
| Field | Description |
|---|---|
encoding
string
|
Encoding is the file's encoding (e.g. base64). |
data
string
|
Data is the file's data. |
FileContentSecretRef
(Appears on:FileContent)
FileContentSecretRef contains keys for referencing a file content's data from a secret in the same namespace.
| Field | Description |
|---|---|
name
string
|
Name is the name of the secret. |
dataKey
string
|
DataKey is the key in the secret's `.data` field that should be read. |
IPFamily
Underlying type: string
(Appears on:NetworkSpec, NetworkStatus)
IPFamily is a type for specifying an IP protocol version to use in Gardener clusters.
InPlaceUpdates
(Appears on:OperatingSystemConfigSpec)
InPlaceUpdates is a structure containing configuration for in-place updates.
| Field | Description |
|---|---|
operatingSystemVersion
string
|
OperatingSystemVersion is the version of the operating system. |
kubelet
string
|
KubeletVersion is the version of the kubelet. |
credentialsRotation
CredentialsRotation
|
(Optional)
CredentialsRotation is a structure containing information about the last initiation time of the certificate authority and service account key rotation. |
InPlaceUpdatesStatus
(Appears on:OperatingSystemConfigStatus)
InPlaceUpdatesStatus is a structure containing configuration for in-place updates.
| Field | Description |
|---|---|
osUpdate
OSUpdate
|
(Optional)
OSUpdate defines the configuration for the operating system update. |
InPlaceUpdatesWorkerStatus
(Appears on:WorkerStatus)
InPlaceUpdatesWorkerStatus contains the configuration for in-place updates.
| Field | Description |
|---|---|
workerPoolToHashMap
object (keys:string, values:string)
|
(Optional)
WorkerPoolToHashMap is a map of worker pool names to their corresponding hash. |
Infrastructure
Infrastructure is a specification for cloud provider infrastructure.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
InfrastructureSpec
|
Specification of the Infrastructure. |
status
InfrastructureStatus
|
(Optional) |
InfrastructureSpec
(Appears on:Infrastructure)
InfrastructureSpec is the spec for an Infrastructure resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
region
string
|
Region is the region of this infrastructure. This field is immutable. |
secretRef
SecretReference
|
SecretRef is a reference to a secret that contains the cloud provider credentials. |
sshPublicKey
integer array
|
(Optional)
SSHPublicKey is the public SSH key that should be used with this infrastructure. |
InfrastructureStatus
(Appears on:Infrastructure)
InfrastructureStatus is the status for an Infrastructure resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
nodesCIDR
string
|
(Optional)
NodesCIDR is the CIDR of the node network that was optionally created by the acting extension controller. |
egressCIDRs
string array
|
(Optional)
EgressCIDRs is a list of CIDRs used by the shoot as the source IP for egress traffic. For certain environments the egress |
networking
InfrastructureStatusNetworking
|
(Optional)
Networking contains information about cluster networking such as CIDRs. |
InfrastructureStatusNetworking
(Appears on:InfrastructureStatus)
InfrastructureStatusNetworking is a structure containing information about the node, service and pod network ranges.
| Field | Description |
|---|---|
pods
string array
|
(Optional)
Pods are the CIDRs of the pod network. |
nodes
string array
|
(Optional)
Nodes are the CIDRs of the node network. |
services
string array
|
(Optional)
Services are the CIDRs of the service network. |
MachineDeployment
(Appears on:WorkerStatus)
MachineDeployment is a created machine deployment.
| Field | Description |
|---|---|
name
string
|
Name is the name of the `MachineDeployment` resource. |
minimum
integer
|
Minimum is the minimum number for this machine deployment. |
maximum
integer
|
Maximum is the maximum number for this machine deployment. |
priority
integer
|
(Optional)
Priority (or weight) is the importance by which this machine deployment will be scaled by cluster autoscaling. |
MachineImage
(Appears on:WorkerPool)
MachineImage contains logical information about the name and the version of the machie image that should be used. The logical information must be mapped to the provider-specific information (e.g., AMIs, ...) by the provider itself.
| Field | Description |
|---|---|
name
string
|
Name is the logical name of the machine image. |
version
string
|
Version is the version of the machine image. |
Network
Network is the specification for cluster networking.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
NetworkSpec
|
Specification of the Network. |
status
NetworkStatus
|
(Optional) |
NetworkSpec
(Appears on:Network)
NetworkSpec is the spec for an Network resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
podCIDR
string
|
PodCIDR defines the CIDR that will be used for pods. This field is immutable. |
serviceCIDR
string
|
ServiceCIDR defines the CIDR that will be used for services. This field is immutable. |
ipFamilies
IPFamily array
|
(Optional)
IPFamilies specifies the IP protocol versions to use for shoot networking. |
NetworkStatus
(Appears on:Network)
NetworkStatus is the status for an Network resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
ipFamilies
IPFamily array
|
(Optional)
IPFamilies specifies the IP protocol versions that actually are used for shoot networking. |
NodeTemplate
(Appears on:WorkerPool)
NodeTemplate contains information about the expected node properties.
OSUpdate
(Appears on:InPlaceUpdatesStatus)
OSUpdate contains the configuration for the operating system update.
| Field | Description |
|---|---|
command
string
|
Command defines the command responsible for performing machine image updates. |
args
string array
|
(Optional)
Args provides a mechanism to pass additional arguments or flags to the Command. |
Object
Underlying type: interface{GetExtensionSpec() Spec; GetExtensionStatus() Status; k8s.io/apimachinery/pkg/apis/meta/v1.Object; k8s.io/apimachinery/pkg/runtime.Object}
Object is an extension object resource.
OperatingSystemConfig
OperatingSystemConfig is a specification for a OperatingSystemConfig resource
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
OperatingSystemConfigSpec
|
Specification of the OperatingSystemConfig. |
status
OperatingSystemConfigStatus
|
(Optional) |
OperatingSystemConfigPurpose
Underlying type: string
(Appears on:OperatingSystemConfigSpec)
OperatingSystemConfigPurpose is a string alias.
OperatingSystemConfigSpec
(Appears on:OperatingSystemConfig)
OperatingSystemConfigSpec is the spec for a OperatingSystemConfig resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
criConfig
CRIConfig
|
(Optional)
CRI config is a structure contains configurations of the CRI library |
purpose
OperatingSystemConfigPurpose
|
Purpose describes how the result of this OperatingSystemConfig is used by Gardener. Either it |
units
Unit array
|
(Optional)
Units is a list of unit for the operating system configuration (usually, a systemd unit). |
files
File array
|
(Optional)
Files is a list of files that should get written to the host's file system. |
inPlaceUpdates
InPlaceUpdates
|
(Optional)
InPlaceUpdates contains the configuration for in-place updates. |
OperatingSystemConfigStatus
(Appears on:OperatingSystemConfig)
OperatingSystemConfigStatus is the status for a OperatingSystemConfig resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
extensionUnits
Unit array
|
(Optional)
ExtensionUnits is a list of additional systemd units provided by the extension. |
extensionFiles
File array
|
(Optional)
ExtensionFiles is a list of additional files provided by the extension. |
cloudConfig
CloudConfig
|
(Optional)
CloudConfig is a structure for containing the generated output for the given operating system |
inPlaceUpdates
InPlaceUpdatesStatus
|
(Optional)
InPlaceUpdates contains the configuration for in-place updates. |
PluginConfig
(Appears on:ContainerdConfig)
PluginConfig contains configuration values for the containerd plugins section.
| Field | Description |
|---|---|
op
PluginPathOperation
|
(Optional)
Op is the operation for the given path. Possible values are 'add' and 'remove', defaults to 'add'. |
path
string array
|
Path is a list of elements that construct the path in the plugins section. |
values
JSON
|
(Optional)
Values are the values configured at the given path. If defined, it is expected as json format: |
PluginPathOperation
Underlying type: string
(Appears on:PluginConfig)
PluginPathOperation is a type alias for operations at containerd's plugin configuration.
RegistryCapability
Underlying type: string
RegistryCapability specifies an action a client can perform against a registry.
RegistryConfig
(Appears on:ContainerdConfig)
RegistryConfig contains registry configuration options.
| Field | Description |
|---|---|
upstream
string
|
Upstream is the upstream name of the registry. |
server
string
|
(Optional)
Server is the URL to registry server of this upstream. |
hosts
RegistryHost array
|
Hosts are the registry hosts. |
readinessProbe
boolean
|
(Optional)
ReadinessProbe determines if host registry endpoints should be probed before they are added to the containerd config. |
RegistryHost
(Appears on:RegistryConfig)
RegistryHost contains configuration values for a registry host.
| Field | Description |
|---|---|
url
string
|
URL is the endpoint address of the registry mirror. |
capabilities
RegistryCapability array
|
(Optional)
Capabilities determine what operations a host is |
caCerts
string array
|
(Optional)
CACerts are paths to public key certificates used for TLS. |
overridePath
boolean
|
(Optional)
OverridePath sets the 'override_path' field to allow defining the API endpoint in the URL. |
SelfHostedShootExposure
SelfHostedShootExposure contains the configuration for the exposure of a self-hosted shoot control plane.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
SelfHostedShootExposureSpec
|
Specification of the SelfHostedShootExposure. |
status
SelfHostedShootExposureStatus
|
(Optional) |
SelfHostedShootExposureSpec
(Appears on:SelfHostedShootExposure)
SelfHostedShootExposureSpec is the spec for an SelfHostedShootExposure resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
credentialsRef
ObjectReference
|
(Optional)
CredentialsRef is a reference to the cloud provider credentials. |
port
integer
|
Port is the port number that should be exposed by the exposure mechanism. |
endpoints
ControlPlaneEndpoint array
|
Endpoints contains a list of healthy control plane nodes to expose. |
SelfHostedShootExposureStatus
(Appears on:SelfHostedShootExposure)
SelfHostedShootExposureStatus is the status for an SelfHostedShootExposure resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
ingress
LoadBalancerIngress array
|
(Optional)
Ingress is a list of endpoints of the exposure mechanism. |
ServiceAccountKeyRotation
(Appears on:CredentialsRotation)
ServiceAccountKeyRotation contains information about the service account key credential rotation.
| Field | Description |
|---|---|
lastInitiationTime
Time
|
(Optional)
LastInitiationTime is the most recent time when the service account key credential rotation was initiated. |
Spec
Underlying type: interface{GetExtensionClass() *ExtensionClass; GetExtensionPurpose() *string; GetExtensionType() string; GetProviderConfig() *k8s.io/apimachinery/pkg/runtime.RawExtension}
Spec is the spec section of an Object.
Status
Underlying type: interface{GetConditions() []github.com/gardener/gardener/pkg/apis/core/v1beta1.Condition; GetLastError() *github.com/gardener/gardener/pkg/apis/core/v1beta1.LastError; GetLastOperation() *github.com/gardener/gardener/pkg/apis/core/v1beta1.LastOperation; GetObservedGeneration() int64; GetProviderStatus() *k8s.io/apimachinery/pkg/runtime.RawExtension; GetResources() []github.com/gardener/gardener/pkg/apis/core/v1beta1.NamedResourceReference; GetState() *k8s.io/apimachinery/pkg/runtime.RawExtension; SetConditions([]github.com/gardener/gardener/pkg/apis/core/v1beta1.Condition); SetLastError(*github.com/gardener/gardener/pkg/apis/core/v1beta1.LastError); SetLastOperation(*github.com/gardener/gardener/pkg/apis/core/v1beta1.LastOperation); SetObservedGeneration(int64); SetResources(namedResourceReferences []github.com/gardener/gardener/pkg/apis/core/v1beta1.NamedResourceReference); SetState(state *k8s.io/apimachinery/pkg/runtime.RawExtension)}
Status is the status of an Object.
Unit
(Appears on:OperatingSystemConfigSpec, OperatingSystemConfigStatus)
Unit is a unit for the operating system configuration (usually, a systemd unit).
| Field | Description |
|---|---|
name
string
|
Name is the name of a unit. |
command
UnitCommand
|
(Optional)
Command is the unit's command. |
enable
boolean
|
(Optional)
Enable describes whether the unit is enabled or not. |
content
string
|
(Optional)
Content is the unit's content. |
dropIns
DropIn array
|
(Optional)
DropIns is a list of drop-ins for this unit. |
filePaths
string array
|
FilePaths is a list of files the unit depends on. If any file changes a restart of the dependent unit will be |
UnitCommand
Underlying type: string
(Appears on:Unit)
UnitCommand is a string alias.
Volume
(Appears on:WorkerPool)
Volume contains information about the root disks that should be used for worker pools.
| Field | Description |
|---|---|
name
string
|
(Optional)
Name of the volume to make it referenceable. |
type
string
|
(Optional)
Type is the type of the volume. |
size
string
|
Size is the of the root volume. |
encrypted
boolean
|
(Optional)
Encrypted determines if the volume should be encrypted. |
Worker
Worker is a specification for a Worker resource.
| Field | Description |
|---|---|
metadata
ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the metadata field.
|
spec
WorkerSpec
|
Specification of the Worker. |
status
WorkerStatus
|
(Optional) |
WorkerPool
(Appears on:WorkerSpec)
WorkerPool is the definition of a specific worker pool.
| Field | Description |
|---|---|
machineType
string
|
MachineType contains information about the machine type that should be used for this worker pool. |
maximum
integer
|
Maximum is the maximum size of the worker pool. |
maxSurge
IntOrString
|
MaxSurge is maximum number of VMs that are created during an update. |
maxUnavailable
IntOrString
|
MaxUnavailable is the maximum number of VMs that can be unavailable during an update. |
annotations
object (keys:string, values:string)
|
(Optional)
Annotations is a map of key/value pairs for annotations for all the `Node` objects in this worker pool. |
labels
object (keys:string, values:string)
|
(Optional)
Labels is a map of key/value pairs for labels for all the `Node` objects in this worker pool. |
taints
Taint array
|
(Optional)
Taints is a list of taints for all the `Node` objects in this worker pool. |
machineImage
MachineImage
|
MachineImage contains logical information about the name and the version of the machie image that |
minimum
integer
|
Minimum is the minimum size of the worker pool. |
name
string
|
Name is the name of this worker pool. |
nodeAgentSecretName
string
|
(Optional)
NodeAgentSecretName is uniquely identifying selected aspects of the OperatingSystemConfig. If it changes, then the |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is a provider specific configuration for the worker pool. |
userDataSecretRef
SecretKeySelector
|
UserDataSecretRef references a Secret and a data key containing the data that is sent to the provider's APIs when |
volume
Volume
|
(Optional)
Volume contains information about the root disks that should be used for this worker pool. |
dataVolumes
DataVolume array
|
(Optional)
DataVolumes contains a list of additional worker volumes. |
kubeletDataVolumeName
string
|
(Optional)
KubeletDataVolumeName contains the name of a dataVolume that should be used for storing kubelet state. |
zones
string array
|
(Optional)
Zones contains information about availability zones for this worker pool. |
machineControllerManager
MachineControllerManagerSettings
|
(Optional)
MachineControllerManagerSettings contains configurations for different worker-pools. Eg. MachineDrainTimeout, MachineHealthTimeout. |
kubernetesVersion
string
|
(Optional)
KubernetesVersion is the kubernetes version in this worker pool |
kubeletConfig
KubeletConfig
|
(Optional)
KubeletConfig contains the kubelet configuration for the worker pool. |
nodeTemplate
NodeTemplate
|
(Optional)
NodeTemplate contains resource information of the machine which is used by Cluster Autoscaler to generate nodeTemplate during scaling a nodeGroup |
architecture
string
|
(Optional)
Architecture is the CPU architecture of the worker pool machines and machine image. |
clusterAutoscaler
ClusterAutoscalerOptions
|
(Optional)
ClusterAutoscaler contains the cluster autoscaler configurations for the worker pool. |
priority
integer
|
(Optional)
Priority (or weight) is the importance by which this worker pool will be scaled by cluster autoscaling. |
updateStrategy
MachineUpdateStrategy
|
(Optional)
UpdateStrategy specifies the machine update strategy for the worker pool. |
WorkerSpec
(Appears on:Worker)
WorkerSpec is the spec for a Worker resource.
| Field | Description |
|---|---|
type
string
|
Type contains the instance of the resource's kind. |
class
ExtensionClass
|
(Optional)
Class holds the extension class used to control the responsibility for multiple provider extensions. |
providerConfig
RawExtension
|
(Optional)
ProviderConfig is the provider specific configuration. |
infrastructureProviderStatus
RawExtension
|
(Optional)
InfrastructureProviderStatus is a raw extension field that contains the provider status that has |
region
string
|
Region is the name of the region where the worker pool should be deployed to. This field is immutable. |
secretRef
SecretReference
|
SecretRef is a reference to a secret that contains the cloud provider specific credentials. |
sshPublicKey
integer array
|
(Optional)
SSHPublicKey is the public SSH key that should be used with these workers. |
pools
WorkerPool array
|
Pools is a list of worker pools. |
WorkerStatus
(Appears on:Worker)
WorkerStatus is the status for a Worker resource.
| Field | Description |
|---|---|
providerStatus
RawExtension
|
(Optional)
ProviderStatus contains provider-specific status. |
conditions
Condition array
|
(Optional)
Conditions represents the latest available observations of a Seed's current state. |
lastError
LastError
|
(Optional)
LastError holds information about the last occurred error during an operation. |
lastOperation
LastOperation
|
(Optional)
LastOperation holds information about the last operation on the resource. |
observedGeneration
integer
|
ObservedGeneration is the most recent generation observed for this resource. |
state
RawExtension
|
(Optional)
State can be filled by the operating controller with what ever data it needs. |
resources
NamedResourceReference array
|
(Optional)
Resources holds a list of named resource references that can be referred to in the state by their names. |
machineDeployments
MachineDeployment array
|
MachineDeployments is a list of created machine deployments. It will be used to e.g. configure |
machineDeploymentsLastUpdateTime
Time
|
(Optional)
MachineDeploymentsLastUpdateTime is the timestamp when the status.MachineDeployments slice was last updated. |
inPlaceUpdates
InPlaceUpdatesWorkerStatus
|
(Optional)
InPlaceUpdates contains the status for in-place updates. |