doc adjust

change doc structrue

Change-Id: I66bea1f0a922930f0407dc04898fbb410d9305e9
Signed-off-by: Harry Huang <huangxiangyu5@huawei.com>

18 files changed, 246 insertions, 7 deletions

diff --git a/docs/development/design/design.rst b/docs/development/design/design.rst
new file mode 100644
index 0000000..c4dda17
--- /dev/null
+++ b/docs/development/design/design.rst
@@ -0,0 +1,111 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) by Yingjun Li (HUAWEI) and Harry Huang (HUAWEI)
+
+OPERA Requirement and Design
+============================
+
+- Define Scenario OS-NOSDN-OPENO-HA and Integrate OPEN-O M Release
+  with OPNFV D Release (with OpenStack Newton)
+- Integrate OPEN-O to OPNFV CI Process
+   + Integrate automatic Open-O and Juju installation
+- Deploy Clearwater vIMS through OPEN-O
+   + Test case to simulate SIP clients voice call
+- Integrate vIMS test scripts to FuncTest
+
+OS-NOSDN-OPENO-HA Scenario Definition
+=====================================
+
+Compass4NFV supports Open-O NFV Scenario
+----------------------------------------
+- Scenario name: os-nosdn-openo-ha
+- Deployment: OpenStack + Open-O + JuJu
+- Setups:
+   + Virtual deployment (one physical server as Jump Server with
+     OS ubuntu)
+   + Physical Deployment (one physical server as Jump Server,
+     ubuntu + 5 physical Host Server)
+
+.. figure:: images/deploy_overview.png
+    :alt: deploy overview
+    :figclass: align-center
+
+    Fig 1. Deploy Overview
+
+Open-O is participating OPNFV CI Process
+========================================
+
+- All steps are linked to OPNFV CI Process
+- Jenkins jobs remotely access OPEN-O NEXUS repository to fetch binaries
+- COMPASS is to deploy scenario based on OpenStack Newton release.
+- OPEN-O and JuJu installation scripts will be triggered in Jenkins job
+  after COMPASS finish deploying OpenStack
+- Clearwater vIMS deploy scripts will be integrated into FuncTest
+- Clearwater vIMS test scripts will be integrated into FuncTest
+
+
+.. figure:: images/opera_ci.png
+    :alt: opera ci
+    :figclass: align-center
+
+    Fig 2. Opera Ci
+
+The vIMS is used as initial use case
+====================================
+
+based on which test cases will be created and aligned with Open-O first
+release for OPNFV D release.
+
+- Creatting scenario (os-nosdn-openoe-ha) to integrate Open-O with OpenStack Newton.
+- Integrating with COMPASS as installer, FuncTest as testing framework
+- Clearwater vIMS is used as VNFs, Juju is used as VNFM.
+- Use Open-O as Orchestrator to deploy vIMS to do end-2-end test with the following steps.
+
+1.  deploy Open-O as orchestrator
+2.  create tenant by Open-O to OpenStack
+3.  deploy vIMS VNFs from orchestrator based on TOSCA blueprintn and create VNFs
+4.  launch test suite
+5.  collect results and clean up
+
+.. figure:: images/vIMS_deploy.png
+    :alt: vIMS deploy
+    :figclass: align-center
+
+    Fig 3. vIMS Deploy
+
+Requirement and Tasks
+=====================
+
+OPERA Deployment Key idea
+-------------------------
+
+- Keep OPEN-O deployment agnostic from an installer perspective (Apex, Compass, Fuel, Joid)
+- Breakdown deployments in single scripts (isolation)
+- Have OPNFV CI Process (Jenkins) control and monitor the execution
+
+Tasks need to be done for OPNFV CD process
+------------------------------------------
+
+1.  Compass to deploy scenario of os-nosdn-openo-noha
+2.  Automate OPEN-O installation (deployment) process
+3.  Automate JuJu installation process
+4.  Create vIMS TOSCA blueprint (for vIMS deployment)
+5.  Automate vIMS package deployment (need helper/OPEN-O M)
+     - (a)Jenkins to invoke OPEN-O Restful API to import & deploy vIMS ackage
+6.  Integrate scripts of step 2,3,4,5 with OPNFV CD Jenkins Job
+
+FUNCTEST
+--------
+
+1.  test case automation
+     - (a)Invoke URL request to vIMS services to test deployment is successfully done.
+2.  Integrate test scripts with FuncTest
+     - (a)trigger these test scripts
+     - (b)record test result to DB
+
+.. figure:: images/functest.png
+    :alt: functest
+    :figclass: align-center
+
+    Fig 4. Functest
+
diff --git a/docs/development/design/images/deploy_overview.png b/docs/development/design/images/deploy_overview.png
new file mode 100644
index 0000000..0a00425
--- /dev/null
+++ b/docs/development/design/images/deploy_overview.png
diff --git a/docs/development/design/images/functest.png b/docs/development/design/images/functest.png
new file mode 100644
index 0000000..a8c3f06
--- /dev/null
+++ b/docs/development/design/images/functest.png
diff --git a/docs/development/design/images/opera_ci.png b/docs/development/design/images/opera_ci.png
new file mode 100644
index 0000000..ef41555
--- /dev/null
+++ b/docs/development/design/images/opera_ci.png
diff --git a/docs/development/design/images/vIMS_deploy.png b/docs/development/design/images/vIMS_deploy.png
new file mode 100644
index 0000000..c3f71ad
--- /dev/null
+++ b/docs/development/design/images/vIMS_deploy.png
diff --git a/docs/FAQ/index.rst b/docs/development/design/index.rst
index c1e208f..b5278fe 100644
--- a/docs/FAQ/index.rst
+++ b/docs/development/design/index.rst
@@ -1,4 +1,5 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License... http://creativecommons.org/licenses/by/4.0
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
 
 *************************************
 OPNFV Opera Installation Instructions
