Skip to content

Latest commit

 

History

History
4251 lines (4251 loc) · 80.3 KB

extensions.md

File metadata and controls

4251 lines (4251 loc) · 80.3 KB

Packages:

extensions.gardener.cloud/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

BackupBucket

BackupBucket is a specification for backup bucket.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		BackupBucket
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
BackupBucketSpec

Specification of the BackupBucket. If the object’s deletion timestamp is set, this field is immutable.



DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
region
string

Region is the region of this bucket. This field is immutable.
secretRef
Kubernetes core/v1.SecretReference

SecretRef is a reference to a secret that contains the credentials to access object store.
status
BackupBucketStatus 		(Optional)

BackupEntry

BackupEntry is a specification for backup Entry.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		BackupEntry
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
BackupEntrySpec

Specification of the BackupEntry. If the object’s deletion timestamp is set, this field is immutable.



DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
backupBucketProviderStatus
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

BackupBucketProviderStatus contains the provider status that has been generated by the controller responsible for the BackupBucket resource.
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
Kubernetes core/v1.SecretReference

SecretRef is a reference to a secret that contains the credentials to access object store.
status
BackupEntryStatus 		(Optional)

Bastion

Bastion is a bastion or jump host that is dynamically created to provide SSH access to shoot nodes.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		Bastion
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
BastionSpec

Spec is the specification of this Bastion. If the object’s deletion timestamp is set, this field is immutable.



DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
userData
[]byte

UserData is the base64-encoded user data for the bastion instance. This should contain code to provision the SSH key on the bastion instance. This field is immutable.
ingress
[]BastionIngressPolicy

Ingress controls from where the created bastion host should be reachable.
status
BastionStatus 		(Optional)

Status is the bastion’s status.

Cluster

Cluster is a specification for a Cluster resource.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		Cluster
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ClusterSpec

cloudProfile
k8s.io/apimachinery/pkg/runtime.RawExtension

CloudProfile is a raw extension field that contains the cloudprofile resource referenced by the shoot that has to be reconciled.
seed
k8s.io/apimachinery/pkg/runtime.RawExtension

Seed is a raw extension field that contains the seed resource referenced by the shoot that has to be reconciled.
shoot
k8s.io/apimachinery/pkg/runtime.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
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		ContainerRuntime
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ContainerRuntimeSpec

Specification of the ContainerRuntime. If the object’s deletion timestamp is set, this field is immutable.



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. For each worker pool and type, Gardener deploys a ContainerRuntime CRD.
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
status
ContainerRuntimeStatus 		(Optional)

ControlPlane

ControlPlane is a specification for a ControlPlane resource.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		ControlPlane
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ControlPlaneSpec

Specification of the ControlPlane. If the object’s deletion timestamp is set, this field is immutable.



DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
purpose
Purpose 		(Optional)

Purpose contains the data if a cloud provider needs additional components in order to expose the control plane. This field is immutable.
infrastructureProviderStatus
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

InfrastructureProviderStatus contains the provider status that has been generated by the controller responsible for the Infrastructure resource.
region
string

Region is the region of this control plane. This field is immutable.
secretRef
Kubernetes core/v1.SecretReference

SecretRef is a reference to a secret that contains the cloud provider specific credentials.
status
ControlPlaneStatus 		(Optional)

DNSRecord

DNSRecord is a specification for a DNSRecord resource.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		DNSRecord
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
DNSRecordSpec

Specification of the DNSRecord. If the object’s deletion timestamp is set, this field is immutable.



DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
secretRef
Kubernetes core/v1.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. If that is also not specified, the extension controller will use its default region.
zone
string 		(Optional)

Zone is the DNS hosted zone of this DNS record. If not specified, it will be determined automatically by getting all hosted zones of the account and searching for the longest zone name that is a suffix of Name.
name
string

Name is the fully qualified domain name, e.g. “api.”. This field is immutable.
recordType
DNSRecordType

RecordType is the DNS record type. Only A, CNAME, and TXT records are currently supported. This field is immutable.
values
[]string

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
int64 		(Optional)

TTL is the time to live in seconds. Defaults to 120.
status
DNSRecordStatus 		(Optional)

Extension

Extension is a specification for a Extension resource.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		Extension
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ExtensionSpec

