OPNFV KVM4NFV: Documentation Enhancement
[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 POD1 is used as test environment for kvmfornfv to execute cyclictest. As
21 part of this test environment Intel pod1-jump is configured as jenkins slave
22 and all the latest build artifacts are downloaded on to it. Intel pod1-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**- The ./ci/build.sh is the main script used to trigger
32 the Rpms (on 'centos') and Debians (on 'ubuntu') builds in this case.
33
34 * How to build Kernel/Qemu Rpms- To build rpm packages, build.sh script is run
35   with -p and -o option (i.e. if -p package option is  passed as "centos" or in
36   default case). Example: sh ./ci/build.sh -p centos -o build_output
37
38 * How to build Kernel/Qemu Debians- To build debian packages, build.sh script
39   is run with -p and -o option (i.e. if -p package option is  passed as
40   "ubuntu"). Example: sh ./ci/build.sh -p ubuntu -o build_output
41
42 * How to build all Kernel & Qemu, Rpms & Debians- To build both debian and rpm
43   packages, build.sh script is run with -p and -o option (i.e. if -p package
44   option is passed as "both"). Example: sh ./ci/build.sh -p both -o build_output
45
46 Installation instructions
47 -------------------------
48
49 Installation can be done in the following ways-
50
51 **1. From kvmfornfv source code**-
52 The build packages that are prepared in the above section, are installed
53 differently depending on the platform.
54
55 Please visit the links for each-
56
57 * Centos : https://www.centos.org/docs/5/html/Deployment_Guide-en-US/s1-rpm-using.html
58 * Ubuntu : https://help.ubuntu.com/community/InstallingSoftware
59
60 **2. Using Fuel installer**-
61
62 * Please refer to the document present at /fuel-plugin/README.md
63
64 Post-installation activities
65 ----------------------------
66
67 After the packages are built, test these packages by executing the scripts
68 present in ci/envs for configuring the host and guest respectively.