utils

package
v0.0.0-...-86eb79a Latest Latest
Warning

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

 Go to latest Published: Sep 8, 2025 License: Apache-2.0 Imports: 46 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ODFInfoConfigMapName                = "odf-info"
	ConfigMapResourceType               = "ConfigMap"
	ClientInfoConfigMapName             = "odf-client-info"
	StorageClientMappingConfigMapName   = "storage-client-mapping"
	StorageClusterPeerNameAnnotationKey = "ocs.openshift.io/storage-cluster-peer"
)
View Source 
const (
	BucketGenerateName = "odrbucket"

	// s3
	S3ProfilePrefix    = "s3profile"
	S3Endpoint         = "s3CompatibleEndpoint"
	S3BucketName       = "s3Bucket"
	S3ProfileName      = "s3ProfileName"
	S3Region           = "s3Region"
	AwsAccessKeyId     = "AWS_ACCESS_KEY_ID"
	AwsSecretAccessKey = "AWS_SECRET_ACCESS_KEY"

	// ramen
	RamenHubOperatorConfigName = "ramen-hub-operator-config"

	// handlers
	RookSecretHandlerName       = "rook"
	S3SecretHandlerName         = "s3"
	DRModeAnnotationKey         = "multicluster.openshift.io/mode"
	MirrorPeerNameAnnotationKey = "multicluster.odf.openshift.io/mirrorpeer"
	HubOperatorNamespaceKey     = "hub.multicluster.odf.openshift.io/operator-namespace"
)
View Source 
const (
	InternalLabel                   SecretLabelType = "INTERNAL"
	IgnoreLabel                     SecretLabelType = "IGNORE"
	ProviderLabel                   SecretLabelType = "PROVIDER"
	SecretLabelTypeKey                              = "multicluster.odf.openshift.io/secret-type"
	CreatedByLabelKey                               = "multicluster.odf.openshift.io/created-by"
	ObjectKindLabelKey                              = "multicluster.odf.openshift.io/object-kind"
	CreatorMulticlusterOrchestrator                 = "odf-multicluster-orchestrator"
	NamespaceKey                                    = "namespace"
	StorageClusterNameKey                           = "storage-cluster-name"
	SecretDataKey                                   = "secret-data"
	SecretOriginKey                                 = "secret-origin"
	MirrorPeerSecret                                = "mirrorpeersecret"
	HubRecoveryLabel                                = "cluster.open-cluster-management.io/backup"
)
View Source 
const (
	RBDType                                   CephType = "rbd"
	CephFSType                                CephType = "cephfs"
	RBDProvisionerTemplate                             = "%s.rbd.csi.ceph.com"
	CephFSProvisionerTemplate                          = "%s.cephfs.csi.ceph.com"
	DefaultVirtualizationStorageClassName              = "%s-ceph-rbd-virtualization"
	DefaultCephRBDStorageClassTemplate                 = "%s-ceph-rbd"
	DefaultRadosNamespaceStorageClassTemplate          = "%s-ceph-rbd-rados-namespace-"
	DefaultCephFSStorageClassTemplate                  = "%s-cephfs"
	DefaultSubvolumeGroup                              = "csi"
	DefaultRadosNamespace                              = ""
)
View Source 
const (
	DefaultCephFSVSCNameTemplate   = "%s-cephfsplugin-snapclass"
	DefaultRBDVSCNameTemplate      = "%s-rbdplugin-snapclass"
	DefaultCephFSVSCDriverTemplate = "%s.cephfs.csi.ceph.com"
	DefaultRBDVSCDriverTemplate    = "%s.rbd.csi.ceph.com"
)
View Source 
const MCVLabelKey = "multicluster.odf.openshift.io/cluster"
View Source 
const MCVNameTemplate = "odf-multicluster-mcv-%s"
View Source 
const (
	OdfInfoClusterClaimNamespacedName = "odfinfo.odf.openshift.io"
)

Variables

