common

Documentation

Index

• Constants
• Variables
• func AwaitOperation(ctx context.Context, op *crusoeapi.Operation, projectID string, ...) (*crusoeapi.Operation, error)
• func CancellableSleep(ctx context.Context, duration time.Duration) error
• func GetAsyncOperationResult[T any](ctx context.Context, op *crusoeapi.Operation, projectID string, ...) (*T, *crusoeapi.Operation, error)
• func GetTopologyKey(pluginName, key string) string
• func OpResultToError(res interface{}) (expectedErr, unexpectedErr error)
• func RequestSizeToBytes(capacityRange *csi.CapacityRange) (int64, error)
• func RequestSizeToGiB(capacityRange *csi.CapacityRange) (int, error)
• func TrimPVCPrefix(pvcName string) string
• func UnpackSwaggerErr(original error) error
• type DiskType
• type OpResultErr
• type OpStatus

Constants

const (
	NumBytesInGiB       = 1024 * 1024 * 1024
	NumGiBInTiB         = 1024
	BlockSizeSSD        = 4096
	MinSSDSizeGiB       = 1
	MaxSSDSizeGiB       = NumGiBInTiB * 10
	SSDSizeIncrementGiB = 1
	MinFSSizeGiB        = NumGiBInTiB
	MaxFSSizeGiB        = NumGiBInTiB * 1000
	FSSizeIncrementGiB  = NumGiBInTiB
)

Numeric constants.

const (
	TopologyLocationKey            = "location"
	TopologySupportsSharedDisksKey = "supports-shared-disks"

	VolumeContextDiskSerialNumberKey = "csi.crusoe.ai/serial-number"
	VolumeContextDiskNameKey         = "csi.crusoe.ai/disk-name"
)

Map keys.

const (
	SSDPluginName    = "ssd.csi.crusoe.ai"
	SSDPluginVersion = "0.1.0"

	FSPluginName    = "fs.csi.crusoe.ai"
	FSPluginVersion = "0.1.0"
)

Plugin metadata.

const (
	// OperationTimeout is the maximum time the Crusoe CSI driver will wait for an asynchronous operation to complete.
	OperationTimeout = 5 * time.Minute

	// MaxVolumesPerNode refers to the maximum number of disks that can be attached to a VM
	// ref: https://docs.crusoecloud.com/storage/disks/overview#persistent-disks
	MaxVolumesPerNode = 15

	// MaxDiskNameLength refers to the maximum permissible length of a Crusoe disk name
	// ref: https://docs.crusoecloud.com/storage/disks/overview#persistent-disks
	MaxDiskNameLength = 63
)

Runtime options.

Variables

var (
	ErrNotImplemented = errors.New("not implemented")
	ErrTimeout        = errors.New("timeout")
)

var (
	ErrUnableToGetOpRes         = errors.New("failed to get result of operation")
	ErrUnexpectedOperationState = errors.New("unexpected operation state")
	ErrNoSizeRequested          = errors.New("no disk size requested")
)

var BaseControllerCapabilities = []*csi.ControllerServiceCapability{
	{
		Type: &csi.ControllerServiceCapability_Rpc{
			Rpc: &csi.ControllerServiceCapability_RPC{
				Type: csi.ControllerServiceCapability_RPC_CREATE_DELETE_VOLUME,
			},
		},
	},
	{
		Type: &csi.ControllerServiceCapability_Rpc{
			Rpc: &csi.ControllerServiceCapability_RPC{
				Type: csi.ControllerServiceCapability_RPC_PUBLISH_UNPUBLISH_VOLUME,
			},
		},
	},
	{
		Type: &csi.ControllerServiceCapability_Rpc{
			Rpc: &csi.ControllerServiceCapability_RPC{
				Type: csi.ControllerServiceCapability_RPC_EXPAND_VOLUME,
			},
		},
	},
	{
		Type: &csi.ControllerServiceCapability_Rpc{
			Rpc: &csi.ControllerServiceCapability_RPC{
				Type: csi.ControllerServiceCapability_RPC_SINGLE_NODE_MULTI_WRITER,
			},
		},
	},
}

