utils

Jun 25, 2024

Changes in this version

+ func AppendDebugMoverEnvVar(replicationSourceOrDestObj metav1.Object, envVars []corev1.EnvVar) []corev1.EnvVar

Feb 22, 2024

Changes in this version

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

+ func GetCopyTriggerValue(pvc *corev1.PersistentVolumeClaim) string

+ func GetLatestCopyTriggerValue(pvc *corev1.PersistentVolumeClaim) string

+ func GetLatestCopyTriggerWaitingSinceValue(pvc *corev1.PersistentVolumeClaim) string

+ func PVCUsesCopyTrigger(pvc *corev1.PersistentVolumeClaim) bool

+ func SetLatestCopyStatusCompleted(pvc *corev1.PersistentVolumeClaim) bool

+ func SetLatestCopyStatusInProgress(pvc *corev1.PersistentVolumeClaim) bool

+ func SetLatestCopyStatusWaitingForTrigger(pvc *corev1.PersistentVolumeClaim) bool

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

+ func SetLatestCopyTriggerWaitingSinceValueNow(pvc *corev1.PersistentVolumeClaim) bool

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

+ func UpdatePodTemplateSpecFromMoverConfig(podTemplateSpec *corev1.PodTemplateSpec, ...)

Oct 30, 2023

Changes in this version

+ const SnapInUseByVolumePopulatorLabelPrefix

+ const VolsyncLabelPrefix

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

+ func GetAndValidateConfigMap(ctx context.Context, cl client.Client, logger logr.Logger, ...) error

+ func IsCRDNotPresentError(err error) bool

+ func IsSnapshot(image *corev1.TypedLocalObjectReference) bool

+ func MarkDoNotDelete(snapshot *snapv1.VolumeSnapshot) bool

+ func PvcIsBlockMode(pvc *corev1.PersistentVolumeClaim) bool

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

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

+ type CustomCAObject interface

+ GetVolumeSource func(path string) corev1.VolumeSource

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

+ type CustomCAObjectConfigMap struct

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

+ type CustomCAObjectSecret struct

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

Mar 3, 2023

Changes in this version

+ const DefaultMoverLogMaxBytes

+ const DefaultMoverLogTailLines

+ const MoverLogDebugEnvVar

+ const MoverLogMaxBytesEnvVar

+ const MoverLogTailLinesEnvVar

+ func AllLines(line string) *string

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

+ func GetMoverLogMaxBytes() int

+ func GetMoverLogTailLines() int64

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

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

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

+ func IsMoverLogDebug() bool

+ func TruncateString(s string, maxBytes int) string

+ func UpdateMoverStatusForFailedJob(ctx context.Context, logger logr.Logger, ...)

+ func UpdateMoverStatusForSuccessfulJob(ctx context.Context, logger logr.Logger, ...)

+ type SAHandlerUserSupplied struct

+ Client client.Client

+ SA *corev1.ServiceAccount

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

+ type SAHandlerVolSync struct

+ Client client.Client

+ Context context.Context

+ Owner metav1.Object

+ Privileged bool

+ SA *corev1.ServiceAccount

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

Feb 28, 2023

Changes in this version

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

Feb 23, 2023

Changes in this version

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

+ func PvcIsReadOnly(pvc *corev1.PersistentVolumeClaim) bool

type SAHandler

+ Privileged bool

Sep 15, 2022

Changes in this version

+ const DoNotDeleteLabelKey

+ const ErrUnableToSetControllerRef

+ const OwnedByLabelKey

+ const OwnedByLabelValue

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

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

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

+ func CreateOrUpdateDeleteOnImmutableErr(ctx context.Context, k8sClient client.Client, obj client.Object, ...) (ctrlutil.OperationResult, error)

+ func GetServiceAddress(svc *corev1.Service) string

+ func HasLabel(obj Labelable, key string) bool

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

+ func IsMarkedDoNotDelete(snapshot *snapv1.VolumeSnapshot) bool

+ func IsOwnedByVolsync(obj Labelable) bool

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

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

+ func RemoveLabel(obj Labelable, key string) bool

+ func RemoveOwnedByVolSync(obj Labelable) bool

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

+ func SetOwnedByVolSync(obj Labelable) bool

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

+ func UnmarkForCleanup(obj metav1.Object) bool

+ type AffinityInfo struct

+ NodeSelector map[string]string

+ Tolerations []corev1.Toleration

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

+ type Labelable interface

+ GetLabels func() map[string]string

+ SetLabels func(labels map[string]string)

Mar 28, 2022

Changes in this version

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

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

Aug 5, 2021

Changes in this version

+ const DefaultSCCName

+ var SCCName string

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

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

+ func GetAndValidateSecret(ctx context.Context, client client.Client, logger logr.Logger, ...) error

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

+ func NameFor(obj metav1.Object) types.NamespacedName

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

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

+ type SAHandler struct

+ Client client.Client

+ Context context.Context

+ Owner metav1.Object

+ SA *corev1.ServiceAccount

+ func NewSAHandler(ctx context.Context, c client.Client, owner metav1.Object, ...) SAHandler

+ func (d *SAHandler) Reconcile(l logr.Logger) (bool, error)