shoot

package
v1.132.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 13, 2025 License: Apache-2.0 Imports: 58 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func SortByIPFamilies 

func SortByIPFamilies(ipfamilies []gardencorev1beta1.IPFamily, cidrs []net.IPNet) []net.IPNet

SortByIPFamilies sorts a slice of CIDRs according to the specified IP family order. For dual-stack configurations, CIDRs are ordered by the IP family preference. For single-stack configurations, matching CIDRs are placed first, followed by non-matching CIDRs.

Types

type Addons 

type Addons struct {
	KubernetesDashboard kubernetesdashboard.Interface
	NginxIngress        component.Deployer
}

Addons contains references for the addons.

type Builder 

type Builder struct {
	// contains filtered or unexported fields
}

Builder is an object that builds Shoot objects.

func NewBuilder 

func NewBuilder() *Builder

NewBuilder returns a new Builder.

func (*Builder) Build 

func (b *Builder) Build(ctx context.Context, c client.Reader) (*Shoot, error)

Build initializes a new Shoot object.

func (*Builder) WithCloudProfileObject 

func (b *Builder) WithCloudProfileObject(cloudProfileObject *gardencorev1beta1.CloudProfile) *Builder

WithCloudProfileObject sets the cloudProfileFunc attribute at the Builder.

func (*Builder) WithCloudProfileObjectFrom 

func (b *Builder) WithCloudProfileObjectFrom(reader client.Reader) *Builder

WithCloudProfileObjectFrom sets the cloudProfileFunc attribute at the Builder after fetching it from the given reader.

func (*Builder) WithCloudProfileObjectFromCluster 

func (b *Builder) WithCloudProfileObjectFromCluster(seedClient kubernetes.Interface, clusterName string) *Builder

WithCloudProfileObjectFromCluster sets the cloudProfileFunc attribute at the Builder.

func (*Builder) WithDefaultDomains 

func (b *Builder) WithDefaultDomains(defaultDomains []*gardenerutils.Domain) *Builder

WithDefaultDomains sets the defaultDomains attribute at the Builder.

func (*Builder) WithExposureClassObject 

func (b *Builder) WithExposureClassObject(exposureClass *gardencorev1beta1.ExposureClass) *Builder

WithExposureClassObject sets the exposureClass attribute at the Builder.

func (*Builder) WithInternalDomain 

func (b *Builder) WithInternalDomain(internalDomain *gardenerutils.Domain) *Builder

WithInternalDomain sets the internalDomain attribute at the Builder.

func (*Builder) WithProjectName 

func (b *Builder) WithProjectName(projectName string) *Builder

WithProjectName sets the projectName attribute at the Builder.

func (*Builder) WithSeedObject 

func (b *Builder) WithSeedObject(seed *gardencorev1beta1.Seed) *Builder

WithSeedObject sets the seed attribute at the Builder.

func (*Builder) WithServiceAccountIssuerHostname added in v1.91.0 

func (b *Builder) WithServiceAccountIssuerHostname(secret *corev1.Secret) *Builder

WithServiceAccountIssuerHostname prepares the Builder for initialization of the service account issuer hostname. Should be called before Builder.Build.

func (*Builder) WithShootCredentialsFrom added in v1.102.0 

func (b *Builder) WithShootCredentialsFrom(c client.Reader) *Builder

WithShootCredentialsFrom sets the shootCredentialsFunc attribute at the Builder after fetching it from the given reader.

func (*Builder) WithShootObject 

func (b *Builder) WithShootObject(shootObject *gardencorev1beta1.Shoot) *Builder

WithShootObject sets the shootObjectFunc attribute at the Builder.

func (*Builder) WithShootObjectFromCluster 

func (b *Builder) WithShootObjectFromCluster(seedClient kubernetes.Interface, clusterName string) *Builder

WithShootObjectFromCluster sets the shootObjectFunc attribute at the Builder.

func (*Builder) WithoutShootCredentials added in v1.103.2 

func (b *Builder) WithoutShootCredentials() *Builder

