Skip to content

Commit

Permalink
man: update remaining copyright notices
Browse files Browse the repository at this point in the history
Signed-off-by: Josh Durgin <[email protected]>
  • Loading branch information
jdurgin committed Apr 29, 2013
1 parent 4abf081 commit 825a431
Show file tree
Hide file tree
Showing 21 changed files with 42 additions and 83 deletions.
44 changes: 2 additions & 42 deletions man/ceph-authtool.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-AUTHTOOL" "8" "December 29, 2012" "dev" "Ceph"
.TH "CEPH-AUTHTOOL" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-authtool \- ceph keyring manipulation tool
.
Expand Down Expand Up @@ -99,8 +99,6 @@ read, write, and execute permission. The \fBallow *\fP grants full
superuser permissions for the given subsystem.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Expand All @@ -114,12 +112,8 @@ mds = "allow"
mon = "allow rwx"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A librados user restricted to a single pool might look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Expand All @@ -128,12 +122,8 @@ mon = "allow r"
osd = "allow rw pool foo"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A client using rbd with read access to one pool and read/write access to another:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Expand All @@ -142,12 +132,8 @@ mon = "allow r"
osd = "allow class\-read object_prefix rbd_children, allow pool templates r class\-read, allow pool vms rwx"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A client mounting the file system with minimal permissions would need caps like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Expand All @@ -158,13 +144,9 @@ osd = "allow rw pool data"
mon = "allow r"
.ft P
.fi
.UNINDENT
.UNINDENT
.SH OSD CAPABILITIES
.sp
In general, an osd capability follows the grammar:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Expand All @@ -174,12 +156,8 @@ match := [pool[=]<poolname> | object_prefix <prefix>]
capspec := * | [r][w][x] [class\-read] [class\-write]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The capspec determines what kind of operations the entity can perform:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Expand All @@ -192,8 +170,6 @@ class\-write = can call class methods that are writes
i.e. ceph osd tell ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The match criteria restrict a grant based on the pool being accessed.
Grants are additive if the client fulfills the match condition. For
Expand All @@ -211,53 +187,37 @@ value is the capability string (see above).
.SH EXAMPLE
.sp
To create a new keyring containing a key for client.foo:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph\-authtool \-C \-n client.foo \-\-gen\-key keyring
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To associate some capabilities with the key (namely, the ability to
mount a Ceph filesystem):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph\-authtool \-n client.foo \-\-cap mds \(aqallow\(aq \-\-cap osd \(aqallow rw pool=data\(aq \-\-cap mon \(aqallow r\(aq keyring
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To display the contents of the keyring:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph\-authtool \-l keyring
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When mount a Ceph file system, you can grab the appropriately encoded secret key with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mount \-t ceph serverhost:/ mountpoint \-o name=foo,secret=\(gaceph\-authtool \-p \-n client.foo keyring\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-authtool\fP is part of the Ceph distributed file system. Please
Expand All @@ -267,6 +227,6 @@ information.
.sp
\fBceph\fP(8)
.SH COPYRIGHT
2010-2012, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-clsinfo.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-CLSINFO" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-CLSINFO" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-clsinfo \- show class object information
.
Expand Down Expand Up @@ -64,6 +64,6 @@ information.
.sp
\fBceph\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-conf.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-CONF" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-CONF" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-conf \- ceph conf file tool
.
Expand Down Expand Up @@ -112,6 +112,6 @@ information.
\fBceph\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-debugpack.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-DEBUGPACK" "8" "October 19, 2012" "dev" "Ceph"
.TH "CEPH-DEBUGPACK" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-debugpack \- ceph debug packer utility
.
Expand Down Expand Up @@ -62,6 +62,6 @@ information.
.sp
\fBceph\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-dencoder.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-DENCODER" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-DENCODER" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-dencoder \- ceph encoder/decoder utility
.
Expand Down Expand Up @@ -157,6 +157,6 @@ information.
.sp
\fBceph\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-fuse.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-FUSE" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-FUSE" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-fuse \- FUSE-based client for ceph
.
Expand Down Expand Up @@ -84,6 +84,6 @@ the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
fusermount(8),
\fBceph\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-mds.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-MDS" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-MDS" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-mds \- ceph metadata server daemon
.
Expand Down Expand Up @@ -89,6 +89,6 @@ Connect to specified monitor (instead of looking through
\fBceph\-mon\fP(8),
\fBceph\-osd\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-mon.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-MON" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-MON" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-mon \- ceph monitor daemon
.
Expand Down Expand Up @@ -105,6 +105,6 @@ information.
\fBceph\-mds\fP(8),
\fBceph\-osd\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-osd.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-OSD" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-OSD" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-osd \- ceph object storage daemon
.
Expand Down Expand Up @@ -138,6 +138,6 @@ the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
\fBceph\-mon\fP(8),
\fBceph\-authtool\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-rbdnamer.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-RBDNAMER" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-RBDNAMER" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-rbdnamer \- udev helper to name RBD devices
.
Expand Down Expand Up @@ -56,6 +56,6 @@ information.
\fBrbd\fP(8),
\fBceph\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-run.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-RUN" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-RUN" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-run \- restart daemon on core dump
.
Expand Down Expand Up @@ -57,6 +57,6 @@ the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
\fBceph\-mds\fP(8),
\fBceph\-osd\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph-syn.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH-SYN" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPH-SYN" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph-syn \- ceph synthetic workload generator
.
Expand Down Expand Up @@ -116,6 +116,6 @@ the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
\fBceph\fP(8),
\fBceph\-fuse\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ceph.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPH" "8" "October 19, 2012" "dev" "Ceph"
.TH "CEPH" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
ceph \- ceph file system control utility
.
Expand Down Expand Up @@ -119,6 +119,6 @@ online documentation, at
\fBceph\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
5 changes: 2 additions & 3 deletions man/cephfs.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CEPHFS" "8" "September 27, 2012" "dev" "Ceph"
.TH "CEPHFS" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
cephfs \- ceph file system options utility
.
Expand Down Expand Up @@ -103,7 +103,6 @@ layouts changed.
You\(aqll notice that the layout information allows you to specify a
preferred OSD for placement. This feature is unsupported and ignored
in modern versions of the Ceph servers; do not use it.

.SH AVAILABILITY
.sp
\fBcephfs\fP is part of the Ceph distributed file system. Please refer
Expand All @@ -113,6 +112,6 @@ information.
.sp
\fBceph\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/librados-config.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "LIBRADOS-CONFIG" "8" "September 27, 2012" "dev" "Ceph"
.TH "LIBRADOS-CONFIG" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
librados-config \- display information about librados
.
Expand Down Expand Up @@ -62,6 +62,6 @@ more information.
\fBceph\fP(8),
\fBrados\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/monmaptool.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "MONMAPTOOL" "8" "September 27, 2012" "dev" "Ceph"
.TH "MONMAPTOOL" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
monmaptool \- ceph monitor cluster map manipulation tool
.
Expand Down Expand Up @@ -145,6 +145,6 @@ information.
\fBcrushtool\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/mount.ceph.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "MOUNT.CEPH" "8" "September 27, 2012" "dev" "Ceph"
.TH "MOUNT.CEPH" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
mount.ceph \- mount a ceph file system
.
Expand Down Expand Up @@ -201,6 +201,6 @@ information.
\fBceph\-fuse\fP(8),
\fBceph\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/osdmaptool.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "OSDMAPTOOL" "8" "September 27, 2012" "dev" "Ceph"
.TH "OSDMAPTOOL" "8" "April 29, 2013" "dev" "Ceph"
.SH NAME
osdmaptool \- ceph osd cluster map manipulation tool
.
Expand Down Expand Up @@ -100,6 +100,6 @@ information.
\fBcrushtool\fP(8),
\fBmkcephfs\fP(8)
.SH COPYRIGHT
2012, Inktank Storage, Inc.
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.
Loading

0 comments on commit 825a431

Please sign in to comment.