doc/rbd: tweak the format of command line blocks

to use the "prompt" directive for better rendering.

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/doc/rbd/iscsi-target-ansible.rst b/doc/rbd/iscsi-target-ansible.rst
index d38e3bd018c49c51d553318441f06c707e4593b4..bf8a1ec9b35a1dbc8b0e7cffd0836e5e756656da 100644 (file)
--- a/doc/rbd/iscsi-target-ansible.rst
+++ b/doc/rbd/iscsi-target-ansible.rst
@@ -100,10 +100,10 @@ Perform the followint steps on the Ansible installer node.
 
 #. As ``root``, execute the Ansible playbook:
 
-   ::
+   .. prompt:: bash #
 
-       # cd /usr/share/ceph-ansible
-       # ansible-playbook site.yml --limit iscsigws
+      cd /usr/share/ceph-ansible
+      ansible-playbook site.yml --limit iscsigws
 
    .. note::
     The Ansible playbook will handle RPM dependencies, setting up daemons,
@@ -114,9 +114,9 @@ Perform the followint steps on the Ansible installer node.
 
 #. Verify the configuration from an iSCSI gateway node:
 
-   ::
+   .. prompt:: bash #
 
-       # gwcli ls
+      gwcli ls
 
    .. note::
     See the `Configuring the iSCSI Target using the Command Line Interface`_
@@ -138,9 +138,9 @@ will restore the Linux IO state. The Ansible playbook disables the
 target service during the deployment. Below are the outcomes of when
 interacting with the ``rbd-target-api`` Systemd service.
 
-::
+.. prompt:: bash #
 
-    # systemctl <start|stop|restart|reload> rbd-target-api
+   systemctl <start|stop|restart|reload> rbd-target-api
 
 -  ``reload``
 
@@ -186,6 +186,8 @@ correct mode is chosen, this operation will delete data.
   A purge operation will fail, if RBD images have snapshots or clones
   and are exported through the Ceph iSCSI gateway.
 
+.. highlight:: console
+
 ::
 
     [root@rh7-iscsi-client ceph-ansible]# ansible-playbook purge_gateways.yml

diff --git a/doc/rbd/iscsi-target-cli-manual-install.rst b/doc/rbd/iscsi-target-cli-manual-install.rst
index ccc422e0d73684628c6a11727b3abb7c1a21a6d6..005f8aa94eacd721f914841c8e2555a8622b1a0c 100644 (file)
--- a/doc/rbd/iscsi-target-cli-manual-install.rst
+++ b/doc/rbd/iscsi-target-cli-manual-install.rst
@@ -49,15 +49,15 @@ on each machine that will be a iSCSI gateway:
 In order to install all the packages needed to run iSCSI with Ceph, you need to download them directly from their repository by using Git.
 On CentOS/RHEL execute:
 
-::
+.. prompt:: bash >
 
-   > sudo yum install git
+   sudo yum install git
 
 On Debian/Ubuntu execute:
 
-::
+.. prompt:: bash >
 
-   > sudo apt install git
+   sudo apt install git
    
 To know more about Git and how it works, please, visit https://git-scm.com
 
@@ -76,7 +76,7 @@ documentation for specific instructions on how to build this kernel. The only
 Ceph iSCSI specific requirements are that the following build options must be
 enabled:
 
-    ::
+    .. code-block:: ini
     
        CONFIG_TARGET_CORE=m
        CONFIG_TCM_USER2=m
@@ -94,32 +94,32 @@ tcmu-runner
 
    Installation:
 
-   ::
+   .. prompt:: bash >
 
-       > git clone https://github.com/open-iscsi/tcmu-runner
-       > cd tcmu-runner
+      git clone https://github.com/open-iscsi/tcmu-runner
+      cd tcmu-runner
 
    Run the following command to install all the needed dependencies:
 
-   ::
+   .. prompt:: bash >
 
-       > ./extra/install_dep.sh   
+      ./extra/install_dep.sh
    
    Now you can build the tcmu-runner.
    To do so, use the following build command:
 
-   ::
+   .. prompt:: bash >
 
-       > cmake -Dwith-glfs=false -Dwith-qcow=false -DSUPPORT_SYSTEMD=ON -DCMAKE_INSTALL_PREFIX=/usr
-       > make install
+      cmake -Dwith-glfs=false -Dwith-qcow=false -DSUPPORT_SYSTEMD=ON -DCMAKE_INSTALL_PREFIX=/usr
+      make install
 
    Enable and start the daemon:
 
