Project

General

Profile

Documentation #2670

Docs shouldn't direct users to echo to /sys/bus/rbd for normal use

Added by Anonymous about 11 years ago. Updated about 11 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
John Wilkins
Target version:
v0.51
% Done:

0%

Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

A naive user looking for "rbd map" will instead find this:

http://ceph.com/docs/master/rbd/rados-rbd-cmds/

with commands like

echo "{mon-ip-address} name={user-name} rbd {image-name}" | sudo tee /sys/bus/rbd/add

instead of "rbd map". While I think the lower-level interface should be documented somewhere, regular folk should use "rbd map" and not /sys/bus/rbd.

Right now it seems the only documentation we have on "rbd map" is the rbd manpage:
http://ceph.com/docs/master/man/8/rbd/

Associated revisions

Revision 4ce0a516 (diff)
Added by Sage Weil about 11 years ago

doc: properly document 'rbd map' without touching sysfs

Fixes: #2670
Signed-off-by: Sage Weil <>

History

#1 Updated by Sage Weil about 11 years ago

  • Project changed from Ceph to rbd

#2 Updated by Sage Weil about 11 years ago

  • translation missing: en.field_position set to 1

#3 Updated by Sage Weil about 11 years ago

  • Assignee set to John Wilkins

#4 Updated by Sage Weil about 11 years ago

  • Status changed from New to 12
  • translation missing: en.field_position deleted (6)
  • translation missing: en.field_position set to 1

#5 Updated by Sage Weil about 11 years ago

  • Target version set to v0.50
  • translation missing: en.field_position deleted (8)
  • translation missing: en.field_position set to 1324

#6 Updated by Sage Weil about 11 years ago

  • Status changed from 12 to In Progress
  • translation missing: en.field_position deleted (1324)
  • translation missing: en.field_position set to 1324

#7 Updated by Sage Weil about 11 years ago

  • translation missing: en.field_position deleted (1324)
  • translation missing: en.field_position set to 1

#8 Updated by Sage Weil about 11 years ago

  • Target version changed from v0.50 to v0.51
  • translation missing: en.field_position deleted (17)
  • translation missing: en.field_position set to 1

#9 Updated by Anonymous about 11 years ago

  • translation missing: en.field_position deleted (1)
  • translation missing: en.field_position set to 9

#10 Updated by Sage Weil about 11 years ago

  • Status changed from In Progress to Resolved

Also available in: Atom PDF