Specification of the Extension. If the object’s deletion timestamp is set, this field is immutable.



DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
status
ExtensionStatus 		(Optional)

Infrastructure

Infrastructure is a specification for cloud provider infrastructure.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		Infrastructure
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
InfrastructureSpec

Specification of the Infrastructure. If the object’s deletion timestamp is set, this field is immutable.



DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
region
string

Region is the region of this infrastructure. This field is immutable.
secretRef
Kubernetes core/v1.SecretReference

SecretRef is a reference to a secret that contains the actual result of the generated cloud config.
sshPublicKey
[]byte 		(Optional)

SSHPublicKey is the public SSH key that should be used with this infrastructure.
status
InfrastructureStatus 		(Optional)

Network

Network is the specification for cluster networking.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		Network
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
NetworkSpec

Specification of the Network. If the object’s deletion timestamp is set, this field is immutable.



DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
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.
status
NetworkStatus 		(Optional)

OperatingSystemConfig

OperatingSystemConfig is a specification for a OperatingSystemConfig resource

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		OperatingSystemConfig
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
OperatingSystemConfigSpec

Specification of the OperatingSystemConfig. If the object’s deletion timestamp is set, this field is immutable.



criConfig
CRIConfig 		(Optional)

CRI config is a structure contains configurations of the CRI library
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
purpose
OperatingSystemConfigPurpose

Purpose describes how the result of this OperatingSystemConfig is used by Gardener. Either it gets sent to the Worker extension controller to bootstrap a VM, or it is downloaded by the cloud-config-downloader script already running on a bootstrapped VM. This field is immutable.
reloadConfigFilePath
string 		(Optional)

ReloadConfigFilePath is the path to the generated operating system configuration. If set, controllers are asked to use it when determining the .status.command of this resource. For example, if for CoreOS the reload-path might be “/var/lib/config”; then the controller shall set .status.command to “/usr/bin/coreos-cloudinit –from-file=/var/lib/config”.
units
[]Unit 		(Optional)

Units is a list of unit for the operating system configuration (usually, a systemd unit).
files
[]File 		(Optional)

Files is a list of files that should get written to the host’s file system.
status
OperatingSystemConfigStatus 		(Optional)

Worker

Worker is a specification for a Worker resource.

Field Description
apiVersion
string		 extensions.gardener.cloud/v1alpha1
kind
string 		Worker
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
WorkerSpec

Specification of the Worker. If the object’s deletion timestamp is set, this field is immutable.



DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
infrastructureProviderStatus
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

InfrastructureProviderStatus is a raw extension field that contains the provider status that has been generated by the controller responsible for the Infrastructure resource.
region
string

Region is the name of the region where the worker pool should be deployed to. This field is immutable.
secretRef
Kubernetes core/v1.SecretReference

SecretRef is a reference to a secret that contains the cloud provider specific credentials.
sshPublicKey
[]byte 		(Optional)

SSHPublicKey is the public SSH key that should be used with these workers.
pools
[]WorkerPool

Pools is a list of worker pools.
status
WorkerStatus 		(Optional)

BackupBucketSpec

(Appears on: BackupBucket)

BackupBucketSpec is the spec for an BackupBucket resource.

Field Description
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
region
string

Region is the region of this bucket. This field is immutable.
secretRef
Kubernetes core/v1.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
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.
generatedSecretRef
Kubernetes core/v1.SecretReference 		(Optional)

GeneratedSecretRef is reference to the secret generated by backup bucket, which will have object store specific credentials.

BackupEntrySpec

(Appears on: BackupEntry)

BackupEntrySpec is the spec for an BackupEntry resource.

Field Description
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
backupBucketProviderStatus
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

BackupBucketProviderStatus contains the provider status that has been generated by the controller responsible for the BackupBucket resource.
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
Kubernetes core/v1.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
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.

BastionIngressPolicy

(Appears on: BastionSpec)

BastionIngressPolicy represents an ingress policy for SSH bastion hosts.

Field Description
ipBlock
Kubernetes networking/v1.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
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
userData
[]byte

UserData is the base64-encoded user data for the bastion instance. This should contain code to provision the SSH key on the bastion instance. This field is immutable.
ingress
[]BastionIngressPolicy

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
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.
ingress
Kubernetes core/v1.LoadBalancerIngress 		(Optional)

