ceph.rook.io / v1 / CephBlockPool

• 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

  NamedBlockPoolSpec allows a block pool to be created with a non-default name. This is more specific than the NamedPoolSpec so we get schema validation on the allowed pool names that can be specified.

• string

  .spec .application

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

• string | null

  .spec .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 .crushRoot

  The root of the crush hierarchy utilized by the pool

• string | null

  .spec .deviceClass

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

• boolean

  .spec .enableCrushUpdates

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

• boolean

  .spec .enableRBDStats

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

• object

  .spec .erasureCoded

  The erasure code settings

• string

  .spec .erasureCoded .algorithm

  The algorithm for erasure coding

• integer required

  .spec .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 .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 .failureDomain

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

• object

  .spec .mirroring

  The mirroring settings

• boolean

  .spec .mirroring .enabled

  Enabled whether this pool is mirrored or not

• string

  .spec .mirroring .mode

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

• object | null

  .spec .mirroring .peers

  Peers represents the peers spec

• array

  .spec .mirroring .peers .secretNames

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

• array

  .spec .mirroring .snapshotSchedules

  SnapshotSchedules is the scheduling of snapshot for mirrored images/pools

• string

  .spec .mirroring .snapshotSchedules[] .interval

  Interval represent the periodicity of the snapshot.

• string

  .spec .mirroring .snapshotSchedules[] .path

  Path is the path to snapshot, only valid for CephFS

• string

  .spec .mirroring .snapshotSchedules[] .startTime

  StartTime indicates when to start the snapshot

• string

  .spec .name

  The desired name of the pool if different from the CephBlockPool CR name.

• object | null

  .spec .parameters

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

• object | null

  .spec .quotas

  The quota settings

• integer

  .spec .quotas .maxBytes

  MaxBytes represents the quota in bytes Deprecated in favor of MaxSize

• integer

  .spec .quotas .maxObjects

  MaxObjects represents the quota in objects

• string

  .spec .quotas .maxSize

  MaxSize represents the quota in bytes as a string

• object

  .spec .replicated

  The replication settings

• object | null

  .spec .replicated .hybridStorage

  HybridStorage represents hybrid storage tier settings

• string required

  .spec .replicated .hybridStorage .primaryDeviceClass

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

• string required

  .spec .replicated .hybridStorage .secondaryDeviceClass

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

• integer

  .spec .replicated .replicasPerFailureDomain

  ReplicasPerFailureDomain the number of replica in the specified failure domain

• boolean

  .spec .replicated .requireSafeReplicaSize

  RequireSafeReplicaSize if false allows you to set replica 1

• integer required

  .spec .replicated .size

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

• string

  .spec .replicated .subFailureDomain

  SubFailureDomain the name of the sub-failure domain

• number

  .spec .replicated .targetSizeRatio

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

• object

  .spec .statusCheck

  The mirroring statusCheck

• object | null

  .spec .statusCheck .mirror

  HealthCheckSpec represents the health check of an object store bucket

• boolean

  .spec .statusCheck .mirror .disabled

• string

  .spec .statusCheck .mirror .interval

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

• string

  .spec .statusCheck .mirror .timeout

• object

  .status

  CephBlockPoolStatus represents the mirroring status of Ceph Storage Pool

• 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

• object | null

  .status .info

• object

  .status .mirroringInfo

  MirroringInfoSpec is the status of the pool/radosnamespace mirroring

• string

  .status .mirroringInfo .details

• string

  .status .mirroringInfo .lastChanged

• string

  .status .mirroringInfo .lastChecked

• string

  .status .mirroringInfo .mode

  Mode is the mirroring mode

• array

  .status .mirroringInfo .peers

  Peers are the list of peer sites connected to that cluster

• string

  .status .mirroringInfo .peers[] .client_name

  ClientName is the CephX user used to connect to the peer

• string

  .status .mirroringInfo .peers[] .direction

  Direction is the peer mirroring direction

• string

  .status .mirroringInfo .peers[] .mirror_uuid

  MirrorUUID is the mirror UUID

• string

  .status .mirroringInfo .peers[] .site_name

  SiteName is the current site name

• string

  .status .mirroringInfo .peers[] .uuid

  UUID is the peer UUID

• string

  .status .mirroringInfo .site_name

  SiteName is the current site name

• object

  .status .mirroringStatus

  MirroringStatusSpec is the status of the pool/radosNamespace mirroring

• string

  .status .mirroringStatus .details

  Details contains potential status errors

• string

  .status .mirroringStatus .lastChanged

  LastChanged is the last time time the status last changed

• string

  .status .mirroringStatus .lastChecked

  LastChecked is the last time time the status was checked

• object

  .status .mirroringStatus .summary

  Summary is the mirroring status summary

• string

  .status .mirroringStatus .summary .daemon_health

  DaemonHealth is the health of the mirroring daemon

• string

  .status .mirroringStatus .summary .health

  Health is the mirroring health

• string

  .status .mirroringStatus .summary .image_health

  ImageHealth is the health of the mirrored image

• object | null

  .status .mirroringStatus .summary .states

  States is the various state for all mirrored images

• integer

  .status .mirroringStatus .summary .states .error

  Error is when the mirroring state is errored

• integer

  .status .mirroringStatus .summary .states .replaying

  Replaying is when the replay of the mirroring journal is on-going

• integer

  .status .mirroringStatus .summary .states .starting_replay

  StartingReplay is when the replay of the mirroring journal starts

• integer

  .status .mirroringStatus .summary .states .stopped

  Stopped is when the mirroring state is stopped

• integer

  .status .mirroringStatus .summary .states .stopping_replay

  StopReplaying is when the replay of the mirroring journal stops

• integer

  .status .mirroringStatus .summary .states .syncing

  Syncing is when the image is syncing

• integer

  .status .mirroringStatus .summary .states .unknown

  Unknown is when the mirroring state is unknown

• integer

  .status .observedGeneration

  ObservedGeneration is the latest generation observed by the controller.

• string

  .status .phase

  ConditionType represent a resource’s status

• integer

  .status .poolID

  optional

• object

  .status .snapshotScheduleStatus

  SnapshotScheduleStatusSpec is the status of the snapshot schedule

• string

  .status .snapshotScheduleStatus .details

  Details contains potential status errors

• string

  .status .snapshotScheduleStatus .lastChanged

  LastChanged is the last time time the status last changed

• string

  .status .snapshotScheduleStatus .lastChecked

  LastChecked is the last time time the status was checked

• array | null

  .status .snapshotScheduleStatus .snapshotSchedules

  SnapshotSchedules is the list of snapshots scheduled