github.com/openebs/api@v1.12.0/config/crds/bases/cstor.openebs.io_cstorvolumes.yaml (about) 1 2 --- 3 apiVersion: apiextensions.k8s.io/v1beta1 4 kind: CustomResourceDefinition 5 metadata: 6 annotations: 7 controller-gen.kubebuilder.io/version: v0.2.9 8 creationTimestamp: null 9 name: cstorvolumes.cstor.openebs.io 10 spec: 11 group: cstor.openebs.io 12 names: 13 kind: CStorVolume 14 listKind: CStorVolumeList 15 plural: cstorvolumes 16 singular: cstorvolume 17 scope: Namespaced 18 validation: 19 openAPIV3Schema: 20 description: CStorVolume describes a cstor volume resource created as custom 21 resource 22 properties: 23 apiVersion: 24 description: 'APIVersion defines the versioned schema of this representation 25 of an object. Servers should convert recognized schemas to the latest 26 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 27 type: string 28 kind: 29 description: 'Kind is a string value representing the REST resource this 30 object represents. Servers may infer this from the endpoint the client 31 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 32 type: string 33 metadata: 34 type: object 35 spec: 36 description: CStorVolumeSpec is the spec for a CStorVolume resource 37 properties: 38 capacity: 39 anyOf: 40 - type: integer 41 - type: string 42 description: Capacity represents the desired size of the underlying 43 volume. 44 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ 45 x-kubernetes-int-or-string: true 46 consistencyFactor: 47 description: ConsistencyFactor is minimum number of volume replicas 48 i.e. `RF/2 + 1` has to be connected to the target for write operations. 49 Basically more then 50% of replica has to be connected to target. 50 type: integer 51 desiredReplicationFactor: 52 description: DesiredReplicationFactor represents maximum number of replicas 53 that are allowed to connect to the target. Required for scale operations 54 type: integer 55 iqn: 56 description: Target iSCSI Qualified Name.combination of nodeBase 57 type: string 58 replicaDetails: 59 description: ReplicaDetails refers to the trusty replica information 60 properties: 61 knownReplicas: 62 additionalProperties: 63 type: string 64 description: KnownReplicas represents the replicas that target can 65 trust to read data 66 type: object 67 type: object 68 replicationFactor: 69 description: ReplicationFactor represents number of volume replica created 70 during volume provisioning connect to the target 71 type: integer 72 targetIP: 73 description: TargetIP IP of the iSCSI target service 74 type: string 75 targetPort: 76 description: iSCSI Target Port typically TCP ports 3260 77 type: string 78 targetPortal: 79 description: iSCSI Target Portal. The Portal is combination of IP:port 80 (typically TCP ports 3260) 81 type: string 82 required: 83 - capacity 84 - consistencyFactor 85 - desiredReplicationFactor 86 - iqn 87 - replicationFactor 88 - targetIP 89 - targetPort 90 - targetPortal 91 type: object 92 status: 93 description: CStorVolumeStatus is for handling status of cvr. 94 properties: 95 capacity: 96 anyOf: 97 - type: integer 98 - type: string 99 description: Represents the actual capacity of the underlying volume. 100 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ 101 x-kubernetes-int-or-string: true 102 conditions: 103 description: Current Condition of cstorvolume. If underlying persistent 104 volume is being resized then the Condition will be set to 'ResizePending'. 105 items: 106 description: CStorVolumeCondition contains details about state of 107 cstorvolume 108 properties: 109 lastProbeTime: 110 description: Last time we probed the condition. 111 format: date-time 112 type: string 113 lastTransitionTime: 114 description: Last time the condition transitioned from one status 115 to another. 116 format: date-time 117 type: string 118 message: 119 description: Human-readable message indicating details about last 120 transition. 121 type: string 122 reason: 123 description: Unique, this should be a short, machine understandable 124 string that gives the reason for condition's last transition. 125 If it reports "ResizePending" that means the underlying cstorvolume 126 is being resized. 127 type: string 128 status: 129 description: ConditionStatus states in which state condition is 130 present 131 type: string 132 type: 133 description: CStorVolumeConditionType is a valid value of CStorVolumeCondition.Type 134 type: string 135 required: 136 - status 137 - type 138 type: object 139 type: array 140 lastTransitionTime: 141 description: LastTransitionTime refers to the time when the phase changes 142 format: date-time 143 type: string 144 lastUpdateTime: 145 description: LastUpdateTime refers to the time when last status updated 146 due to any operations 147 format: date-time 148 type: string 149 message: 150 description: A human-readable message indicating details about why the 151 volume is in this state. 152 type: string 153 phase: 154 description: CStorVolumePhase is to hold result of action. 155 type: string 156 replicaDetails: 157 description: ReplicaDetails refers to the trusty replica information 158 properties: 159 knownReplicas: 160 additionalProperties: 161 type: string 162 description: KnownReplicas represents the replicas that target can 163 trust to read data 164 type: object 165 type: object 166 replicaStatuses: 167 items: 168 description: ReplicaStatus stores the status of replicas 169 properties: 170 checkpointedIOSeq: 171 description: Represents IO number of replica persisted on the 172 disk 173 type: string 174 inflightRead: 175 description: Ongoing reads I/O from target to replica 176 type: string 177 inflightSync: 178 description: Ongoing sync I/O from target to replica 179 type: string 180 inflightWrite: 181 description: ongoing writes I/O from target to replica 182 type: string 183 mode: 184 description: Mode represents replica status i.e. Healthy, Degraded 185 type: string 186 quorum: 187 description: 'Quorum indicates wheather data wrtitten to the replica 188 is lost or exists. "0" means: data has been lost( might be ephimeral 189 case) and will recostruct data from other Healthy replicas in 190 a write-only mode 1 means: written data is exists on replica' 191 type: string 192 replicaId: 193 description: ID is replica unique identifier 194 type: string 195 upTime: 196 description: time since the replica connected to target 197 type: integer 198 required: 199 - checkpointedIOSeq 200 - inflightRead 201 - inflightSync 202 - inflightWrite 203 - mode 204 - quorum 205 - replicaId 206 - upTime 207 type: object 208 type: array 209 required: 210 - phase 211 type: object 212 versionDetails: 213 description: VersionDetails provides the details for upgrade 214 properties: 215 autoUpgrade: 216 description: If AutoUpgrade is set to true then the resource is upgraded 217 automatically without any manual steps 218 type: boolean 219 desired: 220 description: Desired is the version that we want to upgrade or the control 221 plane version 222 type: string 223 status: 224 description: Status gives the status of reconciliation triggered when 225 the desired and current version are not same 226 properties: 227 current: 228 description: Current is the version of resource 229 type: string 230 dependentsUpgraded: 231 description: DependentsUpgraded gives the details whether all children 232 of a resource are upgraded to desired version or not 233 type: boolean 234 lastUpdateTime: 235 description: LastUpdateTime is the time the status was last updated 236 format: date-time 237 type: string 238 message: 239 description: Message is a human readable message if some error occurs 240 type: string 241 reason: 242 description: Reason is the actual reason for the error state 243 type: string 244 state: 245 description: State is the state of reconciliation 246 type: string 247 required: 248 - current 249 - dependentsUpgraded 250 - state 251 type: object 252 required: 253 - autoUpgrade 254 - desired 255 - status 256 type: object 257 required: 258 - spec 259 - status 260 - versionDetails 261 type: object 262 version: v1 263 versions: 264 - name: v1 265 served: true 266 storage: true 267 status: 268 acceptedNames: 269 kind: "" 270 plural: "" 271 conditions: [] 272 storedVersions: []