| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 1 | What: /sys/bus/rbd/ |
| 2 | Date: November 2010 |
| Sage Weil | 55b00ba | 2011-03-21 15:06:50 -0700 | [diff] [blame] | 3 | Contact: Yehuda Sadeh <yehuda@newdream.net>, |
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 4 | Sage Weil <sage@newdream.net> |
| 5 | Description: |
| 6 | |
| 7 | Being used for adding and removing rbd block devices. |
| 8 | |
| 9 | Usage: <mon ip addr> <options> <pool name> <rbd image name> [snap name] |
| 10 | |
| 11 | $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add |
| 12 | |
| 13 | The snapshot name can be "-" or omitted to map the image read/write. A <dev-id> |
| 14 | will be assigned for any registered block device. If snapshot is used, it will |
| 15 | be mapped read-only. |
| 16 | |
| 17 | Removal of a device: |
| 18 | |
| 19 | $ echo <dev-id> > /sys/bus/rbd/remove |
| 20 | |
| Ilya Dryomov | 9b60e70 | 2013-12-13 15:28:57 +0200 | [diff] [blame] | 21 | What: /sys/bus/rbd/add_single_major |
| 22 | Date: December 2013 |
| 23 | KernelVersion: 3.14 |
| 24 | Contact: Sage Weil <sage@inktank.com> |
| 25 | Description: Available only if rbd module is inserted with single_major |
| 26 | parameter set to true. |
| 27 | Usage is the same as for /sys/bus/rbd/add. If present, |
| 28 | should be used instead of the latter: any attempts to use |
| 29 | /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is |
| 30 | available will fail for backwards compatibility reasons. |
| 31 | |
| 32 | What: /sys/bus/rbd/remove_single_major |
| 33 | Date: December 2013 |
| 34 | KernelVersion: 3.14 |
| 35 | Contact: Sage Weil <sage@inktank.com> |
| 36 | Description: Available only if rbd module is inserted with single_major |
| 37 | parameter set to true. |
| 38 | Usage is the same as for /sys/bus/rbd/remove. If present, |
| 39 | should be used instead of the latter: any attempts to use |
| 40 | /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is |
| 41 | available will fail for backwards compatibility reasons. |
| 42 | |
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 43 | Entries under /sys/bus/rbd/devices/<dev-id>/ |
| 44 | -------------------------------------------- |
| 45 | |
| 46 | client_id |
| 47 | |
| 48 | The ceph unique client id that was assigned for this specific session. |
| 49 | |
| Alex Elder | 34b1318 | 2012-07-13 20:35:12 -0500 | [diff] [blame] | 50 | features |
| 51 | |
| 52 | A hexadecimal encoding of the feature bits for this image. |
| 53 | |
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 54 | major |
| 55 | |
| 56 | The block device major number. |
| 57 | |
| Ilya Dryomov | dd82fff | 2013-12-13 15:28:57 +0200 | [diff] [blame] | 58 | minor |
| 59 | |
| 60 | The block device minor number. (December 2013, since 3.14.) |
| 61 | |
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 62 | name |
| 63 | |
| 64 | The name of the rbd image. |
| 65 | |
| Alex Elder | 589d30e | 2012-07-10 20:30:11 -0500 | [diff] [blame] | 66 | image_id |
| 67 | |
| 68 | The unique id for the rbd image. (For rbd image format 1 |
| 69 | this is empty.) |
| 70 | |
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 71 | pool |
| 72 | |
| Alex Elder | 9bb2f33 | 2012-07-12 10:46:35 -0500 | [diff] [blame] | 73 | The name of the storage pool where this rbd image resides. |
| 74 | An rbd image name is unique within its pool. |
| 75 | |
| 76 | pool_id |
| 77 | |
| 78 | The unique identifier for the rbd image's pool. This is |
| 79 | a permanent attribute of the pool. A pool's id will never |
| 80 | change. |
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 81 | |
| 82 | size |
| 83 | |
| 84 | The size (in bytes) of the mapped block device. |
| 85 | |
| 86 | refresh |
| 87 | |
| 88 | Writing to this file will reread the image header data and set |
| 89 | all relevant datastructures accordingly. |
| 90 | |
| 91 | current_snap |
| 92 | |
| 93 | The current snapshot for which the device is mapped. |
| 94 | |
| Alex Elder | 86b00e0 | 2012-10-25 23:34:42 -0500 | [diff] [blame] | 95 | parent |
| 96 | |
| 97 | Information identifying the pool, image, and snapshot id for |
| 98 | the parent image in a layered rbd image (format 2 only). |