CStorVolume
cstor.openebs.io / v1
apiVersion: cstor.openebs.io/v1
kind: CStorVolume
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object required
CStorVolumeSpec is the spec for a CStorVolume resource
capacity
string | integer
Capacity represents the desired size of the underlying volume.
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
consistencyFactor
integer
ConsistencyFactor is minimum number of volume replicas i.e. `RF/2 + 1` has to be connected to the target for write operations. Basically more then 50% of replica has to be connected to target.
desiredReplicationFactor
integer
DesiredReplicationFactor represents maximum number of replicas that are allowed to connect to the target. Required for scale operations
iqn
string
Target iSCSI Qualified Name.combination of nodeBase
replicaDetails object
ReplicaDetails refers to the trusty replica information
knownReplicas
object
KnownReplicas represents the replicas that target can trust to read data
replicationFactor
integer
ReplicationFactor represents number of volume replica created during volume provisioning connect to the target
targetIP
string
TargetIP IP of the iSCSI target service
targetPort
string
iSCSI Target Port typically TCP ports 3260
targetPortal
string
iSCSI Target Portal. The Portal is combination of IP:port (typically TCP ports 3260)
status object
CStorVolumeStatus is for handling status of cvr.
capacity
string | integer
Represents the actual capacity of the underlying volume.
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$conditions []object
Current Condition of cstorvolume. If underlying persistent volume is being resized then the Condition will be set to 'ResizePending'.
lastProbeTime
string
Last time we probed the condition.
format:
date-time
lastTransitionTime
string
Last time the condition transitioned from one status to another.
format:
date-time
message
string
Human-readable message indicating details about last transition.
reason
string
Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizePending" that means the underlying cstorvolume is being resized.
status
string required
ConditionStatus states in which state condition is present
type
string required
CStorVolumeConditionType is a valid value of CStorVolumeCondition.Type
lastTransitionTime
string
LastTransitionTime refers to the time when the phase changes
format:
date-time
lastUpdateTime
string
LastUpdateTime refers to the time when last status updated due to any operations
format:
date-time
message
string
A human-readable message indicating details about why the volume is in this state.
phase
string
CStorVolumePhase is to hold result of action.
replicaDetails object
ReplicaDetails refers to the trusty replica information
knownReplicas
object
KnownReplicas represents the replicas that target can trust to read data
replicaStatuses []object
checkpointedIOSeq
string required
Represents IO number of replica persisted on the disk
inflightRead
string required
Ongoing reads I/O from target to replica
inflightSync
string required
Ongoing sync I/O from target to replica
inflightWrite
string required
ongoing writes I/O from target to replica
mode
string required
Mode represents replica status i.e. Healthy, Degraded
quorum
string required
Quorum indicates wheather data wrtitten to the replica is lost or exists. "0" means: data has been lost( might be ephimeral case) and will recostruct data from other Healthy replicas in a write-only mode 1 means: written data is exists on replica
replicaId
string required
ID is replica unique identifier
upTime
integer required
time since the replica connected to target
versionDetails object
VersionDetails provides the details for upgrade
autoUpgrade
boolean
If AutoUpgrade is set to true then the resource is upgraded automatically without any manual steps
desired
string
Desired is the version that we want to upgrade or the control plane version
status object
Status gives the status of reconciliation triggered when the desired and current version are not same
current
string
Current is the version of resource
dependentsUpgraded
boolean
DependentsUpgraded gives the details whether all children of a resource are upgraded to desired version or not
lastUpdateTime
string
LastUpdateTime is the time the status was last updated
format:
date-time
message
string
Message is a human readable message if some error occurs
reason
string
Reason is the actual reason for the error state
state
string
State is the state of reconciliation
No matches. Try .spec.capacity for an exact path