Project

General

Profile

Documentation #57001

RBD Rewrite Project

Added by Zac Dover 6 months ago. Updated about 2 months ago.

Status:
In Progress
Priority:
Normal
Assignee:
Category:
documentation
Target version:
-
% Done:

0%

Spent time:
Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

Josh Durgin and Zac Dover decided on 29 Jul 2022 that the RBD Documentation should be organized more like the CephFS documentation. This should involve a short document that provides a basic overview of RBD.

History

#2 Updated by Cole Mitchell 3 months ago

As of 16 Nov 2022 AEST, the front matter of the RBD book reads as follows:

A block is a sequence of bytes (often 512). Block-based storage interfaces are a mature and common way to store data on media including HDDs, SSDs, CDs, floppy disks, and even tape. The ubiquity of block device interfaces is a perfect fit for interacting with mass data storage including Ceph.

Ceph block devices are thin-provisioned, resizable, and store data striped over multiple OSDs. Ceph block devices leverage RADOS capabilities including snapshotting, replication and strong consistency. Ceph block storage clients communicate with Ceph clusters through kernel modules or the librbd library.

Ceph’s block devices deliver high performance with vast scalability to kernel modules, or to KVMs such as QEMU, and cloud-based computing systems like OpenStack and CloudStack that rely on libvirt and QEMU to integrate with Ceph block devices. You can use the same cluster to operate the Ceph RADOS Gateway, the Ceph File System, and Ceph block devices simultaneously.

#3 Updated by Zac Dover 2 months ago

https://medium.com/system-design-blog/eventual-consistency-vs-strong-consistency-b4de1f92534d - A medium.com article describing the difference between "strong consistency" and "immediate consistency".

#4 Updated by Zac Dover 2 months ago

https://github.com/ceph/ceph/pull/49035

This PR swaps the order of the first two paragraphs in the front matter.

This sentence remains in need of a rewrite: "The ubiquity of block device interfaces is a perfect fit for interacting with mass data storage including Ceph.". I doubt that block device interfaces' ubiquity is what makes block device interfaces a perfect fit for interacting with mass data storage. I suspect rather that block device interfaces are generally available and are likely to be familiar or easily learned.

#5 Updated by Zac Dover 2 months ago

  • Subject changed from Improve RBD Getting Started Documentation to RBD Rewrite Project
  • Category set to documentation
  • Status changed from New to In Progress

Many semantic errors are present in the text of the RBD documentation as of 06 Dec 2022. Each of the files in the doc/rbd/ directory could be improved by an editorial pass focused on the semantics of the text.

#6 Updated by Zac Dover 2 months ago

https://github.com/ceph/ceph/pull/49282 - Refine the "Create a Block Device Pool" section of doc/rbd/rados-rbd-cmds.rst.

#7 Updated by Zac Dover 2 months ago

https://github.com/ceph/ceph/pull/49283 - Refine "Create a Block Device User" in doc/rbd/rados-rbd-cmds.rst.

#8 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49282 - Refine the "Create a Block Device Pool" section of doc/rbd/rados-rbd-cmds.rst.

#9 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49306 - Refine "Create a Block Device User"

#10 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49338 - doc/rbd: refine "Creating a Block Device Image"

#11 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49339 - refine "Listing Block Device Images" in doc/rbd/rados-rbd-cmds.rst

#12 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49340 - refine "Retrieving Image Information" in doc/rbd/rados-rbd-cmds.rst.

#13 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49341 -refine "Resizing a Block Device Image" in doc/rbd/rados-rbd-cmds.rst.

#14 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49342 - refine "Removing a Block Device Image" in doc/rbd/rados-rbd-cmds.rst

#15 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49343 - refine "Restoring a Block Device Image" in doc/rbd/rados-rbd-cmds.rst

#16 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49394 - refine rbd-snapshot.rst

#17 Updated by Zac Dover about 2 months ago

https://github.com/ceph/ceph/pull/49488 - refine rbd-exclusive-locks.rst

Also available in: Atom PDF