.. This work is licensed under a Creative Commons Attribution 4.0 International License.

.. http://creativecommons.org/licenses/by/4.0

=====================================
KVM4NFV CICD Installation Instruction
=====================================

Preparing the installation
--------------------------

The OPNFV project- KVM4NFV (https://gerrit.opnfv.org/gerrit/kvmfornfv.git) is
cloned first, to make the build scripts for Qemu & Kernel, Rpms and Debians
available.

HW requirements
---------------

These build scripts are triggered on the Jenkins-Slave build server. Currently
Intel POD1 is used as test environment for kvmfornfv to execute cyclictest. As
part of this test environment Intel pod1-jump is configured as jenkins slave
and all the latest build artifacts are downloaded on to it. Intel pod1-node1
is the host on which a guest vm will be launched as a part of running cylictest
through yardstick.

Build instructions
------------------

Builds are possible for the following packages-

**kvmfornfv source code**- The ./ci/build.sh is the main script used to trigger
the Rpms (on 'centos') and Debians (on 'ubuntu') builds in this case.

* How to build Kernel/Qemu Rpms- To build rpm packages, build.sh script is run
  with -p and -o option (i.e. if -p package option is  passed as "centos" or in
  default case). Example: sh ./ci/build.sh -p centos -o build_output

* How to build Kernel/Qemu Debians- To build debian packages, build.sh script
  is run with -p and -o option (i.e. if -p package option is  passed as
  "ubuntu"). Example: sh ./ci/build.sh -p ubuntu -o build_output

* How to build all Kernel & Qemu, Rpms & Debians- To build both debian and rpm
  packages, build.sh script is run with -p and -o option (i.e. if -p package
  option is passed as "both"). Example: sh ./ci/build.sh -p both -o build_output

Installation instructions
-------------------------

Installation can be done in the following ways-

**1. From kvmfornfv source code**-
The build packages that are prepared in the above section, are installed
differently depending on the platform.

Please visit the links for each-

* Centos : https://www.centos.org/docs/5/html/Deployment_Guide-en-US/s1-rpm-using.html
* Ubuntu : https://help.ubuntu.com/community/InstallingSoftware

**2. Using Fuel installer**-

* Please refer to the document present at /fuel-plugin/README.md

Post-installation activities
----------------------------

After the packages are built, test these packages by executing the scripts
present in ci/envs for configuring the host and guest respectively.

..
    Revision: e5900e6aa4fad9bacacc3f07912c7f2f694cc332
    Build date: 2016-09-08