util

Documentation

Index

• Constants
• func AlignBytes(currBytes int64, stepBytes int64) int64
• func BackupVolumeSourceToCSIVolumeHandle(backupVolumeSource string) (string, error)
• func BytesToGb(bytes int64) int64
• func CheckLabelValueRegex(value string) error
• func ConvertLabelsStringToMap(labels string) (map[string]string, error)
• func ConvertVolToShareName(csiVolName string) string
• func GbToBytes(gbs int64) int64
• func GetBackupLocation(params map[string]string) string
• func GetMultishareOpsTimeoutConfig(opType OperationType) (time.Duration, time.Duration, error)
• func GetRegionFromZone(location string) (string, error)
• func IsAligned(curSizeBytes int64, expectedBytes int64) bool
• func IsBackupHandle(handle string) (bool, error)
• func IsSnapshotTypeSupported(params map[string]string) (bool, error)
• func Max(a, b int64) int64
• func MbToBytes(mbs int64) int64
• func Min(a, b int64) int64
• func ParseInstanceURI(instanceURI string) (string, string, string, error)
• func ParseShareURI(shareURI string) (string, string, string, string, error)
• func ParseTimestamp(timestamp string) (*timestamppb.Timestamp, error)
• func RoundBytesToGb(bytes int64) int64
• type IPAllocator
  • func NewIPAllocator(pendingIPRanges map[string]bool) *IPAllocator
  • func (ipAllocator *IPAllocator) GetUnreservedIPRange(cidr string, ipRangeSize int, cloudInstancesReservedIPRanges map[string]bool) (string, error)
  • func (ipAllocator *IPAllocator) ReleaseIPRange(ipRange string)
• type OperationStatus
• type OperationType
  • func ConvertInstanceOpVerbToType(v string) OperationType
  • func ConvertShareOpVerbToType(v string) OperationType
  • func (o OperationType) String() string
• type VolumeLocks
  • func NewVolumeLocks() *VolumeLocks
  • func (vl *VolumeLocks) Release(volumeID string)
  • func (vl *VolumeLocks) TryAcquire(volumeID string) bool

Constants

const (
	// the ipRangeSize for Filestore instances
	IpRangeSize = 29

	// the ipRangeSize for enterprise tier Filestore instances
	IpRangeSizeEnterprise = 24
)

const (
	InstanceURISplitLen        = 6
	ShareURISplitLen           = 8
	MultishareCSIVolIdSplitLen = 6

	MinMultishareInstanceSizeBytes    int64 = 1 * Tb
	MaxMultishareInstanceSizeBytes    int64 = 10 * Tb
	MaxShareSizeBytes                 int64 = 1 * Tb
	MinShareSizeBytes                 int64 = 100 * Gb
	MaxSharesPerInstance                    = 10
	NewMultishareInstancePrefix             = "fs-"
	ParamMultishareInstanceScLabelKey       = "storage_gke_io_storage-class-id"
)

const (
	OpVerbCreate = "create"
	OpVerbDelete = "delete"
	OpVerbUpdate = "update"
)

const (
	Mb = 1024 * 1024
	Gb = 1024 * Mb
	Tb = 1024 * Gb

	// VolumeSnapshot parameters
	VolumeSnapshotTypeKey      = "type"
	VolumeSnapshotLocationKey  = "location"
	VolumeSnapshotTypeSnapshot = "snapshot"
	VolumeSnapshotTypeBackup   = "backup"

	SnapshotHandleBackupKey = "backups"
)

const (
	VolumeOperationAlreadyExistsFmt = "An operation with the given volume key %s already exists"
)

Functions

func AlignBytes

func AlignBytes(currBytes int64, stepBytes int64) int64

Aligns to the next higher multiple of step size. No-op if step size is 0, or already aligned.

func BackupVolumeSourceToCSIVolumeHandle

func BackupVolumeSourceToCSIVolumeHandle(backupVolumeSource string) (string, error)

func BytesToGb

func BytesToGb(bytes int64) int64

func CheckLabelValueRegex

func CheckLabelValueRegex(value string) error

func ConvertLabelsStringToMap

