shoot

Documentation

Index

• Constants
• func ComputeTechnicalID(projectName string, shoot *gardencorev1beta1.Shoot) string
• func ConstructExternalClusterDomain(shoot *gardencorev1beta1.Shoot) *string
• func ConstructExternalDomain(ctx context.Context, client client.Client, shoot *gardencorev1beta1.Shoot, ...) (*garden.Domain, error)
• func ConstructInternalClusterDomain(shootName, shootProject string, internalDomain *garden.Domain) string
• func IsIncompleteDNSConfigError(err error) bool
• func MergeExtensions(registrations []gardencorev1beta1.ControllerRegistration, ...) (map[string]Extension, error)
• func UnfoldTechnicalID(technicalID string) (projectName, shootName string)
• type Extension
• type IncompleteDNSConfigError
  • func (e *IncompleteDNSConfigError) Error() string
• type OperatingSystemConfig
• type OperatingSystemConfigData
• type OperatingSystemConfigs
• type Shoot
  • func New(k8sGardenClient kubernetes.Interface, ...) (*Shoot, error)
  • func (s *Shoot) ComputeAPIServerURL(runsInSeed, useInternalClusterDomain bool, apiServerAddress string) string
  • func (s *Shoot) ComputeCloudConfigSecretName(workerName string) string
  • func (s *Shoot) GetIngressFQDN(subDomain string) string
  • func (s *Shoot) GetNodeCount() int32
  • func (s *Shoot) GetNodeNetwork() *string
  • func (s *Shoot) GetPodNetwork() string
  • func (s *Shoot) GetPurpose() gardencorev1beta1.ShootPurpose
  • func (s *Shoot) GetReplicas(wokenUp int) int
  • func (s *Shoot) GetServiceNetwork() string
  • func (s *Shoot) GetWorkerNames() []string
  • func (s *Shoot) IPVSEnabled() bool
  • func (s *Shoot) KubernetesDashboardEnabled() bool
  • func (s *Shoot) NginxIngressEnabled() bool

Constants

const ExtensionDefaultTimeout = 3 * time.Minute

ExtensionDefaultTimeout is the default timeout and defines how long Gardener should wait for a successful reconciliation of this extension resource.

const TechnicalIDPrefix = "shoot--"

TechnicalIDPrefix is a prefix used for a shoot's technical id.

Functions

func ComputeTechnicalID

func ComputeTechnicalID(projectName string, shoot *gardencorev1beta1.Shoot) string

ComputeTechnicalID determines the technical id of that Shoot which is later used for the name of the namespace and for tagging all the resources created in the infrastructure.

func ConstructExternalClusterDomain

func ConstructExternalClusterDomain(shoot *gardencorev1beta1.Shoot) *string

ConstructExternalClusterDomain constructs the external Shoot cluster domain, i.e. the domain which will be put into the Kubeconfig handed out to the user.

func ConstructExternalDomain

func ConstructExternalDomain(ctx context.Context, client client.Client, shoot *gardencorev1beta1.Shoot, shootSecret *corev1.Secret, defaultDomains []*garden.Domain) (*garden.Domain, error)

ConstructExternalDomain constructs an object containing all relevant information of the external domain that shall be used for a shoot cluster - based on the configuration of the Garden cluster and the shoot itself.

func ConstructInternalClusterDomain

func ConstructInternalClusterDomain(shootName, shootProject string, internalDomain *garden.Domain) string

ConstructInternalClusterDomain constructs the internal base domain pof this shoot cluster. It is only used for internal purposes (all kubeconfigs except the one which is received by the user will only talk with the kube-apiserver via a DNS record of domain). In case the given <internalDomain> already contains "internal", the result is constructed as "<shootName>.<shootProject>.<internalDomain>." In case it does not, the word "internal" will be appended, resulting in "<shootName>.<shootProject>.internal.<internalDomain>".

func IsIncompleteDNSConfigError

func IsIncompleteDNSConfigError(err error) bool

IsIncompleteDNSConfigError returns true if the error indicates that not the DNS config is incomplete.

func MergeExtensions

func MergeExtensions(registrations []gardencorev1beta1.ControllerRegistration, extensions []gardencorev1beta1.Extension, namespace string) (map[string]Extension, error)

MergeExtensions merges the given controller registrations with the given extensions, expecting that each type in extensions is also represented in the registration.

func UnfoldTechnicalID

func UnfoldTechnicalID(technicalID string) (projectName, shootName string)

UnfoldTechnicalID extracts the project and shoot names from Shoot's TechnicalID which is also used for namespace

Types

type Extension

type Extension struct {
	extensionsv1alpha1.Extension
	Timeout time.Duration
}

Extension contains information about the extension api resouce as well as configuration information.

type IncompleteDNSConfigError

type IncompleteDNSConfigError struct{}

IncompleteDNSConfigError is a custom error type.