WithoutShootCredentials sets the shootCredentialsFunc attribute at the builder to return empty Secret as credentials.

type Components 

type Components struct {
	BackupEntry              backupentry.Interface
	SourceBackupEntry        backupentry.Interface
	ControlPlane             *ControlPlane
	Extensions               *Extensions
	SystemComponents         *SystemComponents
	Addons                   *Addons
	GardenerAccess           component.Deployer
	DependencyWatchdogAccess component.Deployer
}

Components contains different components deployed in the Shoot cluster.

type ControlPlane 

type ControlPlane struct {
	Alertmanager             alertmanager.Interface
	BlackboxExporter         component.DeployWaiter
	ClusterAutoscaler        clusterautoscaler.Interface
	EtcdMain                 etcd.Interface
	EtcdEvents               etcd.Interface
	EtcdCopyBackupsTask      etcdcopybackupstask.Interface
	EventLogger              component.Deployer
	KubeAPIServerService     component.DeployWaiter
	KubeAPIServerSNI         component.DeployWaiter
	KubeAPIServer            kubeapiserver.Interface
	KubeScheduler            component.DeployWaiter
	KubeControllerManager    kubecontrollermanager.Interface
	KubeStateMetrics         component.DeployWaiter
	MachineControllerManager machinecontrollermanager.Interface
	Plutono                  plutono.Interface
	Prometheus               prometheus.Interface
	ResourceManager          resourcemanager.Interface
	Vali                     vali.Interface
	OtelCollector            collector.Interface
	VerticalPodAutoscaler    vpa.Interface
	VPNSeedServer            vpnseedserver.Interface
}

ControlPlane contains references to K8S control plane components.

type Extensions 

type Extensions struct {
	ContainerRuntime      containerruntime.Interface
	ControlPlane          controlplane.Interface
	ExternalDNSRecord     dnsrecord.Interface
	InternalDNSRecord     dnsrecord.Interface
	IngressDNSRecord      dnsrecord.Interface
	Extension             extension.Interface
	Infrastructure        infrastructure.Interface
	Network               network.Interface
	OperatingSystemConfig operatingsystemconfig.Interface
	Worker                worker.Interface
}

Extensions contains references to extension resources.

type Networks 

type Networks struct {
	// Pods subnets
	Pods []net.IPNet
	// Services subnets
	Services []net.IPNet
	// Nodes subnets
	Nodes []net.IPNet
	// EgressCIDRs contains the outgoing IP address ranges used by the cluster if known.
	EgressCIDRs []net.IPNet
	// APIServer are the ClusterIPs of default/kubernetes Service
	APIServer []net.IP
	// CoreDNS are the ClusterIPs of kube-system/coredns Service
	CoreDNS []net.IP
}

Networks contains pre-calculated subnets and IP address for various components.

func ToNetworks 

func ToNetworks(shoot *gardencorev1beta1.Shoot, workerless bool) (*Networks, error)

ToNetworks return a network with computed cidrs and ClusterIPs for a Shoot

type Shoot 

type Shoot struct {

	// Credentials is either [*corev1.Secret] or [*securityv1alpha1.WorkloadIdentity]
	Credentials   client.Object
	CloudProfile  *gardencorev1beta1.CloudProfile
	ExposureClass *gardencorev1beta1.ExposureClass

	// ControlPlaneNamespace is the namespace in which the control plane components run.
	ControlPlaneNamespace string
	KubernetesVersion     *semver.Version

	// InternalClusterDomain is empty for self-hosted shoots, which only have an external domain (Shoot.spec.dns.domain).
	InternalClusterDomain *string
	// ExternalClusterDomain is nil if Shoot.Spec.DNS.Domain is unset.
	ExternalClusterDomain *string
	// ExternalDomain is nil if Shoot.Spec.DNS.Domain is unset.
	ExternalDomain *gardenerutils.Domain

	Purpose                                 gardencorev1beta1.ShootPurpose
	IsWorkerless                            bool
	WantsClusterAutoscaler                  bool
	WantsVerticalPodAutoscaler              bool
	WantsAlertmanager                       bool
	IgnoreAlerts                            bool
	HibernationEnabled                      bool
	VPNHighAvailabilityEnabled              bool
	VPNHighAvailabilityNumberOfSeedServers  int
	VPNHighAvailabilityNumberOfShootClients int
	VPNVPAUpdateDisabled                    bool
	NodeLocalDNSEnabled                     bool
	TopologyAwareRoutingEnabled             bool
	Networks                                *Networks
	BackupEntryName                         string
	OSCSyncJitterPeriod                     *metav1.Duration
	ResourcesToEncrypt                      []string
	EncryptedResources                      []string
	ServiceAccountIssuerHostname            *string

	Components *Components
	// contains filtered or unexported fields
}

