component

Documentation

Index

• func AllApplicationObjects(configsLists ...ResourceConfigs) []client.Object
• func AllRuntimeObjects(configsLists ...ResourceConfigs) []client.Object
• func DeployResourceConfigs(ctx context.Context, c client.Client, namespace string, ...) error
• func DestroyResourceConfigs(ctx context.Context, c client.Client, namespace string, ...) error
• type AggregateMonitoringConfig
• type AggregateMonitoringConfiguration
• type CentralLoggingConfig
• type CentralLoggingConfiguration
• type CentralMonitoringConfig
• type CentralMonitoringConfiguration
• type Class
• type ClusterType
• type DeployMigrateWaiter
• type DeployWaiter
  • func NoOp() DeployWaiter
  • func OpDestroyAndWait(dw ...Deployer) DeployWaiter
  • func OpDestroyWithoutWait(dw ...Deployer) DeployWaiter
  • func OpWait(dw ...Deployer) DeployWaiter
• type Deployer
  • func OpDestroy(d ...Deployer) Deployer
• type MigrateWaiter
• type Migrator
• type MonitoringComponent
• type Phase
  • func (s Phase) Done() Phase
• type ResourceConfig
• type ResourceConfigs
  • func MergeResourceConfigs(configsLists ...ResourceConfigs) ResourceConfigs
• type Secret
• type Waiter

Functions

func AllApplicationObjects

func AllApplicationObjects(configsLists ...ResourceConfigs) []client.Object

AllApplicationObjects returns all objects of class Application from the provided ResourceConfigs lists.

func AllRuntimeObjects

func AllRuntimeObjects(configsLists ...ResourceConfigs) []client.Object

AllRuntimeObjects returns all objects of class Runtime from the provided ResourceConfigs lists.

func DeployResourceConfigs

func DeployResourceConfigs(
	ctx context.Context,
	c client.Client,
	namespace string,
	clusterType ClusterType,
	managedResourceName string,
	registry *managedresources.Registry,
	allResources ResourceConfigs,
) error

DeployResourceConfigs deploys the provided ResourceConfigs <allResources> based on the ClusterType. For seeds, all resources are deployed via a single ManagedResource (independent of their Class). For shoots, all Runtime resources are applied directly with the client while all Application resources are deployed via a ManagedResource.

func DestroyResourceConfigs

func DestroyResourceConfigs(
	ctx context.Context,
	c client.Client,
	namespace string,
	clusterType ClusterType,
	managedResourceName string,
	resourceConfigs ...ResourceConfigs,
) error

DestroyResourceConfigs destroys the provided ResourceConfigs <allResources> based on the ClusterType. For seeds, all resources are deleted indirectly by deleting the ManagedResource. For shoots, all Runtime resources are deleted directly with the client while all Application resources are deleted indirectly by deleting the ManagedResource.

Types

type AggregateMonitoringConfig

type AggregateMonitoringConfig struct {
	// ScrapeConfigs are the scrape configurations for aggregate Prometheus.
	ScrapeConfigs []string
}

AggregateMonitoringConfig is a structure that contains configuration for the aggregate monitoring stack.

type AggregateMonitoringConfiguration

type AggregateMonitoringConfiguration func() (AggregateMonitoringConfig, error)

AggregateMonitoringConfiguration is a function alias for returning configuration for the aggregate monitoring.

type CentralLoggingConfig

type CentralLoggingConfig struct {
	// Filters contains the filters for specific component.
	Filters string
	// Parser contains the parsers for specific component.
	Parsers string
	// UserExposed defines if the component is exposed to the end-user.
	UserExposed bool
	// PodPrefixes is the list of prefixes of the pod names when logging config is user-exposed.
	PodPrefixes []string
}

CentralLoggingConfig is a structure that contains configuration for the central logging stack.

type CentralLoggingConfiguration

type CentralLoggingConfiguration func() (CentralLoggingConfig, error)

CentralLoggingConfiguration is a function alias for returning configuration for the central logging.

type CentralMonitoringConfig

type CentralMonitoringConfig struct {
	// ScrapeConfigs are the scrape configurations for central Prometheus.
	ScrapeConfigs []string
	// CAdvisorScrapeConfigMetricRelabelConfigs are metric_relabel_configs for the cadvisor scrape config job.
	CAdvisorScrapeConfigMetricRelabelConfigs []string
}

CentralMonitoringConfig is a structure that contains configuration for the central monitoring stack.

type CentralMonitoringConfiguration

type CentralMonitoringConfiguration func() (CentralMonitoringConfig, error)

CentralMonitoringConfiguration is a function alias for returning configuration for the central monitoring.

type Class

type Class uint8

