← Back to branch summary

~ubuntu-branches/ubuntu/quantal/ceph/quantal

« back to all changes in this revision

Viewing changes to doc/man/8/mkcephfs.rst

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2012-07-16 09:56:24 UTC
  • mfrom: (0.3.11)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: package-import@ubuntu.com-20120716095624-azr2w4hbhei1rxmx
Tags: upstream-0.48
Import upstream version 0.48

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/8/mkcephfs.rst
 
1
=======================================
 
2
 mkcephfs -- create a ceph file system
 
3
=======================================
 
4
 
 
5
.. program:: mkcephfs
 
6
 
 
7
Synopsis
 
8
========
 
9
 
 
10
| **mkcephfs** [ -c *ceph.conf* ] [ --mkbtrfs ] [ -a, --all-hosts [ -k
 
11
  */path/to/admin.keyring* ] ]
 
12
 
 
13
 
 
14
Description
 
15
===========
 
16
 
 
17
**mkcephfs** is used to create an empty Ceph file system, possibly
 
18
spanning multiple hosts. The ceph.conf file describes the composition
 
19
of the entire Ceph cluster, including which hosts are participating,
 
20
which daemons run where, and which paths are used to store file system
 
21
data or metadata.
 
22
 
 
23
The mkcephfs tool can be used in two ways. If -a is used, it will use
 
24
ssh and scp to connect to remote hosts on your behalf and do the setup
 
25
of the entire cluster. This is the easiest solution, but can also be
 
26
inconvenient (if you don't have ssh to connect without prompting for
 
27
passwords) or slow (if you have a large cluster).
 
28
 
 
29
Alternatively, you can run each setup phase manually. First, you need
 
30
to prepare a monmap that will be shared by each node::
 
31
 
 
32
        # prepare
 
33
        master# mkdir /tmp/foo
 
34
        master# mkcephfs -c /etc/ceph/ceph.conf \
 
35
          --prepare-monmap -d /tmp/foo
 
36
 
 
37
Share the ``/tmp/foo`` directory with other nodes in whatever way is
 
38
convenient for you. On each OSD and MDS node::
 
39
 
 
40
        osdnode# mkcephfs --init-local-daemons osd -d /tmp/foo
 
41
        mdsnode# mkcephfs --init-local-daemons mds -d /tmp/foo
 
42
 
 
43
Collect the contents of the /tmp/foo directories back onto a single
 
44
node, and then::
 
45
 
 
46
        master# mkcephfs --prepare-mon -d /tmp/foo
 
47
 
 
48
Finally, distribute ``/tmp/foo`` to all monitor nodes and, on each of
 
49
those nodes::
 
50
 
 
51
        monnode# mkcephfs --init-local-daemons mon -d /tmp/foo
 
52
 
 
53
 
 
54
Options
 
55
=======
 
56
 
 
57
.. option:: -a, --allhosts
 
58
 
 
59
   Performs the necessary initialization steps on all hosts in the
 
60
   cluster, executing commands via SSH.
 
61
 
 
62
.. option:: -c ceph.conf, --conf=ceph.conf
 
63
 
 
64
   Use the given conf file instead of the default ``/etc/ceph/ceph.conf``.
 
65
 
 
66
.. option:: -k /path/to/keyring
 
67
 
 
68
   When ``-a`` is used, we can specify a location to copy the
 
69
   client.admin keyring, which is used to administer the cluster. The
 
70
   default is ``/etc/ceph/keyring`` (or whatever is specified in the
 
71
   config file).
 
72
 
 
73
.. option:: --mkbtrfs
 
74
 
 
75
   Create and mount the any btrfs file systems specified in the
 
76
   ceph.conf for OSD data storage using mkfs.btrfs. The "btrfs devs"
 
77
   and (if it differs from "osd data") "btrfs path" options must be
 
78
   defined.
 
79
 
 
80
   **NOTE** Btrfs is still considered experimental.  This option
 
81
   can ease some configuration pain, but is the use of btrfs is not
 
82
   required when ``osd data`` directories are mounted manually by the
 
83
   adminstrator.
 
84
 
 
85
   **NOTE** This option is deprecated and will be removed in a future
 
86
   release.
 
87
 
 
88
.. option:: --no-copy-conf
 
89
 
 
90
   By default, mkcephfs with -a will copy the new configuration to
 
91
   /etc/ceph/ceph.conf on each node in the cluster.  This option
 
92
   disables that behavior.
 
93
 
 
94
Subcommands
 
95
===========
 
96
 
 
97
The sub-commands performed during cluster setup can be run individually with
 
98
 
 
99
.. option:: --prepare-monmap -d dir -c ceph.conf
 
100
 
 
101
   Create an initial monmap with a random fsid/uuid and store it and
 
102
   the ceph.conf in dir.
 
103
 
 
104
.. option:: --init-local-daemons type -d dir
 
105
 
 
106
   Initialize any daemons of type type on the local host using the
 
107
   monmap in dir.  For types osd and mds, the resulting authentication
 
108
   keys will be placed in dir.  For type mon, the initial data files
 
109
   generated by --prepare-mon (below) are expected in dir.
 
110
 
 
111
.. option:: --prepare-mon -d dir
 
112
 
 
113
   Prepare the initial monitor data based on the monmap, OSD, and MDS
 
114
   authentication keys collected in dir, and put the result in dir.
 
115
 
 
116
 
 
117
Availability
 
118
============
 
119
 
 
120
**mkcephfs** is part of the Ceph distributed file system. Please refer
 
121
to the Ceph wiki at http://ceph.newdream.net/wiki for more
 
122
information.
 
123
 
 
124
 
 
125
See also
 
126
========
 
127
 
 
128
:doc:`ceph <ceph>`\(8),
 
129
:doc:`monmaptool <monmaptool>`\(8),
 
130
:doc:`osdmaptool <osdmaptool>`\(8),
 
131
:doc:`crushtool <crushtool>`\(8)