View Source 
var (
	Eq operator = "eq"
	Lt operator = "lt"
	Gt operator = "gt"
)
View Source 
var InternalSecretPredicate = predicate.Funcs{
	CreateFunc: func(e event.CreateEvent) bool {
		return IsSecretInternal(e.Object)
	},
	DeleteFunc: func(e event.DeleteEvent) bool {
		return IsSecretInternal(e.Object)
	},
	UpdateFunc: func(e event.UpdateEvent) bool {
		return (IsSecretInternal(e.ObjectOld) && IsSecretInternal(e.ObjectNew))
	},
	GenericFunc: func(_ event.GenericEvent) bool {
		return false
	},
}
View Source 
var OriginMap = map[string]string{"RookOrigin": "rook", "S3Origin": "S3"}

Functions

func CalculateMD5Hash 

func CalculateMD5Hash(value any) string

func CalculateStorageId 

func CalculateStorageId(ctx context.Context, c client.Client, sc storagev1.StorageClass, storageClusterNamespacedName types.NamespacedName) (string, error)

func CompareSemverMajorMinorVersions 

func CompareSemverMajorMinorVersions(v1, v2 string, opr operator) (bool, error)

func ContainsPeerRef 

func ContainsPeerRef(slice []multiclusterv1alpha1.PeerRef, peerRef *multiclusterv1alpha1.PeerRef) bool

ContainsPeerRef checks if a slice of PeerRef contains the provided PeerRef

func ContainsString 

func ContainsString(slice []string, s string) bool

ContainsString checks if a slice of strings contains the provided string

func ContainsSubject 

func ContainsSubject(slice []rbacv1.Subject, subject *rbacv1.Subject) bool

func ContainsSuffix 

func ContainsSuffix(slice []string, s string) bool

func CreateOrUpdateManagedClusterView 

func CreateOrUpdateManagedClusterView(ctx context.Context, client ctrlClient.Client, resourceToFindName string, resourceToFindNamespace string, resourceToFindType string, clusterName string, ownerRef *metav1.OwnerReference) (*viewv1beta1.ManagedClusterView, controllerutil.OperationResult, error)

func CreateOrUpdateManifestWork 

func CreateOrUpdateManifestWork(ctx context.Context, c client.Client, name string, namespace string, objJson []byte, manifestConfigOptions []workv1.ManifestConfigOption, ownerRef metav1.OwnerReference) (controllerutil.OperationResult, error)

func CreateOrUpdateObjectBucketClaim 

func CreateOrUpdateObjectBucketClaim(ctx context.Context, c client.Client, bucketName, bucketNamespace string, annotations map[string]string) (controllerutil.OperationResult, error)

func CreateOrUpdateSecretsFromInternalSecret 

func CreateOrUpdateSecretsFromInternalSecret(ctx context.Context, rc client.Client, scheme *runtime.Scheme, currentNamespace string, secret *corev1.Secret, mirrorPeer multiclusterv1alpha1.MirrorPeer, logger *slog.Logger) error

func CreateUniqueName 

func CreateUniqueName(params ...string) string

CreateUniqueName function creates a sha512 hex sum from the given parameters

func CreateUniqueSecretName 

func CreateUniqueSecretName(managedCluster, storageClusterNamespace, storageClusterName string, prefix ...string) string

CreateUniqueSecretName function creates a name of 40 chars using sha512 hex sum from the given parameters

func CreateUniqueSecretNameForClient 

func CreateUniqueSecretNameForClient(providerKey, clientKey1, clientKey2 string) string

func DecodeConfigMap 

func DecodeConfigMap(objJson []byte) (*corev1.ConfigMap, error)

func DoesAnotherMirrorPeerPointToPeerRef 

func DoesAnotherMirrorPeerPointToPeerRef(ctx context.Context, rc client.Client, peerRef *multiclusterv1alpha1.PeerRef) (bool, error)

DoesAnotherMirrorPeerPointToPeerRef checks if another mirrorpeer is pointing to the provided peer ref

