From: Zac Dover Date: Tue, 17 Aug 2021 04:34:49 +0000 (+1000) Subject: doc: improve RBD "Block Devices and Nomad" X-Git-Tag: v17.1.0~1052^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=66ebe00fb31bc2521a37ba53486ef7f2b2e16f7b;p=ceph.git doc: improve RBD "Block Devices and Nomad" This PR improves the English syntax and spelling in the "Block Devices and Nomad" section of the rbd-nomad.rst page. This PR rewrites the top-level matter. Signed-off-by: Zac Dover --- diff --git a/doc/rbd/rbd-nomad.rst b/doc/rbd/rbd-nomad.rst index 427b2c6fa114..cc38651ef985 100644 --- a/doc/rbd/rbd-nomad.rst +++ b/doc/rbd/rbd-nomad.rst @@ -2,15 +2,18 @@ Block Devices and Nomad ========================= -Like Kubernetes, Nomad can use Ceph Block Device thanks to `ceph-csi`_, -which allow to dynamically provision RBD images or import existing one. +Like Kubernetes, Nomad can use Ceph Block Device. This is made possible by +`ceph-csi`_, which allows you to dynamically provision RBD images or import +existing RBD images. -Every nomad version can use `ceph-csi`_, however we'll here describe the -latest version available at writing time, Nomad v1.1.2 . +Every version of Nomad is compatible with `ceph-csi`_, but the reference +version of Nomad that was used to generate the procedures and guidance in this +document is Nomad v1.1.2, the latest version available at the time of the +writing of the document. To use Ceph Block Devices with Nomad, you must install and configure ``ceph-csi`` within your Nomad environment. The following -diagram depicts the Nomad/Ceph technology stack. +diagram shows the Nomad/Ceph technology stack. .. ditaa:: +-------------------------+-------------------------+ @@ -43,11 +46,11 @@ diagram depicts the Nomad/Ceph technology stack. +------------------------+ +------------------------+ .. note:: - Nomad has many task drivers, but we'll only use a Docker container in this example. + Nomad has many possible task drivers, but this example uses only a Docker container. .. important:: - ``ceph-csi`` uses the RBD kernel modules by default which may not support all - Ceph `CRUSH tunables`_ or `RBD image features`_. + ``ceph-csi`` uses the RBD kernel modules by default, which may not support + all Ceph `CRUSH tunables`_ or `RBD image features`_. Create a Pool ============= @@ -428,4 +431,4 @@ It will reuse the same RBD image. .. _CRUSH tunables: ../../rados/operations/crush-map/#tunables .. _RBD image features: ../rbd-config-ref/#image-features .. _nomad sateful: https://learn.hashicorp.com/tutorials/nomad/stateful-workloads-csi-volumes?in=nomad/stateful-workloads#create-the-job-file -.. _ceph-csi release: https://github.com/ceph/ceph-csi#ceph-csi-container-images-and-release-compatibility \ No newline at end of file +.. _ceph-csi release: https://github.com/ceph/ceph-csi#ceph-csi-container-images-and-release-compatibility