/
ocs.openshift.io_storageclusters.yaml
8170 lines (8170 loc) · 534 KB
/
ocs.openshift.io_storageclusters.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.9.2
creationTimestamp: null
name: storageclusters.ocs.openshift.io
spec:
group: ocs.openshift.io
names:
kind: StorageCluster
listKind: StorageClusterList
plural: storageclusters
singular: storagecluster
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
- description: Current Phase
jsonPath: .status.phase
name: Phase
type: string
- description: External Storage Cluster
jsonPath: .spec.externalStorage.enable
name: External
type: boolean
- jsonPath: .metadata.creationTimestamp
name: Created At
type: string
- description: Storage Cluster Version
jsonPath: .status.version
name: Version
type: string
name: v1
schema:
openAPIV3Schema:
description: StorageCluster represents a cluster including Ceph Cluster, NooBaa
and all the storage and compute resources required.
properties:
apiVersion:
description: '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'
type: string
kind:
description: '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'
type: string
metadata:
type: object
spec:
description: StorageClusterSpec defines the desired state of StorageCluster
properties:
allowRemoteStorageConsumers:
description: AllowRemoteStorageConsumers Indicates that the OCS cluster
should deploy the needed components to enable connections from remote
consumers.
type: boolean
arbiter:
description: ArbiterSpec specifies the storage cluster options related
to arbiter. If Arbiter is enabled, ArbiterLocation in the NodeTopologies
must be specified.
properties:
arbiterMonPVCTemplate:
description: PersistentVolumeClaim is a user's request for and
claim to a persistent volume
properties:
apiVersion:
description: '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'
type: string
kind:
description: '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'
type: string
metadata:
description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata'
properties:
annotations:
additionalProperties:
type: string
type: object
finalizers:
items:
type: string
type: array
labels:
additionalProperties:
type: string
type: object
name:
type: string
namespace:
type: string
type: object
spec:
description: 'spec defines the desired characteristics of
a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
accessModes:
description: 'accessModes contains the desired access
modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
description: 'dataSource field can be used to specify
either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim) If the provisioner
or an external controller can support the specified
data source, it will create a new volume based on the
contents of the specified data source. When the AnyVolumeDataSource
feature gate is enabled, dataSource contents will be
copied to dataSourceRef, and dataSourceRef contents
will be copied to dataSource when dataSourceRef.namespace
is not specified. If the namespace is specified, then
dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
description: APIGroup is the group for the resource
being referenced. If APIGroup is not specified,
the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
type: string
kind:
description: Kind is the type of resource being referenced
type: string
name:
description: Name is the name of resource being referenced
type: string
required:
- kind
- name
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
description: 'dataSourceRef specifies the object from
which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty
API group (non core object) or a PersistentVolumeClaim
object. When this field is specified, volume binding
will only succeed if the type of the specified object
matches some installed volume populator or dynamic provisioner.
This field will replace the functionality of the dataSource
field and as such if both fields are non-empty, they
must have the same value. For backwards compatibility,
when namespace isn''t specified in dataSourceRef, both
fields (dataSource and dataSourceRef) will be set to
the same value automatically if one of them is empty
and the other is non-empty. When namespace is specified
in dataSourceRef, dataSource isn''t set to the same
value and must be empty. There are three important differences
between dataSource and dataSourceRef: * While dataSource
only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim
objects. * While dataSource ignores disallowed values
(dropping them), dataSourceRef preserves all values,
and generates an error if a disallowed value is specified.
* While dataSource only allows local objects, dataSourceRef
allows objects in any namespaces. (Beta) Using this
field requires the AnyVolumeDataSource feature gate
to be enabled. (Alpha) Using the namespace field of
dataSourceRef requires the CrossNamespaceVolumeDataSource
feature gate to be enabled.'
properties:
apiGroup:
description: APIGroup is the group for the resource
being referenced. If APIGroup is not specified,
the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
type: string
kind:
description: Kind is the type of resource being referenced
type: string
name:
description: Name is the name of resource being referenced
type: string
namespace:
description: Namespace is the namespace of resource
being referenced Note that when a namespace is specified,
a gateway.networking.k8s.io/ReferenceGrant object
is required in the referent namespace to allow that
namespace's owner to accept the reference. See the
ReferenceGrant documentation for details. (Alpha)
This field requires the CrossNamespaceVolumeDataSource
feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
description: 'resources represents the minimum resources
the volume should have. If RecoverVolumeExpansionFailure
feature is enabled users are allowed to specify resource
requirements that are lower than previous value but
must still be higher than capacity recorded in the status
field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount
of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: '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/'
type: object
type: object
selector:
description: selector is a label query over volumes to
consider for binding.
properties:
matchExpressions:
description: matchExpressions is a list of label selector
requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector
that contains values, a key, and an operator that
relates the key and values.
properties:
key:
description: key is the label key that the selector
applies to.
type: string
operator:
description: operator represents a key's relationship
to a set of values. Valid operators are In,
NotIn, Exists and DoesNotExist.
type: string
values:
description: values is an array of string values.
If the operator is In or NotIn, the values
array must be non-empty. If the operator is
Exists or DoesNotExist, the values array must
be empty. This array is replaced during a
strategic merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: matchLabels is a map of {key,value} pairs.
A single {key,value} in the matchLabels map is equivalent
to an element of matchExpressions, whose key field
is "key", the operator is "In", and the values array
contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
description: 'storageClassName is the name of the StorageClass
required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeAttributesClassName:
description: 'volumeAttributesClassName may be used to
set the VolumeAttributesClass used by this claim. If
specified, the CSI driver will create or update the
volume with the attributes defined in the corresponding
VolumeAttributesClass. This has a different purpose
than storageClassName, it can be changed after the claim
is created. An empty string value means that no VolumeAttributesClass
will be applied to the claim but it''s not allowed to
reset this field to empty string once it is set. If
unspecified and the PersistentVolumeClaim is unbound,
the default VolumeAttributesClass will be set by the
persistentvolume controller if it exists. If the resource
referred to by volumeAttributesClass does not exist,
this PersistentVolumeClaim will be set to a Pending
state, as reflected by the modifyVolumeStatus field,
until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
(Alpha) Using this field requires the VolumeAttributesClass
feature gate to be enabled.'
type: string
volumeMode:
description: volumeMode defines what type of volume is
required by the claim. Value of Filesystem is implied
when not included in claim spec.
type: string
volumeName:
description: volumeName is the binding reference to the
PersistentVolume backing this claim.
type: string
type: object
status:
description: 'status represents the current information/status
of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
accessModes:
description: 'accessModes contains the actual access modes
the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
allocatedResourceStatuses:
additionalProperties:
description: When a controller receives persistentvolume
claim update with ClaimResourceStatus for a resource
that it does not recognizes, then it should ignore
that update and let other controllers handle it.
type: string
description: "allocatedResourceStatuses stores status
of resource being resized for the given PVC. Key names
follow standard Kubernetes label syntax. Valid values
are either: * Un-prefixed keys: - storage - the capacity
of the volume. * Custom resources must use implementation-defined
prefixed names such as \"example.com/my-custom-resource\"
Apart from above values - keys that are unprefixed or
have kubernetes.io prefix are considered reserved and
hence may not be used. \n ClaimResourceStatus can be
in any of following states: - ControllerResizeInProgress:
State set when resize controller starts resizing the
volume in control-plane. - ControllerResizeFailed: State
set when resize has failed in resize controller with
a terminal error. - NodeResizePending: State set when
resize controller has finished resizing the volume but
further resizing of volume is needed on the node. -
NodeResizeInProgress: State set when kubelet starts
resizing the volume. - NodeResizeFailed: State set when
resizing has failed in kubelet with a terminal error.
Transient errors don't set NodeResizeFailed. For example:
if expanding a PVC for more capacity - this field can
be one of the following states: - pvc.status.allocatedResourceStatus['storage']
= \"ControllerResizeInProgress\" - pvc.status.allocatedResourceStatus['storage']
= \"ControllerResizeFailed\" - pvc.status.allocatedResourceStatus['storage']
= \"NodeResizePending\" - pvc.status.allocatedResourceStatus['storage']
= \"NodeResizeInProgress\" - pvc.status.allocatedResourceStatus['storage']
= \"NodeResizeFailed\" When this field is not set, it
means that no resize operation is in progress for the
given PVC. \n A controller that receives PVC update
with previously unknown resourceName or ClaimResourceStatus
should ignore the update for the purpose it was designed.
For example - a controller that only is responsible
for resizing capacity of the volume, should ignore PVC
updates that change other valid resources associated
with PVC. \n This is an alpha field and requires enabling
RecoverVolumeExpansionFailure feature."
type: object
x-kubernetes-map-type: granular
allocatedResources:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: "allocatedResources tracks the resources
allocated to a PVC including its capacity. Key names
follow standard Kubernetes label syntax. Valid values
are either: * Un-prefixed keys: - storage - the capacity
of the volume. * Custom resources must use implementation-defined
prefixed names such as \"example.com/my-custom-resource\"
Apart from above values - keys that are unprefixed or
have kubernetes.io prefix are considered reserved and
hence may not be used. \n Capacity reported here may
be larger than the actual capacity when a volume expansion
operation is requested. For storage quota, the larger
value from allocatedResources and PVC.spec.resources
is used. If allocatedResources is not set, PVC.spec.resources
alone is used for quota calculation. If a volume expansion
capacity request is lowered, allocatedResources is only
lowered if there are no expansion operations in progress
and if the actual volume capacity is equal or lower
than the requested capacity. \n A controller that receives
PVC update with previously unknown resourceName should
ignore the update for the purpose it was designed. For
example - a controller that only is responsible for
resizing capacity of the volume, should ignore PVC updates
that change other valid resources associated with PVC.
\n This is an alpha field and requires enabling RecoverVolumeExpansionFailure
feature."
type: object
capacity:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: capacity represents the actual resources
of the underlying volume.
type: object
conditions:
description: conditions is the current Condition of persistent
volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'ResizeStarted'.
items:
description: PersistentVolumeClaimCondition contains
details about state of pvc
properties:
lastProbeTime:
description: lastProbeTime is the time we probed
the condition.
format: date-time
type: string
lastTransitionTime:
description: lastTransitionTime is the time the
condition transitioned from one status to another.
format: date-time
type: string
message:
description: message is the human-readable message
indicating details about last transition.
type: string
reason:
description: reason is a unique, this should be
a short, machine understandable string that gives
the reason for condition's last transition. If
it reports "ResizeStarted" that means the underlying
persistent volume is being resized.
type: string
status:
type: string
type:
description: PersistentVolumeClaimConditionType
is a valid value of PersistentVolumeClaimCondition.Type
type: string
required:
- status
- type
type: object
type: array
currentVolumeAttributesClassName:
description: currentVolumeAttributesClassName is the current
name of the VolumeAttributesClass the PVC is using.
When unset, there is no VolumeAttributeClass applied
to this PersistentVolumeClaim This is an alpha field
and requires enabling VolumeAttributesClass feature.
type: string
modifyVolumeStatus:
description: ModifyVolumeStatus represents the status
object of ControllerModifyVolume operation. When this
is unset, there is no ModifyVolume operation being attempted.
This is an alpha field and requires enabling VolumeAttributesClass
feature.
properties:
status:
description: 'status is the status of the ControllerModifyVolume
operation. It can be in any of following states:
- Pending Pending indicates that the PersistentVolumeClaim
cannot be modified due to unmet requirements, such
as the specified VolumeAttributesClass not existing.
- InProgress InProgress indicates that the volume
is being modified. - Infeasible Infeasible indicates
that the request has been rejected as invalid by
the CSI driver. To resolve the error, a valid VolumeAttributesClass
needs to be specified. Note: New statuses can be
added in the future. Consumers should check for
unknown statuses and fail appropriately.'
type: string
targetVolumeAttributesClassName:
description: targetVolumeAttributesClassName is the
name of the VolumeAttributesClass the PVC currently
being reconciled
type: string
required:
- status
type: object
phase:
description: phase represents the current phase of PersistentVolumeClaim.
type: string
type: object
type: object
disableMasterNodeToleration:
description: DisableMasterNodeToleration can be used to turn off
the arbiter mon toleration for the master node taint.
type: boolean
enable:
type: boolean
type: object
backingStorageClasses:
description: BackingStorageClasses is a list of storage classes that
will be provisioned by the storagecluster controller to be used
in storageDeviceSets section of the CR.
items:
description: BackingStorageClass defines the backing storageclass
for StorageDeviceSet
properties:
metadata:
properties:
annotations:
additionalProperties:
type: string
type: object
finalizers:
items:
type: string
type: array
labels:
additionalProperties:
type: string
type: object
name:
type: string
namespace:
type: string
type: object
parameters:
additionalProperties:
type: string
description: Parameters holds the parameters for the provisioner
that should create volumes of this storage class.
type: object
provisioner:
description: Provisioner indicates the type of the provisioner.
type: string
type: object
type: array
csi:
description: CSIDriverSpec defines the CSI driver settings for the
StorageCluster.
properties:
readAffinity:
description: ReadAffinity defines the read affinity settings for
CSI driver.
properties:
crushLocationLabels:
description: CrushLocationLabels defines which node labels
to use as CRUSH location. This should correspond to the
values set in the CRUSH map.
items:
type: string
type: array
enabled:
description: Enables read affinity for CSI driver.
type: boolean
type: object
type: object
defaultStorageProfile:
description: DefaultStorageProfile is the default storage profile
to use for the storagerequest as StorageProfile is optional.
type: string
enableCephTools:
description: EnableCephTools toggles on whether or not the ceph tools
pod should be deployed. Defaults to false
type: boolean
encryption:
description: EncryptionSpec defines if encryption should be enabled
for the Storage Cluster It is optional and defaults to false.
properties:
clusterWide:
type: boolean
enable:
description: deprecated from OCS 4.10 onwards, acting as a dummy,
UI will keep sending this flag for backward compatibility (OCP
4.10 + OCS 4.9)
type: boolean
keyRotation:
description: KeyRotation defines options for Key Rotation.
properties:
enable:
description: Enable represents whether the key rotation is
enabled.
type: boolean
schedule:
default: '@weekly'
description: Schedule represents the cron schedule for key
rotation.
type: string
type: object
kms:
description: KeyManagementServiceSpec provides a way to enable
KMS
properties:
enable:
type: boolean
type: object
storageClass:
type: boolean
storageClassName:
description: StorageClassName specifies the name of the storage
class created for ceph encrypted block pools
maxLength: 253
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
type: object
externalStorage:
description: ExternalStorage is optional and defaults to false. When
set to true, OCS will connect to an external OCS Storage Cluster
instead of provisioning one locally.
properties:
enable:
type: boolean
type: object
flexibleScaling:
description: If enabled, sets the failureDomain to host, allowing
devices to be distributed evenly across all nodes, regardless of
distribution in zones or racks.
type: boolean
hostNetwork:
description: HostNetwork defaults to false
type: boolean
instanceType:
type: string
labelSelector:
description: LabelSelector is used to specify custom labels of nodes
to run OCS on
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: A label selector requirement is a selector that
contains values, a key, and an operator that relates the key
and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: operator represents a key's relationship to
a set of values. Valid operators are In, NotIn, Exists
and DoesNotExist.
type: string
values:
description: values is an array of string values. If the
operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values
array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator
is "In", and the values array contains only "value". The requirements
are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
logCollector:
description: Logging represents loggings settings
nullable: true
properties:
enabled:
description: Enabled represents whether the log collector is enabled
type: boolean
maxLogSize:
anyOf:
- type: integer
- type: string
description: MaxLogSize is the maximum size of the log per ceph
daemons. Must be at least 1M.
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
periodicity:
description: Periodicity is the periodicity of the log rotation.
pattern: ^$|^(hourly|daily|weekly|monthly|1h|24h|1d)$
type: string
type: object
manageNodes:
type: boolean
managedResources:
description: ManagedResources specifies how to deal with auxiliary
resources reconciled with the StorageCluster
properties:
cephBlockPools:
description: ManageCephBlockPools defines how to reconcile CephBlockPools
properties:
defaultStorageClass:
description: if set to true, the storageClass created for
cephBlockPools will be annotated as the default for the
whole cluster
type: boolean
disableSnapshotClass:
type: boolean
disableStorageClass:
type: boolean
reconcileStrategy:
type: string
storageClassName:
description: StorageClassName specifies the name of the storage
class created for ceph block pools
maxLength: 253
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
virtualizationStorageClassName:
description: VirtualizationStorageClassName specifies the
name of the storage class created for ceph block pools for
virtualization environment
maxLength: 253
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
type: object
cephCluster:
description: ManageCephCluster defines how to reconcile the Ceph
cluster definition
properties:
mgrCount:
enum:
- 1
- 2
type: integer
monCount:
enum:
- 3
- 5
type: integer
reconcileStrategy:
type: string
waitTimeoutForHealthyOSDInMinutes:
description: WaitTimeoutForHealthyOSDInMinutes defines the
time the operator would wait before an OSD can be stopped
for upgrade or restart. If `continueUpgradeAfterChecksEvenIfNotHealthy`
is `false` and the timeout exceeds and OSD is not ok to
stop, then the operator would skip upgrade for the current
OSD and proceed with the next one. If `continueUpgradeAfterChecksEvenIfNotHealthy`
is `true`, then operator would continue with the upgrade
of an OSD even if its not ok to stop after the timeout.
This timeout won't be applied if `skipUpgradeChecks` is
`true`. The default wait timeout is 10 minutes.
format: int64
type: integer
type: object
cephConfig:
description: ManageCephConfig defines how to reconcile the Ceph
configuration
properties:
reconcileStrategy:
type: string
type: object
cephDashboard:
description: ManageCephDashboard defines how to reconcile Ceph
dashboard
properties:
enable:
type: boolean
ssl:
description: serve the dashboard using SSL
type: boolean
type: object
cephFilesystems:
description: ManageCephFilesystems defines how to reconcile CephFilesystems
properties:
activeMetadataServers:
type: integer
additionalDataPools:
description: AdditionalDataPools specifies list of additional
named cephfs data pools
items:
description: NamedPoolSpec represents the named ceph pool
spec
properties:
application:
description: The application name to set on the pool.
Only expected to be set for rgw pools.
type: string
compressionMode:
description: 'DEPRECATED: use Parameters instead, e.g.,
Parameters["compression_mode"] = "force" The inline
compression mode in Bluestore OSD to set to (options
are: none, passive, aggressive, force) Do NOT set
a default value for kubebuilder as this will override
the Parameters'
enum:
- none
- passive
- aggressive
- force
- ""
nullable: true
type: string
crushRoot:
description: The root of the crush hierarchy utilized
by the pool
nullable: true
type: string
deviceClass:
description: The device class the OSD should set to
for use in the pool
nullable: true
type: string
enableRBDStats:
description: EnableRBDStats is used to enable gathering
of statistics for all RBD images in the pool
type: boolean
erasureCoded:
description: The erasure code settings
properties:
algorithm:
description: The algorithm for erasure coding
type: string
codingChunks:
description: Number of coding chunks per object
in an erasure coded storage pool (required for
erasure-coded pool type). This is the number of
OSDs that can be lost simultaneously before data
cannot be recovered.
minimum: 0
type: integer
dataChunks:
description: Number of data chunks per object in
an erasure coded storage pool (required for erasure-coded
pool type). The number of chunks required to recover
an object when any single OSD is lost is the same
as dataChunks so be aware that the larger the
number of data chunks, the higher the cost of
recovery.
minimum: 0
type: integer
required:
- codingChunks
- dataChunks
type: object
failureDomain:
description: 'The failure domain: osd/host/(region or
zone if available) - technically also any type in
the crush map'
type: string
mirroring:
description: The mirroring settings
properties:
enabled:
description: Enabled whether this pool is mirrored
or not
type: boolean
mode:
description: 'Mode is the mirroring mode: either
pool or image'
type: string
peers:
description: Peers represents the peers spec
nullable: true
properties:
secretNames:
description: SecretNames represents the Kubernetes
Secret names to add rbd-mirror or cephfs-mirror
peers
items:
type: string
type: array
type: object
snapshotSchedules:
description: SnapshotSchedules is the scheduling
of snapshot for mirrored images/pools
items:
description: SnapshotScheduleSpec represents the
snapshot scheduling settings of a mirrored pool
properties:
interval:
description: Interval represent the periodicity
of the snapshot.
type: string
path:
description: Path is the path to snapshot,
only valid for CephFS
type: string
startTime:
description: StartTime indicates when to start
the snapshot
type: string
type: object
type: array
type: object
name:
description: Name of the pool
type: string
parameters:
additionalProperties:
type: string
description: Parameters is a list of properties to enable
on a given pool
nullable: true
type: object
x-kubernetes-preserve-unknown-fields: true
quotas:
description: The quota settings
nullable: true
properties:
maxBytes:
description: MaxBytes represents the quota in bytes
Deprecated in favor of MaxSize
format: int64
type: integer
maxObjects:
description: MaxObjects represents the quota in
objects
format: int64
type: integer
maxSize:
description: MaxSize represents the quota in bytes
as a string
pattern: ^[0-9]+[\.]?[0-9]*([KMGTPE]i|[kMGTPE])?$
type: string
type: object
replicated:
description: The replication settings
properties:
hybridStorage:
description: HybridStorage represents hybrid storage
tier settings
nullable: true
properties:
primaryDeviceClass:
description: PrimaryDeviceClass represents high
performance tier (for example SSD or NVME)
for Primary OSD
minLength: 1
type: string
secondaryDeviceClass:
description: SecondaryDeviceClass represents
low performance tier (for example HDDs) for
remaining OSDs
minLength: 1
type: string
required:
- primaryDeviceClass
- secondaryDeviceClass
type: object
replicasPerFailureDomain:
description: ReplicasPerFailureDomain the number
of replica in the specified failure domain
minimum: 1
type: integer
requireSafeReplicaSize:
description: RequireSafeReplicaSize if false allows
you to set replica 1
type: boolean
size:
description: Size - Number of copies per object
in a replicated storage pool, including the object
itself (required for replicated pool type)
minimum: 0
type: integer
subFailureDomain:
description: SubFailureDomain the name of the sub-failure
domain
type: string
targetSizeRatio:
description: TargetSizeRatio gives a hint (%) to
Ceph in terms of expected consumption of the total
cluster capacity
type: number
required:
- size
type: object
statusCheck:
description: The mirroring statusCheck
properties:
mirror:
description: HealthCheckSpec represents the health
check of an object store bucket
nullable: true
properties:
disabled:
type: boolean
interval:
description: Interval is the internal in second
or minute for the health check to run like
60s for 60 seconds
type: string
timeout:
type: string
type: object
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
type: array
dataPoolSpec:
description: DataPoolSpec specifies the pool specification
for the default cephfs data pool