func EventTypePredicate 

func EventTypePredicate(create, update, del, generic bool) predicate.Predicate

EventTypePredicate return a predicate to filter events based on their respective event type. This helper allows for the selection of multiple types resulting in a predicate that can filter in more than a single event type

func FetchAllMirrorPeers 

func FetchAllMirrorPeers(ctx context.Context, rc client.Client) ([]multiclusterv1alpha1.MirrorPeer, error)

func FetchAllSecretsWithLabel 

func FetchAllSecretsWithLabel(ctx context.Context, rc client.Client, namespace string, secretLabelType SecretLabelType) ([]corev1.Secret, error)

FetchAllSecretsWithLabel will get all the internal secrets in the namespace and with the provided label if the namespace is empty, it will fetch from all the namespaces if the label type is 'Ignore', it will fetch all the internal secrets (both source and destination)

func FetchCephCluster 

func FetchCephCluster(ctx context.Context, c client.Client, storageClusterNamespacedName types.NamespacedName) (*rookv1.CephCluster, error)

func FetchClientInfoConfigMap 

func FetchClientInfoConfigMap(ctx context.Context, c client.Client, currentNamespace string) (*corev1.ConfigMap, error)

func FetchConfigMap 

func FetchConfigMap(ctx context.Context, c client.Client, name, namespace string) (*corev1.ConfigMap, error)

FetchConfigMap fetches a ConfigMap with a given name from a given namespace

func FetchMirrorPeerByName 

func FetchMirrorPeerByName(ctx context.Context, rc client.Client, name string) (*multiclusterv1alpha1.MirrorPeer, error)

func FetchSecretWithName 

func FetchSecretWithName(ctx context.Context, rc client.Client, secretName types.NamespacedName) (*corev1.Secret, error)

func FnvHash 

func FnvHash(s string) uint32

fnv64a is a 64-bit non-cryptographic hash algorithm with a low collision and a high distribution rate. https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function

func GenerateBucketName 

func GenerateBucketName(mirrorPeer multiclusterv1alpha1.MirrorPeer) string

func GenerateUniqueIdForMirrorPeer 

func GenerateUniqueIdForMirrorPeer(mirrorPeer multiclusterv1alpha1.MirrorPeer) string

func GetClientConfig 

func GetClientConfig(kubeConfigFile string) (*rest.Config, error)

GetClientConfig returns the rest.Config for a kubeconfig file

func GetClientFromConfig 

func GetClientFromConfig(config *rest.Config, scheme *runtime.Scheme) (client.Client, error)

GetClientFromConfig returns a controller-runtime Client for a rest.Config

func GetClusterID 

func GetClusterID(ctx context.Context, client client.Client, clusterName string) (string, error)

getClusterID returns the cluster ID of the OCP-Cluster

func GetCurrentStorageClusterRef 

func GetCurrentStorageClusterRef(mp *multiclusterv1alpha1.MirrorPeer, spokeClusterName string) (*multiclusterv1alpha1.StorageClusterRef, error)

func GetDefaultStorageClasses 

func GetDefaultStorageClasses(ctx context.Context, c client.Client, storageClusterName string) ([]storagev1.StorageClass, error)

func GetDefaultVolumeSnapshotClasses 

func GetDefaultVolumeSnapshotClasses(ctx context.Context, c client.Client, storageClusterName string) ([]*snapshotv1.VolumeSnapshotClass, error)

func GetEnv 

func GetEnv(key string, filenames ...string) string

func GetEnvOrDefault 

func GetEnvOrDefault(key, defaultValue string, filenames ...string) string

func GetKey 

func GetKey(clusterName, clientName string) string

func GetLogger 

func GetLogger(zapL *zap.Logger) *slog.Logger

func GetManagedClusterById 

func GetManagedClusterById(ctx context.Context, c client.Client, clusterId string) (*clusterv1.ManagedCluster, error)

GetManagedClusterById fetches a ManagedCluster by its cluster ID label

