utils

package
v0.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 26, 2024 License: AGPL-3.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	VolsyncLabelPrefix = "volsync.backube"

	DoNotDeleteLabelKey = VolsyncLabelPrefix + "/do-not-delete"
	OwnedByLabelKey     = "app.kubernetes.io/created-by"
	OwnedByLabelValue   = "volsync"

	SnapInUseByVolumePopulatorLabelPrefix = VolsyncLabelPrefix + "/volpop-pvc-"
)
View Source 
const (
	// Env var - max bytes we will log into the status log
	MoverLogMaxBytesEnvVar      = "MOVER_LOG_MAX_BYTES"
	DefaultMoverLogMaxBytes int = 1024

	// Env var - max lines we will tail from a mover pod to process logs
	// Set to -1 to tail all lines since the mover pod start
	MoverLogTailLinesEnvVar        = "MOVER_LOG_TAIL_LINES"
	DefaultMoverLogTailLines int64 = -1

	// Env var - Set to "true" to log all lines (up to MOVER_LOG_MAX_LINES) of mover logs
	MoverLogDebugEnvVar = "MOVER_LOG_DEBUG"
)
View Source 
const DefaultSCCName = "volsync-privileged-mover" // #nosec G101 - gosec thinks this is a credential

DefaultSCCName is the default name of the volsync security context constraint

View Source 
const (
	ErrUnableToSetControllerRef = "unable to set controller reference"
)

Define the error messages to be returned by VolSync.

Variables

View Source 
var SCCName string

SCCName is the name of the SCC to use for the mover Jobs

Functions

func AddAllLabels added in v0.5.0 

func AddAllLabels(obj Labelable, labels map[string]string) bool

Ensures that all labels in the provided map are present and returns True if an update was made

func AddLabel added in v0.5.0 

func AddLabel(obj Labelable, key string, value string) bool

Ensures that a given key/value label is present and returns True if an update was made

func AllLines added in v0.7.0 

func AllLines(line string) *string

func AppendEnvVarsForClusterWideProxy added in v0.6.1 

func AppendEnvVarsForClusterWideProxy(envVars []corev1.EnvVar) []corev1.EnvVar

func AppendRCloneEnvVars added in v0.9.0 

func AppendRCloneEnvVars(secret *corev1.Secret, envVars []corev1.EnvVar) []corev1.EnvVar

Append k/v from the secret if they start with RCLONE_

func CleanupObjects 

func CleanupObjects(ctx context.Context, c client.Client,
	logger logr.Logger, owner client.Object, types []client.Object) error

CleanupObjects deletes all objects that have been marked. The objects to be cleaned up must have been previously marked via MarkForCleanup() and associated with "owner". The "types" array should contain one object of each type to clean up.

func CleanupSnapshotsWithLabelCheck added in v0.5.0 

func CleanupSnapshotsWithLabelCheck(ctx context.Context, c client.Client,
	logger logr.Logger, owner client.Object, snapList *snapv1.VolumeSnapshotList) error

func ConfigMapHasFields added in v0.8.0 

func ConfigMapHasFields(configMap *corev1.ConfigMap, fields ...string) error

func CreateOrUpdateDeleteOnImmutableErr added in v0.5.0 

func CreateOrUpdateDeleteOnImmutableErr(ctx context.Context, k8sClient client.Client, obj client.Object,
	log logr.Logger, f ctrlutil.MutateFn) (ctrlutil.OperationResult, error)

If an update causes an immutable error, delete the object and return an error (or potentially an error from the delete if the delete fails). The caller should ensure (usually via a requeue) that createOrUpdate is called on the resource again in order for it to be recreated.

func EnvFromSecret 

func EnvFromSecret(secretName string, field string, optional bool) corev1.EnvVar

func FilterLogs added in v0.7.0 

func FilterLogs(reader io.Reader, lineFilter func(line string) *string) (string, error)

Appies lineFilter to each line

func GetAndValidateConfigMap added in v0.8.0 

