This patch is used to update the documents of D-release.
[kvmfornfv.git] / docs / installationprocedure / kvm4nfv-cicd.installation.instruction.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 .. http://creativecommons.org/licenses/by/4.0
4
5 =====================================
6 KVM4NFV CICD Installation Instruction
7 =====================================
8
9 Preparing the installation
10 --------------------------
11
12 The OPNFV project- KVM4NFV (https://gerrit.opnfv.org/gerrit/kvmfornfv.git) is
13 cloned first, to make the build scripts for Qemu & Kernel, Rpms and Debians
14 available.
15
16 HW requirements
17 ---------------
18
19 These build scripts are triggered on the Jenkins-Slave build server. Currently
20 Intel POD10 is used as test environment for kvmfornfv to execute cyclictest. As
21 part of this test environment Intel pod10-jump is configured as jenkins slave
22 and all the latest build artifacts are downloaded on to it. Intel pod10-node1
23 is the host on which a guest vm will be launched as a part of running cylictest
24 through yardstick.
25
26 Build instructions
27 ------------------
28
29 Builds are possible for the following packages-
30
31 **kvmfornfv source code**
32
33 The ./ci/build.sh is the main script used to trigger
34 the Rpms (on 'centos') and Debians (on 'ubuntu') builds in this case.
35
36 * How to build Kernel/Qemu Rpms- To build rpm packages, build.sh script is run
37   with -p and -o option (i.e. if -p package option is  passed as "centos" or in
38   default case). Example:
39
40 .. code:: bash
41
42    cd kvmfornfv/
43
44    For Kernel/Qemu RPMs,
45    sh ./ci/build.sh -p centos -o build_output
46
47 * How to build Kernel/Qemu Debians- To build debian packages, build.sh script
48   is run with -p and -o option (i.e. if -p package option is  passed as
49   "ubuntu"). Example:
50
51 .. code:: bash
52
53    cd kvmfornfv/
54
55    For Kernel/Qemu Debians,
56    sh ./ci/build.sh -p ubuntu -o build_output
57
58
59 * How to build all Kernel & Qemu, Rpms & Debians- To build both debian and rpm
60   packages, build.sh script is run with -p and -o option (i.e. if -p package
61   option is passed as "both"). Example:
62
63 .. code:: bash
64
65    cd kvmfornfv/
66
67    For Kernel/Qemu RPMs and Debians,
68    sh ./ci/build.sh -p both -o build_output
69
70 Installation instructions
71 -------------------------
72
73 Installation can be done in the following ways-
74
75 **1. From kvmfornfv source code**-
76 The build packages that are prepared in the above section, are installed
77 differently depending on the platform.
78
79 Please visit the links for each-
80
81 * Centos : https://www.centos.org/docs/5/html/Deployment_Guide-en-US/s1-rpm-using.html
82 * Ubuntu : https://help.ubuntu.com/community/InstallingSoftware
83
84 **2. Using Fuel installer**-
85
86 * Please refer to the document present at /fuel-plugin/README.md
87
88 Post-installation activities
89 ----------------------------
90
91 After the packages are built, test these packages by executing the scripts
92 present in ci/envs for configuring the host and guest respectively.