func GetManagedClusterViewName 

func GetManagedClusterViewName(clusterName string) string

func GetManifestWork 

func GetManifestWork(ctx context.Context, c client.Client, manifestWorkName string, namespace string) (*workv1.ManifestWork, error)

func GetMirrorPeerForClusterSet 

func GetMirrorPeerForClusterSet(ctx context.Context, client client.Client, clusterSet []string) (*multiclusterv1alpha1.MirrorPeer, error)

func GetNamespacedNameForClusterInfo 

func GetNamespacedNameForClusterInfo(managedCluster clusterv1.ManagedCluster) (types.NamespacedName, error)

func GetODFInfoConfigMap 

func GetODFInfoConfigMap(ctx context.Context, c client.Client, namespace string) (*corev1.ConfigMap, error)

GetODFInfoConfigMap fetches the odf-info ConfigMap from the given namespace. This will only work on the managed cluster

func GetObjectBucketClaim 

func GetObjectBucketClaim(ctx context.Context, c client.Client, bucketName, bucketNamespace string) (*obv1alpha1.ObjectBucketClaim, error)

func GetPeerRefForProviderCluster 

func GetPeerRefForProviderCluster(ctx context.Context, spokeClient, hubClient client.Client, mp *multiclusterv1alpha1.MirrorPeer) ([]multiclusterv1alpha1.PeerRef, error)

GetPeerRefForProviderCluster returns the client peer ref for the current provider cluster

func GetPeerRefForSpokeCluster 

func GetPeerRefForSpokeCluster(mp *multiclusterv1alpha1.MirrorPeer, spokeClusterName string) (*multiclusterv1alpha1.PeerRef, error)

GetPeerRefForSpokeCluster returns the peer ref for the cluster name

func GetSecretNameByPeerRef 

func GetSecretNameByPeerRef(pr multiclusterv1alpha1.PeerRef, prefix ...string) string

func GetStorageClientMapping 

func GetStorageClientMapping(ctx context.Context, c client.Client, currentNamespace string) (*corev1.ConfigMap, error)

func GetStorageClusterFromCurrentNamespace 

func GetStorageClusterFromCurrentNamespace(ctx context.Context, c client.Client, namespace string) (*ocsv1.StorageCluster, error)

func GetStorageIdsForDefaultStorageClasses 

func GetStorageIdsForDefaultStorageClasses(ctx context.Context, c client.Client, scNamespacedName types.NamespacedName, spokeClusterName string) (map[CephType]string, error)

func GetVolumeSnapshotClass 

func GetVolumeSnapshotClass(ctx context.Context, c client.Client, volumeSnapshotClassName string) (*snapshotv1.VolumeSnapshotClass, error)

func GetZapLogger 

func GetZapLogger(dev bool) *zap.Logger

func HasHubRecoveryLabels 

func HasHubRecoveryLabels(secret *corev1.Secret) bool

func HasRequiredODFKey 

func HasRequiredODFKey(mc *clusterv1.ManagedCluster) bool

func IsSecretInternal 

func IsSecretInternal(obj client.Object) bool

IsSecretInternal returns true if the provided object is a secret with Inernal label

func IsStorageClientType 

func IsStorageClientType(ctx context.Context, c client.Client, mirrorPeer multiclusterv1alpha1.MirrorPeer, operatorNs string) (bool, error)

IsStorageClientType checks if peerRefs on MirrorPeer is of type StorageClient or StorageCluster

func ListStorageClasses 

func ListStorageClasses(ctx context.Context, c client.Client) ([]storagev1.StorageClass, error)

func NamePredicate 

func NamePredicate(name string) predicate.Predicate

Name Predicate return a predicate the filter events produced by resources that matches the given name

func NamespacePredicate 

func NamespacePredicate(namespace string) predicate.Predicate

Namespace Predicate return a predicate the filter events produced by resources that matches the given namespace

func RemoveMirrorPeer 

