diff options
author | Gergely Csatari <gergely.csatari@nokia.com> | 2018-02-01 10:17:12 +0100 |
---|---|---|
committer | Gergely Csatari <gergely.csatari@nokia.com> | 2018-02-01 13:27:40 +0100 |
commit | 0944cc15c038b1c4424bedae581ce40eb4644326 (patch) | |
tree | eedbe607efa8305a07aa55d1213953f42c0b875d /docs/development | |
parent | 5ed69809f33e546bf3e06dc285a90e0818c89ceb (diff) |
Error corrections and architecture option updates
Correction of some errors which are permitting a succesfull build
in the master following these descriptions: http://docs.opnfv.org/en/latest/how-to-use-docs/include-documentation.html#individual-project-documentation
Moving the architecture options to the Container4NFV wiki and
leaving only a reference here.
Change-Id: I7b4debc90997f8812a5681daa8bfa19f90724cef
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Diffstat (limited to 'docs/development')
6 files changed, 21 insertions, 83 deletions
diff --git a/docs/development/gapanalysis/gap-analysis-architecture-options.rst b/docs/development/gapanalysis/gap-analysis-architecture-options.rst index c629dfe..4d91c09 100644 --- a/docs/development/gapanalysis/gap-analysis-architecture-options.rst +++ b/docs/development/gapanalysis/gap-analysis-architecture-options.rst @@ -3,71 +3,8 @@ .. (c) Gergely Csatari (Nokia) ================================== -OpenRetriever architecture options +Container4NFV architecture options ================================== -1 Architecture options to support only containers on bare metal -............................................................... -To support containers on bare metal without the support of VM-s only a single -VIM is needed. -This architecture option is targeted by OpenRetriever in OPNFV Euphrates, and -this architecture option is considered in the gap analyzis against -:doc:`OpenStack <gap-analysis-openstack>` and -:doc:`Kubernetes <gap-analysis-kubernetes-v1.5>`. -Examples: Kubernetes, OpenStack with Zun_ and Kuryr_, which as a side effect -also supports VM-s. - -2 Architecture options to support containers and VM-s -..................................................... -There are different architecture options to support container based and VM based -VNF-s in OPNFV. This section provides a list of these options with a brief -description and examples. -In the descriptions providing the same API means, that the same set of API-s are -used (like the OpenStack_ API-s or the Kubernetes_ API), integrted networks mean, -that the network connections of the workloads can be connected without leaving -the domain of the VIM and shared hardware resources mean that it is possible to -start a workload VM and a workload container on the same physical host. - -2.1 Separate VIM-s -================== -There is a separate VIM for VM-s and a separate for containers, they use -different hardware pools, they provide different API-s and their networks are -not integrated. -Examples: A separate OpenStack instance for the VM-s and a separate Kubernetes_ -instance for the containers. - -2.2 Single VIM -============== -One VIM supports both VM-s and containers using the same hardware pool, with -the same API and with integrated networking solution. -Examples: OpenStack with Zun_ and Kuryr_ or Kubernetes_ with Kubevirt_, Virtlet_ or -similar. - -2.3 Combined VIM-s -================== -There are two VIM-s from API perspective, but usually the VIM-s share hardware -pools on some level. This option have suboptions. - -2.3.1 Container VIM on VM VIM ------------------------------ -A container VIM is deployed on top of resources managed by a VM VIM, they share -the same hardware pool, but they have separate domains in the pool, they provide -separate API-s and there are possibilities to integrate their networks. -Example: A Kubernetes_ is deployed into VM-s or bare metal hosts into an -OpenStack deployment optionally with Magnum. Kuryr_ integrates the networks on -some level. - -2.3.2 VM VIM on Container VIM ------------------------------ -A VM VIM is deployed on top of resources managed by a container VIM, they do not -share the same hardware pool, provide different API and do not have integrated -networks. -Example: `Kolla Kubernetes <https://github.com/openstack/kolla-kubernetes>`_ or -`OpenStack Helm <https://wiki.openstack.org/wiki/Openstack-helm>`_. - -.. _Kubernetes: http://kubernetes.io/ -.. _Kubevirt: https://github.com/kubevirt/ -.. _Kuryr: https://docs.openstack.org/developer/kuryr/ -.. _OpenStack: https://www.openstack.org/ -.. _Virtlet: https://github.com/Mirantis/virtlet -.. _Zun: https://wiki.openstack.org/wiki/Zun +Analyzis of the architecture options were moved to the +`Container4NFV wiki <https://wiki.opnfv.org/display/OpenRetriever/Analyzis+of+architecture+options>`_.
\ No newline at end of file diff --git a/docs/development/gapanalysis/gap-analysis-kubernetes-v1.5.rst b/docs/development/gapanalysis/gap-analysis-kubernetes-v1.5.rst index f8fb85a..367237d 100644 --- a/docs/development/gapanalysis/gap-analysis-kubernetes-v1.5.rst +++ b/docs/development/gapanalysis/gap-analysis-kubernetes-v1.5.rst @@ -3,10 +3,10 @@ .. (c) Xuan Jia (China Mobile) ================================================ -OpenRetriever Gap Analysis with Kubernetes v1.5 +Container4NFV Gap Analysis with Kubernetes v1.5 ================================================ -This section provides users with OpenRetriever gap analysis regarding feature +This section provides users with Container4NFV gap analysis regarding feature requirement with Kubernetes Official Release. The following table lists the use cases / feature requirements of container integrated functionality, and its gap analysis with Kubernetes Official Release. diff --git a/docs/development/gapanalysis/gap-analysis-openstack.rst b/docs/development/gapanalysis/gap-analysis-openstack.rst index a7357aa..5840f1d 100644 --- a/docs/development/gapanalysis/gap-analysis-openstack.rst +++ b/docs/development/gapanalysis/gap-analysis-openstack.rst @@ -3,9 +3,9 @@ .. (c) Xuan Jia (China Mobile), Gergely Csatari (Nokia) ========================================= -OpenRetriever Gap Analysis with OpenStack +Container4NFV Gap Analysis with OpenStack ========================================= -This section provides a gap analyzis between the targets of OpenRetriever for +This section provides a gap analyzis between the targets of Container4NFV for release Euphrates (E) or later and the features provided by OpenStack in release Ocata. As the OPNFV and OpenStack releases tend to change over time this analyzis is planned to be countinously updated. @@ -47,7 +47,7 @@ integrated functionality, and its gap analysis with OpenStack. |Kuryr_ needs to support MACVLAN and IPVLAN |Kuryr_ |Using MACVLAN or IPVLAN could provide better network performance. |Open | | | |It is planned for Ocata. | | +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+----------------+ - |Kuryr_ Kubernetes_ integration is needed |Kuryr_ |It is done in the frame of OpenRetriever. |Targeted to | + |Kuryr_ Kubernetes_ integration is needed |Kuryr_ |It is done in the frame of Container4NFV. |Targeted to | | | | |OPNFV release E | | | | |/OpenStack Ocata| +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+----------------+ diff --git a/docs/development/gapanalysis/gap-analysis-opnfv-installer.rst b/docs/development/gapanalysis/gap-analysis-opnfv-installer.rst index f1c047b..ecfa47e 100644 --- a/docs/development/gapanalysis/gap-analysis-opnfv-installer.rst +++ b/docs/development/gapanalysis/gap-analysis-opnfv-installer.rst @@ -3,9 +3,9 @@ .. (c) Xuan Jia (China Mobile) =============================================== -OpenRetriever Gap Analysis with OPNFV Installer +Container4NFV Gap Analysis with OPNFV Installer =============================================== -This section provides users with OpenRetriever gap analysis regarding feature +This section provides users with Container4NFV gap analysis regarding feature requirement with OPNFV Installer in Danube Official Release. The following table lists the use cases / feature requirements of container integrated functionality, and its gap analysis with OPNFV Installer in Danube Official diff --git a/docs/development/gapanalysis/index.rst b/docs/development/gapanalysis/index.rst index 9b22674..dc390d9 100644 --- a/docs/development/gapanalysis/index.rst +++ b/docs/development/gapanalysis/index.rst @@ -3,13 +3,13 @@ .. (c) Xuan Jia (China Mobile) ========================== -OpenRetriever Gap Analysis +Container4NFV Gap Analysis ========================== -:Project: OpenRetriever, https://wiki.opnfv.org/display/openretriever +:Project: Container4NFV, https://wiki.opnfv.org/display/OpenRetriever/Container4NFV -:Editors: Xuan Jia (China Mobile) -:Authors: Xuan Jia (China Mobile) +:Editors: Xuan Jia (China Mobile), Gergely Csatari (Nokia) +:Authors: Container4NFV team :Abstract: This document provides the users with top-down gap analysis regarding OpenRetriever feature requirements with OPNFV Installer, OpenStack diff --git a/docs/development/ngvsrequirements/ngvs-requirements-document.rst b/docs/development/ngvsrequirements/ngvs-requirements-document.rst index d2c775e..793708f 100644 --- a/docs/development/ngvsrequirements/ngvs-requirements-document.rst +++ b/docs/development/ngvsrequirements/ngvs-requirements-document.rst @@ -2,7 +2,7 @@ .. License.http://creativecommons.org/licenses/by/4.0 .. (c) Xuan Jia (China Mobile) -========================================================================== +=========================================================================== OpenRetriever Next Gen VIM & Edge Computing Scheduler Requirements Document =========================================================================== @@ -44,15 +44,15 @@ At a high level, we believe the VIM scheduler must: - Support legacy and event-driven scheduling - By legacy scheduling we mean scheduling without any trigger (see above) -i.e. the current technique used by schedulers such as OpenStack Nova. + i.e. the current technique used by schedulers such as OpenStack Nova. - By event-driven scheduling we mean scheduling with a trigger (see above). -We do not mean that the unikernel or container that is going to run the VNF is -already running . The instance is started and torn-down in response to traffic. -The two step process is transparent to the user. + We do not mean that the unikernel or container that is going to run the VNF is + already running . The instance is started and torn-down in response to traffic. + The two step process is transparent to the user. - More specialized higher level schedulers and orchestration systems may be -run on top e.g. FaaS (similar to AWS Lambda) etc. + run on top e.g. FaaS (similar to AWS Lambda) etc. +----------------------------------------------------------------------------------------+ | Serverless vs. FaaS vs. Event-Driven Terminology | @@ -257,6 +257,7 @@ Multiple compute types | | - Support shared storage (e.g. OpenStack | | | Cinder, K8s volumes etc.) | +----------------------------------------+-----------------------------------------------+ + .. [1] Intel EPA includes DPDK, SR-IOV, CPU and NUMA pinning, Huge Pages etc. |