X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Finstallationprocedure%2Fkvm4nfv-cicd.installation.instruction.rst;h=dedcca34fc33925a8a30fece845b30f888ace02c;hb=9f343782f79512bb6423c973f591dcc90b63ab6b;hp=54886668dcd2c5eead93a54b5f111359212fc446;hpb=5a56bf69988b7c72e88546eb4659576fb51bfb77;p=kvmfornfv.git diff --git a/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst b/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst index 54886668d..dedcca34f 100644 --- a/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst +++ b/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 -===================================== -KVM4NFV CICD Installation Instruction -===================================== +================================ +KVM4NFV Installation Instruction +================================ Preparing the installation -------------------------- @@ -17,9 +17,9 @@ 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 +Intel POD10 is used as test environment for kvm4nfv to execute cyclictest. As +part of this test environment Intel pod10-jump is configured as jenkins slave +and all the latest build artifacts are downloaded on to it. Intel pod10-node1 is the host on which a guest vm will be launched as a part of running cylictest through yardstick. @@ -28,20 +28,59 @@ Build instructions Builds are possible for the following packages- -**kvmfornfv source code**- The ./ci/build.sh is the main script used to trigger +**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 + default case). Example: + +.. code:: bash + + cd kvmfornfv/ + + For Kernel/Qemu RPMs, + 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 + "ubuntu"). Example: + +.. code:: bash + + cd kvmfornfv/ + + For Kernel/Qemu Debians, + 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 + option is passed as "both"). Example: + +.. code:: bash + + cd kvmfornfv/ + + For Kernel/Qemu RPMs and Debians, + sh ./ci/build.sh -p both -o build_output + +.. note:: Kvm4nfv can be installed in two ways + + 1. As part of a `scenario deployment`_ + 2. As a `stand alone`_ component + +.. _scenario deployment: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description +.. _stand alone: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#build-instructions + +For installation of kvmfornfv as part of scenario deployment use this `link`_ + +.. code:: bash + + http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description + Installation instructions ------------------------- @@ -57,10 +96,6 @@ 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 -Test the built packages by executing the scripts present in ci/envs for -configuring host and guest respectively. Once the setup is in place, cyclictest -is performed via yardtick, using ./ci/test_kvmfornfv.sh - **2. Using Fuel installer**- * Please refer to the document present at /fuel-plugin/README.md @@ -68,7 +103,5 @@ is performed via yardtick, using ./ci/test_kvmfornfv.sh Post-installation activities ---------------------------- -After the rpm and debian builds are deployed successfully on the host-guest and -give the expected cyclictest results, jenkins gives +1 to indicate the -completion of verify process. Thereafter, the releng executes the merge process -to merge this code into parent repository. +After the packages are built, test these packages by executing the scripts +present in ci/envs for configuring the host and guest respectively.