Class is a type alias for describing the class of a resource.

const (
	// Runtime means that the resource belongs to the runtime cluster (seed).
	Runtime Class = iota
	// Application means that the resource belongs to the target cluster (shoot).
	Application
)

type ClusterType

type ClusterType string

ClusterType is a type alias for a cluster type.

const (
	// ClusterTypeSeed is a constant for the 'seed' cluster type.
	ClusterTypeSeed ClusterType = "seed"
	// ClusterTypeShoot is a constant for the 'shoot' cluster type.
	ClusterTypeShoot ClusterType = "shoot"
)

type DeployMigrateWaiter

type DeployMigrateWaiter interface {
	Deployer
	Migrator
	MigrateWaiter
	Waiter
}

DeployMigrateWaiter controls and waits for the life-cycle and control-plane migration operations of a component.

type DeployWaiter

type DeployWaiter interface {
	Deployer
	Waiter
}

DeployWaiter controls and waits for life-cycle operations of a component.

func NoOp

func NoOp() DeployWaiter

NoOp does nothing.

func OpDestroyAndWait

func OpDestroyAndWait(dw ...Deployer) DeployWaiter

OpDestroyAndWait creates a DeployWaiter which calls Destroy instead of Deploy, and WaitCleanup.

func OpDestroyWithoutWait

func OpDestroyWithoutWait(dw ...Deployer) DeployWaiter

OpDestroyWithoutWait creates a DeployWaiter which calls Destroy instead of Deploy.

func OpWait

func OpWait(dw ...Deployer) DeployWaiter

OpWait creates a DeployWaiter which calls Wait .

type Deployer

type Deployer interface {
	// Deploy a component.
	Deploy(ctx context.Context) error
	// Destroy already deployed component.
	Destroy(ctx context.Context) error
}

Deployer is used to control the life-cycle of a component.

func OpDestroy

func OpDestroy(d ...Deployer) Deployer

OpDestroy creates a Deployer which calls Destroy instead of Deploy.

type MigrateWaiter

type MigrateWaiter interface {
	WaitMigrate(ctx context.Context) error
}

MigrateWaiter waits for the control-plane migration operations of a component to finish.

type Migrator

type Migrator interface {
	Restore(ctx context.Context, shootState *v1alpha1.ShootState) error
	Migrate(ctx context.Context) error
}

Migrator is used to control the control-plane migration operations of a component.

type MonitoringComponent

type MonitoringComponent interface {
	// ScrapeConfigs returns the scrape configurations for Prometheus.
	ScrapeConfigs() ([]string, error)
	// AlertingRules returns the alerting rules configs for AlertManager (mapping file name to rule config).
	AlertingRules() (map[string]string, error)
}

MonitoringComponent exposes configuration for Prometheus as well as the AlertManager.

type Phase

type Phase int

Phase is the phase of a component.

const (
	// PhaseUnknown is in an unknown component phase.
	PhaseUnknown Phase = iota
	// PhaseEnabled is when a component was enabled before and it's still active.
	PhaseEnabled
	// PhaseDisabled is when a component was disabled before and it's still disabled.
	PhaseDisabled
	// PhaseEnabling is when a component was disabled before, but it's being activated.
	PhaseEnabling
	// PhaseDisabling is when a component was enabled before, but it's being disabled.
	PhaseDisabling
)

func (Phase) Done

func (s Phase) Done() Phase

Done returns a completed phase. e.g. Enabling -> Enabled Disabling -> Disabled otherwise returns the same phase.

type ResourceConfig

type ResourceConfig struct {
	Obj      client.Object
	Class    Class
	MutateFn func()
}

ResourceConfig contains the configuration for a resource. More concretely, it specifies the class and a mutation function MutateFn which should mutate the specification of the provided object Obj.

type ResourceConfigs

type ResourceConfigs []ResourceConfig

ResourceConfigs is a list of multiple ResourceConfig objects.

func MergeResourceConfigs

func MergeResourceConfigs(configsLists ...ResourceConfigs) ResourceConfigs

MergeResourceConfigs merges the provided ResourceConfigs lists into a new ResourceConfigs object.

type Secret

type Secret struct {
	// Name is the name of the Kubernetes secret object.
	Name string
	// Checksum is the checksum of the secret's data.
	Checksum string
	// Data is the data of the secret.
	Data map[string][]byte
}

Secret is a structure that contains information about a Kubernetes secret which is managed externally.

type Waiter

type Waiter interface {
	// Wait for deployment to finish and component to report ready.
	Wait(ctx context.Context) error
	// WaitCleanup for destruction to finish and component to be fully removed.
	WaitCleanup(ctx context.Context) error
}

Waiter waits for life-cycle operations of a component to finish.