CephBlockPool [cephblockpools.ceph.rook.io/v1]
- Description
- CephBlockPool represents a Ceph Storage Pool
- Type
object- Required
metadataspec
Specification
.spec
- Description
- 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.
- Type
object
.spec.erasureCoded
- Description
- The erasure code settings
- Type
object- Required
codingChunksdataChunks
.spec.mirroring
- Description
- The mirroring settings
- Type
object
.spec.mirroring.peers
- Description
- Peers represents the peers spec
- Type
object
.spec.mirroring.peers.secretNames
- Description
- SecretNames represents the Kubernetes Secret names to add rbd-mirror or cephfs-mirror peers
- Type
array
.spec.mirroring.peers.secretNames[]
- Type
string
.spec.mirroring.snapshotSchedules
- Description
- SnapshotSchedules is the scheduling of snapshot for mirrored images/pools
- Type
array
.spec.mirroring.snapshotSchedules[]
- Description
- SnapshotScheduleSpec represents the snapshot scheduling settings of a mirrored pool
- Type
object
.spec.parameters
- Description
- Parameters is a list of properties to enable on a given pool
- Type
object
.spec.quotas
- Description
- The quota settings
- Type
object
.spec.replicated
- Description
- The replication settings
- Type
object- Required
size
.spec.replicated.hybridStorage
- Description
- HybridStorage represents hybrid storage tier settings
- Type
object- Required
primaryDeviceClasssecondaryDeviceClass
.spec.statusCheck
- Description
- The mirroring statusCheck
- Type
object
.spec.statusCheck.mirror
- Description
- HealthCheckSpec represents the health check of an object store bucket
- Type
object
.status
- Description
- CephBlockPoolStatus represents the mirroring status of Ceph Storage Pool
- Type
object
.status.cephx
- Description
- PeerTokenCephxStatus represents the cephx key rotation status for peer tokens
- Type
object
.status.cephx.peerToken
- Description
- PeerToken shows the rotation status of the peer token associated with the `rbd-mirror-peer` user.
- Type
object
.status.conditions
- Type
array
.status.conditions[]
- Description
- Condition represents a status condition on any Rook-Ceph Custom Resource.
- Type
object
.status.info
- Type
object
.status.mirroringInfo
- Description
- MirroringInfoSpec is the status of the pool/radosnamespace mirroring
- Type
object
.status.mirroringInfo.peers
- Description
- Peers are the list of peer sites connected to that cluster
- Type
array
.status.mirroringInfo.peers[]
- Description
- PeersSpec contains peer details
- Type
object
.status.mirroringStatus
- Description
- MirroringStatusSpec is the status of the pool/radosNamespace mirroring
- Type
object
.status.mirroringStatus.summary
- Description
- Summary is the mirroring status summary
- Type
object
.status.mirroringStatus.summary.group_states
- Description
- GroupStates is the various state for all mirrored image groups
- Type
object
.status.mirroringStatus.summary.image_states
- Description
- ImageStates is the various state for all mirrored images
- Type
object
.status.mirroringStatus.summary.states
- Description
- States is the various state for all mirrored images
- Type
object
.status.snapshotScheduleStatus
- Description
- SnapshotScheduleStatusSpec is the status of the snapshot schedule
- Type
object
.status.snapshotScheduleStatus.snapshotSchedules
- Description
- SnapshotSchedules is the list of snapshots scheduled
- Type
array
.status.snapshotScheduleStatus.snapshotSchedules[]
- Description
- SnapshotSchedulesSpec is the list of snapshot scheduled for images in a pool
- Type
object
.status.snapshotScheduleStatus.snapshotSchedules[].items
- Description
- Items is the list schedules times for a given snapshot
- Type
array
.status.snapshotScheduleStatus.snapshotSchedules[].items[]
- Description
- SnapshotSchedule is a schedule
- Type
object
API Endpoints
The following API endpoints are available:
/apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpoolsDELETE: delete collection of CephBlockPoolGET: list objects of kind CephBlockPoolPOST: create a new CephBlockPool
/apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools/{name}DELETE: delete the specified CephBlockPoolGET: read the specified CephBlockPoolPATCH: partially update the specified CephBlockPoolPUT: replace the specified CephBlockPool
/apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools/{name}/statusGET: read status of the specified CephBlockPoolPATCH: partially update status of the specified CephBlockPoolPUT: replace status of the specified CephBlockPool
/apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools
- HTTP method
DELETE- Description
- delete collection of CephBlockPool
- HTTP responses
- HTTP method
GET- Description
- list objects of kind CephBlockPool
- HTTP responses
- HTTP method
POST- Description
- create a new CephBlockPool
- Query parameters
- Body parameters
- HTTP responses
/apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools/{name}
- HTTP method
DELETE- Description
- delete the specified CephBlockPool
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified CephBlockPool
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified CephBlockPool
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified CephBlockPool
- Query parameters
- Body parameters
- HTTP responses
/apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools/{name}/status
- HTTP method
GET- Description
- read status of the specified CephBlockPool
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified CephBlockPool
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified CephBlockPool
- Query parameters
- Body parameters
- HTTP responses