@@ -6,5 +7,6 @@ OPNFV Opera Installation Instructions
 
 .. toctree::
    :numbered:
-   :maxdepth:
+   :maxdepth: 4
 
+   design.rst
diff --git a/docs/development/overview/images/key_item.png b/docs/development/overview/images/key_item.png
new file mode 100644
index 0000000..f3e5882
--- /dev/null
+++ b/docs/development/overview/images/key_item.png
diff --git a/docs/development/overview/images/openo_component.png b/docs/development/overview/images/openo_component.png
new file mode 100644
index 0000000..cb73df3
--- /dev/null
+++ b/docs/development/overview/images/openo_component.png
diff --git a/docs/development/overview/images/vIMS_deploy.png b/docs/development/overview/images/vIMS_deploy.png
new file mode 100644
index 0000000..c3f71ad
--- /dev/null
+++ b/docs/development/overview/images/vIMS_deploy.png
diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst
new file mode 100644
index 0000000..2566863
--- /dev/null
+++ b/docs/development/overview/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+*************************************
+OPNFV Opera Installation Instructions
+*************************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   overview.rst
diff --git a/docs/development/overview/overview.rst b/docs/development/overview/overview.rst
new file mode 100644
index 0000000..c3ca7df
--- /dev/null
+++ b/docs/development/overview/overview.rst
@@ -0,0 +1,71 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) by Yingjun Li (HUAWEI) and Harry Huang (HUAWEI)
+
+OPERA Project Overview
+======================
+
+Since OPNFV board expanded its scope to include NFV MANO last year,
+several upstream open source projects have been created to develop
+MANO solutions. Each solution has demonstrated its unique value in
+specific area. Open-Orchestrator (OPEN-O) project is one of such
+communities. Opera seeks to develop requirements for OPEN-O MANO
+support in the OPNFV reference platform, with the plan to eventually
+integrate OPEN-O in OPNFV as a non-exclusive upstream MANO. The
+project will definitely benefit not only OPNFV and Open-O, but can
+be referenced by other MANO integration as well. In particular, this
+project is basically use case driven. Based on that, it will focus
+on the requirement of interfaces/data models for integration among
+various components and OPNFV platform. The requirement is designed
+to support integration among Open-O as NFVO with Juju as VNFM and
+OpenStack as VIM.
+
+Currently OPNFV has already included upstream OpenStack as VIM, and
+Juju and Tacker have been being considered as gVNFM by different OPNFV
+projects. OPEN-O as NFVO part of MANO will interact with OpenStack and
+Juju. The key items required for the integration can be described as
+follows.
+
+.. figure:: images/key_item.png
+    :alt: key item
+    :figclass: align-center
+
+    Fig 1. Key Item for Integration
+
+Open-O is scoped for the integration
+====================================
+
+OPEN-O includes various components for OPNFV MANO integration. The initial
+release of integration will be focusing on NFV-O, Common service and Common
+TOSCA. Other components of Open-O will be gradually integrated to OPNFV
+reference platform in later release.
+
+.. figure:: images/openo_component.png
+    :alt: openo component
+    :figclass: align-center
+
+    Fig 2. Deploy Overview
+
+The vIMS is used as initial use case
+====================================
+
+based on which test cases will be created and aligned with Open-O first
+release for OPNFV D release.
+
+- Creatting scenario (os-nosdn-openoe-ha) to integrate Open-O with OpenStack Newton.
+- Integrating with COMPASS as installer, FuncTest as testing framework
+- Clearwater vIMS is used as VNFs, Juju is used as VNFM.
+- Use Open-O as Orchestrator to deploy vIMS to do end-2-end test with the following steps.
+
+1.  deploy Open-O as orchestrator
+2.  create tenant by Open-O to OpenStack
+3.  deploy vIMS VNFs from orchestrator based on TOSCA blueprintn and create VNFs
+4.  launch test suite
+5.  collect results and clean up
+
+.. figure:: images/vIMS_deploy.png
+    :alt: vIMS deploy
+    :figclass: align-center
+
+    Fig 3. vIMS Deploy
+
diff --git a/docs/release/configguide/configguide.rst b/docs/release/configguide/configguide.rst
new file mode 100644
index 0000000..debec97
--- /dev/null
+++ b/docs/release/configguide/configguide.rst
@@ -0,0 +1,31 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) by Yingjun Li (HUAWEI) and Harry Huang (HUAWEI)
+
+Config Guide
+------------------
+
+Add OpenStack Admin Openrc file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add the admin openrc file of your local openstack into opera/conf
+directory with the name of admin-openrc.sh.
+
+Config open-o.yml
+~~~~~~~~~~~~~~~~~
+
+Set openo_version to specify Open-O version.
+
+Set openo_ip to specify an external ip to access Open-O services.
+(leave the value unset will use local server's external ip)
+
+Set ports in openo_docker_net to specify Open-O's exposed service
+ports.
+
+Set enable_sdno to specify if use Open-O 's sdno services.
+(set this value false will not launch Open-O sdno dockers and reduce
+deploy duration)
+
+Set vnf_type to specify the vnf type need to be deployed.
+(currently only support clearwater deployment, leave this unset will
+not deploy any vnf)
diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst
new file mode 100644
index 0000000..c97215b
--- /dev/null
+++ b/docs/release/configguide/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+*************************************
+OPNFV Opera Installation Instructions
+*************************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   configguide.rst
diff --git a/docs/installationprocedure/index.rst b/docs/release/installation/index.rst
index bb20e9a..bb20e9a 100644
--- a/docs/installationprocedure/index.rst
+++ b/docs/release/installation/index.rst
diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
index d87bde7..bda9183 100644
--- a/docs/installationprocedure/installation.instruction.rst
+++ b/docs/release/installation/installation.instruction.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) by Yingjun Li (HUAWEI)
+.. (c) by Yingjun Li (HUAWEI) and Harry Huang (HUAWEI)
 
 Opera Installation Instructions
 ===============================
