ceph/doc/man/8/rbd-nbd.rst
Prasanna Kumar Kalever 688f0c5fb0 rbd-nbd: support notrim option with map command
currently --notrim option works for rbd kernel mounter, but fails with rbd-nbd

$ rbd device --options notrim map rbd-pool/image0
/dev/rbd0
$ rbd device list
id  pool      namespace  image   snap  device
0   rbd-pool             image0  -     /dev/rbd0

$ rbd device --device-type nbd --options try-netlink,notrim map rbd-pool/image0
rbd-nbd: unknown args: --notrim
rbd: rbd-nbd failed with error: /data/ceph/build/bin/rbd-nbd: exit status: 1

With this changes:
$ rbd device --device-type nbd --options try-netlink,notrim map rbd-pool/image0
/dev/nbd0
$ rbd-nbd list-mapped
id    pool      namespace  image   snap  device
6945  rbd-pool             image0  -     /dev/nbd0
$ ps -eo "cmd" |grep [r]bd-nbd
/data/ceph/build/bin/rbd-nbd map rbd-pool/image0 --try-netlink --notrim

Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
2021-06-28 13:46:43 +05:30

94 lines
2.5 KiB
ReStructuredText

:orphan:
=========================================
rbd-nbd -- map rbd images to nbd device
=========================================
.. program:: rbd-nbd
Synopsis
========
| **rbd-nbd** [-c conf] [--read-only] [--device *nbd device*] [--nbds_max *limit*] [--max_part *limit*] [--exclusive] [--notrim] [--encryption-format *format*] [--encryption-passphrase-file *passphrase-file*] [--io-timeout *seconds*] [--reattach-timeout *seconds*] map *image-spec* | *snap-spec*
| **rbd-nbd** unmap *nbd device* | *image-spec* | *snap-spec*
| **rbd-nbd** list-mapped
| **rbd-nbd** attach --device *nbd device* *image-spec* | *snap-spec*
| **rbd-nbd** detach *nbd device* | *image-spec* | *snap-spec*
Description
===========
**rbd-nbd** is a client for RADOS block device (rbd) images like rbd kernel module.
It will map a rbd image to a nbd (Network Block Device) device, allowing access it
as regular local block device.
Options
=======
.. option:: -c ceph.conf
Use *ceph.conf* configuration file instead of the default
``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
.. option:: --read-only
Map read-only.
.. option:: --nbds_max *limit*
Override the parameter nbds_max of NBD kernel module when modprobe, used to
limit the count of nbd device.
.. option:: --max_part *limit*
Override for module param max_part.
.. option:: --exclusive
Forbid writes by other clients.
.. option:: --notrim
Turn off trim/discard.
.. option:: --encryption-format
Image encryption format.
Possible values: *luks1*, *luks2*
.. option:: --encryption-passphrase-file
Path of file containing a passphrase for unlocking image encryption.
.. option:: --io-timeout *seconds*
Override device timeout. Linux kernel will default to a 30 second request timeout.
Allow the user to optionally specify an alternate timeout.
.. option:: --reattach-timeout *seconds*
Specify timeout for the kernel to wait for a new rbd-nbd process is
attached after the old process is detached. The default is 30
second.
Image and snap specs
====================
| *image-spec* is [*pool-name*]/*image-name*
| *snap-spec* is [*pool-name*]/*image-name*\ @\ *snap-name*
The default for *pool-name* is "rbd". If an image name contains a slash
character ('/'), *pool-name* is required.
Availability
============
**rbd-nbd** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
the Ceph documentation at https://docs.ceph.com/ for more information.
See also
========
:doc:`rbd <rbd>`\(8)