Newer documentation is now live.You are currently reading an older version.

MiraCephHealth and MiraCephSecret status descriptions

Warning

This procedure is valid for MOSK clusters that use the MiraCeph custom resource (CR), which is available since MOSK 25.2 to replace the unsupported KaaSCephCluster resource. And MiraCeph will be automatically migrated to CephDeployment in MOSK 26.1. For details, see Deprecation Notes: KaaSCephCluster API on management clusters.

For the equivalent procedure with the unsupported KaaSCephCluster CR, refer to the following section:

KaaSCephCluster.status description

Сeph cluster status is collected in three main resources:

  • MiraCeph status contains validation and current step statuses of spec reconcile.

  • MiraCephHealth allows you to verify the current health of a Ceph cluster and identify potentially problematic components.

  • MiraCephSecret allows you to obtain the current secret refs to access Ceph storage. For details, refer to Manage Ceph RBD or CephFS clients and RGW users.

This section describes status parameters for these resources. To view MiraCephHealth or MiraCephSecret, perform the steps described in Verify Ceph cluster state.

MiraCeph status parameters

Field

Description

phase

Current handling phase of the applied Ceph cluster spec. Can equal to Creating, Deploying, Validation, Ready, Deleting, or Failed.

message

Detailed description of the current phase or an error message if the phase is Failed.

lastRun

DateTime when previous spec reconcile occurred.

clusterVersion

Current Ceph cluster version, for example, v18.2.4.

validation

Validation result (Succeed or Failed) of the MiraCeph spec with a list of messages, if any. The validation section includes the following fields:

validation:
  result: Succeed or Failed
  messages: ["error", "messages", "list"]
  lastValidatedGeneration: <metadata.generation>

MiraCephHealth status parameters

MiraCephHealth status high-level parameters

Field

Description

fullClusterInfo

Complete information about Ceph cluste including cluster, Ceph resources, and daemon health. It helps reveal potentially problematic components. For fullClusterInfo fields description, see MiraCeph status.fullClusterInfo parameters.

lastCheck

DateTime when previous cluster state check occurred.

lastUpdate

DateTime when previous cluster state update occurred.

messages

List of strings of all issues found during cluster state check.

miraCephGeneration

Number of MiraCeph resource generation that was used during previous state check.

state

Cluster state that can be Ready or Failed depending on the Ceph cluster state check.
MiraCeph status.fullClusterInfo parameters

Field

Description

clusterStatus

General information from Rook about the Ceph cluster health and current state. Contains the following fields:

clusterStatus:
  state: <rook ceph cluster common status>
  phase: <rook ceph cluster spec reconcile phase>
  message: <rook ceph cluster phase details>
  conditions: <history of rook ceph cluster
              reconcile steps>
  ceph: <ceph cluster health>
  storage:
    deviceClasses: <list of used device classes
                   in ceph cluster>
  version:
    image: <ceph image used in ceph cluster>
    version: <ceph version of ceph cluster>

operatorStatus

Status of the Rook Ceph Operator pod that is Ok or Not running.

daemonsStatus

Map of statuses for each Ceph cluster daemon type. Indicates the expected and actual number of Ceph daemons on the cluster. Available daemon types are: mgr, mon, osd, and rgw. The map contains the following fields:

daemonsStatus:
  <daemonType>:
    status: <daemons status>
    running: <number of running daemons with
             details>

For example:

daemonsStatus:
  mgr:
    running: a is active mgr ([] standBy)
    status: Ok
  mon:
    running: '3/3 mons running: [a c d] in quorum'
    status: Ok
  osd:
    running: '4/4 running: 4 up, 4 in'
    status: Ok
  rgw:
    running: 2/2 running
             ([openstack.store.a openstack.store.b])
    status: Ok

blockStorageStatus

State of the Ceph cluster block storage resources. Includes the following fields:

  • pools - status map for each CephBlockPool resource. The map includes the following fields:

    pools:
  <cephBlockPoolName>:
    present: <flag indicating whether required pool is
             present in ceph cluster>
    status: <rook ceph block pool resource status>

  • clients - status map for each Ceph client resource. The map includes the following fields:

    clients:
  <cephClientName>:
    present: <flag indicating whether required client is
             present in ceph cluster>
    status: <rook ceph client resource status>

objectStorageStatus

State of the Ceph cluster object storage resources. Includes the following fields:

  • objectStoreStatus - status of the Rook Ceph Object Store. Information is delivered from Rook.

  • objectStoreUsers - status map for each Ceph Object User resource. The map includes the following fields:

    objectStoreUsers:
  <cephObjectUserName>:
    present: <flag indicating whether required rgw user is
             present in ceph cluster>
    phase: <rook ceph object user resource phase>

  • objectStoreBuckets - status map for each Ceph Object Bucket resource. The map includes the following fields:

    objectStoreBuckets:
  <cephObjectBucketName>:
    present: <flag indicating whether required rgw bucket is
             present in ceph cluster>
    phase: <rook ceph object bucket resource phase>

cephDetails

Verbose details of the Ceph cluster state. Contains the diskUsage field describes the used, available, and total storage size for each deviceClass and pool.

cephDetails:
  diskUsage:
    deviceClass:
      <deviceClass>:
        # The amount of raw storage consumed by user data (excluding bluestore database).
        bytesUsed: "<number>"
        # The amount of free space available in the cluster.
        bytesAvailable: "<number>"
        # The amount of storage capacity managed by the cluster.
        bytesTotal: "<number>"
    pools:
      <poolName>:
        # The space allocated for a pool over all OSDs. This includes replication,
        # allocation granularity, and erasure-coding overhead. Compression savings
        # and object content gaps are also taken into account. BlueStore database
        # is not included in this amount.
        bytesUsed: "<number>"
        # The notional percentage of storage used per pool.
        usedPercentage: "<number>"
        # Number calculated with the formula: bytesTotal - bytesUsed.
        bytesAvailable: "<number>"
        # An estimate of the notional amount of data that can be written to this pool.
        bytesTotal: "<number>"

cephCSIPluginDaemonsStatus

Contains information, similar to the daemonsStatus format, for each Ceph CSI plugin deployed in the Ceph cluster: rbd and, if enabled, cephfs. The cephCSIPluginDaemonsStatus field contains the following fields:

cephCSIPluginDaemonsStatus:
  <csiPlugin>:
    running: <number of running daemons with details>
    status: <csi plugin status>

For example:

cephCSIPluginDaemonsStatus:
  csi-rbdplugin:
    running: 1/3 running
    status: Some csi-rbdplugin daemons are not ready
  csi-cephfsplugin:
    running: 3/3 running
    status: Ok

MiraCephSecret status parameters

Field

Description

state

Current state of the secret collector on the Ceph cluster:

  • Ready - information about secrets is collected successfully

  • Failed - information about secrets fails to be collected

lastSecretCheck

DateTime when the Ceph cluster secrets were verified last time.

lastSecretUpdate

DateTime when the Ceph cluster secrets were updated last time.

secretsInfo

List of secrets for Ceph clients and RADOS Gateway users:

  • clientSecrets - details on secrets for Ceph clients

  • rgwUserSecrets - details on secrets for Ceph RADOS Gateway users

For example:

lastSecretCheck: "2022-09-05T07:05:35Z"
lastSecretUpdate: "2022-09-05T06:02:00Z"
secretInfo:
  clientSecrets:
  - name: client.admin
    secretName: rook-ceph-admin-keyring
    secretNamespace: rook-ceph
state: Ready

messages

List of error or warning messages, if any, found when collecting information about the Ceph cluster.