From c450b54ffb461e5a9a157b13679686170f7c385d Mon Sep 17 00:00:00 2001 From: Yifei Xue Date: Thu, 24 Aug 2017 21:50:22 +0800 Subject: Docs update for E release JIRA: - Update the structure of docs directory. Update the docs for E release. Add some new docs for E release. Change-Id: Ib4b6aced3d6ac88404d8518b5461e20d26e017e1 Signed-off-by: Yifei Xue --- docs/development/index.rst | 18 +++ .../development/overview/containerized_compass.rst | 6 + docs/development/overview/index.rst | 13 +++ docs/release/FAQ/faq.rst | 129 --------------------- docs/release/FAQ/index.rst | 17 --- docs/release/configguide/index.rst | 13 +++ docs/release/release-notes/release-notes.rst | 27 +++-- docs/release/scenarios/index.rst | 15 +++ docs/release/userguide/FAQ/faq.rst | 129 +++++++++++++++++++++ docs/release/userguide/FAQ/index.rst | 17 +++ 10 files changed, 224 insertions(+), 160 deletions(-) create mode 100644 docs/development/index.rst create mode 100644 docs/development/overview/containerized_compass.rst create mode 100644 docs/development/overview/index.rst delete mode 100644 docs/release/FAQ/faq.rst delete mode 100644 docs/release/FAQ/index.rst create mode 100644 docs/release/configguide/index.rst create mode 100644 docs/release/scenarios/index.rst create mode 100644 docs/release/userguide/FAQ/faq.rst create mode 100644 docs/release/userguide/FAQ/index.rst (limited to 'docs') diff --git a/docs/development/index.rst b/docs/development/index.rst new file mode 100644 index 00000000..734fe961 --- /dev/null +++ b/docs/development/index.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV. + + +=========== +Compass4NFV +=========== + +.. toctree:: + :maxdepth: 2 + + ./overview/index.rst + ./design/index.rst + +Indices +======= +* :ref:`search` diff --git a/docs/development/overview/containerized_compass.rst b/docs/development/overview/containerized_compass.rst new file mode 100644 index 00000000..de3ec902 --- /dev/null +++ b/docs/development/overview/containerized_compass.rst @@ -0,0 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) by Justin Chi (HUAWEI) and Yifei Xue (HUAWEI) + +Introduction of Containerized Compass +===================================== diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst new file mode 100644 index 00000000..56e3a550 --- /dev/null +++ b/docs/development/overview/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 + +.. _compass4nfv-overview: + +********************************* +Compass4NFV Development Overview +********************************* + +.. toctree:: + :maxdepth: 2 + + containerized_compass.rst diff --git a/docs/release/FAQ/faq.rst b/docs/release/FAQ/faq.rst deleted file mode 100644 index 177ff0bb..00000000 --- a/docs/release/FAQ/faq.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) - - -What is Compass4nfv -=================== - -Compass4nfv is an installer project based on open source project Compass, -which provides automated deployment and management of OpenStack and other distributed systems. -It can be considered as what the LiveCD to a single box for a pool of servers – bootstrapping -the server pool. - -see more information, please visit - -`OPNFV Compass4nfv project page `_ - -`COMPASS Home Page `_ - -What's the additional setting in switch if use the default network configuration -================================================================================ - -Here is the Compass4nfv default network configration file: -compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml -OR -compass4nfv_FAQ/deploy/conf/vm_environment/huawei-virtual1/network.yml - -It uses a VLAN network for mgmt and storage networks that are share one NIC(eth1) as a -default network configuration. So you need add an additional tagged VLAN (101) and VLAN (102) on -eth1's switch for access. - -How to deal with installation failure caused by setting pxe and reset nodes failed -================================================================================== - -At first, please make sure that deployed nodes' ipmi network can access from Jumphost and -IPMI user/pass is correct. - -Compass4nfv supports IPMI 1.0 or IPMI 2.0 to control your nodes, so you can set it according your IPMI -version in dha.yml. - -.. code-block:: yaml - - ipmiVer: '2.0' - -How to deal with installation failure caused by "The Server quit without updating PID file" -=========================================================================================== - -If you see "The Server quit without updating PID file" in installation print log, it is caused by -mgmt network can't access from each deployed nodes, so you need to check your switch setting whether -an additional tagged VLAN is added if uses default network configuration. - -How to set OpenStack Dashboard login user and password -====================================================== - -It uses admin/console as the default user/pass for OpenStack Dashboard, and you can set it in below file: -compass4nfv/deploy/conf/base.conf - -How to visit OpenStack Dashboard -================================ - -You can visit OpenStack Dashboard by URL: http://{puclib_vip}/horizon - -The public virtual IP is configured in "compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml" -or "compass4nfv_FAQ/deploy/conf/vm_environment/huawei-virtual1/network.yml", defined as below: - -.. code-block:: yaml - - public_vip: - ip: 192.168.50.240 - -How to access controller nodes after deployment -=============================================== - -1. First you should login Compass VM via ssh command on Jumphost by default user/pass root/root. -The default login IP of Compass VM is configured in "compass4nfv/deploy/conf/base.conf", defined as below: - -.. code-block:: bash - - export MGMT_IP=${MGMT_IP:-192.168.200.2} - -2. Then you can login the controller nodes (host1-3) by default user/pass root/root via the install -network IPs which are configured in "compass4nfv/deploy/conf/base.conf", defined as below: - -.. code-block:: bash - - export MANAGEMENT_IP_START=${MANAGEMENT_IP_START:-'10.1.0.50'} - - -.. code-block:: console - - - +-------------+ - | | - +----------+ host1 | - | | | - | +-------------+ - | - +---------+ | +-------------+ - | | install | | | - | Compass +---------------+----------+ host2 | - | | network | | | - +---+VM+--+ | +-------------+ - +--------------------+ | - | | | +-------------+ - | Jumphost | | | | - | | +----------+ host3 | - +--------------------+ | | - +-------------+ - - -Where is OpenStack RC file -========================== - -It is located /opt/admin-openrc.sh in each controller node as default. Please source it first if you -want to use OpenStack CLI. - -How to recovery network connection after Jumphost reboot -======================================================== - -.. code-block:: bash - - source deploy/network.sh && save_network_info - -References -========== -For more information on the Compass4nfv FAQ, please visit - -`COMPASS FAQ WIKI Page `_ - diff --git a/docs/release/FAQ/index.rst b/docs/release/FAQ/index.rst deleted file mode 100644 index a843a213..00000000 --- a/docs/release/FAQ/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _compass4nfv-FAQ: - -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 - -====================================== -Compass4nfv Frequently Asked Questions -====================================== - -.. toctree:: - :numbered: - :maxdepth: 4 - - how-to-build-customized-iso.rst - how-to-deploy-while-jumphost-cannot-access-internet.rst - how-to-deploy-without-internet-access.rst - faq.rst diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 00000000..fae27101 --- /dev/null +++ b/docs/release/configguide/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 + +.. _compass4nfv-overview: + +********************************* +Compass4NFV Release Overview +********************************* + +.. toctree:: + :maxdepth: 2 + + containerized_compass.rst diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 44678b87..99e18b54 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) -Release Note for the Danube release of OPNFV when using Compass4nfv as a deployment tool. +Release Note for the Euphrates release of OPNFV when using Compass4nfv as a deployment tool. Abstract ======== @@ -25,16 +25,16 @@ Release Data | **Project** | Compass4nfv | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | Compass4nfv/Danube.1.0 | +| **Repo/tag** | Compass4nfv/Euphrates.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Danube.1.0 | +| **Release designation** | Euphrates.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | March 31 2017 | +| **Release date** | September 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Danube release | +| **Purpose of the delivery** | OPNFV Euphrates release | | | | +--------------------------------------+--------------------------------------+ @@ -44,16 +44,16 @@ Deliverables Software deliverables ~~~~~~~~~~~~~~~~~~~~~ - - Compass4nfv/Danube.1.0 ISO, please get it from `OPNFV software download page `_ + - Compass4nfv/Euphrates.1.0 tarball, please get it from `OPNFV software download page `_ .. _document-label: Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ - - OPNFV(Danube) Compass4nfv installation instructions + - OPNFV(Euphrates) Compass4nfv installation instructions - - OPNFV(Danube) Compass4nfv Release Notes + - OPNFV(Euphrates) Compass4nfv Release Notes Version change -------------- @@ -62,21 +62,20 @@ Version change Module version change ~~~~~~~~~~~~~~~~~~~~~ -This is the Danube release of compass4nfv as a deployment toolchain in OPNFV, the following +This is the Euphrates release of compass4nfv as a deployment toolchain in OPNFV, the following upstream components supported with this release. - Ubuntu 16.04/Centos 7.3 - - Openstack (Newton release) + - Openstack (Ocata release) - - Opendaylight (Boron SR2 release) + - Opendaylight (Nitrogen release) - - ONOS (J-bird release/later release) Document version change ~~~~~~~~~~~~~~~~~~~~~~~ -Adjusted the document structure, and you can see document at `OPNFV(Danube) Compass4nfv installation instructions `_. +Adjusted the document structure, and you can see document at `OPNFV(Euphrates) Compass4nfv installation instructions `_. Reason for new version ---------------------- @@ -145,7 +144,7 @@ Known issues Test Result =========== -The Danube release with the Compass4nfv deployment toolchain has undergone QA test +The Euphrates release with the Compass4nfv deployment toolchain has undergone QA test runs with the following results: Functest: http://testresults.opnfv.org/reporting/functest/release/danube/index-status-compass.html diff --git a/docs/release/scenarios/index.rst b/docs/release/scenarios/index.rst new file mode 100644 index 00000000..a00eb44a --- /dev/null +++ b/docs/release/scenarios/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. _compass4nfv-scenarios: + +********************* +Compass4NFV Scenarios +********************* + +.. toctree:: + :maxdepth: 2 + + os-nosdn-nofeature-ha.rst + os-odl-nofeature-ha.rst + diff --git a/docs/release/userguide/FAQ/faq.rst b/docs/release/userguide/FAQ/faq.rst new file mode 100644 index 00000000..177ff0bb --- /dev/null +++ b/docs/release/userguide/FAQ/faq.rst @@ -0,0 +1,129 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) + + +What is Compass4nfv +=================== + +Compass4nfv is an installer project based on open source project Compass, +which provides automated deployment and management of OpenStack and other distributed systems. +It can be considered as what the LiveCD to a single box for a pool of servers – bootstrapping +the server pool. + +see more information, please visit + +`OPNFV Compass4nfv project page `_ + +`COMPASS Home Page `_ + +What's the additional setting in switch if use the default network configuration +================================================================================ + +Here is the Compass4nfv default network configration file: +compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml +OR +compass4nfv_FAQ/deploy/conf/vm_environment/huawei-virtual1/network.yml + +It uses a VLAN network for mgmt and storage networks that are share one NIC(eth1) as a +default network configuration. So you need add an additional tagged VLAN (101) and VLAN (102) on +eth1's switch for access. + +How to deal with installation failure caused by setting pxe and reset nodes failed +================================================================================== + +At first, please make sure that deployed nodes' ipmi network can access from Jumphost and +IPMI user/pass is correct. + +Compass4nfv supports IPMI 1.0 or IPMI 2.0 to control your nodes, so you can set it according your IPMI +version in dha.yml. + +.. code-block:: yaml + + ipmiVer: '2.0' + +How to deal with installation failure caused by "The Server quit without updating PID file" +=========================================================================================== + +If you see "The Server quit without updating PID file" in installation print log, it is caused by +mgmt network can't access from each deployed nodes, so you need to check your switch setting whether +an additional tagged VLAN is added if uses default network configuration. + +How to set OpenStack Dashboard login user and password +====================================================== + +It uses admin/console as the default user/pass for OpenStack Dashboard, and you can set it in below file: +compass4nfv/deploy/conf/base.conf + +How to visit OpenStack Dashboard +================================ + +You can visit OpenStack Dashboard by URL: http://{puclib_vip}/horizon + +The public virtual IP is configured in "compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml" +or "compass4nfv_FAQ/deploy/conf/vm_environment/huawei-virtual1/network.yml", defined as below: + +.. code-block:: yaml + + public_vip: + ip: 192.168.50.240 + +How to access controller nodes after deployment +=============================================== + +1. First you should login Compass VM via ssh command on Jumphost by default user/pass root/root. +The default login IP of Compass VM is configured in "compass4nfv/deploy/conf/base.conf", defined as below: + +.. code-block:: bash + + export MGMT_IP=${MGMT_IP:-192.168.200.2} + +2. Then you can login the controller nodes (host1-3) by default user/pass root/root via the install +network IPs which are configured in "compass4nfv/deploy/conf/base.conf", defined as below: + +.. code-block:: bash + + export MANAGEMENT_IP_START=${MANAGEMENT_IP_START:-'10.1.0.50'} + + +.. code-block:: console + + + +-------------+ + | | + +----------+ host1 | + | | | + | +-------------+ + | + +---------+ | +-------------+ + | | install | | | + | Compass +---------------+----------+ host2 | + | | network | | | + +---+VM+--+ | +-------------+ + +--------------------+ | + | | | +-------------+ + | Jumphost | | | | + | | +----------+ host3 | + +--------------------+ | | + +-------------+ + + +Where is OpenStack RC file +========================== + +It is located /opt/admin-openrc.sh in each controller node as default. Please source it first if you +want to use OpenStack CLI. + +How to recovery network connection after Jumphost reboot +======================================================== + +.. code-block:: bash + + source deploy/network.sh && save_network_info + +References +========== +For more information on the Compass4nfv FAQ, please visit + +`COMPASS FAQ WIKI Page `_ + diff --git a/docs/release/userguide/FAQ/index.rst b/docs/release/userguide/FAQ/index.rst new file mode 100644 index 00000000..a843a213 --- /dev/null +++ b/docs/release/userguide/FAQ/index.rst @@ -0,0 +1,17 @@ +.. _compass4nfv-FAQ: + +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 + +====================================== +Compass4nfv Frequently Asked Questions +====================================== + +.. toctree:: + :numbered: + :maxdepth: 4 + + how-to-build-customized-iso.rst + how-to-deploy-while-jumphost-cannot-access-internet.rst + how-to-deploy-without-internet-access.rst + faq.rst -- cgit 1.2.3-korg