utils

Documentation

Index

• func AddVeleroExcludeLabelToObjectMeta(objectMeta *metav1.ObjectMeta)
• func AppendVeleroExcludeLabels(origLabels map[string]string) map[string]string
• func CompareVersion(currentVersion string, minVersion string) int
• func CreateKubeClientSet() (*kubernetes.Clientset, error)
• func CreatePluginClientSet() (*plugin_clientset.Clientset, error)
• func DeleteSvcSnapshot(svcSnapshotName string, gcSnapshotName string, gcSnapshotNamespace string, ...) error
• func GetBackupdriverClient(config *rest.Config) (v1alpha1.BackupdriverV1alpha1Interface, error)
• func GetBool(str string, defValue bool) bool
• func GetCSIClusterType(kubeClient kubernetes.Interface) (constants.ClusterFlavor, error)
• func GetCSIClusterTypeFromEnv(containers []k8sv1.Container) (constants.ClusterFlavor, error)
• func GetCSIInstalledVersion(kubeClient kubernetes.Interface) (string, error)
• func GetCSIVersionFromImage(containers []k8sv1.Container) (string, error)
• func GetClusterFlavor(config *rest.Config) (constants.ClusterFlavor, error)
• func GetComponentFromImage(image string, component string) string
• func GetComponentsFromImage(image string) map[string]string
• func GetDefaultS3PETM(logger logrus.FieldLogger) (*s3repository.ProtectedEntityTypeManager, error)
• func GetIVDPETMFromParamsMap(params map[string]interface{}, logger logrus.FieldLogger) (*ivd.IVDProtectedEntityTypeManager, error)
• func GetKubeClientConfig() (*rest.Config, error)
• func GetS3PETMFromParamsMap(params map[string]interface{}, logger logrus.FieldLogger) (*s3repository.ProtectedEntityTypeManager, error)
• func GetS3SessionOptionsFromParamsMap(params map[string]interface{}, logger logrus.FieldLogger) (session.Options, error)
• func GetStringFromParamsMap(params map[string]interface{}, key string, logger logrus.FieldLogger) (value string, ok bool)
• func GetSupervisorConfig(guestConfig *rest.Config, logger logrus.FieldLogger) (*rest.Config, string, error)
• func GetSupervisorParameters(config *rest.Config, ns string, logger logrus.FieldLogger) (map[string]string, error)
• func GetVcConfigSecretFilterFunc(logger logrus.FieldLogger) func(obj interface{}) bool
• func GetVersionFromImage(containers []k8sv1.Container, imageName string) string
• func IsFeatureEnabled(feature string, defValue bool, logger logrus.FieldLogger) bool
• func ParseLines(lines []string, params map[string]interface{}, logger logrus.FieldLogger)
• func PatchUpload(req *datamover_api.Upload, mutate func(*datamover_api.Upload), ...) (*datamover_api.Upload, error)
• func RetrieveBSLFromBackup(ctx context.Context, backupName string, config *rest.Config, ...) (string, error)
• func RetrieveParamsFromBSL(repositoryParams map[string]string, bslName string, config *rest.Config, ...) error
• func RetrievePodNodesByVolumeId(volumeId string) (string, error)
• func RetrieveVSLFromVeleroBSLs(params map[string]interface{}, bslName string, config *rest.Config, ...) error
• func RetrieveVcConfigSecret(params map[string]interface{}, config *rest.Config, logger logrus.FieldLogger) error
• func RetrieveVddkLogLevel(params map[string]interface{}, logger logrus.FieldLogger) error
• type ClientConfigNotFoundError
  • func NewClientConfigNotFoundError(errMsg string) ClientConfigNotFoundError
  • func (this ClientConfigNotFoundError) Error() string
• type NotFoundError
  • func NewNotFoundError(errMsg string) NotFoundError
  • func (this NotFoundError) Error() string

Functions

func AddVeleroExcludeLabelToObjectMeta

func AddVeleroExcludeLabelToObjectMeta(objectMeta *metav1.ObjectMeta)

Adds the Velero label to exclude this K8S resource from the backup

func AppendVeleroExcludeLabels

func AppendVeleroExcludeLabels(origLabels map[string]string) map[string]string

func CompareVersion

func CompareVersion(currentVersion string, minVersion string) int

If currentVersion < minVersion, return -1 If currentVersion == minVersion, return 0 If currentVersion > minVersion, return 1 Assume input versions are both valid

func CreateKubeClientSet

func CreateKubeClientSet() (*kubernetes.Clientset, error)

func CreatePluginClientSet

func CreatePluginClientSet() (*plugin_clientset.Clientset, error)

func DeleteSvcSnapshot

func DeleteSvcSnapshot(svcSnapshotName string, gcSnapshotName string, gcSnapshotNamespace string, guestConfig *rest.Config, logger logrus.FieldLogger) error

Provide a utility function in guest cluster to clean up corresponding supervisor cluster snapshot CR

func GetBackupdriverClient

func GetBackupdriverClient(config *rest.Config) (v1alpha1.BackupdriverV1alpha1Interface, error)

func GetBool

func GetBool(str string, defValue bool) bool

func GetCSIClusterType

