+k8s:conversion-gen=github.com/openebs/api/v2/pkg/internalapis/apis/cstor +k8s:conversion-gen-external-types=github.com/openebs/api/v2/pkg/apis/cstor/v1 +groupName=cstor.openebs.io.

Dump runs 'zpool dump' command and unmarshal the output in above schema.

Resource takes an unqualified resource and returns a Group qualified GroupResource.

BKPCStorStatusDone , backup is completed.

BKPCStorStatusEmpty represents backup resource is created and yet to be reconcile by backup controller.

BKPCStorStatusFailed , backup is failed.

BKPCStorStatusInit , backup is initialized.

BKPCStorStatusInProgress , backup is in progress.

BKPCStorStatusInvalid , backup operation is invalid.

BKPCStorStatusPending , backup is pending.

CloneEnableKEY is used to enable/disable cloning for a cstorvolumereplica.

ConditionInProgress states resize of underlying volumes are in progress.

ConditionSuccess states resizing underlying volumes are successfull.

CSPIDiskReplacement condition will be available when user triggers disk replacement by replacing the blockdevice.

CSPIDiskUnavailable condition will be available when one (or) more disks were unavailable.

CSPIPoolExpansion condition will be available when user triggers pool expansion by adding blockdevice/raidgroup (or) when underlying disk got expanded.

CSPIPoolLost condition will be available when unable to import the pool.

CStorPoolStatusCreateFailed is state when pool creation failed.

CStorPoolStatusDegraded signifies that the pool is degraded.

CStorPoolStatusDeletionFailed ensures the resource deletion has failed.

CStorPoolStatusEmpty ensures the create operation is to be done, if import fails.

CStorPoolStatusError signifies that the pool status could not be fetched.

CStorPoolStatusErrorDuplicate ensures error due to duplicate resource.

CStorPoolStatusFaulted signifies that the pool is faulted.

CStorPoolStatusInit is initial state of CSP, before pool creation.

CStorPoolStatusInvalid ensures invalid resource.

CStorPoolStatusOffline signifies that the pool is offline.

CStorPoolStatusOnline signifies that the pool is online.

CStorPoolStatusPending ensures pending task for cstorpool.

CStorPoolStatusRemoved signifies that the pool is removed.

CStorPoolStatusUnavail signifies that the pool is not available.

CStorVolumeAttachmentStatusMounteid indicated that the volume has been successfulled mounted on the node.

CStorVolumeAttachmentStatusMountFailed indicates that login and mount process from the volume has bben started but failed kubernetes needs to retry sending nodepublish.

CStorVolumeAttachmentStatusMountUnderProgress indicates that the volume is busy and unavailable for use by other goroutines, an iSCSI login followed by mount is under progress on this volume.

CStorVolumeAttachmentStatusRaw indicates that the volume is being used in raw format by the application, therefore CSI has only performed iSCSI login operation on this volume and avoided filesystem creation and mount.

CStorVolumeAttachmentStatusRemountUnderProgress indicates that the volume is being remounted.

CStorVolumeAttachmentStatusResizeInProgress indicates that the volume is being resized.

CStorVolumeAttachmentStatusUninitialized indicates that no operation has been performed on the volume yet on this node.

CStorVolumeAttachmentStatusUnMounted indicated that the volume has been successfuly unmounted and logged out of the node.

CStorVolumeAttachmentStatusUnmountInProgress indicates that the volume is busy and unavailable for use by other goroutines, an unmount operation on volume is under progress.

CStorVolumeAttachmentStatusWaitingForCVCBound indicates that the volume components are still being created.

CStorVolumeAttachmentStatusWaitingForVolumeToBeReady indicates that the replicas are yet to connect to target.

CStorVolumeConfigPhaseBound indiacates that the cstorvolume has beenprovisioned and bound to the cstor volume claim.

CStorVolumeConfigPhaseFailed indiacates that the cstorvolume provisioninghas failed.

CStorVolumeConfigPhasePending indicates that the cvc is still waiting forthe cstorvolume to be created and bound.

CStorVolumeConfigResizeFailed ...

CStorVolumeConfigResizePending ...

CStorVolumeConfigResizeSuccess ...

CStorVolumeConfigResizePending ...

CStorVolumeResizing - a user trigger resize of pvc has been started.

CVRStatusDegraded describes volume replica is connected to the target and rebuilding from other replicas is not yet started but ready for serving IO's.

CVRStatusDeletionFailed describes volume replica deletion is failed.

CVRStatusEmpty describes CVR resource is created but not yet monitored by controller(i.e resource is just created).

CVRStatusError describes either volume replica is not exist in cstor pool.

CVRStatusInit describes CVR resource is newly created but it is not yet created zfs dataset.

CVRStatusInvalid ensures invalid resource(currently not honoring).

CVRStatusNewReplicaDegraded describes replica is recreated (due to pool recreation[underlying disk got changed]/volume replica scaleup cases) and just connected to the target.

