diff options
Diffstat (limited to 'docs/platformoverview/softwarearchitecture.rst')
| -rw-r--r-- | docs/platformoverview/softwarearchitecture.rst | 90 |
1 files changed, 26 insertions, 64 deletions
diff --git a/docs/platformoverview/softwarearchitecture.rst b/docs/platformoverview/softwarearchitecture.rst index a3e815ec5..2f98f42ee 100644 --- a/docs/platformoverview/softwarearchitecture.rst +++ b/docs/platformoverview/softwarearchitecture.rst @@ -6,27 +6,25 @@ OPNFV Platform Architecture =========================== -.. ==> Add reference links from https://wiki.opnfv.org/releases/brahmaputra/releasedocs - -.. ==> All links should point to release docs, not to OPNFV-Wiki or artifacts. - +The OPNFV project addresses a number of aspects in the development of a consistent virtualization +platform including common hardware requirements, software architecture and installed state. +The platform architecture as the OPNFV project approaches it is dicussed in the following sections. OPNFV Lab Infrastructure ======================== The `Pharos Project <https://www.opnfv.org/developers/pharos>`_ provides a lab infrastructure that is geographically and technically diverse. -Labs instantiate **bare-metal** and **virtual** environments that are accessed remotely by the -community and used for OPNFV platform and feature development, builds, deploys and testing. -This will greatly assist in developing a highly robust and stable OPNFV platform +Labs instantiate bare-metal and virtual environments that are accessed remotely by the +community and used for OPNFV platform and feature development, build, deploy and testing. +This helps in developing a highly robust and stable OPNFV platform with well understood performance characteristics. Community labs are hosted by OPNFV member companies on a voluntary basis. The Linux Foundation also hosts an OPNFV lab that provides centralised CI and other production resources which are linked to community labs. Future lab capabilities will include the ability easily automate deploy and test of any -OPNFV install scenario in any lab environemnt as well as a *Virtual Lab* for -developer on-boarding with minimal effort. +OPNFV install scenario in any lab environemnt as well as on a virtual infrastructure. .. ==> I am not sure this is the best place to include this. @@ -35,22 +33,17 @@ Software architecture ===================== This section will provide information which upstream projects, versions and components are -integrated in the release to implement OPNFV requirement. You can find a requirement list -`here <http://artifacts.opnfv.org/genesisreq/docs/requirements.pdf>`_. +integrated in the release to implement OPNFV requirement. You can find the list of common +requirements for deployment tools here: +http://artifacts.opnfv.org/genesisreq/brahmaputra/requirements/requirements.pdf. OpenStack --------- .. ==> didn't understand Chris' suggestion about reducing the heading level for these sub-topics -OPNFV uses OpenStack as cloud management system. -Brahmaputra is based on OpenStack Liberty Release. -The set of sub-projects varies slightly depending on the installer. - -.. ==> If possible replace the list of OpenStack components here by a link to an -.. appropriate document -.. (http://artifacts.opnfv.org/genesisreq/review/10155/requirements/component-support.html -.. was suggested, but this is different infomation.) +OPNFV integrates OpenStack as cloud management system where Brahmaputra uses the OpenStack Liberty Release. +The set of sub-projects deployed in a brahmaputra platform varies slightly depending on the installer and scenario. The following table shows which components are deployed. @@ -76,12 +69,6 @@ The following table shows which components are deployed. | swift | object-store | Available | --- | Available | Available | +------------+----------------+-----------+-----------+-----------+-----------+ -.. This table is created by outputs from jenkins functest log, components registering at keystone -.. would prefer a table per scenario. - -Some of the sub-projects are not deployed in all scenarios. - -.. end of the part to be replaced by link if possible. Note that additional components of OpenStack are used as part of deployment tools and test frameworks (Fuel, Tempest, Rally). @@ -105,16 +92,13 @@ SDN Controllers --------------- OPNFV Brahmaputra release supports different SDN controllers. -Some scenarios don't use an SDN controller but rely just on **Neutron** networking capabilities. +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 will vary. -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 the Brahmaputra configuration and +user guides. Brahmaputra also provides scenarios without an SDN controller, just using OpenStack Neutron. -The OpenDaylight project is a collaborative open source project that aims to accelerate -adoption of Software-Defined Networking (SDN) and Network Functions Virtualization -(NFV) with a transparent approach that fosters new innovation. - -**OpenDaylight** is an SDN controller that aims to accelerate +OpenDaylight is an SDN controller aiming to accelerate adoption of Software-Defined Networking (SDN) and Network Functions Virtualization (NFV) with a transparent approach that fosters new innovation. OpenDaylight runs within a JVM and is installed in OPNFV within a container and integrated with OpenStack @@ -123,7 +107,7 @@ You can find more information about OpenDaylight among the release artifacts at `Downloads page <https://www.opendaylight.org/downloads>`_. Please ensure you are using the Beryllium documentation. -**ONOS** is an SDN controller written in Java with a distributed architecture with special focus to +ONOS is an SDN controller written in Java with a distributed architecture with special focus to support scalability, fault tolerance and hardware and software upgrades without interrupting network traffic. More information on the internal design of ONOS may be found in @@ -133,11 +117,11 @@ More information on the internal design of ONOS may be found in 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/docs/design/design.pdf>`_, -`User guide <http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html>`_ and -`Config guide <http://artifacts.opnfv.org/onosfw/brahmaputra/docs/configguide/index.html>`_. +`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>`_. -.. **OpenContrail** SDN controller will be supported in the next drop of the Brahmaputra release. +.. OpenContrail SDN controller will be supported in the next drop of the Brahmaputra release. Data Plane @@ -147,15 +131,13 @@ OPNFV extends Linux's virtual networking capabilies by using virtual switch and router components including improving those components by requirements specific to telco use cases. -For instance some scenarios use **OpenVSwich** +For instance some scenarios use OpenVSwitch to replace Linux bridges as it offers advantages in terms of mobility, hardware 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/docs/userguides/userguides.pdf>`_ - -.. ==> need input, if we mention other components +`OVSNFV User's Guide <http://artifacts.opnfv.org/ovsnfv/brahmaputra/docs/userguides/userguides.pdf>`_ Other Components ---------------- @@ -222,26 +204,6 @@ The following scenarios are supported, some of them can be deployed using differ * nosdn-kvm-ha * nosdn-ovs_kvm-ha -Please find more information at -`<https://wiki.opnfv.org/functextnexttaks>`_ - -.. ==> As soon as better information is available, the list can be replaced by a link to e.g. -.. http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/configoptions.html#opnfv-scenario-s. - - -.. Dynamic View -.. ============ - -.. Editors note: we might skip this section completely for Brahmaputra. - -.. Or we provide rather short statements. In later versions, we have to describe which -.. software is involved in which way during: - -.. * VNF Life Cycle (onboarding, instantiate, scaling): we can reference to other documents -.. * Hardware Life Cycle (mainly how to add compute nodes, but also other cases) -.. * ... - - - - +Please find more information at: +http://artifacts.opnfv.org/opnfvdocs/brahmaputra/configguide/configoptions.html#opnfv-scenario-s. |