var BaseIdentityCapabilities = []*csi.PluginCapability{
	{
		Type: &csi.PluginCapability_Service_{
			Service: &csi.PluginCapability_Service{
				Type: csi.PluginCapability_Service_VOLUME_ACCESSIBILITY_CONSTRAINTS,
			},
		},
	},
}

var BaseNodeCapabilities = []*csi.NodeServiceCapability{
	{
		Type: &csi.NodeServiceCapability_Rpc{
			Rpc: &csi.NodeServiceCapability_RPC{
				Type: csi.NodeServiceCapability_RPC_SINGLE_NODE_MULTI_WRITER,
			},
		},
	},
}

var NodeCapabilityExpandVolume = csi.NodeServiceCapability{
	Type: &csi.NodeServiceCapability_Rpc{
		Rpc: &csi.NodeServiceCapability_RPC{
			Type: csi.NodeServiceCapability_RPC_EXPAND_VOLUME,
		},
	},
}

var PluginCapabilityControllerService = csi.PluginCapability{
	Type: &csi.PluginCapability_Service_{
		Service: &csi.PluginCapability_Service{
			Type: csi.PluginCapability_Service_CONTROLLER_SERVICE,
		},
	},
}

var PluginCapabilityVolumeExpansionOffline = csi.PluginCapability{
	Type: &csi.PluginCapability_VolumeExpansion_{
		VolumeExpansion: &csi.PluginCapability_VolumeExpansion{
			Type: csi.PluginCapability_VolumeExpansion_OFFLINE,
		},
	},
}

var PluginCapabilityVolumeExpansionOnline = csi.PluginCapability{
	Type: &csi.PluginCapability_VolumeExpansion_{
		VolumeExpansion: &csi.PluginCapability_VolumeExpansion{
			Type: csi.PluginCapability_VolumeExpansion_ONLINE,
		},
	},
}

Functions

func AwaitOperation

func AwaitOperation(ctx context.Context, op *crusoeapi.Operation, projectID string,
	getOp func(ctx context.Context, projectID string, operationID string) (crusoeapi.Operation, *http.Response, error),
) (
	*crusoeapi.Operation, error,
)

AwaitOperation polls an async API operation until it resolves into a success or failure state.

func CancellableSleep

func CancellableSleep(ctx context.Context, duration time.Duration) error

func GetAsyncOperationResult

func GetAsyncOperationResult[T any](ctx context.Context, op *crusoeapi.Operation, projectID string,
	getOp func(ctx context.Context, projectID string, operationID string) (crusoeapi.Operation, *http.Response, error),
) (*T, *crusoeapi.Operation, error)

func GetTopologyKey

func GetTopologyKey(pluginName, key string) string

func OpResultToError

func OpResultToError(res interface{}) (expectedErr, unexpectedErr error)

func RequestSizeToBytes

func RequestSizeToBytes(capacityRange *csi.CapacityRange) (int64, error)

func RequestSizeToGiB

func RequestSizeToGiB(capacityRange *csi.CapacityRange) (int, error)

func TrimPVCPrefix

func TrimPVCPrefix(pvcName string) string

func UnpackSwaggerErr

func UnpackSwaggerErr(original error) error

UnpackSwaggerErr takes a swagger error and safely attempts to extract the additional information which is present in the response. The error is returned unchanged if it cannot be unpacked.

Types

type DiskType

type DiskType string

const (
	// DiskTypeSSD and DiskTypeFS names correspond to the Crusoe API enum values.
	DiskTypeSSD DiskType = "persistent-ssd"
	DiskTypeFS  DiskType = "shared-volume"
)

Enums.

type OpResultErr

type OpResultErr struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type OpStatus

type OpStatus string

const (
	PollInterval          = 1 * time.Second
	OpSucceeded  OpStatus = "SUCCEEDED"
	OpInProgress OpStatus = "IN_PROGRESS"
	OpFailed     OpStatus = "FAILED"
)