Documentation
¶
Index ¶
- Constants
- Variables
- func CentralLoggingConfiguration() (component.CentralLoggingConfig, error)
- func CheckEtcdObject(obj client.Object) error
- func NewBootstrapper(c client.Client, namespace string, kubernetesVersion *semver.Version, ...) component.DeployWaiter
- func NewCRD(c client.Client, applier kubernetes.Applier) component.Deployer
- func NewDependencyWatchdogWeederConfiguration(role string) (map[string]weederapi.DependantSelectors, error)
- type BackupConfig
- type Class
- type Interface
- type Values
Constants ¶
const ( // ClassNormal is a constant for a normal etcd (without extensive metrics or higher resource settings, etc.) ClassNormal Class = "normal" // ClassImportant is a constant for an important etcd (with extensive metrics or higher resource settings, etc.). // Such etcds are also unsafe to evict (from the PoV of the cluster-autoscaler when trying to scale down). ClassImportant Class = "important" // SecretNameClient is the name of the secret containing the client certificate and key for the etcd. SecretNameClient = "etcd-client" // LabelAppValue is the value of a label whose key is 'app'. LabelAppValue = "etcd-statefulset" )
const (
// Druid is a constant for the name of the etcd-druid.
Druid = "etcd-druid"
)
Variables ¶
var ( // DefaultInterval is the default interval for retry operations. DefaultInterval = 5 * time.Second // DefaultSevereThreshold is the default threshold until an error reported by another component is treated as 'severe'. DefaultSevereThreshold = 3 * time.Minute // DefaultTimeout is the default timeout and defines how long Gardener should wait // for a successful reconciliation of an Etcd resource. DefaultTimeout = 5 * time.Minute )
var ( //go:embed crds/templates/crd-druid.gardener.cloud_etcds.yaml // CRD holds the etcd custom resource definition template CRD string )
var ( // TimeNow is a function returning the current time exposed for testing. TimeNow = time.Now )
var TimeoutWaitForManagedResource = 2 * time.Minute
TimeoutWaitForManagedResource is the timeout used while waiting for the ManagedResources to become healthy or deleted.
Functions ¶
func CentralLoggingConfiguration ¶
func CentralLoggingConfiguration() (component.CentralLoggingConfig, error)
CentralLoggingConfiguration returns a fluent-bit parser and filter for the etcd and backup-restore sidecar logs.
func CheckEtcdObject ¶
CheckEtcdObject checks if the given Etcd object was reconciled successfully.
func NewBootstrapper ¶
func NewBootstrapper( c client.Client, namespace string, kubernetesVersion *semver.Version, etcdConfig *config.ETCDConfig, image string, imageVectorOverwrite *string, priorityClassName string, ) component.DeployWaiter
NewBootstrapper creates a new instance of DeployWaiter for the etcd bootstrapper.
func NewDependencyWatchdogWeederConfiguration ¶
func NewDependencyWatchdogWeederConfiguration(role string) (map[string]weederapi.DependantSelectors, error)
NewDependencyWatchdogWeederConfiguration returns the configuration for the dependency watchdog ensuring that its dependant pods are restarted as soon as it recovers from a crash loop.
Types ¶
type BackupConfig ¶
type BackupConfig struct { // Provider is the name of the infrastructure provider for the blob storage bucket. Provider string // Container is the name of the blob storage bucket. Container string // SecretRefName is the name of a Secret object containing the credentials of the selected infrastructure provider. SecretRefName string // Prefix is a prefix that shall be used for the filename of the backups of this etcd. Prefix string // FullSnapshotSchedule is a cron schedule that declares how frequent full snapshots shall be taken. FullSnapshotSchedule string // LeaderElection contains configuration for the leader election for the etcd backup-restore sidecar. LeaderElection *gardenletconfig.ETCDBackupLeaderElection // DeltaSnapshotRetentionPeriod defines the duration for which delta snapshots will be retained, excluding the latest snapshot set. DeltaSnapshotRetentionPeriod *metav1.Duration }
BackupConfig contains information for configuring the backup-restore sidecar so that it takes regularly backups of the etcd's data directory.
type Interface ¶
type Interface interface { component.DeployWaiter // Snapshot triggers the backup-restore sidecar to perform a full snapshot in case backup configuration is provided. Snapshot(context.Context, rest.HTTPClient) error // SetBackupConfig sets the backup configuration. SetBackupConfig(config *BackupConfig) // Get retrieves the Etcd resource Get(context.Context) (*druidv1alpha1.Etcd, error) // Scale scales the etcd resource to the given replica count. Scale(context.Context, int32) error // RolloutPeerCA gets the peer CA and patches the // related `etcd` resource to use this new CA for peer communication. RolloutPeerCA(context.Context) error // GetValues returns the current configuration values of the deployer. GetValues() Values // GetReplicas gets the Replicas field in the Values. GetReplicas() *int32 // SetReplicas sets the Replicas field in the Values. SetReplicas(*int32) }
Interface contains functions for a etcd deployer.
type Values ¶
type Values struct { NamePrefix string Role string Class Class Replicas *int32 StorageCapacity string StorageClassName *string DefragmentationSchedule *string CARotationPhase gardencorev1beta1.CredentialsRotationPhase RuntimeKubernetesVersion *semver.Version BackupConfig *BackupConfig HVPAEnabled bool MaintenanceTimeWindow gardencorev1beta1.MaintenanceTimeWindow ScaleDownUpdateMode *string PriorityClassName string HighAvailabilityEnabled bool TopologyAwareRoutingEnabled bool VPAEnabled bool }
Values are the configuration values for the ETCD.