-   ::
+   .. prompt:: bash >
 
-       > systemctl daemon-reload
-       > systemctl enable tcmu-runner
-       > systemctl start tcmu-runner
+      systemctl daemon-reload
+      systemctl enable tcmu-runner
+      systemctl start tcmu-runner
 
 
 rtslib-fb
@@ -127,35 +127,35 @@ rtslib-fb
 
    Installation:
 
-   ::
+   .. prompt:: bash >
 
-       > git clone https://github.com/open-iscsi/rtslib-fb.git
-       > cd rtslib-fb
-       > python setup.py install
+      git clone https://github.com/open-iscsi/rtslib-fb.git
+      cd rtslib-fb
+      python setup.py install
 
 configshell-fb
 --------------
 
    Installation:
 
-   ::
+   .. prompt:: bash >
 
-       > git clone https://github.com/open-iscsi/configshell-fb.git
-       > cd configshell-fb
-       > python setup.py install
+      git clone https://github.com/open-iscsi/configshell-fb.git
+      cd configshell-fb
+      python setup.py install
 
 targetcli-fb
 ------------
 
    Installation:
 
-   ::
+   .. prompt:: bash >
 
-       > git clone https://github.com/open-iscsi/targetcli-fb.git
-       > cd targetcli-fb
-       > python setup.py install
-       > mkdir /etc/target
-       > mkdir /var/target
+      git clone https://github.com/open-iscsi/targetcli-fb.git
+      cd targetcli-fb
+      python setup.py install
+      mkdir /etc/target
+      mkdir /var/target
 
    .. warning:: The ceph-iscsi tools assume they are managing all targets
       on the system. If targets have been setup and are being managed by
@@ -166,23 +166,23 @@ ceph-iscsi
 
    Installation:
 
-   ::
+   .. prompt:: bash >
 
-       > git clone https://github.com/ceph/ceph-iscsi.git
-       > cd ceph-iscsi
-       > python setup.py install --install-scripts=/usr/bin
-       > cp usr/lib/systemd/system/rbd-target-gw.service /lib/systemd/system
-       > cp usr/lib/systemd/system/rbd-target-api.service /lib/systemd/system
+      git clone https://github.com/ceph/ceph-iscsi.git
+      cd ceph-iscsi
+      python setup.py install --install-scripts=/usr/bin
+      cp usr/lib/systemd/system/rbd-target-gw.service /lib/systemd/system
+      cp usr/lib/systemd/system/rbd-target-api.service /lib/systemd/system
 
    Enable and start the daemon:
 
-   ::
+   .. prompt:: bash >
 
-       > systemctl daemon-reload
-       > systemctl enable rbd-target-gw
-       > systemctl start rbd-target-gw
-       > systemctl enable rbd-target-api
-       > systemctl start rbd-target-api
+      systemctl daemon-reload
+      systemctl enable rbd-target-gw
+      systemctl start rbd-target-gw
+      systemctl enable rbd-target-api
+      systemctl start rbd-target-api
 
 Installation is complete. Proceed to the setup section in the
 `main ceph-iscsi CLI page`_.

diff --git a/doc/rbd/iscsi-target-cli.rst b/doc/rbd/iscsi-target-cli.rst
index d888a34b09d944601906025faf20a78cf81980e3..ef98cc1a6fe7b4e64fc4735e53797b5e664ad699 100644 (file)
--- a/doc/rbd/iscsi-target-cli.rst
+++ b/doc/rbd/iscsi-target-cli.rst
@@ -67,16 +67,16 @@ For rpm based instructions execute the following commands:
 #. As ``root``, on all iSCSI gateway nodes, install the
    ``ceph-iscsi`` package:
 
-   ::
+   .. prompt:: bash #
 
-       # yum install ceph-iscsi
+      yum install ceph-iscsi
 
 #. As ``root``, on all iSCSI gateway nodes, install the ``tcmu-runner``
    package:
 
-   ::
+   .. prompt:: bash #
 
-       # yum install tcmu-runner
+      yum install tcmu-runner
 
 **Setup:**
 
@@ -84,9 +84,9 @@ For rpm based instructions execute the following commands:
    like the iSCSI configuration. To check if this pool has been created
    run:
 
-   ::
+   .. prompt:: bash #
 
