Skip to content

Commit

Permalink
Added snapshot docs
Browse files Browse the repository at this point in the history
Signed-off-by: Utkarsh Bhatt <utkarsh.bhatt@canonical.com>
  • Loading branch information
UtkarshBhatthere committed Jul 23, 2024
1 parent 1b2784c commit 28e490a
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 4 deletions.
45 changes: 45 additions & 0 deletions docs/explanation/taking-snapshots.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
================================
Taking Backups for your Workload
================================

The MicroCeph deployed Ceph cluster supports snapshot based backups
for Block and File based workloads.

This document is an index of upstream documentation available for snapshots
along with some bridging commentary to help understand it better.

RBD Snapshots:
--------------

Ceph supports creating point in time read-only logical copies. This allows
an operator to create a checkpoint for their workload backup. The snapshots
can be exported for external backup or kept in Ceph for rollback to older version.

Pre-requisites
++++++++++++++

Refer to :doc:`How to mount MicroCeph Block Devices <../tutorial/mount-block-device.rst>`
for getting started with RBD.

Once you have a the block device mounted and in use, you can jump to
`Ceph RBD Snapshots`_

CephFs Snapshots:
-----------------

Similar to RBD snapshots, CephFs snapshots are read-only logical copies of **any chosen subdirectory**
of the corresponding filesystem.

Pre-requisites
++++++++++++++

Refer to :doc:`How to mount MicroCeph CephFs shares <../tutorial/mount-cephfs-share.rst>`
for getting started with CephFs.

Once you have a the filesystem mounted and in use, you can jump to
`CephFs Snapshots`_

.. LINKS
.. _Ceph RBD Snapshots: https://docs.ceph.com/en/latest/rbd/rbd-snapshot/
.. _CephFs Snapshots: https://docs.ceph.com/en/latest/dev/cephfs-snapshots/
4 changes: 2 additions & 2 deletions docs/tutorial/mount-block-device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Mount MicroCeph backed Block Devices
====================================

This tutorial will guide you with mounting Block devices backed by a
MicroCeph cluster.
Ceph RBD (RADOS Block Device) are virtual block devices backed by the Ceph storage cluster.
This tutorial will guide you with mounting Block devices using MicroCeph.

The above will be achieved by creating an rbd image on the MicroCeph deployed
Ceph cluster, mapping it on the client machine, and then mounting it.
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/mount-cephfs-share.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Mount MicroCeph backed CephFs shares
====================================

This tutorial will guide you with mounting CephFs share backed by a
MicroCeph cluster.
CephFs (Ceph Filesystem) are filesystem shares backed by the Ceph storage cluster.
This tutorial will guide you with mounting CephFs shares using MicroCeph.

The above will be achieved by creating an fs on the MicroCeph deployed
Ceph cluster, and then mounting it using the kernel driver.
Expand Down

0 comments on commit 28e490a

Please sign in to comment.