CStorPoolInstance
cstor.openebs.io / v1
apiVersion: cstor.openebs.io/v1
kind: CStorPoolInstance
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
Spec is the specification of the cstorpoolinstance resource.
dataRaidGroups []object required
DataRaidGroups is the raid group configuration for the given pool.
blockDevices []object required
blockDeviceName
string required
BlockDeviceName is the name of the block device.
capacity
integer
Capacity is the capacity of the block device. It is system generated
format:
int64
devLink
string
DevLink is the dev link for block devices
hostName
string
HostName is the name of kubernetes node where the pool should be created.
nodeSelector
object required
NodeSelector is the labels that will be used to select a node for pool provisioning. Required field
poolConfig object
PoolConfig is the default pool config that applies to the pool on node.
auxResources object
AuxResources are the compute resources required by the cstor-pool pod side car containers.
claims []object
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
name
string required
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
limits
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
compression
string
Compression to enable compression Optional -- defaults to off Possible values : lz, off
dataRaidGroupType
string required
DataRaidGroupType is the raid type.
priorityClassName
string
PriorityClassName if specified applies to this pool pod If left empty, DefaultPriorityClassName is applied. (See CStorPoolClusterSpec.DefaultPriorityClassName) If both are empty, not priority class is applied.
resources object
Resources are the compute resources required by the cstor-pool container.
claims []object
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
name
string required
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
limits
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
roThresholdLimit
integer
ROThresholdLimit is threshold(percentage base) limit for pool read only mode. If ROThresholdLimit(%) amount of pool storage is reached then pool will set to readonly. NOTE: 1. If ROThresholdLimit is set to 100 then entire pool storage will be used by default it will be set to 85%. 2. ROThresholdLimit value will be 0 <= ROThresholdLimit <= 100.
thickProvision
boolean
ThickProvision to enable thick provisioning Optional -- defaults to false
tolerations []object
Tolerations, if specified, the pool pod's tolerations.
effect
string
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key
string
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator
string
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds
integer
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
format:
int64
value
string
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
writeCacheGroupType
string
WriteCacheGroupType is the write cache raid type.
writeCacheRaidGroups []object
WriteCacheRaidGroups is the write cache raid group.
blockDevices []object required
blockDeviceName
string required
BlockDeviceName is the name of the block device.
capacity
integer
Capacity is the capacity of the block device. It is system generated
format:
int64
devLink
string
DevLink is the dev link for block devices
status object
Status is the possible statuses of the cstorpoolinstance resource.
capacity object
Capacity describes the capacity details of a cstor pool
free
string | integer required
Amount of usable space in the pool after excluding metadata and raid parity
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
total
string | integer required
Sum of usable capacity in all the data raidgroups
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
used
string | integer required
Amount of physical data (and its metadata) written to pool after applying compression, etc..,
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$zfs object required
ZFSCapacityAttributes contains advanced information about pool capacity details
logicalUsed
string | integer required
LogicalUsed is the amount of space that is "logically" consumed by this pool and all its descendents. The logical space ignores the effect of the compression and copies properties, giving a quantity closer to the amount of data that applications see. However, it does include space consumed by metadata.
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$conditions []object
Current state of CSPI with details.
lastTransitionTime
string
Last time the condition transitioned from one status to another.
format:
date-time
lastUpdateTime
string
The last time this condition was updated.
format:
date-time
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string required
Status of the condition, one of True, False, Unknown.
type
string required
Type of CSPC condition.
healthyReplicas
integer required
HealthyReplicas describes the total count of healthy Volume Replicas in the cstor pool
format:
int32
phase
string
The phase of a CStorPool is a simple, high-level summary of the pool state on the node.
provisionedReplicas
integer required
ProvisionedReplicas describes the total count of Volume Replicas present in the cstor pool
format:
int32
readOnly
boolean required
ReadOnly if pool is readOnly or not
versionDetails object
VersionDetails is the openebs version.
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.dataRaidGroups for an exact path