diff options
| -rw-r--r-- | docs/platformoverview/deploymenttools.rst | 13 | ||||
| -rw-r--r-- | docs/platformoverview/index.rst | 10 | ||||
| -rw-r--r-- | docs/platformoverview/softwarearchitecture.rst | 20 | ||||
| -rw-r--r-- | docs/platformoverview/testcasesframework.rst | 2 |
4 files changed, 23 insertions, 22 deletions
diff --git a/docs/platformoverview/deploymenttools.rst b/docs/platformoverview/deploymenttools.rst index f3693c0ae..034ceda69 100644 --- a/docs/platformoverview/deploymenttools.rst +++ b/docs/platformoverview/deploymenttools.rst @@ -18,8 +18,7 @@ RDO manager is a Triple-O based installation tool. Triple-O is an image based life cycle deployment tool that is a member of the OpenStack Big Tent Governance. Apex uses Centos on all target platforms and can deploy all SDN controllers. Find more information at -`OpenStack Wiki for Triple-O <https://wiki.openstack.org/wiki/TripleO>`_ and the OPNFV user guide and -config guide. +`OpenStack Wiki for Triple-O <https://wiki.openstack.org/wiki/TripleO>`_ and `OPNFV Configuration Guide`_. **Compass** is an installer project based on open source project Compass, which provides automated deployment and management of OpenStack and other distributed systems. @@ -27,16 +26,14 @@ It can be considered as what the LiveCD to a single box for a pool of servers †Compass is based on Ansible. It can deploy Ubuntu or Centos as target operating system and ODL and ONOS as SDN controllers. Find more information at -`OpenStack Wiki for Compass <https://wiki.openstack.org/wiki/Compass>`_ and the OPNFV user guide and -config guide. +`OpenStack Wiki for Compass <https://wiki.openstack.org/wiki/Compass>`_ and `OPNFV Configuration Guide`_. **Fuel** is an installer project based on the Fuel OpenStack open source project providing automated deployment and management of OpenStack and other distributed systems. Fuel is based on puppet and deploys the Ubuntu Linux operating system; the OpenStack virtual Infra-structure manager, and OpenDaylight or ONOS SDN controllers. Find more information at -`OpenStack Wiki for Fuel <https://wiki.openstack.org/wiki/Fuel>`_ and the OPNFV user guide and -config guide. +`OpenStack Wiki for Fuel <https://wiki.openstack.org/wiki/Fuel>`_ and `OPNFV Configuration Guide`_. **Joid** is an installer utilizes the technology developed in Juju and MAAS. Juju allows you to deploy, configure, manage, maintain, and scale @@ -44,4 +41,6 @@ cloud services quickly and efficiently on public clouds, as well as on physical OpenStack, and containers. Together with MAAS hardware usage can be optimized. For more info on Juju and MAAS, please visit `<https://jujucharms.com/>`_, `<http://maas.ubuntu.com>`_ and the -`Joid Userguide <http://artifacts.opnfv.org/joid/brahmaputra/docs/userguide/index.html>`_. +`Joid User Guide <http://artifacts.opnfv.org/joid/brahmaputra/docs/userguide/index.html>`_. + +.. _`OPNFV Configuration Guide`: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst index 856da8f4a..ca3bf449d 100644 --- a/docs/platformoverview/index.rst +++ b/docs/platformoverview/index.rst @@ -3,13 +3,13 @@ .. (c) OPNFV, Huawei ******************************** -OPNFV Platform Overview document +OPNFV Platform Overview Document ******************************** .. toctree:: :maxdepth: 2 - ./introduction.rst - ./softwarearchitecture.rst - ./deploymenttools.rst - ./testcasesframework.rst + introduction.rst + softwarearchitecture.rst + deploymenttools.rst + testcasesframework.rst diff --git a/docs/platformoverview/softwarearchitecture.rst b/docs/platformoverview/softwarearchitecture.rst index 2f98f42ee..cf122a5ef 100644 --- a/docs/platformoverview/softwarearchitecture.rst +++ b/docs/platformoverview/softwarearchitecture.rst @@ -50,6 +50,8 @@ The following table shows which components are deployed. +------------+----------------+-----------+-----------+-----------+-----------+ | services | type | Apex | Compass | Fuel | Joid | +============+================+===========+===========+===========+===========+ +| aodh | alarming | Available | --- | --- | --- | ++------------+----------------+-----------+-----------+-----------+-----------+ | ceilometer | metering | Available | Available | Available | Available | +------------+----------------+-----------+-----------+-----------+-----------+ | cinder | volume | Available | Available | Available | Available | @@ -94,9 +96,9 @@ SDN Controllers OPNFV Brahmaputra release supports different SDN controllers. Some scenarios don't use an SDN controller but rely just on Neutron networking capabilities. -Depending on the SDN controller you are using, the featureset available will vary. More -information on feature support and scenarios can be found in the Brahmaputra configuration and -user guides. Brahmaputra also provides scenarios without an SDN controller, just using OpenStack Neutron. +Depending on the SDN controller you are using, the featureset available will vary. +More information on feature support and scenarios can be found in `OPNFV Configuration Guide`_ and `OPNFV User Guide`_. +Brahmaputra also provides scenarios without an SDN controller, just using OpenStack Neutron. OpenDaylight is an SDN controller aiming to accelerate adoption of Software-Defined Networking (SDN) and Network Functions Virtualization @@ -116,10 +118,9 @@ More information on the internal design of ONOS may be found in `wiki of the ONOS project <https://wiki.onosproject.org>`_. ONOS is integrated to OPNFV using a framework ONOSFW and Neutron plugins. Details can be found in the ONOS specific OPNFV documents, - `Design guide <http://artifacts.opnfv.org/onosfw/brahmaputra/design/design.pdf>`_, `User guide <http://artifacts.opnfv.org/onosfw/brahmaputra/userguide/index.html>`_ and -`Config guide <http://artifacts.opnfv.org/onosfw/brahmaputra/configguide/index.html>`_. +`Configuration guide <http://artifacts.opnfv.org/onosfw/brahmaputra/configguide/index.html>`_. .. OpenContrail SDN controller will be supported in the next drop of the Brahmaputra release. @@ -137,7 +138,7 @@ integration and use by network controllers. OPNFV leverages these by upgrade to a specific installation using user-space datapath. This includes changes to other dataplane components, including libvirt, qemu, DPDK etc. Please find more information in -`OVSNFV User's Guide <http://artifacts.opnfv.org/ovsnfv/brahmaputra/docs/userguides/userguides.pdf>`_ +`OVSNFV User's Guide <http://artifacts.opnfv.org/ovsnfv/brahmaputra/docs/userguides/userguides.pdf>`_. Other Components ---------------- @@ -157,7 +158,7 @@ information, like hardware, BIOS, OS, etc. .. ==> need more input Please find more information at -`KVM4NFV project documentation <http://artifacts.opnfv.org/kvmfornfv/docs/all/all.pdf>`_ +`KVM4NFV project documentation <http://artifacts.opnfv.org/kvmfornfv/docs/all/all.pdf>`_. .. As it is a platform overview I think if we mention KVM as hypervisor we should focus on which version we are using and how as opposed to the OPNFV project that deals with KVM itself. @@ -178,8 +179,7 @@ is a virtual machine and provides the virtual resources using nested virtualizat The initial deployment is done using a so-called "jumphost". This server (either bare metal or virtual) is first installed with the installer program that then installs OpenStack -and other components on the controller nodes and compute nodes. See the -`OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/userguide.pdf>`_ +and other components on the controller nodes and compute nodes. See the `OPNFV User Guide`_ for more details. .. Editors note: @@ -207,3 +207,5 @@ The following scenarios are supported, some of them can be deployed using differ Please find more information at: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/configguide/configoptions.html#opnfv-scenario-s. +.. _`OPNFV Configuration Guide`: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide +.. _`OPNFV User Guide`: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide diff --git a/docs/platformoverview/testcasesframework.rst b/docs/platformoverview/testcasesframework.rst index 985929482..73c9cd187 100644 --- a/docs/platformoverview/testcasesframework.rst +++ b/docs/platformoverview/testcasesframework.rst @@ -62,7 +62,7 @@ OPNFV feature test cases include basic telecom feature testing from OPNFV projec for example nfv-kvm, sfc, ipv6, Parser, Availability and SDN VPN. All of the Yardstick test cases are listed on -`<http://artifacts.opnfv.org/yardstick/brahmaputra/docs/configguide_yardstick_testcases/03-list-of-tcs.html>`_ +`<http://artifacts.opnfv.org/yardstick/brahmaputra/docs/configguide_yardstick_testcases/03-list-of-tcs.html>`_. Additional Testing |