Ingress is the external IP and/or hostname of the bastion host.

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 docker and containerd.

CRIName (string alias)

(Appears on: CRIConfig)

CRIName is a type alias for the CRI name string.

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

SecretRef is a reference to a secret that contains the actual result of the generated cloud config.

ClusterSpec

(Appears on: Cluster)

ClusterSpec is the spec for a Cluster resource.

Field Description
cloudProfile
k8s.io/apimachinery/pkg/runtime.RawExtension

CloudProfile is a raw extension field that contains the cloudprofile resource referenced by the shoot that has to be reconciled.
seed
k8s.io/apimachinery/pkg/runtime.RawExtension

Seed is a raw extension field that contains the seed resource referenced by the shoot that has to be reconciled.
shoot
k8s.io/apimachinery/pkg/runtime.RawExtension

Shoot is a raw extension field that contains the shoot resource that has to be reconciled.

ContainerRuntimeSpec

(Appears on: ContainerRuntime)

ContainerRuntimeSpec is the spec for a ContainerRuntime resource.

Field Description
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. For each worker pool and type, Gardener deploys a ContainerRuntime CRD.
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.

ContainerRuntimeStatus

(Appears on: ContainerRuntime)

ContainerRuntimeStatus is the status for a ContainerRuntime resource.

Field Description
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.

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. This field is immutable.
selector
Kubernetes meta/v1.LabelSelector

Selector is the label selector used by the extension to match the nodes belonging to the worker pool.

ControlPlaneSpec

(Appears on: ControlPlane)

ControlPlaneSpec is the spec of a ControlPlane resource.

Field Description
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
purpose
Purpose 		(Optional)

Purpose contains the data if a cloud provider needs additional components in order to expose the control plane. This field is immutable.
infrastructureProviderStatus
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

InfrastructureProviderStatus contains the provider status that has been generated by the controller responsible for the Infrastructure resource.
region
string

Region is the region of this control plane. This field is immutable.
secretRef
Kubernetes core/v1.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
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.

DNSRecordSpec

(Appears on: DNSRecord)

DNSRecordSpec is the spec of a DNSRecord resource.

Field Description
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
secretRef
Kubernetes core/v1.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. If that is also not specified, the extension controller will use its default region.
zone
string 		(Optional)

Zone is the DNS hosted zone of this DNS record. If not specified, it will be determined automatically by getting all hosted zones of the account and searching for the longest zone name that is a suffix of Name.
name
string

Name is the fully qualified domain name, e.g. “api.”. This field is immutable.
recordType
DNSRecordType

