Enabling and disabling NVMe-oF gateways

Temporarily disable or enable NVMe-oF gateways for maintenance and controlled failover scenarios.

About this task

NVMe-oF gateways can be administratively disabled to support maintenance or controlled failover scenarios. To perform maintenance on a gateway, disable it to stop servicing I/O and re-enable it after the maintenance is complete.

When a gateway is disabled, I/O traffic is redirected to other available gateways in the group. Re-enabling the gateway allows it to resume normal operation.

Procedure

  1. Disable an NVMe-oF gateway.
    ceph nvme-gw disable GW_ID NVME-OF_POOL_NAME NVME-OF_GROUP_NAME
    For example,
    [root@host01 ~]# ceph nvme-gw disable nvmeof_pool01.nvmeof_group01 .nvme.rbd group1
    The gateway stops servicing I/O, and traffic is redirected to other gateways.
  2. Enable the NVMe-oF gateway.
    After maintenance or troubleshooting activities are complete and the gateway is verified to be healthy, re-enable the gateway to restore normal I/O processing.
    ceph nvme-gw enable GW_ID NVME-OF_POOL_NAME NVME-OF_GROUP_NAME
    For example,
    [root@host01 ~]# ceph nvme-gw enable nvmeof_pool01.nvmeof_group01 .nvme.rbd group1
    The gateway resumes servicing I/O and normal traffic distribution.

What to do next

Verify that the gateway state is updated and that I/O traffic is redirected or resumed as expected.