ceph.rook.io / v1 / CephObjectZone

• string

  .apiVersion

  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

• string

  .kind

  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

• object required

  .metadata

• object required

  .spec

  ObjectZoneSpec represent the spec of an ObjectZone

• array | null

  .spec .customEndpoints

  If this zone cannot be accessed from other peer Ceph clusters via the ClusterIP Service endpoint created by Rook, you must set this to the externally reachable endpoint(s). You may include the port in the definition. For example: “https://my-object-store.my-domain.net:443”. In many cases, you should set this to the endpoint of the ingress resource that makes the CephObjectStore associated with this CephObjectStoreZone reachable to peer clusters. The list can have one or more endpoints pointing to different RGW servers in the zone.

  If a CephObjectStore endpoint is omitted from this list, that object store’s gateways will not receive multisite replication data (see CephObjectStore.spec.gateway.disableMultisiteSyncTraffic).

• object | null

  .spec .dataPool

  The data pool settings

• string

  .spec .dataPool .application

  The application name to set on the pool. Only expected to be set for rgw pools.

• string | null

  .spec .dataPool .compressionMode

  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

• string | null

  .spec .dataPool .crushRoot

  The root of the crush hierarchy utilized by the pool

• string | null

  .spec .dataPool .deviceClass

  The device class the OSD should set to for use in the pool

• boolean

  .spec .dataPool .enableCrushUpdates

  Allow rook operator to change the pool CRUSH tunables once the pool is created

• boolean

  .spec .dataPool .enableRBDStats

  EnableRBDStats is used to enable gathering of statistics for all RBD images in the pool

• object

  .spec .dataPool .erasureCoded

  The erasure code settings

• string

  .spec .dataPool .erasureCoded .algorithm

  The algorithm for erasure coding

• integer required

  .spec .dataPool .erasureCoded .codingChunks

  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.

• integer required

  .spec .dataPool .erasureCoded .dataChunks

  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.

• string

  .spec .dataPool .failureDomain

  The failure domain: osd/host/(region or zone if available) - technically also any type in the crush map

• object

  .spec .dataPool .mirroring

  The mirroring settings

• boolean

  .spec .dataPool .mirroring .enabled

  Enabled whether this pool is mirrored or not

• string

  .spec .dataPool .mirroring .mode

  Mode is the mirroring mode: pool, image or init-only.

• object | null

  .spec .dataPool .mirroring .peers

  Peers represents the peers spec

• array

  .spec .dataPool .mirroring .peers .secretNames

  SecretNames represents the Kubernetes Secret names to add rbd-mirror or cephfs-mirror peers

• array

  .spec .dataPool .mirroring .snapshotSchedules

  SnapshotSchedules is the scheduling of snapshot for mirrored images/pools

• string

  .spec .dataPool .mirroring .snapshotSchedules[] .interval

  Interval represent the periodicity of the snapshot.

• string

  .spec .dataPool .mirroring .snapshotSchedules[] .path

  Path is the path to snapshot, only valid for CephFS

• string

  .spec .dataPool .mirroring .snapshotSchedules[] .startTime

  StartTime indicates when to start the snapshot

• object | null

  .spec .dataPool .parameters

  Parameters is a list of properties to enable on a given pool

• object | null

  .spec .dataPool .quotas

  The quota settings

• integer

  .spec .dataPool .quotas .maxBytes

  MaxBytes represents the quota in bytes Deprecated in favor of MaxSize

• integer

  .spec .dataPool .quotas .maxObjects

  MaxObjects represents the quota in objects

• string

  .spec .dataPool .quotas .maxSize

  MaxSize represents the quota in bytes as a string

• object

  .spec .dataPool .replicated

  The replication settings

• object | null

  .spec .dataPool .replicated .hybridStorage

  HybridStorage represents hybrid storage tier settings

• string required

  .spec .dataPool .replicated .hybridStorage .primaryDeviceClass

  PrimaryDeviceClass represents high performance tier (for example SSD or NVME) for Primary OSD

• string required

  .spec .dataPool .replicated .hybridStorage .secondaryDeviceClass

  SecondaryDeviceClass represents low performance tier (for example HDDs) for remaining OSDs

• integer

  .spec .dataPool .replicated .replicasPerFailureDomain

  ReplicasPerFailureDomain the number of replica in the specified failure domain

