component

Documentation

Index

• type BootstrapSeed
• type DeployMigrateWaiter
• type DeployWaiter
  • func NoOp() DeployWaiter
  • func OpDestroy(dw ...DeployWaiter) DeployWaiter
• type Deployer
  • func OpDestroyAndWait(dw ...DeployWaiter) Deployer
  • func OpWaiter(dw ...DeployWaiter) Deployer
• type LoggingConfig
• type LoggingConfiguration
• type MigrateWaiter
• type Migrator
• type MonitoringComponent
• type Phase
  • func (s Phase) Done() Phase
• type Secret
• type Waiter

Types

type BootstrapSeed

type BootstrapSeed func(ctx context.Context, c client.Client, namespace, version string) error

BootstrapSeed is a function alias for components that require to bootstrap the seed cluster.

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 OpDestroy

func OpDestroy(dw ...DeployWaiter) DeployWaiter

OpDestroy creates a DeployWaiter which calls Destroy instead of create and WaitCleanup instead of 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 OpDestroyAndWait

func OpDestroyAndWait(dw ...DeployWaiter) Deployer

OpDestroyAndWait creates a Deployer which calls Destroy instead of create and waits for destruction.

func OpWaiter

func OpWaiter(dw ...DeployWaiter) Deployer

OpWaiter creates a Deployer which calls waits for each operation.

type LoggingConfig

type LoggingConfig struct {
	// Filters contains the filters for specific component
	Filters string
	// Parser contains the parsers for specific component
	Parsers string
	// PodPrefix is the prefix of the pod name
	PodPrefix string
	// UserExposed defines if the component is exposed to the end-user
	UserExposed bool
}

LoggingConfig is a structure that contains additional Fluentbit filters and parsers

type LoggingConfiguration

type LoggingConfiguration func() (LoggingConfig, error)

LoggingConfiguration is a function alias for returning logging parsers and filters.

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 configurationsv 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
	// PhaseEnabled 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 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
}

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.