summaryrefslogtreecommitdiffstats
path: root/docs/octopus_docs/octopus_info.rst
diff options
context:
space:
mode:
authorMatthewLi <matthew.lijun@huawei.com>2016-01-20 21:10:57 -0500
committerFatih Degirmenci <fatih.degirmenci@ericsson.com>2016-02-01 08:22:50 +0000
commitb732ec93d9c393daf590e1f1de87f80089cfadf5 (patch)
treef60555ee1fb345ba04a23c8b9f38af946cda55d4 /docs/octopus_docs/octopus_info.rst
parenta17eb962dcfe5e4f0074d874c95a554e137b9176 (diff)
change the docs format to satisfy sphinx
JIRA: OCTO-145 Change-Id: Ic20206fcfcab59354f657a316f76ac4f91935ffb Signed-off-by: MatthewLi <matthew.lijun@huawei.com> (cherry picked from commit 9adbfb9aedab48b320d52270e2ba723d68f7caa1)
Diffstat (limited to 'docs/octopus_docs/octopus_info.rst')
-rw-r--r--docs/octopus_docs/octopus_info.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/octopus_docs/octopus_info.rst b/docs/octopus_docs/octopus_info.rst
new file mode 100644
index 0000000..a02f455
--- /dev/null
+++ b/docs/octopus_docs/octopus_info.rst
@@ -0,0 +1,38 @@
+Project: Continuous Integration (Octopus)
+==========================================
+
+Introduction
+-------------
+
+Problem Statement:
+^^^^^^^^^^^^^^^^^^^
+
+OPNFV will use many upstream open source projects to create the reference platform.
+All these projects are developed and tested independently and in many cases,
+not have use cases of other projects in mind.
+Therefore it is to be expected that integration of these projects probably will unveil some gaps in functionality,
+since testing the OPNFV use cases needs the interworking of many upstream projects.
+Thus this integration work will bring major benefit to the community.
+
+Therefore the goal of the CI project – Octopus – is to quickly provide
+prototype integration of a first set of upstream projects.
+Step by step this later will be evolved to a full blown development environment with
+automated test and verification as a continuous integration environment, supporting both,
+the parallel evolutionary work in the upstream projects, and the improvement of NFV support in this reference platform.
+
+Summary
+^^^^^^^^
+
+The CI project provides the starting point for all OPNFV development activities.
+It starts by integrating stable versions of basic upstream projects,
+and from there creates a full development environment for OPNFV including automatic builds and basic verification.
+This is a very complex task and therefore needs a step by step approach.
+At the same time it is urgent to have a basic environment in place very soon.
+
+* **Create a hierarchical build environment** for the same integrated upstream projects as "getstarted",
+that uses the build tools as defined by each of the upstream projects and combines them.
+This allows development and verification in OPNFV collaborative projects.
+
+* **Implement automatic build process on central servers** - Provide automation and periodic builds
+
+* **Execute the continuous automated builds and basic verification**