package
1.12.0
Repository: https://github.com/openebs/api.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
Resource takes an unqualified resource and returns a Group qualified GroupResource.

# Constants

APIVersion holds the value of OpenEBS version.
BKPCStorStatusDone , backup is completed.
BKPCStorStatusEmpty ensures the create operation is to be done, if import fails.
BKPCStorStatusFailed , backup is failed.
BKPCStorStatusInit , backup is initialized.
BKPCStorStatusInProgress , backup is in progress.
BKPCStorStatusInvalid , backup operation is invalid.
BKPCStorStatusPending , backup is pending.
BlockDeviceActive is the state for a block device that is connected to the node.
BlockDeviceClaimed represents that the block device is bound to a BDC.
BlockDeviceClaimStatusDone represents BlockDeviceClaim has been assigned backing blockdevice and ready for use.
BlockDeviceClaimStatusEmpty represents that the BlockDeviceClaim was just created.
BlockDeviceClaimStatusInvalidCapacity represents BlockDeviceClaim has invalid capacity request i.e.
BlockDeviceClaimStatusPending represents BlockDeviceClaim has not been assigned devices yet.
BlockDeviceInactive is the state for a block device that is disconnected from a node.
BlockDeviceReleased represents that the block device is released from the BDC, pending cleanup jobs.
BlockDeviceUnclaimed represents that the block device is not bound to any BDC, all cleanup jobs have been completed and is available for claiming.
BlockDeviceUnknown is the state for a block device whose state (attached/detached) cannot be determined at this time.
PoolInstanceUpgrade is the step to upgrade a pool (CSP or CSPI and it's deployment).
PreUpgrade is the step to verify resource before upgrade.
ReplicaUpgrade is the step to upgrade replica deployment of resource.
ResourceStorage defines the storage required as v1.Quantity.
Rollback is the step to rollback to previous version if upgrade fails.
RSTCStorStatusDone , restore operation is completed.
RSTCStorStatusEmpty ensures the create operation is to be done, if import fails.
RSTCStorStatusFailed , restore operation is failed.
RSTCStorStatusInit , restore operation is initialized.
RSTCStorStatusInProgress , restore operation is in progress.
RSTCStorStatusInvalid , restore operation is invalid.
RSTCStorStatusPending , restore operation is pending.
StepCompleted - used for upgrade step that completed successfully.
StepErrored - used for upgrade step that failed.
StepWaiting - used for upgrade step that not yet complete.
StoragePoolKindCSPC holds the value of CStorPoolCluster.
TargetUpgrade is the step to upgrade Target depoyment of resource.
UpgradeError - used for Upgrades that Error for some reason.
UpgradeStarted - used for Upgrades that are Started.
UpgradeSuccess - used for Upgrades that are not available.
Verify is the step to verify the upgrade.
VolumeModeBlock specifies that the block device needs to be used as a raw block.
VolumeModeFileSystem specifies that block device will be used with a filesystem already existing.

# Variables

AddToScheme is a global function that registers this API group & version to a scheme.
SchemeBuilder is the scheme builder with scheme init functions to run for this API package.
SchemeGroupVersion is group version used to register these objects.

# Structs

BlockDevice is the Schema used to represent a BlockDevice CR.
BlockDeviceClaim is the Schema for the BlockDeviceClaim CR.
BlockDeviceClaimList contains a list of BlockDeviceClaim.
BlockDeviceList contains a list of BlockDevice.
BlockDeviceNodeAttributes contains the attributes of the node from which the BD should be selected for claiming.
CStorBackup describes a cstor backup resource created as a custom resource.
CStorBackupList is a list of CStorBackup resources.
CStorBackupSpec is the spec for a CStorBackup resource.
CStorCompletedBackup describes a cstor completed-backup resource created as custom resource.
CStorCompletedBackupList is a list of cstorcompletedbackup resources.
CStorPool is the ResourceType for cstor pool.
CStorPoolCluster is the ResourceType for cstor pool cluster.
CStorPoolInstance is the ResourceType for cstor pool cluster.
CStorRestore describes a cstor restore resource created as a custom resource.
CStorRestoreList is a list of CStorRestore resources.
CStorRestoreSpec is the spec for a CStorRestore resource.
CStorVolume is the ResourceType for cstor volume.
DeviceCapacity defines the physical and logical size of the block device.
DeviceClaimDetails defines the details of the block device that should be claimed.
DeviceClaimResources defines the request by the claim, eg, Capacity, IOPS.
DeviceClaimSpec defines the request details for a BlockDevice.
DeviceClaimStatus defines the observed state of BlockDeviceClaim.
DeviceDetails represent certain hardware/static attributes of the block device.
DeviceDevLink holds the maping between type and links like by-id type or by-path type link.
DeviceSpec defines the properties and runtime status of a BlockDevice.
DeviceStatus defines the observed state of BlockDevice.
FileSystemInfo defines the filesystem type and mountpoint of the device if it exists.
JivaVolume is the ResourceType for jiva volume.
NodeAttribute defines the attributes of a node where the block device is attached.
Options provides additional optional arguments.
ResourceOptions provides additional options for a particular resource.
ResourceSpec is the type of resource which is to be upgraded.
Status represents the state of the step performed during the upgrade.
StoragePoolClaim is the ResourceType for storage pool claim.
UpgradeDetailedStatuses represents the latest available observations of a UpgradeTask current state.
UpgradeTask represents an upgrade task.
UpgradeTaskList is a list of UpgradeTask resources.
UpgradeTaskSpec is the properties of an upgrade task.
UpgradeTaskStatus provides status of a upgradeTask.

# Type aliases

BlockDeviceState defines the observed state of the disk.
BlockDeviceVolumeMode specifies the type in which the BlockDevice can be used.
CStorBackupStatus is to hold status of backup.
CStorRestoreStatus is to hold result of action.
DeviceClaimPhase is a typed string for phase field of BlockDeviceClaim.
DeviceClaimState defines the observed state of BlockDevice.
StepPhase defines the phase of a UpgradeStep.
UpgradePhase defines phase of a UpgradeTask.
UpgradeStep is the current step being performed for a particular resource upgrade.