Shoot is an object containing information about a Shoot cluster.

func (*Shoot) ComputeInClusterAPIServerAddress 

func (s *Shoot) ComputeInClusterAPIServerAddress(runsInShootNamespace bool) string

ComputeInClusterAPIServerAddress returns the internal address for the shoot API server depending on whether the caller runs in the shoot namespace or not.

func (*Shoot) ComputeOutOfClusterAPIServerAddress 

func (s *Shoot) ComputeOutOfClusterAPIServerAddress(preferInternalClusterDomain bool) string

ComputeOutOfClusterAPIServerAddress returns the external address for the shoot API server depending on whether the caller wants to use the internal cluster domain and whether DNS is disabled on this seed.

func (*Shoot) GetDNSRecordComponentsForMigration 

func (s *Shoot) GetDNSRecordComponentsForMigration() []component.DeployMigrateWaiter

GetDNSRecordComponentsForMigration returns a list of component.DeployMigrateWaiters of DNSRecord components that should be migrated by the shoot controller.

func (*Shoot) GetExtensionComponentsForParallelMigration 

func (s *Shoot) GetExtensionComponentsForParallelMigration() []component.DeployMigrateWaiter

GetExtensionComponentsForParallelMigration returns a list of component.DeployMigrateWaiters of extension components that should be migrated by the shoot controller in parallel. Note that this method does not return ControlPlane and Infrastructure components as they require specific handling during migration.

func (*Shoot) GetInfo 

func (s *Shoot) GetInfo() *gardencorev1beta1.Shoot

GetInfo returns the shoot resource of this Shoot in a concurrency safe way. This method should be used only for reading the data of the returned shoot resource. The returned shoot resource MUST NOT BE MODIFIED (except in test code) since this might interfere with other concurrent reads and writes. To properly update the shoot resource of this Shoot use UpdateInfo or UpdateInfoStatus.

func (*Shoot) GetIngressFQDN 

func (s *Shoot) GetIngressFQDN(subDomain string) string

GetIngressFQDN returns the fully qualified domain name of ingress sub-resource for the Shoot cluster. The end result is '<subDomain>.<ingressPrefix>.<clusterDomain>'.

func (*Shoot) GetMaxNodeCount 

func (s *Shoot) GetMaxNodeCount() int32

GetMaxNodeCount returns the sum of all 'maximum' fields of all worker groups of the Shoot.

func (*Shoot) GetReplicas 

func (s *Shoot) GetReplicas(wokenUp int32) int32

GetReplicas returns the given <wokenUp> number if the shoot is not hibernated, or zero otherwise.

func (*Shoot) GetShootState 

func (s *Shoot) GetShootState() *gardencorev1beta1.ShootState

GetShootState returns the shootstate resource of this Shoot in a concurrency safe way. This method should be used only for reading the data of the returned shootstate resource. The returned shootstate resource MUST NOT BE MODIFIED (except in test code) since this might interfere with other concurrent reads and writes. To properly update the shootstate resource of this Shoot use SaveGardenerResourceDataInShootState.

func (*Shoot) HasManagedInfrastructure added in v1.129.0 

func (s *Shoot) HasManagedInfrastructure() bool

HasManagedInfrastructure returns true if the shoot's infrastructure (network, machines, etc.) is managed by Gardener.

func (*Shoot) IPVSEnabled 