• boolean

  .spec .dataPool .replicated .requireSafeReplicaSize

  RequireSafeReplicaSize if false allows you to set replica 1

• integer required

  .spec .dataPool .replicated .size

  Size - Number of copies per object in a replicated storage pool, including the object itself (required for replicated pool type)

• string

  .spec .dataPool .replicated .subFailureDomain

  SubFailureDomain the name of the sub-failure domain

• number

  .spec .dataPool .replicated .targetSizeRatio

  TargetSizeRatio gives a hint (%) to Ceph in terms of expected consumption of the total cluster capacity

• object

  .spec .dataPool .statusCheck

  The mirroring statusCheck

• object | null

  .spec .dataPool .statusCheck .mirror

  HealthCheckSpec represents the health check of an object store bucket

• boolean

  .spec .dataPool .statusCheck .mirror .disabled

• string

  .spec .dataPool .statusCheck .mirror .interval

  Interval is the internal in second or minute for the health check to run like 60s for 60 seconds

• string

  .spec .dataPool .statusCheck .mirror .timeout

• object | null

  .spec .metadataPool

  The metadata pool settings

• string

  .spec .metadataPool .application

  The application name to set on the pool. Only expected to be set for rgw pools.

• string | null

  .spec .metadataPool .compressionMode

  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

• string | null

  .spec .metadataPool .crushRoot

  The root of the crush hierarchy utilized by the pool

• string | null

  .spec .metadataPool .deviceClass

  The device class the OSD should set to for use in the pool

• boolean

  .spec .metadataPool .enableCrushUpdates

  Allow rook operator to change the pool CRUSH tunables once the pool is created

• boolean

  .spec .metadataPool .enableRBDStats

  EnableRBDStats is used to enable gathering of statistics for all RBD images in the pool

• object

  .spec .metadataPool .erasureCoded

  The erasure code settings

• string

  .spec .metadataPool .erasureCoded .algorithm

  The algorithm for erasure coding

• integer required

  .spec .metadataPool .erasureCoded .codingChunks

  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.

• integer required

  .spec .metadataPool .erasureCoded .dataChunks

  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.

• string

  .spec .metadataPool .failureDomain

  The failure domain: osd/host/(region or zone if available) - technically also any type in the crush map

• object

  .spec .metadataPool .mirroring

  The mirroring settings

• boolean

  .spec .metadataPool .mirroring .enabled

  Enabled whether this pool is mirrored or not

• string

  .spec .metadataPool .mirroring .mode

  Mode is the mirroring mode: pool, image or init-only.

• object | null

  .spec .metadataPool .mirroring .peers

  Peers represents the peers spec

• array

  .spec .metadataPool .mirroring .peers .secretNames

  SecretNames represents the Kubernetes Secret names to add rbd-mirror or cephfs-mirror peers

• array

  .spec .metadataPool .mirroring .snapshotSchedules

  SnapshotSchedules is the scheduling of snapshot for mirrored images/pools

• string

  .spec .metadataPool .mirroring .snapshotSchedules[] .interval

  Interval represent the periodicity of the snapshot.

• string

  .spec .metadataPool .mirroring .snapshotSchedules[] .path

  Path is the path to snapshot, only valid for CephFS

• string

  .spec .metadataPool .mirroring .snapshotSchedules[] .startTime

  StartTime indicates when to start the snapshot

• object | null

  .spec .metadataPool .parameters

  Parameters is a list of properties to enable on a given pool

• object | null

  .spec .metadataPool .quotas

  The quota settings

• integer

  .spec .metadataPool .quotas .maxBytes

  MaxBytes represents the quota in bytes Deprecated in favor of MaxSize

• integer

  .spec .metadataPool .quotas .maxObjects

  MaxObjects represents the quota in objects

• string

  .spec .metadataPool .quotas .maxSize

  MaxSize represents the quota in bytes as a string

• object

  .spec .metadataPool .replicated

  The replication settings

• object | null

  .spec .metadataPool .replicated .hybridStorage

  HybridStorage represents hybrid storage tier settings

• string required

  .spec .metadataPool .replicated .hybridStorage .primaryDeviceClass

  PrimaryDeviceClass represents high performance tier (for example SSD or NVME) for Primary OSD

• string required

  .spec .metadataPool .replicated .hybridStorage .secondaryDeviceClass

  SecondaryDeviceClass represents low performance tier (for example HDDs) for remaining OSDs

