1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
=========================================
Cloning the Ceph Source Code Repository
=========================================
To check out the Ceph source code, you must have ``git`` installed
on your local host. To install ``git``, execute::
sudo apt-get install git
You must also have a ``github`` account. If you do not have a
``github`` account, go to `github.com <http://github.com>`_ and register.
Follow the directions for setting up git at
`Set Up Git <http://help.github.com/linux-set-up-git/>`_.
Generate SSH Keys
-----------------
You must generate SSH keys for github to clone the Ceph
repository. If you do not have SSH keys for ``github``, execute::
ssh-keygen
Get the key to add to your ``github`` account (the following example
assumes you used the default file path)::
cat .ssh/id_rsa.pub
Copy the public key.
Add the Key
-----------
Go to your your ``github`` account,
click on "Account Settings" (i.e., the 'tools' icon); then,
click "SSH Keys" on the left side navbar.
Click "Add SSH key" in the "SSH Keys" list, enter a name for
the key, paste the key you generated, and press the "Add key"
button.
Clone the Source
----------------
To clone the Ceph source code repository, execute::
git clone git@github.com:ceph/ceph.git
Once ``git clone`` executes, you should have a full copy of the Ceph
repository.
Clone the Submodules
--------------------
Before you can build Ceph, you must navigate to your new repository and get
the ``init`` submodule and the ``update`` submodule::
cd ceph
git submodule init
git submodule update
.. tip:: Make sure you maintain the latest copies of these submodules.
Running ``git status`` will tell you if the submodules are out of date::
git status
Choose a Branch
---------------
Once you clone the source code and submodules, your Ceph repository
will be on the ``master`` branch by default, which is the unstable
development branch. You may choose other branches too.
- ``master``: The unstable development branch.
- ``stable``: The bugfix branch.
- ``next``: The release candidate branch.
::
git checkout master
|