CVRStatusOffline describes volume replica is created but not yet connected to the target.

CVRStatusOnline describes volume replica is Healthy and data existing on the healthy replica is up to date.

CVRStatusRebuilding describes volume replica has missing data and it started rebuilding missing data from other replicas.

CVRStatusReconstructingNewReplica describes volume replica is recreated and it started reconstructing entier data from other healthy replica.

CVRStatusRecreate describes the volume replica is recreated due to pool recreation/scaleup.

PoolManagerAvailable means the PoolManagerAvailable deployment is available, ie.

PoolMirrored is the mirror raid group.

PoolOperator is the name of the tool that makes pool-related operations.

PoolRaidz is the raidz raid group.

PoolRaidz2 is the raidz2 raid group.

PoolScanCanceled represents pool scan is aborted.

PoolScanFinished represents pool scanning is finished.

PoolScanFuncNone holds value 0.

PoolScanFuncResilver holds value 2 which states device under went resilvering.

PoolScanFuncScrub holds value 1.

PoolScanFuncStates holds value 3.

PoolScanNone represents pool scanning is not yet started.

PoolScanNumOfStates holds value 4.

PoolScanScanning represents pool is undergoing scanning.

PoolStriped is the striped raid group.

ReconcileComplete is the state when desired and current version are equal.

ReconcileInProgress is the state when desired and current version are not same and the reconcile functions is retrying to make them same.

ReconcilePending is the state the reconciliation is still not started yet.

RSTCStorStatusDone , restore operation is completed.

RSTCStorStatusEmpty represents the restore resource is created and yet to be reconciled by restore controller.

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.

SnapshotNameKey stores the name of the snapshot being used to restore this replica.

SourceVolumeKey stores the name of source volume whose snapshot is used to create this cvr.

vdev active on a different host */.

vdev ashift is invalid */.

vdev guid sum doesn't match */.

the label is OK but invalid */.

cannot read log chain(s) */.

bad label or disk contents */.

too many errors */.

external diagnosis or forced fault */.

persistent forced fault */.

VdevAuxIndex represents vdev aux states.

experienced I/O failure */.

no error */.

insufficient number of replicas */.

ldi_open_*() or vn_open() failed */.

hot spare used in another pool */.

vdev was split off into another pool */.

vdev size is too small */.

unsupported features */.

on-disk version is too new */.

on-disk version is too old */.

VdevScanProcessedIndex is index of scaned bytes on disk.

VdevScanStatsScanFuncIndex point to index which inform whether device under went resilvering or not.

VdevScanStatsStateIndex represents the index of dataset scan state.

VdevStateCantOpen represents tried to open, but failed.

VdevStateClosed represents vdev currently not opened.

VdevStateDegraded represents Replicated vdev with unhealthy kids.

VdevStateFaulted represents external request to fault device.

VdevStateHealthy represents vdev is presumed good.

VdevStateIndex represents the device state information.

VdevStateOffline represents vdev not allowed to open.

VdevStateRemoved represents vdev explicitly removed from system.

VdevStateUnknown represents uninitialized vdev.

SchemeGroupVersion is group version used to register these objects.

CStorBackup describes a cstor backup resource created as a custom resource +kubebuilder:object:root=true +kubebuilder:resource:scope=Namespaced,shortName=cbackup +kubebuilder:printcolumn:name="Volume",type=string,JSONPath=`.spec.volumeName`,description="Name of the volume for which this backup is destined" +kubebuilder:printcolumn:name="Backup/Schedule",type=string,JSONPath=`.spec.backupName`,description="Name of the backup or scheduled backup" +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status`,description="Identifies the phase of the backup".

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 +kubebuilder:object:root=true +kubebuilder:resource:scope=Namespaced,shortName=ccompletedbackup +kubebuilder:printcolumn:name="Volume",type=string,JSONPath=`.spec.volumeName`,description="Volume name on which backup is performed" +kubebuilder:printcolumn:name="Backup/Schedule",type=string,JSONPath=`.spec.backupName`,description="Name of the backup or scheduled backup" +kubebuilder:printcolumn:name="LastSnap",type=string,JSONPath=`.spec.lastSnapName`,description="Last successfully backup snapshot".

CStorCompletedBackupList is a list of cstorcompletedbackup resources.

CStorCompletedBackupSpec is the spec for a CStorBackup resource.

CStorPoolCluster describes a CStorPoolCluster custom resource.

CStorPoolClusterCondition describes the state of a CSPC at a certain point.

CStorPoolClusterList is a list of CStorPoolCluster resources.

CStorPoolClusterSpec is the spec for a CStorPoolClusterSpec resource.

CStorPoolClusterStatus represents the latest available observations of a CSPC's current state.

CStorPoolInstance describes a cstor pool instance resource.

CStorPoolInstanceBlockDevice contains the details of block devices that constitutes a raid group.

CStorPoolInstanceCapacity stores the pool capacity related attributes.

CSPIConditionType describes the state of a CSPI at a certain point.

CStorPoolInstanceList is a list of CStorPoolInstance resources.

CStorPoolInstanceSpec is the spec listing fields for a CStorPoolInstance resource.

CStorPoolInstanceStatus is for handling status of pool.

CStorRestore describes a cstor restore resource created as a custom resource +kubebuilder:object:root=true +kubebuilder:resource:scope=Namespaced,shortName=crestore +kubebuilder:printcolumn:name="Backup",type=string,JSONPath=`.spec.restoreName`,description="Name of the snapshot which is restored" +kubebuilder:printcolumn:name="Volume",type=string,JSONPath=`.spec.volumeName`,description="Volume on which restore is performed" +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status`,description="Identifies the state of the restore".

