← Back to index Esc
Kind
Cephblockpool
Group
ceph.rook.io
Version
v1
apiVersion: ceph.rook.io/v1 kind: Cephblockpool metadata: name: example
View raw schema
apiVersion string
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
kind string
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
metadata object required
spec object required
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.
application string
The application name to set on the pool. Only expected to be set for rgw pools.
compressionMode string
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,
crushRoot string
The root of the crush hierarchy utilized by the pool
deviceClass string
The device class the OSD should set to for use in the pool
enableCrushUpdates boolean
Allow rook operator to change the pool CRUSH tunables once the pool is created
enableRBDStats boolean
EnableRBDStats is used to enable gathering of statistics for all RBD images in the pool
erasureCoded object
The erasure code settings
algorithm string
The algorithm for erasure coding. If absent, defaults to the plugin specified in osd_pool_default_erasure_code_profile.
enum: isa, jerasure
codingChunks integer required
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
dataChunks integer required
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
failureDomain string
The failure domain: osd/host/(region or zone if available) - technically also any type in the crush map
mirroring object
The mirroring settings
enabled boolean
Enabled whether this pool is mirrored or not
mode string
Mode is the mirroring mode: pool, image or init-only.
enum: pool, image, init-only
peers object
Peers represents the peers spec
secretNames []string
SecretNames represents the Kubernetes Secret names to add rbd-mirror or cephfs-mirror peers
snapshotSchedules []object
SnapshotSchedules is the scheduling of snapshot for mirrored images/pools
interval string
Interval represent the periodicity of the snapshot.
path string
Path is the path to snapshot, only valid for CephFS
startTime string
StartTime indicates when to start the snapshot
name string
The desired name of the pool if different from the CephBlockPool CR name.
enum: .rgw.root, .nfs, .mgr
parameters object
Parameters is a list of properties to enable on a given pool
quotas object
The quota settings
maxBytes integer
MaxBytes represents the quota in bytes Deprecated in favor of MaxSize
format: int64
maxObjects integer
MaxObjects represents the quota in objects
format: int64
maxSize string
MaxSize represents the quota in bytes as a string
pattern: ^[0-9]+[\.]?[0-9]*([KMGTPE]i|[kMGTPE])?$
replicated object
The replication settings
hybridStorage object
HybridStorage represents hybrid storage tier settings
primaryDeviceClass string required
PrimaryDeviceClass represents high performance tier (for example SSD or NVME) for Primary OSD
minLength: 1
secondaryDeviceClass string required
SecondaryDeviceClass represents low performance tier (for example HDDs) for remaining OSDs
minLength: 1
replicasPerFailureDomain integer
ReplicasPerFailureDomain the number of replica in the specified failure domain
minimum: 1
requireSafeReplicaSize boolean
RequireSafeReplicaSize if false allows you to set replica 1
size integer required
Size - Number of copies per object in a replicated storage pool, including the object itself (required for replicated pool type)
minimum: 0
subFailureDomain string
SubFailureDomain the name of the sub-failure domain
targetSizeRatio number
TargetSizeRatio gives a hint (%) to Ceph in terms of expected consumption of the total cluster capacity
minimum: 0
statusCheck object
The mirroring statusCheck
mirror object
HealthCheckSpec represents the health check of an object store bucket
disabled boolean
interval string
Interval is the internal in second or minute for the health check to run like 60s for 60 seconds
timeout string
status object
CephBlockPoolStatus represents the mirroring status of Ceph Storage Pool
cephx object
PeerTokenCephxStatus represents the cephx key rotation status for peer tokens
peerToken object
PeerToken shows the rotation status of the peer token associated with the `rbd-mirror-peer` user.
keyCephVersion string
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.
keyGeneration integer
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.
format: int32
conditions []object
lastHeartbeatTime string
format: date-time
lastTransitionTime string
format: date-time
message string
reason string
ConditionReason is a reason for a condition
status string
type string
ConditionType represent a resource's status
info object
mirroringInfo object
MirroringInfoSpec is the status of the pool/radosnamespace mirroring
details string
lastChanged string
lastChecked string
mode string
Mode is the mirroring mode
peers []object
Peers are the list of peer sites connected to that cluster
client_name string
ClientName is the CephX user used to connect to the peer
direction string
Direction is the peer mirroring direction
mirror_uuid string
MirrorUUID is the mirror UUID
site_name string
SiteName is the current site name
uuid string
UUID is the peer UUID
site_name string
SiteName is the current site name
mirroringStatus object
MirroringStatusSpec is the status of the pool/radosNamespace mirroring
details string
Details contains potential status errors
lastChanged string
LastChanged is the last time time the status last changed
lastChecked string
LastChecked is the last time time the status was checked
summary object
Summary is the mirroring status summary
daemon_health string
DaemonHealth is the health of the mirroring daemon
group_health string
GroupHealth is the health of the mirrored image group
group_states object
GroupStates is the various state for all mirrored image groups
error integer
Error is when the mirroring state is errored
replaying integer
Replaying is when the replay of the mirroring journal is on-going
starting_replay integer
StartingReplay is when the replay of the mirroring journal starts
stopped integer
Stopped is when the mirroring state is stopped
stopping_replay integer
StopReplaying is when the replay of the mirroring journal stops
syncing integer
Syncing is when the image is syncing
unknown integer
Unknown is when the mirroring state is unknown
health string
Health is the mirroring health
image_health string
ImageHealth is the health of the mirrored image
image_states object
ImageStates is the various state for all mirrored images
error integer
Error is when the mirroring state is errored
replaying integer
Replaying is when the replay of the mirroring journal is on-going
starting_replay integer
StartingReplay is when the replay of the mirroring journal starts
stopped integer
Stopped is when the mirroring state is stopped
stopping_replay integer
StopReplaying is when the replay of the mirroring journal stops
syncing integer
Syncing is when the image is syncing
unknown integer
Unknown is when the mirroring state is unknown
states object
States is the various state for all mirrored images
error integer
Error is when the mirroring state is errored
replaying integer
Replaying is when the replay of the mirroring journal is on-going
starting_replay integer
StartingReplay is when the replay of the mirroring journal starts
stopped integer
Stopped is when the mirroring state is stopped
stopping_replay integer
StopReplaying is when the replay of the mirroring journal stops
syncing integer
Syncing is when the image is syncing
unknown integer
Unknown is when the mirroring state is unknown
observedGeneration integer
ObservedGeneration is the latest generation observed by the controller.
format: int64
phase string
ConditionType represent a resource's status
poolID integer
optional
snapshotScheduleStatus object
SnapshotScheduleStatusSpec is the status of the snapshot schedule
details string
Details contains potential status errors
lastChanged string
LastChanged is the last time time the status last changed
lastChecked string
LastChecked is the last time time the status was checked
snapshotSchedules []object
SnapshotSchedules is the list of snapshots scheduled
image string
Image is the mirrored image
items []object
Items is the list schedules times for a given snapshot
interval string
Interval is the interval in which snapshots will be taken
start_time string
StartTime is the snapshot starting time
namespace string
Namespace is the RADOS namespace the image is part of
pool string
Pool is the pool name
Copied!