Docs for ovsnfv RPM generation for Apex including
[ovsnfv.git] / docs / buildprocedure / build.instructions.rst
1 .. OPNFV - Open Platform for Network Function Virtualization
2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4
5 ========
6 Abstract
7 ========
8
9 This document describes the optional build of the OPNFV Colorado release
10 of the OVSNFV RPMs for the The dependencies and required
11 system resources are also described.
12
13 ============
14 Introduction
15 ============
16
17 This document describes how to build the OVSNFV RPMs. These RPMs are incorporated into the
18 Apex iso artifacts so there is no required action for Apex installation of OPNFV.
19
20 This document describes the optional standalone build of the OVSNFV RPMs.
21
22 ============
23 Requirements
24 ============
25
26
27 Minimum Software Requirements
28 =============================
29
30 The build host should run Centos 7.0
31
32 Setting up OPNFV Gerrit in order to being able to clone the code
33 ----------------------------------------------------------------
34
35 - Start setting up OPNFV gerrit by creating a SSH key (unless you
36   don't already have one), create one with ssh-keygen
37
38 - Add your generated public key in OPNFV Gerrit <https://gerrit.opnfv.org/>
39   (this requires a Linux foundation account, create one if you do not
40   already have one)
41
42 - Select "SSH Public Keys" to the left and then "Add Key" and paste
43   your public key in.
44
45 Clone the OPNFV code Git repository with your SSH key
46 -----------------------------------------------------
47
48 Clone the code repository:
49
50 .. code-block:: bash
51
52     $ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/ovsnfv
53
54 Clone the OPNFV code Git repository using HTML
55 ----------------------------------------------
56
57 .. code-block:: bash
58
59     $ git clone https://gerrit.opnfv.org:29418/ovsnfv
60
61 ========
62 Building
63 ========
64
65 Build using build.sh
66 --------------------
67
68 .. code-block:: bash
69
70     $ cd ovsnfv/ci
71     $ ./build.sh
72