CephBlockPool [cephblockpools.ceph.rook.io/v1]

描述
CephBlockPool represents a Ceph Storage Pool
类型
object
必填
metadataspec

规格

属性类型描述
apiVersionstring

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

kindstring

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

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

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.

statusobject

CephBlockPoolStatus represents the mirroring status of Ceph Storage Pool

.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.
类型
object
属性类型描述
applicationstring

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

compressionModestring

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

crushRootstring

The root of the crush hierarchy utilized by the pool

deviceClassstring

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

enableCrushUpdatesboolean

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

enableRBDStatsboolean

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

erasureCodedobject

The erasure code settings

failureDomainstring

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

mirroringobject

The mirroring settings

namestring

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

parametersobject

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

quotasobject

The quota settings

replicatedobject

The replication settings

statusCheckobject

The mirroring statusCheck

.spec.erasureCoded

描述
The erasure code settings
类型
object
必填
codingChunksdataChunks
属性类型描述
algorithmstring

The algorithm for erasure coding. If absent, defaults to the plugin specified in osd_pool_default_erasure_code_profile.

codingChunksinteger

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.

dataChunksinteger

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.

.spec.mirroring

描述
The mirroring settings
类型
object
属性类型描述
enabledboolean

Enabled whether this pool is mirrored or not

modestring

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

peersobject

Peers represents the peers spec

snapshotSchedulesarray

SnapshotSchedules is the scheduling of snapshot for mirrored images/pools

.spec.mirroring.peers

描述
Peers represents the peers spec
类型
object
属性类型描述
secretNamesarray

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

.spec.mirroring.peers.secretNames

描述
SecretNames represents the Kubernetes Secret names to add rbd-mirror or cephfs-mirror peers
类型
array

.spec.mirroring.peers.secretNames[]

类型
string

.spec.mirroring.snapshotSchedules

描述
SnapshotSchedules is the scheduling of snapshot for mirrored images/pools
类型
array

.spec.mirroring.snapshotSchedules[]

描述
SnapshotScheduleSpec represents the snapshot scheduling settings of a mirrored pool
类型
object
属性类型描述
intervalstring

Interval represent the periodicity of the snapshot.

pathstring

Path is the path to snapshot, only valid for CephFS

startTimestring

StartTime indicates when to start the snapshot

.spec.parameters

描述
Parameters is a list of properties to enable on a given pool
类型
object

.spec.quotas

描述
The quota settings
类型
object
属性类型描述
maxBytesinteger

MaxBytes represents the quota in bytes Deprecated in favor of MaxSize

maxObjectsinteger

MaxObjects represents the quota in objects

maxSizestring

MaxSize represents the quota in bytes as a string

.spec.replicated

描述
The replication settings
类型
object
必填
size
属性类型描述
hybridStorageobject

HybridStorage represents hybrid storage tier settings

replicasPerFailureDomaininteger

ReplicasPerFailureDomain the number of replica in the specified failure domain

requireSafeReplicaSizeboolean

RequireSafeReplicaSize if false allows you to set replica 1

sizeinteger

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

subFailureDomainstring

SubFailureDomain the name of the sub-failure domain

targetSizeRationumber

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

.spec.replicated.hybridStorage

描述
HybridStorage represents hybrid storage tier settings
类型
object
必填
primaryDeviceClasssecondaryDeviceClass
属性类型描述
primaryDeviceClassstring

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

secondaryDeviceClassstring

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

.spec.statusCheck

描述
The mirroring statusCheck
类型
object
属性类型描述
mirrorobject

HealthCheckSpec represents the health check of an object store bucket

.spec.statusCheck.mirror

描述
HealthCheckSpec represents the health check of an object store bucket
类型
object
属性类型描述
disabledboolean
intervalstring

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

timeoutstring

.status

描述
CephBlockPoolStatus represents the mirroring status of Ceph Storage Pool
类型
object
属性类型描述
cephxobject

PeerTokenCephxStatus represents the cephx key rotation status for peer tokens

conditionsarray
infoobject
mirroringInfoobject

MirroringInfoSpec is the status of the pool/radosnamespace mirroring

mirroringStatusobject

MirroringStatusSpec is the status of the pool/radosNamespace mirroring

