]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: Added a snapshot page with outline. Needs additional info.
authorJohn Wilkins <john.wilkins@inktank.com>
Tue, 19 Jun 2012 17:15:35 +0000 (10:15 -0700)
committerJohn Wilkins <john.wilkins@inktank.com>
Tue, 19 Jun 2012 17:15:35 +0000 (10:15 -0700)
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
doc/rbd/rbd-snapshot.rst [new file with mode: 0644]
doc/rbd/rbd.rst

diff --git a/doc/rbd/rbd-snapshot.rst b/doc/rbd/rbd-snapshot.rst
new file mode 100644 (file)
index 0000000..4604b43
--- /dev/null
@@ -0,0 +1,36 @@
+==================
+ RBD Snapshotting
+==================
+One of the advanced features of RADOS block devices is that you can create 
+snapshots of the images to retain a history of an image's state. Ceph supports
+RBD snapshots from the ``rbd`` command, from a kernel object, from a 
+KVM, and from cloud solutions. Once you create snapshots of an image, you 
+can rollback to a snapshot, list snapshots, remove snapshots and purge 
+the snapshots.
+
+.. important:: To use use RBD snapshots, you must have a running Ceph cluster.
+
+.. important:: Generally, you should stop i/o before snapshotting an image.
+   If the image contains a filesystem, the filesystem should be in a
+   consistent state before snapshotting too.
+   
+
+Create Snapshot
+---------------
+<placeholder>
+
+You can take snapshots of RBD images. 
+
+List Snapshots
+--------------
+<placeholder>
+
+
+Rollback Snapshot
+-----------------
+<placeholder>
+
+
+Delete a Snapshot
+-----------------
+<placeholder>
\ No newline at end of file
index 5f797c06645b2a74cfd2a309eee9770efe919cdf..af1682f6a949f9379e32ed717eed1d835f2c5173 100644 (file)
@@ -27,10 +27,11 @@ the Ceph FS filesystem, and RADOS block devices simultaneously.
 
        RADOS Commands <rados-rbd-cmds>
        Kernel Objects <rbd-ko>
+       RBD Snapshots <rbd-snapshot>
        QEMU and RBD <qemu-rbd>
        libvirt <libvirt>
        RBD and OpenStack <rbd-openstack>
        
        
        
-       
\ No newline at end of file
+