Add, remove, or reconfigure Ceph OSDs¶

Mirantis Ceph Controller simplifies Ceph cluster management by automating LCM operations. This section describes how to add, remove, or reconfigure Ceph OSDs.

Add a Ceph OSD on a managed cluster¶

Manually prepare the required machine devices with LVM2 on the existing node because BareMetalHostProfile does not support in-place changes.
To add a Ceph OSD to an existing or hot-plugged raw device
If you want to add a Ceph OSD on top of a raw device that already exists on a node or is hot-plugged, add the required device using the following guidelines:
- You can add a raw device to a node during node deployment.
- If a node supports adding devices without node reboot, you can hot plug a raw device to a node.
- If a node does not support adding devices without node reboot, you can hot plug a raw device during node shutdown. In this case, complete the following steps:
  1. Enable maintenance mode on the managed cluster.
  2. Turn off the required node.
  3. Attach the required raw device to the node.
  4. Turn on the required node.
  5. Disable maintenance mode on the managed cluster.
Open the KaasCephCluster CR of a managed cluster for editing:
```
kubectl edit kaascephcluster -n <managedClusterProjectName>
```
Substitute <managedClusterProjectName> with the corresponding value.

In the nodes.<machineName>.storageDevices section, specify the parameters for a Ceph OSD as required. For the parameters description, see Node parameters.

The example configuration of the nodes section with the new node:

Since MOSK 23.3

nodes:
  kaas-node-5bgk6:
    roles:
    - mon
    - mgr
    storageDevices:
    - config: # existing item
        deviceClass: hdd
      fullPath: /dev/disk/by-id/scsi-SATA_HGST_HUS724040AL_PN1334PEHN18ZS
    - config: # new item
        deviceClass: hdd
      fullPath: /dev/disk/by-id/scsi-0ATA_HGST_HUS724040AL_PN1334PEHN1VBC

Before MOSK 23.3

nodes:
  kaas-node-5bgk6:
    roles:
    - mon
    - mgr
    storageDevices:
    - config: # existing item
        deviceClass: hdd
      name: sdb
    - config: # new item
        deviceClass: hdd
      name: sdc

Warning

Since MOSK 23.3, Mirantis highly recommends using the non-wwn by-id symlinks to specify storage devices in the storageDevices list.

For details, see Container Cloud documentation: Addressing storage devices.

Verify that the Ceph OSD on the specified node is successfully deployed. The fullClusterInfo section should not contain any issues.
```
kubectl -n <managedClusterProjectName> get kaascephcluster -o yaml
```
For example:
```
status:
  fullClusterInfo:
    daemonsStatus:
      ...
      osd:
        running: '3/3 running: 3 up, 3 in'
        status: Ok
```
Note

Since MOSK 23.2, cephDeviceMapping is removed because its large size can potentially exceed the Kubernetes 1.5 MB quota.

Verify the Ceph OSD on the managed cluster:

kubectl -n rook-ceph get pod -l app=rook-ceph-osd -o wide | grep <machineName>

Remove a Ceph OSD from a managed cluster¶

Note

Ceph OSD removal presupposes usage of a KaaSCephOperationRequest CR. For workflow overview, spec and phases description, see High-level workflow of Ceph OSD or node removal.

Warning

When using the non-recommended Ceph pools replicated.size of less than 3, Ceph OSD removal cannot be performed. The minimal replica size equals a rounded up half of the specified replicated.size.

For example, if replicated.size is 2, the minimal replica size is 1, and if replicated.size is 3, then the minimal replica size is 2. The replica size of 1 allows Ceph having PGs with only one Ceph OSD in the acting state, which may cause a PG_TOO_DEGRADED health warning that blocks Ceph OSD removal. Mirantis recommends setting replicated.size to 3 for each Ceph pool.

Open the KaasCephCluster CR of a managed cluster for editing:
```
kubectl edit kaascephcluster -n <managedClusterProjectName>
```
Substitute <managedClusterProjectName> with the corresponding value.

Remove the required Ceph OSD specification from the spec.cephClusterSpec.nodes.<machineName>.storageDevices list:

The example configuration of the nodes section with the new node:

Since MOSK 23.3

nodes:
  kaas-node-5bgk6:
    roles:
    - mon
    - mgr
    storageDevices:
    - config:
        deviceClass: hdd
      fullPath: /dev/disk/by-id/scsi-SATA_HGST_HUS724040AL_PN1334PEHN18ZS
    - config: # remove the entire item entry from storageDevices list
        deviceClass: hdd
      fullPath: /dev/disk/by-id/scsi-0ATA_HGST_HUS724040AL_PN1334PEHN1VBC

Before MOSK 23.3

nodes:
  kaas-node-5bgk6:
    roles:
    - mon
    - mgr
    storageDevices:
    - config:
        deviceClass: hdd
      name: sdb
    - config: # remove the entire item entry from storageDevices list
        deviceClass: hdd
      name: sdc