func GetAndValidateConfigMap(ctx context.Context, cl client.Client,
	logger logr.Logger, configMap *corev1.ConfigMap, fields ...string) error

func GetAndValidateSecret 

func GetAndValidateSecret(ctx context.Context, cl client.Client,
	logger logr.Logger, secret *corev1.Secret, fields ...string) error

func GetCopyTriggerValue added in v0.9.0 

func GetCopyTriggerValue(pvc *corev1.PersistentVolumeClaim) string

func GetLatestCopyTriggerValue added in v0.9.0 

func GetLatestCopyTriggerValue(pvc *corev1.PersistentVolumeClaim) string

func GetLatestCopyTriggerWaitingSinceValue added in v0.9.0 

func GetLatestCopyTriggerWaitingSinceValue(pvc *corev1.PersistentVolumeClaim) string

func GetMoverLogMaxBytes added in v0.7.0 

func GetMoverLogMaxBytes() int

func GetMoverLogTailLines added in v0.7.0 

func GetMoverLogTailLines() int64

func GetNewestPodForJob added in v0.7.0 

func GetNewestPodForJob(ctx context.Context, logger logr.Logger,
	jobName, jobNamespace string, jobFailed bool) (*corev1.Pod, error)

Attempts to get the newest successful pod when jobFailed==false Attempts to get the newest failed pod (or newest running pod if no failed pods) if jobFailed==true

func GetPodsForJob added in v0.7.0 

func GetPodsForJob(ctx context.Context, logger logr.Logger, jobName,
	jobNamespace string) (runningPods []corev1.Pod, successfulPods []corev1.Pod, failedPods []corev1.Pod, err error)

func GetServiceAddress added in v0.5.0 

func GetServiceAddress(svc *corev1.Service) string

GetServiceAddress Returns the address of the given service as a string.

func HasLabel added in v0.5.0 

func HasLabel(obj Labelable, key string) bool

func HasLabelWithValue added in v0.5.0 

func HasLabelWithValue(obj Labelable, key string, value string) bool

func InitPodLogsClient added in v0.7.0 

func InitPodLogsClient(cfg *rest.Config) (*kubernetes.Clientset, error)

func IsCRDNotPresentError added in v0.8.0 

func IsCRDNotPresentError(err error) bool

Check if error is due to the CRD not being present (API kind/group not available) This has changed recently in controller-runtime v0.15.0, see: https://github.com/kubernetes-sigs/controller-runtime/pull/2116

func IsMarkedDoNotDelete added in v0.5.0 

func IsMarkedDoNotDelete(snapshot *snapv1.VolumeSnapshot) bool

func IsMoverLogDebug added in v0.7.0 

func IsMoverLogDebug() bool

func IsOwnedByVolsync added in v0.5.0 

func IsOwnedByVolsync(obj Labelable) bool

Returns True if the object contains a label indicating that it was created by VolSync

func IsSnapshot added in v0.8.0 

func IsSnapshot(image *corev1.TypedLocalObjectReference) bool

func KindAndName added in v0.5.0 

func KindAndName(scheme *runtime.Scheme, obj client.Object) string

func MarkDoNotDelete added in v0.8.0 

func MarkDoNotDelete(snapshot *snapv1.VolumeSnapshot) bool

func MarkForCleanup 

func MarkForCleanup(owner metav1.Object, obj metav1.Object) bool

MarkForCleanup marks the provided "obj" to be deleted at the end of the synchronization iteration.

func MarkOldSnapshotForCleanup added in v0.4.0 

func MarkOldSnapshotForCleanup(ctx context.Context, c client.Client, logger logr.Logger,
	owner metav1.Object, oldImage, latestImage *corev1.TypedLocalObjectReference) error

func PVCUsesCopyTrigger added in v0.9.0 

func PVCUsesCopyTrigger(pvc *corev1.PersistentVolumeClaim) bool

func PrivilegedMoversOk added in v0.6.0 

