diff options
author | Thomas F Herbert <therbert@redhat.com> | 2016-09-12 18:21:32 -0400 |
---|---|---|
committer | Thomas F Herbert <therbert@redhat.com> | 2016-09-19 15:32:26 -0400 |
commit | bb7442a1d6dfd087ce8d77db1a4d60e4822729b1 (patch) | |
tree | a2a90d33aa2b23aa2a988ea87b6caa40072b934e /docs/buildprocedure | |
parent | 1f47771052455ffb19679cc213c76d8087bcc057 (diff) |
Docs for ovsnfv RPM generation for Apex including
scenario description, release notes and build
procedures.
JIRA: OVSNFV-43
Change-Id: I4228e3ba8d7c43b0385c57cae2fcfd508dc5c687
Signed-off-by: Thomas F Herbert <therbert@redhat.com>
(cherry picked from commit de5bd974bee689f4a1ae06f5e0f9c9cee5ffd581)
Diffstat (limited to 'docs/buildprocedure')
-rw-r--r-- | docs/buildprocedure/build.instructions.rst | 72 | ||||
-rw-r--r-- | docs/buildprocedure/index.rst | 14 |
2 files changed, 86 insertions, 0 deletions
diff --git a/docs/buildprocedure/build.instructions.rst b/docs/buildprocedure/build.instructions.rst new file mode 100644 index 0000000..e754967 --- /dev/null +++ b/docs/buildprocedure/build.instructions.rst @@ -0,0 +1,72 @@ +.. OPNFV - Open Platform for Network Function Virtualization +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======== +Abstract +======== + +This document describes the optional build of the OPNFV Colorado release +of the OVSNFV RPMs for the The dependencies and required +system resources are also described. + +============ +Introduction +============ + +This document describes how to build the OVSNFV RPMs. These RPMs are incorporated into the +Apex iso artifacts so there is no required action for Apex installation of OPNFV. + +This document describes the optional standalone build of the OVSNFV RPMs. + +============ +Requirements +============ + + +Minimum Software Requirements +============================= + +The build host should run Centos 7.0 + +Setting up OPNFV Gerrit in order to being able to clone the code +---------------------------------------------------------------- + +- Start setting up OPNFV gerrit by creating a SSH key (unless you + don't already have one), create one with ssh-keygen + +- Add your generated public key in OPNFV Gerrit <https://gerrit.opnfv.org/> + (this requires a Linux foundation account, create one if you do not + already have one) + +- Select "SSH Public Keys" to the left and then "Add Key" and paste + your public key in. + +Clone the OPNFV code Git repository with your SSH key +----------------------------------------------------- + +Clone the code repository: + +.. code-block:: bash + + $ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/ovsnfv + +Clone the OPNFV code Git repository using HTML +---------------------------------------------- + +.. code-block:: bash + + $ git clone https://gerrit.opnfv.org:29418/ovsnfv + +======== +Building +======== + +Build using build.sh +-------------------- + +.. code-block:: bash + + $ cd ovsnfv/ci + $ ./build.sh + diff --git a/docs/buildprocedure/index.rst b/docs/buildprocedure/index.rst new file mode 100644 index 0000000..f9c22a6 --- /dev/null +++ b/docs/buildprocedure/index.rst @@ -0,0 +1,14 @@ +.. This document is protected/licensed under the following conditions +.. Licensed under a Creative Commons Attribution 4.0 International License. +.. You should have received a copy of the license along with this work. +.. If not, see <http://creativecommons.org/licenses/by/4.0/>. + +********************************************* +Build instruction for the OVSNFV RPM for Apex +********************************************* + +.. toctree:: + :numbered: + :maxdepth: 2 + + build.instructions.rst |