1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
5 ================================
6 KVM4NFV Installation Instruction
7 ================================
9 Preparing the installation
10 --------------------------
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
19 These build scripts are triggered on the Jenkins-Slave build server. Currently
20 Intel POD10 is used as test environment for kvm4nfv 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
29 Builds are possible for the following packages-
31 **kvmfornfv source code**
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.
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:
45 sh ./ci/build.sh -p centos -o build_output
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
55 For Kernel/Qemu Debians,
56 sh ./ci/build.sh -p ubuntu -o build_output
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:
67 For Kernel/Qemu RPMs and Debians,
68 sh ./ci/build.sh -p both -o build_output
70 .. note:: Kvm4nfv can be installed in two ways
72 1. As part of a `scenario deployment`_
73 2. As a `stand alone`_ component
75 .. _scenario deployment: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description
76 .. _stand alone: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#build-instructions
78 For installation of kvmfornfv as part of scenario deployment use this `link`_
82 http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description
85 Installation instructions
86 -------------------------
88 Installation can be done in the following ways-
90 **1. From kvmfornfv source code**-
91 The build packages that are prepared in the above section, are installed
92 differently depending on the platform.
94 Please visit the links for each-
96 * Centos : https://www.centos.org/docs/5/html/Deployment_Guide-en-US/s1-rpm-using.html
97 * Ubuntu : https://help.ubuntu.com/community/InstallingSoftware
99 **2. Using Fuel installer**-
101 * Please refer to the document present at /fuel-plugin/README.md
103 Post-installation activities
104 ----------------------------
106 After the packages are built, test these packages by executing the scripts
107 present in ci/envs for configuring the host and guest respectively.