| 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 |  | 
|  | 21 | Entries under /sys/bus/rbd/devices/<dev-id>/ | 
|  | 22 | -------------------------------------------- | 
|  | 23 |  | 
|  | 24 | client_id | 
|  | 25 |  | 
|  | 26 | The ceph unique client id that was assigned for this specific session. | 
|  | 27 |  | 
|  | 28 | major | 
|  | 29 |  | 
|  | 30 | The block device major number. | 
|  | 31 |  | 
|  | 32 | name | 
|  | 33 |  | 
|  | 34 | The name of the rbd image. | 
|  | 35 |  | 
|  | 36 | pool | 
|  | 37 |  | 
| Alex Elder | 9bb2f33 | 2012-07-12 10:46:35 -0500 | [diff] [blame] | 38 | The name of the storage pool where this rbd image resides. | 
|  | 39 | An rbd image name is unique within its pool. | 
|  | 40 |  | 
|  | 41 | pool_id | 
|  | 42 |  | 
|  | 43 | The unique identifier for the rbd image's pool.  This is | 
|  | 44 | a permanent attribute of the pool.  A pool's id will never | 
|  | 45 | change. | 
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 46 |  | 
|  | 47 | size | 
|  | 48 |  | 
|  | 49 | The size (in bytes) of the mapped block device. | 
|  | 50 |  | 
|  | 51 | refresh | 
|  | 52 |  | 
|  | 53 | Writing to this file will reread the image header data and set | 
|  | 54 | all relevant datastructures accordingly. | 
|  | 55 |  | 
|  | 56 | current_snap | 
|  | 57 |  | 
|  | 58 | The current snapshot for which the device is mapped. | 
|  | 59 |  | 
|  | 60 | create_snap | 
|  | 61 |  | 
|  | 62 | Create a snapshot: | 
|  | 63 |  | 
|  | 64 | $ echo <snap-name> > /sys/bus/rbd/devices/<dev-id>/snap_create | 
|  | 65 |  | 
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 66 | snap_* | 
|  | 67 |  | 
|  | 68 | A directory per each snapshot | 
|  | 69 |  | 
|  | 70 |  | 
|  | 71 | Entries under /sys/bus/rbd/devices/<dev-id>/snap_<snap-name> | 
|  | 72 | ------------------------------------------------------------- | 
|  | 73 |  | 
| Josh Durgin | b7f6519 | 2011-12-01 15:12:03 -0800 | [diff] [blame] | 74 | snap_id | 
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 75 |  | 
|  | 76 | The rados internal snapshot id assigned for this snapshot | 
|  | 77 |  | 
| Josh Durgin | b7f6519 | 2011-12-01 15:12:03 -0800 | [diff] [blame] | 78 | snap_size | 
| Yehuda Sadeh | dfc5606 | 2010-11-19 14:51:04 -0800 | [diff] [blame] | 79 |  | 
|  | 80 | The size of the image when this snapshot was taken. | 
|  | 81 |  | 
|  | 82 |  |