observedGenerationinteger

ObservedGeneration is the latest generation observed by the controller.

phasestring

ConditionType represent a resource's status

poolIDinteger

optional

snapshotScheduleStatusobject

SnapshotScheduleStatusSpec is the status of the snapshot schedule

.status.cephx

描述
PeerTokenCephxStatus represents the cephx key rotation status for peer tokens
类型
object
属性类型描述
peerTokenobject

PeerToken shows the rotation status of the peer token associated with the rbd-mirror-peer user.

.status.cephx.peerToken

描述
PeerToken shows the rotation status of the peer token associated with the `rbd-mirror-peer` user.
类型
object
属性类型描述
keyCephVersionstring

KeyCephVersion reports the Ceph version that created the current generation's keys. This is same string format as reported by CephCluster.status.version.version to allow them to be compared. E.g., 20.2.0-0. For all newly-created resources, this field set to the version of Ceph that created the key. The special value "Uninitialized" indicates that keys are being created for the first time. An empty string indicates that the version is unknown, as expected in brownfield deployments.

keyGenerationinteger

KeyGeneration represents the CephX key generation for the last successful reconcile. For all newly-created resources, this field is set to 1. When keys are rotated due to any rotation policy, the generation is incremented or updated to the configured policy generation. Generation 0 indicates that keys existed prior to the implementation of key tracking.

.status.conditions

类型
array

.status.conditions[]

描述
Condition represents a status condition on any Rook-Ceph Custom Resource.
类型
object
属性类型描述
lastHeartbeatTimestring
lastTransitionTimestring
messagestring
reasonstring

ConditionReason is a reason for a condition

statusstring
typestring

ConditionType represent a resource's status

.status.info

类型
object

.status.mirroringInfo

描述
MirroringInfoSpec is the status of the pool/radosnamespace mirroring
类型
object
属性类型描述
detailsstring
lastChangedstring
lastCheckedstring
modestring

Mode is the mirroring mode

peersarray

Peers are the list of peer sites connected to that cluster

site_namestring

SiteName is the current site name

.status.mirroringInfo.peers

描述
Peers are the list of peer sites connected to that cluster
类型
array

.status.mirroringInfo.peers[]

描述
PeersSpec contains peer details
类型
object
属性类型描述
client_namestring

ClientName is the CephX user used to connect to the peer

directionstring

Direction is the peer mirroring direction

mirror_uuidstring

MirrorUUID is the mirror UUID

site_namestring

SiteName is the current site name

uuidstring

UUID is the peer UUID

.status.mirroringStatus

描述
MirroringStatusSpec is the status of the pool/radosNamespace mirroring
类型
object
属性类型描述
detailsstring

Details contains potential status errors

lastChangedstring

LastChanged is the last time time the status last changed

lastCheckedstring

LastChecked is the last time time the status was checked

summaryobject

Summary is the mirroring status summary

.status.mirroringStatus.summary

描述
Summary is the mirroring status summary
类型
object
属性类型描述
daemon_healthstring

DaemonHealth is the health of the mirroring daemon

group_healthstring

GroupHealth is the health of the mirrored image group

group_statesobject

GroupStates is the various state for all mirrored image groups

healthstring

Health is the mirroring health

image_healthstring

ImageHealth is the health of the mirrored image

image_statesobject

ImageStates is the various state for all mirrored images

statesobject

States is the various state for all mirrored images

.status.mirroringStatus.summary.group_states

描述
GroupStates is the various state for all mirrored image groups
类型
object
属性类型描述
errorinteger

Error is when the mirroring state is errored

replayinginteger

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

starting_replayinteger

StartingReplay is when the replay of the mirroring journal starts

stoppedinteger

Stopped is when the mirroring state is stopped

stopping_replayinteger

StopReplaying is when the replay of the mirroring journal stops

syncinginteger

Syncing is when the image is syncing

unknowninteger

Unknown is when the mirroring state is unknown

.status.mirroringStatus.summary.image_states

描述
ImageStates is the various state for all mirrored images
类型
object
属性类型描述
errorinteger

Error is when the mirroring state is errored

replayinginteger

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

starting_replayinteger

StartingReplay is when the replay of the mirroring journal starts

stoppedinteger