CStorRestoreList is a list of CStorRestore resources.

CStorRestoreSpec is the spec for a CStorRestore resource.

CStorSnapshotInfo represents the snapshot information related to particular snapshot.

CStorVolume describes a cstor volume resource created as custom resource.

CStorVolumeAttachment represents a CSI based volume +kubebuilder:object:root=true +kubebuilder:resource:scope=Namespaced,shortName=cva.

CStorVolumeAttachmentList is a list of CStorVolumeAttachment resources.

CStorVolumeAttachmentSpec is the spec for a CStorVolume resource.

CStorVolumeCondition contains details about state of cstorvolume.

CStorVolumeConfig describes a cstor volume claim resource created as custom resource.

CStorVolumeConfigCondition contains details about state of cstor volume.

CStorVolumeConfigList is a list of CStorVolumeConfig resources.

CStorVolumeConfigPublish contains info related to attachment of a volume to a node.

CStorVolumeConfigSpec is the spec for a CStorVolumeConfig resource.

CStorVolumeConfigStatus is for handling status of CstorVolume Claim.

CStorVolumeList is a list of CStorVolume resources.

CStorVolumePolicy describes a configuration required for cstor volume resources.

CStorVolumePolicyList is a list of CStorVolumePolicy resources.

CStorVolumePolicySpec ...

CStorVolumePolicyStatus is for handling status of CstorVolumePolicy.

CStorVolumeReplica describes a cstor volume resource created as custom resource.

CStorVolumeCapacityDetails represents capacity information releated to volume replica.

CStorVolumeReplicaDetails contains trusty replica inform which will be updated by target.

CStorVolumeReplicaList is a list of CStorVolumeReplica resources.

CStorVolumeReplicaSpec is the spec for a CStorVolumeReplica resource.

CStorVolumeReplicaStatus is for handling status of cvr.

CStorVolumeSpec is the spec for a CStorVolume resource.

CStorVolumeStatus is for handling status of cvr.

CVStatus stores the status of a CstorVolume obtained from response.

CVStatusResponse stores the reponse of istgt replica command output It may contain several volumes.

ISCSIInfo has ISCSI protocol specific info, this can be used only if the volume type exposed by the vendor is iSCSI.

PoolConfig is the default pool config that applies to the pool on node.

PoolSpec is the spec for pool on node where it should be created.

Provision represents volume provisioning configuration.

RaidGroup contains the details of a raid group for the pool.

ReplicaPoolInfo represents the pool information of volume replica.

ReplicaSpec represents configuration related to replicas resources.

ReplicaStatus stores the status of replicas.

TargetSpec represents configuration related to cstor target and its resources.

Topology contains the topology strucure of disks used in backend.

Vdev relates to a logical or physical disk in backend.

VdevTree contains the tree strucure of disks used in backend.

VersionDetails provides the details for upgrade.

VersionStatus is the status of the reconciliation of versions.

VolumeInfo contains the volume related info for all types of volumes in CStorVolumeAttachmentSpec.

ZFSCapacityAttributes stores the advanced information about pool capacity related attributes.

ConditionStatus states in which state condition is present.

CStorBackupStatus is a string type that represents the status of the backup.

CStorPoolInstancePhase is the phase for CStorPoolInstance resource.

CStorRestoreStatus is a string type that represents the status of the restore.

CStorVolumeAttachmentStatus status represents the current mount status of the volume.

CStorVolumeConditionType is a valid value of CStorVolumeCondition.Type.

CStorVolumeConfigConditionType is a valid value of CstorVolumeConfigCondition.Type.

CStorVolumeConfigPhase represents the current phase of CStorVolumeConfig.

CStorVolumePhase is to hold result of action.

CStorVolumeReplicaPhase is to hold result of action.

CVRKey represents the properties of a cstorvolumereplica.

PoolScanFunc holds various scanning functions.

PoolScanState states various pool scan states.

PoolType is a label for the pool type of a cStor pool.

ReplicaID is to hold replicaID information.

VdevAux represents reasons why vdev can't open.

VdevList is alias of list of Vdevs.

VdevState represent various device/disk states.

VersionState is the state of reconciliation.