func RemoveMirrorPeer(slice []multiclusterv1alpha1.MirrorPeer, mirrorPeer multiclusterv1alpha1.MirrorPeer) (result []multiclusterv1alpha1.MirrorPeer)

RemoveMirrorPeer removes the given mirrorPeer from the slice and returns the new slice

func RemoveString 

func RemoveString(slice []string, s string) (result []string)

RemoveString removes a given string from a slice and returns the new slice

func ValidateInternalSecret 

func ValidateInternalSecret(internalSecret *corev1.Secret, expectedLabel SecretLabelType) error

func ValidateS3Secret 

func ValidateS3Secret(data map[string][]byte) bool

Types

type CephType 

type CephType string

func GetStorageClassType 

func GetStorageClassType(sc storagev1.StorageClass, storageClusterNamespace string) (CephType, error)

func GetVolumeSnapshotClassType 

func GetVolumeSnapshotClassType(vsc *snapshotv1.VolumeSnapshotClass, storageClusterNamespace string) (CephType, error)

type ClientInfo 

type ClientInfo struct {
	ClusterID                string       `json:"clusterId"`
	Name                     string       `json:"name"`
	ProviderInfo             ProviderInfo `json:"providerInfo,omitempty"`
	ClientManagedClusterName string       `json:"clientManagedClusterName,omitempty"`
	ClientID                 string       `json:"clientId"`
}

func GetClientInfoFromConfigMap 

func GetClientInfoFromConfigMap(clientInfoMap map[string]string, key string) (ClientInfo, error)

Helper function to extract and unmarshal ClientInfo from ConfigMap

type ClusterType 

type ClusterType string
const (
	CONVERGED                     ClusterType = "Converged"
	EXTERNAL                      ClusterType = "External"
	UNKNOWN                       ClusterType = "Unknown"
	CephClusterReplicationIdLabel             = "replicationid.multicluster.openshift.io"
	CephClusterNameTemplate                   = "%s-cephcluster"
)

type InfoCephBlockPool 

type InfoCephBlockPool struct {
	Name          string `json:"name"`
	MirrorEnabled bool   `json:"mirrorEnabled"`
}

type PeerRefType 

type PeerRefType string
const (
	// PeerRefTypeStorageClient represents a storage client
	PeerRefTypeStorageClient PeerRefType = "StorageClient"

	// PeerRefTypeStorageCluster represents a storage cluster
	PeerRefTypeStorageCluster PeerRefType = "StorageCluster"

	// PeerRefTypeUnknown represents an unknown type
	PeerRefTypeUnknown PeerRefType = "Unknown"
)

type ProviderInfo 

type ProviderInfo struct {
	Version                       string               `json:"version"`
	DeploymentType                string               `json:"deploymentType"`
	ProviderManagedClusterName    string               `json:"providerManagedClusterName"`
	NamespacedName                types.NamespacedName `json:"namespacedName"`
	StorageProviderEndpoint       string               `json:"storageProviderEndpoint"`
	CephClusterFSID               string               `json:"cephClusterFSID"`
	StorageProviderPublicEndpoint string               `json:"storageProviderPublicEndpoint"`
	InfoCephBlockPools            []InfoCephBlockPool  `json:"infoCephBlockPools"`
}

type S3Token 

type S3Token struct {
	AccessKeyID          string `json:"AWS_ACCESS_KEY_ID"`
	SecretAccessKey      string `json:"AWS_SECRET_ACCESS_KEY"`
	S3Bucket             string `json:"s3Bucket"`
	S3CompatibleEndpoint string `json:"s3CompatibleEndpoint"`
	S3ProfileName        string `json:"s3ProfileName"`
	S3Region             string `json:"s3Region"`
}

func UnmarshalS3Secret 

func UnmarshalS3Secret(s3Secret *corev1.Secret) (*S3Token, error)

type SecretLabelType 

type SecretLabelType string

func GetInternalLabel 

func GetInternalLabel(secret *corev1.Secret) SecretLabelType

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.