porthole/doc/rbd_pv.md
Sergiy Markin 693f99363e Update porthole project
This PS performs the following changes:
- updates approach to freeze requirements.txt
- adds freeze tox profile
- upgrades helm to v3.9.4
- changes deployment scripts in accordance with new helm v3
- python code has been re-styled to pass pep8 tests
- added tox-docs zuul gate
- added tox-py38 zuul gate
- added tox-cover zuul gate
- added tox-pep8 zuul gate
- deprecated old unit-tests zuul gate
- added a dependency pre-run playbook to deliver zuul node setup needed
  for python tox gates to run unit tests
- added tox profiles for py38,pep8,docs and cover tests

Change-Id: I960326fb0ab8d98cc3f62ffa638286e4fdcbb7c7
2023-06-02 16:01:08 +00:00

1.8 KiB

RBD PVC/PV script

This document provides instructions for using the rbd_pv script to perform Ceph maintenance actions such as backing up and recovering PVCs within your Kubernetes environment.

Usage

Execute utilscli rbd_pv without arguments to list usage options.

utilscli rbd_pv
Backup Usage: utilscli rbd_pv [-b <pvc name>] [-n <namespace>] [-d <backup dest> (optional, default: /tmp/backup)] [-p <ceph rbd pool> (optional, default: rbd)]
Restore Usage: utilscli rbd_pv [-r <restore_file>] [-p <ceph rbd pool> (optional, default: rbd)]
Snapshot Usage: utilscli rbd_pv [-b <pvc name>] [-n <namespace>] [-p <ceph rbd pool> (optional, default: rbd] [-s <create|rollback|remove> (required)]

Backing up a PVC/PV from RBD

To backup a PV, execute the following.

utilscli rbd_pv -b mysql-data-mariadb-server-0 -n openstack

Restoring a PVC/PV Backup

To restore a PV RBD backup image, execute the following.

utilscli rbd_pv -r /backup/kubernetes-dynamic-pvc-ab1f2e8f-21a4-11e9-ab61-ca77944df03c.img

Note: The original PVC/PV will be renamed, not overwritten.

Important: Before restoring, you must ensure the PVC/PV is not mounted!

Creating a Snapshot for a PVC/PV

utilscli rbd_pv -b mysql-data-mariadb-server-0 -n openstack -s create

Rolling Back to a Snapshot for a PVC/PV

utilscli rbd_pv -b mysql-data-mariadb-server-0 -n openstack -s rollback

Important: Before rolling back a snapshot, you must ensure the PVC/PV volume is not mounted!

Removing a Snapshot for a PVC/PV

Important: This command removes all snapshots in Ceph associated with this PVC/PV!

utilscli rbd_pv -b mysql-data-mariadb-server-0 -n openstack -s remove

Show Snapshot and Image Details for a PVC/PV

utilscli rbd_pv -b mysql-data-mariadb-server-0 -n openstack -s show