func (*IncompleteDNSConfigError) Error

func (e *IncompleteDNSConfigError) Error() string

Error prints the error message of the IncompleteDNSConfigError error.

type OperatingSystemConfig

type OperatingSystemConfig struct {
	Name string
	Data OperatingSystemConfigData
}

OperatingSystemConfig contains the operating system config's name and data.

type OperatingSystemConfigData

type OperatingSystemConfigData struct {
	Content string
	Command *string
	Units   []string
}

OperatingSystemConfigData contains the actual content, a command to load it and all units that shall be considered for restart on change.

type OperatingSystemConfigs

type OperatingSystemConfigs struct {
	Downloader OperatingSystemConfig
	Original   OperatingSystemConfig
}

OperatingSystemConfigs contains operating system configs for the downloader script as well as for the original cloud config.

type Shoot

type Shoot struct {
	Info         *gardencorev1beta1.Shoot
	Secret       *corev1.Secret
	CloudProfile *gardencorev1beta1.CloudProfile

	SeedNamespace               string
	KubernetesMajorMinorVersion string

	DisableDNS            bool
	InternalClusterDomain string
	ExternalClusterDomain *string
	ExternalDomain        *garden.Domain

	WantsClusterAutoscaler bool
	WantsAlertmanager      bool
	IgnoreAlerts           bool
	HibernationEnabled     bool

	OperatingSystemConfigsMap map[string]OperatingSystemConfigs
	Extensions                map[string]Extension
	InfrastructureStatus      []byte
	ControlPlaneStatus        []byte
	MachineDeployments        []extensionsv1alpha1.MachineDeployment
}

Shoot is an object containing information about a Shoot cluster.

func New

func New(k8sGardenClient kubernetes.Interface, k8sGardenCoreInformers gardencoreinformers.Interface, shoot *gardencorev1beta1.Shoot, projectName string, disableDNS bool, internalDomain *garden.Domain, defaultDomains []*garden.Domain) (*Shoot, error)

New takes a <k8sGardenClient>, the <k8sGardenCoreInformers> and a <shoot> manifest, and creates a new Shoot representation. It will add the CloudProfile, the cloud provider secret, compute the internal cluster domain and identify the cloud provider.

func (*Shoot) ComputeAPIServerURL

func (s *Shoot) ComputeAPIServerURL(runsInSeed, useInternalClusterDomain bool, apiServerAddress string) string

ComputeAPIServerURL takes a boolean value identifying whether the component connecting to the API server runs in the Seed cluster <runsInSeed>, and a boolean value <useInternalClusterDomain> which determines whether the internal or the external cluster domain should be used.

func (*Shoot) ComputeCloudConfigSecretName

func (s *Shoot) ComputeCloudConfigSecretName(workerName string) string

ComputeCloudConfigSecretName computes the name for a secret which contains the original cloud config for the worker group with the given <workerName>. It is build by the cloud config secret prefix, the worker name itself and a hash of the minor Kubernetes version of the Shoot cluster.

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) GetNodeCount

func (s *Shoot) GetNodeCount() int32

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

func (*Shoot) GetNodeNetwork

func (s *Shoot) GetNodeNetwork() *string

GetNodeNetwork returns the nodes network CIDR for the Shoot cluster. If the infrastructure extension controller has generated a nodes network then this CIDR will take priority. Otherwise, the nodes network CIDR specified in the shoot will be returned (if possible). If no CIDR was specified then nil is returned.

func (*Shoot) GetPodNetwork

func (s *Shoot) GetPodNetwork() string

GetPodNetwork returns the pod network CIDR for the Shoot cluster. If no CIDR was specified then an empty string is returned.

func (*Shoot) GetPurpose

func (s *Shoot) GetPurpose() gardencorev1beta1.ShootPurpose

GetPurpose returns the purpose of the shoot or 'evaluation' if it's nil.

func (*Shoot) GetReplicas

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

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

func (*Shoot) GetServiceNetwork

func (s *Shoot) GetServiceNetwork() string

GetServiceNetwork returns the service network CIDR for the Shoot cluster. If no CIDR was specified then an empty string is returned.

func (*Shoot) GetWorkerNames

func (s *Shoot) GetWorkerNames() []string

GetWorkerNames returns a list of names of the worker groups in the Shoot manifest.

func (*Shoot) IPVSEnabled

func (s *Shoot) IPVSEnabled() bool

IPVSEnabled returns true if IPVS is enabled for the shoot.

func (*Shoot) KubernetesDashboardEnabled

func (s *Shoot) KubernetesDashboardEnabled() bool

KubernetesDashboardEnabled returns true if the kubernetes-dashboard addon is enabled in the Shoot manifest.

func (*Shoot) NginxIngressEnabled

func (s *Shoot) NginxIngressEnabled() bool

NginxIngressEnabled returns true if the nginx-ingress addon is enabled in the Shoot manifest.