Create a YAML template for the KaaSCephOperationRequest CR. Select from the following options:
- Remove Ceph OSD by device name, by-path symlink, or by-id symlink:
```
apiVersion: kaas.mirantis.com/v1alpha1
kind: KaaSCephOperationRequest
metadata:
  name: remove-osd-<machineName>-sdb
  namespace: <managedClusterProjectName>
spec:
  osdRemove:
    nodes:
      <machineName>:
        cleanupByDevice:
        - name: sdb
  kaasCephCluster:
    name: <kaasCephClusterName>
    namespace: <managedClusterProjectName>
```
  Substitute <managedClusterProjectName> with the corresponding cluster namespace and <kaasCephClusterName> with the corresponding KaaSCephCluster name.
  
  Warning
  
  Since MOSK 23.3, Mirantis does not recommend setting device name or device by-path symlink in the cleanupByDevice field as these identifiers are not persistent and can change at node boot. Remove Ceph OSDs with by-id symlinks specified in the path field or use cleanupByOsdId instead.
  
  For details, see Container Cloud documentation: Addressing storage devices.
  Note
  - Since MOSK 23.1, cleanupByDevice is not supported if a device was physically removed from a node. Therefore, use cleanupByOsdId instead. For details, see Remove a failed Ceph OSD by Ceph OSD ID.
  - Before MOSK 23.1, if the storageDevice item was specified with by-id, specify the path parameter in the cleanupByDevice section instead of name.
  - If the storageDevice item was specified with a by-path device path, specify the path parameter in the cleanupByDevice section instead of name.
- Remove Ceph OSD by OSD ID:
```
apiVersion: kaas.mirantis.com/v1alpha1
kind: KaaSCephOperationRequest
metadata:
  name: remove-osd-<machineName>-sdb
  namespace: <managedClusterProjectName>
spec:
  osdRemove:
    nodes:
      <machineName>:
        cleanupByOsdId:
        - 2
  kaasCephCluster:
    name: <kaasCephClusterName>
    namespace: <managedClusterProjectName>
```
  Substitute <managedClusterProjectName> with the corresponding cluster namespace and <kaasCephClusterName> with the corresponding KaaSCephCluster name.
Apply the template on the management cluster in the corresponding namespace:
```
kubectl apply -f remove-osd-<machineName>-sdb.yaml
```

Verify that the corresponding request has been created:

kubectl get kaascephoperationrequest remove-osd-<machineName>-sdb -n <managedClusterProjectName>

Verify that the removeInfo section appeared in the KaaSCephOperationRequest CR status:

kubectl -n <managedClusterProjectName> get kaascephoperationrequest remove-osd-<machineName>-sdb -o yaml

Example of system response:

status:
  childNodesMapping:
    kaas-node-d4aac64d-1721-446c-b7df-e351c3025591: <machineName>
  osdRemoveStatus:
    removeInfo:
      cleanUpMap:
        kaas-node-d4aac64d-1721-446c-b7df-e351c3025591:
          osdMapping:
            "10":
              deviceMapping:
                sdb:
                  path: "/dev/disk/by-path/pci-0000:00:1t.9"
                  partition: "/dev/ceph-b-vg_sdb/osd-block-b-lv_sdb"
                  type: "block"
                  class: "hdd"
                  zapDisk: true

Verify that the cleanUpMap section matches the required removal and wait for the ApproveWaiting phase to appear in status:

kubectl -n <managedClusterProjectName> get kaascephoperationrequest remove-osd-<machineName>-sdb -o yaml

Example of system response:

status:
  phase: ApproveWaiting

Edit the KaaSCephOperationRequest CR and set the approve flag to true:

kubectl -n <managedClusterProjectName> edit kaascephoperationrequest remove-osd-<machineName>-sdb

For example:

spec:
  osdRemove:
    approve: true

Review the following status fields of the KaaSCephOperationRequest CR request processing:
- status.phase - current state of request processing
- status.messages - description of the current phase
- status.conditions - full history of request processing before the current phase
- status.removeInfo.issues and status.removeInfo.warnings - error and warning messages occurred during request processing, if any

Verify that the KaaSCephOperationRequest has been completed. For example:

status:
  phase: Completed # or CompletedWithWarnings if there are non-critical issues

Remove the device cleanup jobs:

kubectl delete jobs -n ceph-lcm-mirantis -l app=miraceph-cleanup-disks

Reconfigure a Ceph OSD on a managed cluster¶

There is no hot reconfiguration procedure for existing Ceph OSDs. To reconfigure an existing Ceph node, follow the steps below:

Remove a Ceph OSD from the Ceph cluster as described in Remove a Ceph OSD from a managed cluster.
Add the same Ceph OSD but with a modified configuration as described in Add a Ceph OSD on a managed cluster.