@@ -76,8 +76,8 @@ Set enable_sdno to specify if use Open-O 's sdno services.
 deploy duration)
 
 Set vnf_type to specify the vnf type need to be deployed.
-(currently only support clearwater deployment, leave this unset will not
-deploy any vnf)
+(currently only support clearwater deployment, leave this unset will
+not deploy any vnf)
 
 Run opera_launch.sh
 ~~~~~~~~~~~~~~~~~~~
diff --git a/docs/installationprocedure/introduction.rst b/docs/release/installation/introduction.rst
index ff8f40b..967df77 100644
--- a/docs/installationprocedure/introduction.rst
+++ b/docs/release/installation/introduction.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) by Yingjun Li (HUAWEI)
+.. (c) by Yingjun Li (HUAWEI) and Harry Huang (HUAWEI)
 
 Abstract
 ========
diff --git a/docs/releasenotes/index.rst b/docs/release/release-notes/index.rst
index 65f5ef4..65f5ef4 100644
--- a/docs/releasenotes/index.rst
+++ b/docs/release/release-notes/index.rst
diff --git a/docs/releasenotes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 19dab96..f57e990 100644
--- a/docs/releasenotes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) Yingjun Li (HUAWEI)
+.. (c) Yingjun Li (HUAWEI) and Harry Huang (HUAWEI)
 
 ==========================
 OPNFV Opera Release Notes