-       # ceph osd lspools
+      ceph osd lspools
 
    If it does not exist instructions for creating pools can be found on the
    `RADOS pool operations page
@@ -95,13 +95,13 @@ For rpm based instructions execute the following commands:
 #. As ``root``, on a iSCSI gateway node, create a file named
    ``iscsi-gateway.cfg`` in the ``/etc/ceph/`` directory:
 
-   ::
+   .. prompt:: bash #
 
-       # touch /etc/ceph/iscsi-gateway.cfg
+      touch /etc/ceph/iscsi-gateway.cfg
 
    #. Edit the ``iscsi-gateway.cfg`` file and add the following lines:
 
-      ::
+      .. code-block:: ini
 
           [config]
           # Name of the Ceph storage cluster. A suitable Ceph configuration file allowing
@@ -148,15 +148,15 @@ For rpm based instructions execute the following commands:
 #. As ``root``, on all iSCSI gateway nodes, enable and start the API
    service:
 
-   ::
+   .. prompt:: bash #
 
-       # systemctl daemon-reload
+      systemctl daemon-reload
        
-       # systemctl enable rbd-target-gw
-       # systemctl start rbd-target-gw
+      systemctl enable rbd-target-gw
+      systemctl start rbd-target-gw
 
-       # systemctl enable rbd-target-api
-       # systemctl start rbd-target-api
+      systemctl enable rbd-target-api
+      systemctl start rbd-target-api
 
 
 **Configuring:**
@@ -170,14 +170,14 @@ to create a iSCSI target and export a RBD image as LUN 0.
 #. As ``root``, on a iSCSI gateway node, start the iSCSI gateway
    command-line interface:
 
-   ::
+   .. prompt:: bash #
 
-       # gwcli
+      gwcli
 
 #. Go to iscsi-targets and create a target with the name
    iqn.2003-01.com.redhat.iscsi-gw:iscsi-igw:
 
-   ::
+   .. code-block:: console
 
        > /> cd /iscsi-target
        > /iscsi-target>  create iqn.2003-01.com.redhat.iscsi-gw:iscsi-igw
@@ -187,7 +187,7 @@ to create a iSCSI target and export a RBD image as LUN 0.
    same IPs used for management operations listed in trusted_ip_list,
    but it is recommended that different IPs are used.
 
-   ::
+   .. code-block:: console
 
        > /iscsi-target> cd iqn.2003-01.com.redhat.iscsi-gw:iscsi-igw/gateways
        > /iscsi-target...-igw/gateways>  create ceph-gw-1 10.172.19.21
@@ -197,7 +197,7 @@ to create a iSCSI target and export a RBD image as LUN 0.
    the skipchecks=true argument must be used. This will avoid the Red Hat kernel
    and rpm checks:
 
-   ::
+   .. code-block:: console
 
        > /iscsi-target> cd iqn.2003-01.com.redhat.iscsi-gw:iscsi-igw/gateways
        > /iscsi-target...-igw/gateways>  create ceph-gw-1 10.172.19.21 skipchecks=true
@@ -205,14 +205,14 @@ to create a iSCSI target and export a RBD image as LUN 0.
 
 #. Add a RBD image with the name disk_1 in the pool rbd:
 
-   ::
+   .. code-block:: console
 
        > /iscsi-target...-igw/gateways> cd /disks
        > /disks> create pool=rbd image=disk_1 size=90G
 
 #. Create a client with the initiator name iqn.1994-05.com.redhat:rh7-client:
 
-   ::
+   .. code-block:: console
 
        > /disks> cd /iscsi-target/iqn.2003-01.com.redhat.iscsi-gw:iscsi-igw/hosts
        > /iscsi-target...eph-igw/hosts>  create iqn.1994-05.com.redhat:rh7-client
@@ -220,7 +220,7 @@ to create a iSCSI target and export a RBD image as LUN 0.
 #. Set the client's CHAP username to myiscsiusername and password to
    myiscsipassword:
 
-   ::
+   .. code-block:: console
 
        > /iscsi-target...at:rh7-client>  auth username=myiscsiusername password=myiscsipassword
 
@@ -230,7 +230,7 @@ to create a iSCSI target and export a RBD image as LUN 0.
 
 #. Add the disk to the client:
 
-   ::
+   .. code-block:: console
 
        > /iscsi-target...at:rh7-client> disk add rbd/disk_1