diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/configguide/configguide.rst | 31 | ||||
| -rw-r--r-- | docs/release/configguide/index.rst | 12 | ||||
| -rw-r--r-- | docs/release/installation/index.rst | 13 | ||||
| -rw-r--r-- | docs/release/installation/installation.instruction.rst | 88 | ||||
| -rw-r--r-- | docs/release/installation/introduction.rst | 22 | ||||
| -rw-r--r-- | docs/release/release-notes/index.rst | 13 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 25 |
7 files changed, 204 insertions, 0 deletions
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/release/installation/index.rst b/docs/release/installation/index.rst new file mode 100644 index 0000000..bb20e9a --- /dev/null +++ b/docs/release/installation/index.rst @@ -0,0 +1,13 @@ +.. 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 + + introduction.rst + installation.instruction.rst diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst new file mode 100644 index 0000000..bda9183 --- /dev/null +++ b/docs/release/installation/installation.instruction.rst @@ -0,0 +1,88 @@ +.. 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 Installation Instructions +=============================== + +This document providing guidelines on how to deploy a working Open-O +environment using opera project. + +The audience of this document is assumed to have good knowledge in +OpenStack and Linux. + + +Preconditions +------------- + +There are some preconditions before starting the Opera deployment + + +A functional OpenStack environment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +OpenStack should be deployed before opera deploy. + +Getting the deployment scripts +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Retrieve the repository of Opera using the following command: + +- git clone https://gerrit.opnfv.org/gerrit/opera + + +Machine requirements +-------------------- + +1. Ubuntu OS (Pre-installed). + +2. Root access. + +3. Minimum 1 NIC (internet access) + +4. CPU cores: 32 + +5. 64 GB free memory + +6. 100G free disk + + +Deploy Instruction +------------------ + +After opera deployment, Open-O dockers will be launched on local +server as orchestrator and juju vm will be launched on OpenStack +as VNFM. + +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) + +Run opera_launch.sh +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: bash + + ./opera_launch.sh + diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst new file mode 100644 index 0000000..967df77 --- /dev/null +++ b/docs/release/installation/introduction.rst @@ -0,0 +1,22 @@ +.. 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) and Harry Huang (HUAWEI) + +Abstract +======== + +This document describes how to install Open-O in an OpenStack deployed environment +using Opera project. + +Version history +=============== + ++--------------------+--------------------+--------------------+---------------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+---------------------------+ +| 2017-02-16 | 0.0.1 | Harry Huang | First draft | +| | | (HUAWEI) | | ++--------------------+--------------------+--------------------+---------------------------+ + + diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..65f5ef4 --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 + +========================================= +OPNFV Danube: Opera Release Notes +========================================= + +.. toctree:: + :numbered: + :maxdepth: 4 + + release-notes.rst + diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..f57e990 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,25 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Yingjun Li (HUAWEI) and Harry Huang (HUAWEI) + +========================== +OPNFV Opera Release Notes +========================== + +This document describes release notes of OPNFV Danube Release of Opera + +Abstract +======== + +Opera project is aimed to deploy a working Open-O environment. + +Release Data +============ + ++--------------------+--------------------+--------------------+---------------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+---------------------------+ +| 2017-02-24 | 0.0.1 | Harry Huang | First draft | +| | | (HUAWEI) | | ++--------------------+--------------------+--------------------+---------------------------+ |