func ConvertLabelsStringToMap(labels string) (map[string]string, error)

ConvertLabelsStringToMap converts the labels from string to map example: "key1=value1,key2=value2" gets converted into {"key1": "value1", "key2": "value2"}

func ConvertVolToShareName

func ConvertVolToShareName(csiVolName string) string

func GbToBytes

func GbToBytes(gbs int64) int64

func GetBackupLocation

func GetBackupLocation(params map[string]string) string

func GetMultishareOpsTimeoutConfig

func GetMultishareOpsTimeoutConfig(opType OperationType) (time.Duration, time.Duration, error)

func GetRegionFromZone

func GetRegionFromZone(location string) (string, error)

func IsAligned

func IsAligned(curSizeBytes int64, expectedBytes int64) bool

func IsBackupHandle

func IsBackupHandle(handle string) (bool, error)

func IsSnapshotTypeSupported

func IsSnapshotTypeSupported(params map[string]string) (bool, error)

func Max

func Max(a, b int64) int64

func MbToBytes

func MbToBytes(mbs int64) int64

func Min

func Min(a, b int64) int64

func ParseInstanceURI

func ParseInstanceURI(instanceURI string) (string, string, string, error)

func ParseShareURI

func ParseShareURI(shareURI string) (string, string, string, string, error)

func ParseTimestamp

func ParseTimestamp(timestamp string) (*timestamppb.Timestamp, error)

func RoundBytesToGb

func RoundBytesToGb(bytes int64) int64

Round up to the nearest Gb

Types

type IPAllocator

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

IPAllocator struct consists of shared resources that are used to keep track of the CIDR IPRanges currently reserved by service instances

func NewIPAllocator

func NewIPAllocator(pendingIPRanges map[string]bool) *IPAllocator

NewIPAllocator is the constructor to initialize the IPAllocator object Argument pendingIPRanges map[string]bool is a set of IP ranges currently reserved by service instances but pending reservation in the cloud instances

func (*IPAllocator) GetUnreservedIPRange

func (ipAllocator *IPAllocator) GetUnreservedIPRange(cidr string, ipRangeSize int, cloudInstancesReservedIPRanges map[string]bool) (string, error)

GetUnreservedIPRange returns an unreserved IP block. cidr: Provided cidr address in which we need to look for an unreserved IP range with specified size ipRangeSize: the size of the unreserved IP range we are looking for cloudInstancesReservedIPRanges: All the used IP ranges in the cloud instances All the used IP ranges in the service instances not updated in cloud instances is extracted from the pendingIPRanges list in the IPAllocator Finally a final reservedIPRange list is created by merging these two lists Potential error cases: 1) No IP range in the CIDR is unreserved 2) Parsing the CIDR resulted in an error

func (*IPAllocator) ReleaseIPRange

func (ipAllocator *IPAllocator) ReleaseIPRange(ipRange string)

ReleaseIPRange releases the pending IPRange Argument ipRange string is an IPV4 range which needs to be released

type OperationStatus

type OperationStatus int

const (
	StatusSuccess OperationStatus = iota
	StatusRunning
	StatusFailed
	StatusUnknown
)

type OperationType

type OperationType int

const (
	InstanceCreate OperationType = iota
	InstanceDelete
	InstanceUpdate
	ShareCreate
	ShareDelete
	ShareUpdate
	UnknownOp
)

func ConvertInstanceOpVerbToType

func ConvertInstanceOpVerbToType(v string) OperationType

func ConvertShareOpVerbToType

func ConvertShareOpVerbToType(v string) OperationType

func (OperationType) String

func (o OperationType) String() string

type VolumeLocks

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

VolumeLocks implements a map with atomic operations. It stores a set of all volume IDs with an ongoing operation.

func NewVolumeLocks

func NewVolumeLocks() *VolumeLocks

func (*VolumeLocks) Release

func (vl *VolumeLocks) Release(volumeID string)

func (*VolumeLocks) TryAcquire

func (vl *VolumeLocks) TryAcquire(volumeID string) bool

TryAcquire tries to acquire the lock for operating on volumeID and returns true if successful. If another operation is already using volumeID, returns false.