Stopped is when the mirroring state is stopped

stopping_replayinteger

StopReplaying is when the replay of the mirroring journal stops

syncinginteger

Syncing is when the image is syncing

unknowninteger

Unknown is when the mirroring state is unknown

.status.mirroringStatus.summary.states

描述
States is the various state for all mirrored images
类型
object
属性类型描述
errorinteger

Error is when the mirroring state is errored

replayinginteger

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

starting_replayinteger

StartingReplay is when the replay of the mirroring journal starts

stoppedinteger

Stopped is when the mirroring state is stopped

stopping_replayinteger

StopReplaying is when the replay of the mirroring journal stops

syncinginteger

Syncing is when the image is syncing

unknowninteger

Unknown is when the mirroring state is unknown

.status.snapshotScheduleStatus

描述
SnapshotScheduleStatusSpec is the status of the snapshot schedule
类型
object
属性类型描述
detailsstring

Details contains potential status errors

lastChangedstring

LastChanged is the last time time the status last changed

lastCheckedstring

LastChecked is the last time time the status was checked

snapshotSchedulesarray

SnapshotSchedules is the list of snapshots scheduled

.status.snapshotScheduleStatus.snapshotSchedules

描述
SnapshotSchedules is the list of snapshots scheduled
类型
array

.status.snapshotScheduleStatus.snapshotSchedules[]

描述
SnapshotSchedulesSpec is the list of snapshot scheduled for images in a pool
类型
object
属性类型描述
imagestring

Image is the mirrored image

itemsarray

Items is the list schedules times for a given snapshot

namespacestring

Namespace is the RADOS namespace the image is part of

poolstring

Pool is the pool name

.status.snapshotScheduleStatus.snapshotSchedules[].items

描述
Items is the list schedules times for a given snapshot
类型
array

.status.snapshotScheduleStatus.snapshotSchedules[].items[]

描述
SnapshotSchedule is a schedule
类型
object
属性类型描述
intervalstring

Interval is the interval in which snapshots will be taken

start_timestring

StartTime is the snapshot starting time

API 端点

可用的 API 端点如下:

  • /apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools
    • DELETE: delete collection of CephBlockPool
    • GET: list objects of kind CephBlockPool
    • POST: create a new CephBlockPool
  • /apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools/{name}
    • DELETE: delete the specified CephBlockPool
    • GET: read the specified CephBlockPool
    • PATCH: partially update the specified CephBlockPool
    • PUT: replace the specified CephBlockPool
  • /apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools/{name}/status
    • GET: read status of the specified CephBlockPool
    • PATCH: partially update status of the specified CephBlockPool
    • PUT: replace status of the specified CephBlockPool

/apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools

HTTP 方法
DELETE
描述
delete collection of CephBlockPool
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind CephBlockPool
HTTP 响应
HTTP 状态码响应体
200 - OKCephBlockPoolList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new CephBlockPool
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
请求体参数
参数类型描述
bodyCephBlockPool schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKCephBlockPool schema
201 - CreatedCephBlockPool schema
202 - AcceptedCephBlockPool schema
401 - UnauthorizedEmpty

/apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools/{name}

HTTP 方法
DELETE
描述
delete the specified CephBlockPool
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified CephBlockPool
HTTP 响应
HTTP 状态码响应体
200 - OKCephBlockPool schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified CephBlockPool
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP 响应
HTTP 状态码响应体
200 - OKCephBlockPool schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified CephBlockPool
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
请求体参数
参数类型描述
bodyCephBlockPool schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKCephBlockPool schema
201 - CreatedCephBlockPool schema
401 - UnauthorizedEmpty

/apis/ceph.rook.io/v1/namespaces/{namespace}/cephblockpools/{name}/status

HTTP 方法
GET
描述
read status of the specified CephBlockPool
HTTP 响应
HTTP 状态码响应体
200 - OKCephBlockPool schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified CephBlockPool
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP 响应
HTTP 状态码响应体
200 - OKCephBlockPool schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified CephBlockPool
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
请求体参数
参数类型描述
bodyCephBlockPool schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKCephBlockPool schema
201 - CreatedCephBlockPool schema
401 - UnauthorizedEmpty