backupentry

Documentation

Index

• Constants
• Variables
• type Interface
  • func New(log logr.Logger, client client.Client, values *Values, ...) Interface
• type Values

Constants

const (
	// DefaultInterval is the default interval for retry operations.
	DefaultInterval = 5 * time.Second
	// DefaultTimeout is the default timeout and defines how long Gardener should wait
	// for a successful reconciliation of a BackupEntry resource.
	DefaultTimeout = 10 * time.Minute
)

Variables

var TimeNow = time.Now

TimeNow returns the current time. Exposed for testing.

Types

type Interface

type Interface interface {
	component.DeployMigrateWaiter
	// Get retrieves and returns the BackupEntry resource based on the configured values.
	Get(context.Context) (*gardencorev1beta1.BackupEntry, error)
	// GetActualBucketName returns the name of the BackupBucket that this BackupEntry was created with.
	GetActualBucketName() string
	// SetBucketName sets the name of the BackupBucket for this BackupEntry.
	SetBucketName(string)
	// SetForceDeletionAnnotation sets the `backupentry.core.gardener.cloud/force-deletion` annotation
	// on the BackupEntry.
	SetForceDeletionAnnotation(context.Context) error
}

Interface contains functions for a BackupEntry deployer.

func New

func New(
	log logr.Logger,
	client client.Client,
	values *Values,
	waitInterval time.Duration,
	waitTimeout time.Duration,
) Interface

New creates a new instance of DeployWaiter for a BackupEntry.

type Values

type Values struct {
	// Namespace is the namespace of the BackupEntry resource.
	Namespace string
	// Name is the name of the BackupEntry resource.
	Name string
	// ShootPurpose is the purpose of the shoot.
	ShootPurpose *gardencorev1beta1.ShootPurpose
	// OwnerReference is a reference to an owner for BackupEntry resource.
	OwnerReference *metav1.OwnerReference
	// SeedName is the name of the seed to which the BackupEntry shall be scheduled.
	SeedName *string
	// BucketName is the name of the bucket in which the BackupEntry shall be reconciled. This value is only used if the
	// BackupEntry does not exist yet. Otherwise, the existing `.spec.bucketName` will be kept even if the BucketName in
	// these values differs.
	BucketName string
}

Values contains the values used to create a BackupEntry resource.