New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
rbdmap: add manpage #8224
Merged
Merged
rbdmap: add manpage #8224
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
:orphan: | ||
|
||
========================================= | ||
rbdmap -- map RBD devices at boot time | ||
========================================= | ||
|
||
.. program:: rbdmap | ||
|
||
Synopsis | ||
======== | ||
|
||
| **rbdmap map** | ||
| **rbdmap unmap** | ||
|
||
|
||
Description | ||
=========== | ||
|
||
**rbdmap** is a shell script that can be run manually by the system | ||
administrator at any time, or automatically at boot time by the init system | ||
(sysvinit, upstart, systemd). The script looks for an environment variable | ||
``RBDMAPFILE``, which defaults to ``/etc/ceph/rbdmap``. This file is | ||
expected to contain a list of RBD images and, possibly, parameters to be | ||
passed to the underlying ``rbd`` command. The syntax of | ||
``/etc/ceph/rbdmap`` is described in the comments at the top of that file. | ||
|
||
The script mounts devices after mapping, and unmounts them before | ||
unmapping. | ||
|
||
|
||
Options | ||
======= | ||
|
||
None | ||
|
||
|
||
Availability | ||
============ | ||
|
||
**rbdmap** is part of Ceph, a massively scalable, open-source, distributed | ||
storage system. Please refer to the Ceph documentation at | ||
http://ceph.com/docs for more information. | ||
|
||
|
||
See also | ||
======== | ||
|
||
:doc:`rbd <rbd>`\(8), |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could use the basic usage info, here. I.e. rbdmap map | unmap.