func (s *Shoot) IPVSEnabled() bool

IPVSEnabled returns true if IPVS is enabled for the shoot.

func (*Shoot) IsSelfHosted 

func (s *Shoot) IsSelfHosted() bool

IsSelfHosted returns true in case of a self-hosted shoot cluster.

func (*Shoot) IsShootControlPlaneLoggingEnabled 

func (s *Shoot) IsShootControlPlaneLoggingEnabled(c *gardenletconfigv1alpha1.GardenletConfiguration) bool

IsShootControlPlaneLoggingEnabled return true if the Shoot controlplane logging is enabled

func (*Shoot) RunsControlPlane added in v1.116.1 

func (s *Shoot) RunsControlPlane() bool

RunsControlPlane returns true in case the Kubernetes control plane runs inside the cluster. In contrast to IsSelfHosted, this function returns false when bootstrapping self-hosted shoot clusters using `gardenadm bootstrap` ("managed infrastructure" scenario).

func (*Shoot) SetInfo 

func (s *Shoot) SetInfo(shoot *gardencorev1beta1.Shoot)

SetInfo sets the shoot resource of this Shoot in a concurrency safe way. This method is not protected by a mutex and does not update the shoot resource in the cluster and so should be used only in exceptional situations, or as a convenience in test code. The shoot passed as a parameter MUST NOT BE MODIFIED after the call to SetInfo (except in test code) since this might interfere with other concurrent reads and writes. To properly update the shoot resource of this Shoot use UpdateInfo or UpdateInfoStatus.

func (*Shoot) SetShootState 

func (s *Shoot) SetShootState(shootState *gardencorev1beta1.ShootState)

SetShootState sets the shootstate resource of this Shoot in a concurrency safe way. This method is not protected by a mutex and does not update the shootstate resource in the cluster and so should be used only in exceptional situations, or as a convenience in test code. The shootstate passed as a parameter MUST NOT BE MODIFIED after the call to SetShootState (except in test code) since this might interfere with other concurrent reads and writes. To properly update the shootstate resource of this Shoot use SaveGardenerResourceDataInShootState.

func (*Shoot) UpdateInfo 

func (s *Shoot) UpdateInfo(ctx context.Context, c client.Client, useStrategicMerge, mergeWithOptimisticLock bool, f func(*gardencorev1beta1.Shoot) error) error

UpdateInfo updates the shoot resource of this Shoot in a concurrency safe way, using the given context, client, and mutate function. It copies the current shoot resource and then uses the copy to patch the resource in the cluster using either client.MergeFrom or client.StrategicMergeFrom depending on useStrategicMerge. This method is protected by a mutex, so only a single UpdateInfo or UpdateInfoStatus operation can be executed at any point in time.

func (*Shoot) UpdateInfoStatus 

func (s *Shoot) UpdateInfoStatus(ctx context.Context, c client.Client, useStrategicMerge, mergeWithOptimisticLock bool, f func(*gardencorev1beta1.Shoot) error) error

UpdateInfoStatus updates the status of the shoot resource of this Shoot in a concurrency safe way, using the given context, client, and mutate function. It copies the current shoot resource and then uses the copy to patch the resource in the cluster using either client.MergeFrom or client.StrategicMergeFrom depending on useStrategicMerge. This method is protected by a mutex, so only a single UpdateInfo or UpdateInfoStatus operation can be executed at any point in time.

type SystemComponents 

type SystemComponents struct {
	APIServerProxy      apiserverproxy.Interface
	BlackboxExporter    component.DeployWaiter
	ClusterIdentity     clusteridentity.Interface
	CoreDNS             coredns.Interface
	KubeProxy           kubeproxy.Interface
	MetricsServer       component.DeployWaiter
	Namespaces          component.DeployWaiter
	NodeLocalDNS        nodelocaldns.Interface
	NodeProblemDetector component.DeployWaiter
	NodeExporter        component.DeployWaiter
	Resources           shootsystem.Interface
	VPNShoot            vpnshoot.Interface
}

SystemComponents contains references to system components.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.