mirror of
https://github.com/ceph/ceph
synced 2024-12-14 07:25:50 +00:00
22bc886ac5
Looks like 'foo' is a leftover, see commit ea9fc87d89 ("doc: Removed
foo. Apparently myimage was added and foo not removed.").
Signed-off-by: Ilya Dryomov <ilya.dryomov@inktank.com>
59 lines
1.5 KiB
ReStructuredText
59 lines
1.5 KiB
ReStructuredText
==========================
|
|
Kernel Module Operations
|
|
==========================
|
|
|
|
.. index:: Ceph Block Device; kernel module
|
|
|
|
.. important:: To use kernel module operations, you must have a running Ceph cluster.
|
|
|
|
Get a List of Images
|
|
====================
|
|
|
|
To mount a block device image, first return a list of the images. ::
|
|
|
|
rbd list
|
|
|
|
Map a Block Device
|
|
==================
|
|
|
|
Use ``rbd`` to map an image name to a kernel module. You must specify the
|
|
image name, the pool name, and the user name. ``rbd`` will load RBD kernel
|
|
module on your behalf if it's not already loaded. ::
|
|
|
|
sudo rbd map {image-name} --pool {pool-name} --id {user-name}
|
|
|
|
For example::
|
|
|
|
sudo rbd map --pool rbd myimage --id admin
|
|
|
|
If you use `cephx`_ authentication, you must also specify a secret. It may come
|
|
from a keyring or a file containing the secret. ::
|
|
|
|
sudo rbd map --pool rbd myimage --id admin --keyring /path/to/keyring
|
|
sudo rbd map --pool rbd myimage --id admin --keyfile /path/to/file
|
|
|
|
|
|
Show Mapped Block Devices
|
|
=========================
|
|
|
|
To show block device images mapped to kernel modules with the ``rbd`` command,
|
|
specify the ``showmapped`` option. ::
|
|
|
|
rbd showmapped
|
|
|
|
|
|
Unmapping a Block Device
|
|
========================
|
|
|
|
To unmap a block device image with the ``rbd`` command, specify the ``unmap``
|
|
option and the device name (i.e., by convention the same as the block device
|
|
image name). ::
|
|
|
|
sudo rbd unmap /dev/rbd/{poolname}/{imagename}
|
|
|
|
For example::
|
|
|
|
sudo rbd unmap /dev/rbd/rbd/foo
|
|
|
|
|
|
.. _cephx: ../../rados/operations/authentication/ |