ceph/man/mkcephfs.8
Sage Weil 57bcdc54d5 mkcephfs: require -k; update man page
Force users to specify keyring location; update man page accordingly.

Signed-off-by: Sage Weil <sage@newdream.net>
2010-12-06 22:18:16 -08:00

47 lines
1.6 KiB
Groff

.TH MKCEPHFS 8
.SH NAME
mkcephfs \- create a ceph file system
.SH SYNOPSIS
.B mkcephfs
[ \fB\-a\fP ]
[ \fB\-c\fP\fI ceph.conf\fP ]
[ \fB\-k\fI /path/to/keyring.bin\fP ]
[ \fB\-\-clobber_old_data\fP ]
[ \fB\-\-mkbtrfs\fP ]
.SH DESCRIPTION
.B mkcephfs
is used to create an empty Ceph file system, possibly spanning multiple
hosts. The \fIceph.conf\fP file describes the composition of the
Ceph cluster, including which hosts are participating, which daemons
run where, and which paths are used to store file system data or
metadata.
.SH OPTIONS
.TP
\fB\-a\fR, \fB\-\-allhosts\fR
Performs the necessary initialization steps on all hosts in the cluster,
executing commands via SSH.
.TP
\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
Use the given conf file instead of the default \fI/etc/ceph/ceph.conf\fP.
.TP
\fB\-k\fI /path/to/keyring.bin\fR
Location to write the client.admin keyring, which is used to administer the cluster. The default is \fI/etc/ceph/keyring.bin\fP, but must still be specified explicitly.
.TP
\fB\-\-clobber_old_data\fR
Overwrite any existing data found in monitor or osd paths.
.TP
\fB\-\-mkbtrfs\fR
Create and mount the any btrfs file systems specified in the
\fBceph.conf\fP for OSD data storage using \fBmkfs.btrfs\fP. The
"btrfs devs" and (if it differs from
"osd data") "btrfs path" options must be defined.
.SH AVAILABILITY
.B mkcephfs
is part of the Ceph distributed file system. Please refer to the Ceph wiki at
http://ceph.newdream.net/wiki for more information.
.SH SEE ALSO
.BR ceph (8),
.BR monmaptool (8),
.BR osdmaptool (8),
.BR crushmaptool (8)