func PrivilegedMoversOk(ctx context.Context, cl client.Client, logger logr.Logger,
	namespace string) (bool, error)

func PvcIsBlockMode added in v0.8.0 

func PvcIsBlockMode(pvc *corev1.PersistentVolumeClaim) bool

func PvcIsReadOnly added in v0.6.0 

func PvcIsReadOnly(pvc *corev1.PersistentVolumeClaim) bool

func ReconcileBatch 

func ReconcileBatch(l logr.Logger, reconcileFuncs ...ReconcileFunc) (bool, error)

reconcileBatch steps through a list of reconcile functions until one returns false or an error.

func RelinquishOwnedSnapshotsWithDoNotDeleteLabel added in v0.5.0 

func RelinquishOwnedSnapshotsWithDoNotDeleteLabel(ctx context.Context, c client.Client,
	logger logr.Logger, owner client.Object) error

func RemoveLabel added in v0.5.0 

func RemoveLabel(obj Labelable, key string) bool

Removes the given key from the object's labels and returns True if an update was made

func RemoveOwnedByVolSync added in v0.5.0 

func RemoveOwnedByVolSync(obj Labelable) bool

Removes the "created by Volsync" label

func RemoveOwnerReference added in v0.8.0 

func RemoveOwnerReference(obj metav1.Object, owner client.Object) bool

func RemoveSnapOwnershipAndLabelsIfRequestedAndUpdate added in v0.8.0 

func RemoveSnapOwnershipAndLabelsIfRequestedAndUpdate(ctx context.Context, c client.Client, logger logr.Logger,
	owner client.Object, snapshot *snapv1.VolumeSnapshot) (bool, error)

func SecretHasFields added in v0.4.0 

func SecretHasFields(secret *corev1.Secret, fields ...string) error

func SetLatestCopyStatusCompleted added in v0.9.0 

func SetLatestCopyStatusCompleted(pvc *corev1.PersistentVolumeClaim) bool

Returns true if the pvc was updated

func SetLatestCopyStatusInProgress added in v0.9.0 

func SetLatestCopyStatusInProgress(pvc *corev1.PersistentVolumeClaim) bool

Returns true if the pvc was updated

func SetLatestCopyStatusWaitingForTrigger added in v0.9.0 

func SetLatestCopyStatusWaitingForTrigger(pvc *corev1.PersistentVolumeClaim) bool

Returns true if the pvc was updated

func SetLatestCopyTriggerValue added in v0.9.0 

func SetLatestCopyTriggerValue(pvc *corev1.PersistentVolumeClaim, value string) bool

Returns true if the pvc was updated

func SetLatestCopyTriggerWaitingSinceValueNow added in v0.9.0 

func SetLatestCopyTriggerWaitingSinceValueNow(pvc *corev1.PersistentVolumeClaim) bool

Returns true if the pvc was updated

func SetOwnedByVolSync added in v0.5.0 

func SetOwnedByVolSync(obj Labelable) bool

Sets a label on the object to indicate it was created by VolSync

func TruncateString added in v0.7.0 

func TruncateString(s string, maxBytes int) string

func UnMarkForCleanupAndRemoveOwnership added in v0.5.0 

func UnMarkForCleanupAndRemoveOwnership(obj metav1.Object, owner client.Object) bool

func UnmarkForCleanup added in v0.5.0 

func UnmarkForCleanup(obj metav1.Object) bool

UnmarkForCleanup removes any previously applied cleanup label

func UpdateMoverStatusFailed added in v0.9.0 

func UpdateMoverStatusFailed(moverStatus *volsyncv1alpha1.MoverStatus, errMessage string)

Updates mover status to failed and puts the errMessage as the logs

func UpdateMoverStatusForFailedJob added in v0.7.0 

func UpdateMoverStatusForFailedJob(ctx context.Context, logger logr.Logger,
	moverStatus *volsyncv1alpha1.MoverStatus, jobName, jobNamespace string, logLineFilter func(string) *string)

