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

KaaSCephCluster.status description

Warning

This procedure is valid for MOSK clusters that use the unsupported KaaSCephCluster custom resource (CR) instead of the MiraCeph CR that is available since MOSK 25.2 as a new Ceph configuration entrypoint.

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

MiraCephHealth and MiraCephSecret status descriptions

KaaSCephCluster.status allows you to learn the current health of a Ceph cluster and identify potentially problematic components. This section describes KaaSCephCluster.status and its fields. To view KaaSCephCluster.status, perform the steps described in Verify Ceph cluster state through CLI.

KaaSCephCluster.status specification

Field

Description

kaasCephState

Describes the current state of KaasCephCluster and reflects any errors during object reconciliation, including spec generation, object creation on a MOSK cluster, and status retrieval.

miraCephInfo

Describes the current phase of Ceph spec reconciliation and spec validation result. The miraCephInfo section contains information about the current validation and reconcile of the KaaSCephCluster and MiraCeph resources. It helps to understand whether the specified configuration is valid to create a Ceph cluster and informs about the current phase of applying this configuration. For miraCephInfo fields description, see KaaSCephCluster.status miraCephInfo specification.

shortClusterInfo

Reresents a short version of fullclusterinfo and contains a summary on the Ceph cluster state collecting process and potential issues. It helps to quickly verify if the fullClusterInfo is actual and if any errors occurred during the information collecting. For shortClusterInfo fields description, see KaaSCephCluster.status shortClusterInfo specification.

fullClusterInfo

Contains a complete Ceph cluster information including cluster, Ceph resources, and daemons health. It helps to reveal the potentially problematic components. For fullClusterInfo fields description, see KaaSCephCluster.status fullClusterInfo specification.

miraCephSecretsInfo

Contains information about secrets of the MOSK cluster that are used in the Ceph cluster, such as keyrings, Ceph clients, RADOS Gateway user credentials, and so on. For miraCephSecretsInfo fields description, see KaaSCephCluster.status miraCephSecretsInfo specification.

The following tables describe all sections of KaaSCephCluster.status.

KaaSCephCluster.status miraCephInfo specification

Field

Description

phase

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

message

Contains a detailed description of the current phase or an error message if the phase is Failed.

validation

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

validation:
  result: Succeed or Failed
  messages: ["error", "messages", "list"]
KaaSCephCluster.status shortClusterInfo specification

Field

Description

state

Current Ceph cluster collector status:

  • Ready if information collecting works as expected

  • Failed if an error occurs

lastCheck

DateTime that equals to the last time when the cluster was verified.

lastUpdate

DateTime that equals to the last time when the Ceph cluster information was updated.

messages

List of error or warning messages found when gathering the facts about the Ceph cluster.
KaaSCephCluster.status fullClusterInfo specification

Field

Description

clusterStatus

General information from Rook about the Ceph cluster health and current state. The clusterStatus field 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 daemonsStatus field 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 whether desired 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 whether desired 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 comes from Rook.

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

    objectStoreUsers:
  <cephObjectUserName>:
    present: <flag whether desired 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 whether desired rgw bucket is
             present in ceph cluster>
    phase: <rook ceph object bucket resource phase>

cephDetails

Verbose details of the Ceph cluster state. Includes the diskUsage field that contains 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
KaaSCephCluster.status miraCephSecretsInfo specification

Field

Description

state

Current state of the secret collector on the Ceph cluster:

  • Ready - secrets information is collected successfully

  • Failed - secrets information 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.