func GetCSIClusterType(kubeClient kubernetes.Interface) (constants.ClusterFlavor, error)

func GetCSIClusterTypeFromEnv

func GetCSIClusterTypeFromEnv(containers []k8sv1.Container) (constants.ClusterFlavor, error)

func GetCSIInstalledVersion

func GetCSIInstalledVersion(kubeClient kubernetes.Interface) (string, error)

func GetCSIVersionFromImage

func GetCSIVersionFromImage(containers []k8sv1.Container) (string, error)

func GetClusterFlavor

func GetClusterFlavor(config *rest.Config) (constants.ClusterFlavor, error)

func GetComponentFromImage

func GetComponentFromImage(image string, component string) string

func GetComponentsFromImage

func GetComponentsFromImage(image string) map[string]string

func GetDefaultS3PETM

func GetDefaultS3PETM(logger logrus.FieldLogger) (*s3repository.ProtectedEntityTypeManager, error)

func GetIVDPETMFromParamsMap

func GetIVDPETMFromParamsMap(params map[string]interface{}, logger logrus.FieldLogger) (*ivd.IVDProtectedEntityTypeManager, error)

func GetKubeClientConfig

func GetKubeClientConfig() (*rest.Config, error)

func GetS3PETMFromParamsMap

func GetS3PETMFromParamsMap(params map[string]interface{}, logger logrus.FieldLogger) (*s3repository.ProtectedEntityTypeManager, error)

func GetS3SessionOptionsFromParamsMap

func GetS3SessionOptionsFromParamsMap(params map[string]interface{}, logger logrus.FieldLogger) (session.Options, error)

func GetStringFromParamsMap

func GetStringFromParamsMap(params map[string]interface{}, key string, logger logrus.FieldLogger) (value string, ok bool)

func GetSupervisorConfig

func GetSupervisorConfig(guestConfig *rest.Config, logger logrus.FieldLogger) (*rest.Config, string, error)

* Get the configuration to access the Supervisor namespace from the GuestCluster. * This routine will be called only for guest cluster. * * The secret to access the Supervisor Cluster will be written in the backup driver * namespace. The steps to get the Supervisor cluster config are: * 1. Create the backup-driver namespace if it does not exist. This is a fixed namespace * where the para virt backup driver secret will be written. * 2. Wait for the para virt backup driver secret to be written. * 3. Get the supervisor cluster configuration from the cert and token in the secret. * TODO: Handle update of the para virt backup driver secret

func GetSupervisorParameters

func GetSupervisorParameters(config *rest.Config, ns string, logger logrus.FieldLogger) (map[string]string, error)

* Get Supervisor parameters present as annotations in the supervisor namespace for the guest. * We do not return all the annotations, but only annotations required but guest cluster plugin.

func GetVcConfigSecretFilterFunc

func GetVcConfigSecretFilterFunc(logger logrus.FieldLogger) func(obj interface{}) bool

func GetVersionFromImage

func GetVersionFromImage(containers []k8sv1.Container, imageName string) string

Return version in the format: vX.Y.Z

func IsFeatureEnabled

func IsFeatureEnabled(feature string, defValue bool, logger logrus.FieldLogger) bool

func ParseLines

func ParseLines(lines []string, params map[string]interface{}, logger logrus.FieldLogger)

func PatchUpload

func PatchUpload(req *datamover_api.Upload, mutate func(*datamover_api.Upload), uploadClient datamover_client.UploadInterface, logger logrus.FieldLogger) (*datamover_api.Upload, error)

func RetrieveBSLFromBackup

func RetrieveBSLFromBackup(ctx context.Context, backupName string, config *rest.Config, logger logrus.FieldLogger) (string, error)

func RetrieveParamsFromBSL

func RetrieveParamsFromBSL(repositoryParams map[string]string, bslName string, config *rest.Config,
	logger logrus.FieldLogger) error

func RetrievePodNodesByVolumeId

func RetrievePodNodesByVolumeId(volumeId string) (string, error)

func RetrieveVSLFromVeleroBSLs

func RetrieveVSLFromVeleroBSLs(params map[string]interface{}, bslName string, config *rest.Config, logger logrus.FieldLogger) error

* Retrieve the Volume Snapshot Location(VSL) as the remote storage location * for the data manager component in plugin from the Backup Storage Locations(BSLs) * of Velero. It will always pick up the first available one.

func RetrieveVcConfigSecret

func RetrieveVcConfigSecret(params map[string]interface{}, config *rest.Config, logger logrus.FieldLogger) error

* In the CSI setup, VC credential is stored as a secret * under the kube-system namespace.

func RetrieveVddkLogLevel

func RetrieveVddkLogLevel(params map[string]interface{}, logger logrus.FieldLogger) error

Types

type ClientConfigNotFoundError

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

func NewClientConfigNotFoundError

func NewClientConfigNotFoundError(errMsg string) ClientConfigNotFoundError

func (ClientConfigNotFoundError) Error

func (this ClientConfigNotFoundError) Error() string

type NotFoundError

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

func NewNotFoundError

func NewNotFoundError(errMsg string) NotFoundError

func (NotFoundError) Error

func (this NotFoundError) Error() string