func UpdateMoverStatusForSuccessfulJob added in v0.7.0 

func UpdateMoverStatusForSuccessfulJob(ctx context.Context, logger logr.Logger,
	moverStatus *volsyncv1alpha1.MoverStatus, jobName, jobNamespace string, logLineFilter func(string) *string)

func UpdatePodTemplateSpecFromMoverConfig added in v0.9.0 

func UpdatePodTemplateSpecFromMoverConfig(podTemplateSpec *corev1.PodTemplateSpec,
	moverConfig volsyncv1alpha1.MoverConfig, defaultMoverResources corev1.ResourceRequirements)

Updates to set the securityContext, podLabels on mover pod in the spec and resourceRequirements on the mover containers based on what is set in the MoverConfig

Types

type AffinityInfo added in v0.5.0 

type AffinityInfo struct {
	NodeSelector map[string]string
	Tolerations  []corev1.Toleration
}

func AffinityFromVolume added in v0.5.0 

func AffinityFromVolume(ctx context.Context, c client.Client, logger logr.Logger,
	pvc *corev1.PersistentVolumeClaim) (*AffinityInfo, error)

Determine the proper affinity to apply based on the current users of a PVC

type CustomCAObject added in v0.8.0 

type CustomCAObject interface {
	// path should be the relative path to filename (key contents will get projected here)
	GetVolumeSource(path string) corev1.VolumeSource
}

CustomCAObject will generate the appropriate volumesource for attaching to a podspec from a source customca secret or configmap. Use ValidateCustomCA() to validate a CustomCASpec and return a CustomCAObject.

func ValidateCustomCA added in v0.8.0 

func ValidateCustomCA(ctx context.Context, cl client.Client, l logr.Logger,
	namespace string, customCA volsyncv1alpha1.CustomCASpec) (CustomCAObject, error)

type CustomCAObjectConfigMap added in v0.8.0 

type CustomCAObjectConfigMap struct {
	// contains filtered or unexported fields
}

func (*CustomCAObjectConfigMap) GetVolumeSource added in v0.8.0 

func (c *CustomCAObjectConfigMap) GetVolumeSource(path string) corev1.VolumeSource

type CustomCAObjectSecret added in v0.8.0 

type CustomCAObjectSecret struct {
	// contains filtered or unexported fields
}

func (*CustomCAObjectSecret) GetVolumeSource added in v0.8.0 

func (c *CustomCAObjectSecret) GetVolumeSource(path string) corev1.VolumeSource

type Labelable added in v0.5.0 

type Labelable interface {
	GetLabels() map[string]string
	SetLabels(labels map[string]string)
}

type ReconcileFunc 

type ReconcileFunc func(logr.Logger) (bool, error)

reconcileFunc is a function that partially reconciles an object. It returns a bool indicating whether reconciling should continue and an error.

type SAHandler 

type SAHandler interface {
	Reconcile(ctx context.Context, l logr.Logger) (*corev1.ServiceAccount, error)
}

func NewSAHandler 

func NewSAHandler(c client.Client, owner metav1.Object, isSource,
	privileged bool, userSuppliedSA *string) SAHandler

type SAHandlerUserSupplied added in v0.7.0 

type SAHandlerUserSupplied struct {
	Client client.Client
	SA     *corev1.ServiceAccount
}

func (*SAHandlerUserSupplied) Reconcile added in v0.7.0 

func (d *SAHandlerUserSupplied) Reconcile(ctx context.Context, l logr.Logger) (*corev1.ServiceAccount, error)

type SAHandlerVolSync added in v0.7.0 

type SAHandlerVolSync struct {
	Context    context.Context
	Client     client.Client
	SA         *corev1.ServiceAccount
	Owner      metav1.Object
	Privileged bool
	// contains filtered or unexported fields
}

func (*SAHandlerVolSync) Reconcile added in v0.7.0 

func (d *SAHandlerVolSync) Reconcile(ctx context.Context, l logr.Logger) (*corev1.ServiceAccount, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.