RecordType is the DNS record type. Only A, CNAME, and TXT records are currently supported. This field is immutable.
values
[]string

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
int64 		(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
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.
zone
string 		(Optional)

Zone is the DNS hosted zone of this DNS record.

DNSRecordType (string alias)

(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 referencable.
type
string 		(Optional)

Type is the type of the volume.
size
string

Size is the of the root volume.
encrypted
bool 		(Optional)

Encrypted determines if the volume should be encrypted.

DefaultSpec

(Appears on: BackupBucketSpec, BackupEntrySpec, BastionSpec, ContainerRuntimeSpec, ControlPlaneSpec, DNSRecordSpec, ExtensionSpec, InfrastructureSpec, NetworkSpec, OperatingSystemConfigSpec, WorkerSpec)

DefaultSpec contains common status fields for every extension resource.

Field Description
type
string

Type contains the instance of the resource’s kind.
providerConfig
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

ProviderConfig is the provider specific configuration.

DefaultStatus

(Appears on: BackupBucketStatus, BackupEntryStatus, BastionStatus, ContainerRuntimeStatus, ControlPlaneStatus, DNSRecordStatus, ExtensionStatus, InfrastructureStatus, NetworkStatus, OperatingSystemConfigStatus, WorkerStatus)

DefaultStatus contains common status fields for every extension resource.

Field Description
providerStatus
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

ProviderStatus contains provider-specific status.
conditions
[]github.com/gardener/gardener/pkg/apis/core/v1beta1.Condition 		(Optional)

Conditions represents the latest available observations of a Seed’s current state.
lastError
github.com/gardener/gardener/pkg/apis/core/v1beta1.LastError 		(Optional)

LastError holds information about the last occurred error during an operation.
lastOperation
github.com/gardener/gardener/pkg/apis/core/v1beta1.LastOperation 		(Optional)

LastOperation holds information about the last operation on the resource.
observedGeneration
int64

ObservedGeneration is the most recent generation observed for this resource.
state
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

State can be filled by the operating controller with what ever data it needs.
resources
[]github.com/gardener/gardener/pkg/apis/core/v1beta1.NamedResourceReference 		(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.

ExtensionSpec

(Appears on: Extension)

ExtensionSpec is the spec for a Extension resource.

Field Description
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.

ExtensionStatus

(Appears on: Extension)

ExtensionStatus is the status for a Extension resource.

Field Description
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.

File

(Appears on: OperatingSystemConfigSpec)

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
int32 		(Optional)

Permissions describes with which permissions the file should get written to the file system. Should be defaulted to octal 0644.
content
FileContent

Content describe the file’s content.

FileCodecID (string alias)

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
bool 		(Optional)

TransmitUnencoded set to true will ensure that the os-extension does not encode the file content when sent to the node. This for example can be used to manipulate the clear-text content before it reaches the node.

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.

InfrastructureSpec

(Appears on: Infrastructure)

InfrastructureSpec is the spec for an Infrastructure resource.

Field Description
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
region
string

Region is the region of this infrastructure. This field is immutable.
secretRef
Kubernetes core/v1.SecretReference

SecretRef is a reference to a secret that contains the actual result of the generated cloud config.
sshPublicKey
[]byte 		(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
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.
nodesCIDR
string 		(Optional)

NodesCIDR is the CIDR of the node network that was optionally created by the acting extension controller. This might be needed in environments in which the CIDR for the network for the shoot worker node cannot be statically defined in the Shoot resource but must be computed dynamically.

MachineDeployment

(Appears on: WorkerStatus)

MachineDeployment is a created machine deployment.

Field Description
name
string

Name is the name of the MachineDeployment resource.
minimum
int32

Minimum is the minimum number for this machine deployment.
maximum
int32

Maximum is the maximum number for this machine deployment.

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.

NetworkSpec

(Appears on: Network)

NetworkSpec is the spec for an Network resource.

Field Description
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
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.

NetworkStatus

(Appears on: Network)

NetworkStatus is the status for an Network resource.

Field Description
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.

NodeTemplate

(Appears on: WorkerPool)

NodeTemplate contains information about the expected node properties.

Field Description
capacity
Kubernetes core/v1.ResourceList

Capacity represents the expected Node capacity.

Object

Object is an extension object resource.

OperatingSystemConfigPurpose (string alias)

(Appears on: OperatingSystemConfigSpec)

OperatingSystemConfigPurpose is a string alias.

OperatingSystemConfigSpec

(Appears on: OperatingSystemConfig)

OperatingSystemConfigSpec is the spec for a OperatingSystemConfig resource.

Field Description
criConfig
CRIConfig 		(Optional)

CRI config is a structure contains configurations of the CRI library
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
purpose
OperatingSystemConfigPurpose

Purpose describes how the result of this OperatingSystemConfig is used by Gardener. Either it gets sent to the Worker extension controller to bootstrap a VM, or it is downloaded by the cloud-config-downloader script already running on a bootstrapped VM. This field is immutable.
reloadConfigFilePath
string 		(Optional)

ReloadConfigFilePath is the path to the generated operating system configuration. If set, controllers are asked to use it when determining the .status.command of this resource. For example, if for CoreOS the reload-path might be “/var/lib/config”; then the controller shall set .status.command to “/usr/bin/coreos-cloudinit –from-file=/var/lib/config”.
units
[]Unit 		(Optional)

Units is a list of unit for the operating system configuration (usually, a systemd unit).
files
[]File 		(Optional)

Files is a list of files that should get written to the host’s file system.

OperatingSystemConfigStatus

(Appears on: OperatingSystemConfig)

OperatingSystemConfigStatus is the status for a OperatingSystemConfig resource.

Field Description
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.
cloudConfig
CloudConfig 		(Optional)

CloudConfig is a structure for containing the generated output for the given operating system config spec. It contains a reference to a secret as the result may contain confidential data.
command
string 		(Optional)

Command is the command whose execution renews/reloads the cloud config on an existing VM, e.g. “/usr/bin/reload-cloud-config -from-file=”. The is optionally provided by Gardener in the .spec.reloadConfigFilePath field.
units
[]string 		(Optional)

Units is a list of systemd unit names that are part of the generated Cloud Config and shall be restarted when a new version has been downloaded.

Purpose (string alias)

(Appears on: ControlPlaneSpec)

Purpose is a string alias.

Spec

Spec is the spec section of an Object.

Status

Status is the status of an Object.

Unit

(Appears on: OperatingSystemConfigSpec)

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
string 		(Optional)

Command is the unit’s command.
enable
bool 		(Optional)

Enable describes whether the unit is enabled or not.
content
string 		(Optional)

Content is the unit’s content.
dropIns
[]DropIn 		(Optional)

DropIns is a list of drop-ins for this unit.

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 referencable.
type
string 		(Optional)

Type is the type of the volume.
size
string

Size is the of the root volume.
encrypted
bool 		(Optional)

Encrypted determines if the volume should be encrypted.

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
int32

Maximum is the maximum size of the worker pool.
maxSurge
k8s.io/apimachinery/pkg/util/intstr.IntOrString

MaxSurge is maximum number of VMs that are created during an update.
maxUnavailable
k8s.io/apimachinery/pkg/util/intstr.IntOrString

MaxUnavailable is the maximum number of VMs that can be unavailable during an update.
annotations
map[string]string 		(Optional)

Annotations is a map of key/value pairs for annotations for all the Node objects in this worker pool.
labels
map[string]string 		(Optional)

Labels is a map of key/value pairs for labels for all the Node objects in this worker pool.
taints
[]Kubernetes core/v1.Taint 		(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 should be used. The logical information must be mapped to the provider-specific information (e.g., AMIs, …) by the provider itself.
minimum
int32

Minimum is the minimum size of the worker pool.
name
string

Name is the name of this worker pool.
providerConfig
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

ProviderConfig is a provider specific configuration for the worker pool.
userData
[]byte

UserData is a base64-encoded string that contains the data that is sent to the provider’s APIs when a new machine/VM that is part of this worker pool shall be spawned.
volume
Volume 		(Optional)

Volume contains information about the root disks that should be used for this worker pool.
dataVolumes
[]DataVolume 		(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 		(Optional)

Zones contains information about availability zones for this worker pool.
machineControllerManager
github.com/gardener/gardener/pkg/apis/core/v1beta1.MachineControllerManagerSettings 		(Optional)

MachineControllerManagerSettings contains configurations for different worker-pools. Eg. MachineDrainTimeout, MachineHealthTimeout.
kubernetesVersion
string 		(Optional)

KubernetesVersion is the kubernetes version in this 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 from zero

WorkerSpec

(Appears on: Worker)

WorkerSpec is the spec for a Worker resource.

Field Description
DefaultSpec
DefaultSpec

(Members of DefaultSpec are embedded into this type.)

DefaultSpec is a structure containing common fields used by all extension resources.
infrastructureProviderStatus
k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional)

InfrastructureProviderStatus is a raw extension field that contains the provider status that has been generated by the controller responsible for the Infrastructure resource.
region
string

Region is the name of the region where the worker pool should be deployed to. This field is immutable.
secretRef
Kubernetes core/v1.SecretReference

SecretRef is a reference to a secret that contains the cloud provider specific credentials.
sshPublicKey
[]byte 		(Optional)

SSHPublicKey is the public SSH key that should be used with these workers.
pools
[]WorkerPool

Pools is a list of worker pools.

WorkerStatus

(Appears on: Worker)

WorkerStatus is the status for a Worker resource.

Field Description
DefaultStatus
DefaultStatus

(Members of DefaultStatus are embedded into this type.)

DefaultStatus is a structure containing common fields used by all extension resources.
machineDeployments
[]MachineDeployment

MachineDeployments is a list of created machine deployments. It will be used to e.g. configure the cluster-autoscaler properly.

Generated with gen-crd-api-reference-docs