• integer

  .spec .metadataPool .replicated .replicasPerFailureDomain

  ReplicasPerFailureDomain the number of replica in the specified failure domain

• boolean

  .spec .metadataPool .replicated .requireSafeReplicaSize

  RequireSafeReplicaSize if false allows you to set replica 1

• integer required

  .spec .metadataPool .replicated .size

  Size - Number of copies per object in a replicated storage pool, including the object itself (required for replicated pool type)

• string

  .spec .metadataPool .replicated .subFailureDomain

  SubFailureDomain the name of the sub-failure domain

• number

  .spec .metadataPool .replicated .targetSizeRatio

  TargetSizeRatio gives a hint (%) to Ceph in terms of expected consumption of the total cluster capacity

• object

  .spec .metadataPool .statusCheck

  The mirroring statusCheck

• object | null

  .spec .metadataPool .statusCheck .mirror

  HealthCheckSpec represents the health check of an object store bucket

• boolean

  .spec .metadataPool .statusCheck .mirror .disabled

• string

  .spec .metadataPool .statusCheck .mirror .interval

  Interval is the internal in second or minute for the health check to run like 60s for 60 seconds

• string

  .spec .metadataPool .statusCheck .mirror .timeout

• boolean

  .spec .preservePoolsOnDelete

  Preserve pools on object zone deletion

• object | null

  .spec .sharedPools

  The pool information when configuring RADOS namespaces in existing pools.

• string

  .spec .sharedPools .dataPoolName

  The data pool used for creating RADOS namespaces in the object store

• string

  .spec .sharedPools .metadataPoolName

  The metadata pool used for creating RADOS namespaces in the object store

• array

  .spec .sharedPools .poolPlacements

  PoolPlacements control which Pools are associated with a particular RGW bucket. Once PoolPlacements are defined, RGW client will be able to associate pool with ObjectStore bucket by providing “

• string

  .spec .sharedPools .poolPlacements[] .dataNonECPoolName

  The data pool used to store ObjectStore data that cannot use erasure coding (ex: multi-part uploads). If dataPoolName is not erasure coded, then there is no need for dataNonECPoolName.

• string required

  .spec .sharedPools .poolPlacements[] .dataPoolName

  The data pool used to store ObjectStore objects data.

• boolean

  .spec .sharedPools .poolPlacements[] .default

  Sets given placement as default. Only one placement in the list can be marked as default. Default is false.

• string required

  .spec .sharedPools .poolPlacements[] .metadataPoolName

  The metadata pool used to store ObjectStore bucket index.

• string required

  .spec .sharedPools .poolPlacements[] .name

  Pool placement name. Name can be arbitrary. Placement with name “default” will be used as default.

• array

  .spec .sharedPools .poolPlacements[] .storageClasses

  StorageClasses can be selected by user to override dataPoolName during object creation. Each placement has default STANDARD StorageClass pointing to dataPoolName. This list allows defining additional StorageClasses on top of default STANDARD storage class.

• string required

  .spec .sharedPools .poolPlacements[] .storageClasses[] .dataPoolName

  DataPoolName is the data pool used to store ObjectStore objects data.

• string required

  .spec .sharedPools .poolPlacements[] .storageClasses[] .name

  Name is the StorageClass name. Ceph allows arbitrary name for StorageClasses, however most clients/libs insist on AWS names so it is recommended to use one of the valid x-amz-storage-class values for better compatibility: REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE See AWS docs: https://aws.amazon.com/de/s3/storage-classes/

• boolean

  .spec .sharedPools .preserveRadosNamespaceDataOnDelete

  Whether the RADOS namespaces should be preserved on deletion of the object store

• string required

  .spec .zoneGroup

  The display name for the ceph users

• object

  .status

  Status represents the status of an object

• array

  .status .conditions

• string

  .status .conditions[] .lastHeartbeatTime

• string

  .status .conditions[] .lastTransitionTime

• string

  .status .conditions[] .message

• string

  .status .conditions[] .reason

  ConditionReason is a reason for a condition

• string

  .status .conditions[] .status

• string

  .status .conditions[] .type

  ConditionType represent a resource’s status

• integer

  .status .observedGeneration

  ObservedGeneration is the latest generation observed by the controller.

• string

  .status .phase