.. This work is licensed under
.. a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
-
+.. Copyright 2017-2018 AT&T Intellectual Property. All rights reserved.
+.. Modifications Copyright 2018 Orange
+.. Modifications Copyright 2018 Amdocs
+.. Modifications Copyright 2018 Huawei
Setting Up ONAP
===============
-ONAP can be deployed using 3 different solutions:
+ONAP is deployed using the ONAP Operations Manager (OOM).
+
+The recommended ONAP deployment is based on Kubernetes, Docker containers
+and Helm installer.
+
+Requirements
+------------
+
+The following is the recommended component version.
+
+ =========== =========
+ Software Version
+ =========== =========
+ Kubernetes 1.11.2
+ Helm 2.9.1
+ kubectl 1.11.2
+ Docker 17.03.x
+ =========== =========
+
+The ONAP full installation is validated with the following footprint:
+ - 14 VM (1 Rancher, 13 K8s nodes)
+ - 8 vCPU
+ - 16 GB RAM
+ - 160 GB Storage
+
+Installation
+------------
+
+Creation of Kubernetes cluster is described here:
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
+
+ONAP installation is described here:
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
+
+NodePorts
+---------
-* Installation using Kubernetes (aka OOM). Recommended method.
-* Installation using Heat template.
-* Advanced installation to install individual components.
+NodePorts are used to allow client applications, that run outside of
+Kubernetes, access to ONAP components deployed by OOM.
+A NodePort maps an externally reachable port to an internal port of an ONAP
+microservice.
+It should be noted that the use of NodePorts is temporary.
+An alternative solution is currently being scoped for the Dublin Release.
-The following table presents the required resources to deploy ONAP.
+* The list of node ports used by ONAP is documented
+ in `ONAP Node Port List <https://wiki.onap.org/display/DW/OOM+NodePort+List>`_.
- ============ === ==== =========== ============
- Installation VM vCPU Memory (GB) Storage (GB)
- ============ === ==== =========== ============
- Kubernetes 4 32 128 160
- Heat 20 88 176 1760
- Individual 1* 1* 2* 20*
- ============ === ==== =========== ============
+.. note::
+ Prior to deployment of ONAP, there is no need to download manually any Docker container.
+ The OOM deployment takes care to automatically download the Docker containers.
-(*) For individual deployment, it depends on the components.
+ It is also possible to deploy a subset of ONAP components on a single VM.
+ The VM flavor to be used depends on the number of ONAP components to be
+ deployed.
-The various installations can be found here:
+.. note::
+ For test purposes, it is possible to use other installations:
.. toctree::
:maxdepth: 1
:titlesonly:
- onap_oom.rst
onap_heat.rst
onap_individual.rst
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017-2018 ONAP
-
.. index:: Setting Up ONAP individual components
have a deep understanding of dependencies between components.
This type of installation is not recommended to fully install ONAP.
-* The list of ports used by default within ONAP is documented
- in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
-
* The ONAP Source Code is available through Gerrit
at https://gerrit.onap.org/r/#/admin/projects or Git at https://git.onap.org/.
-* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap.
+* ONAP is packaged within Docker and can be downloaded from Docker Hub at https://hub.docker.com/r/onap.
* ONAP Docker releases are specified by a list of project artifact versions
in a :ref:`manifest<doc-release-manifest>`.
+++ /dev/null
-.. This work is licensed undera Creative Commons Attribution 4.0
-.. International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2018 ONAP
-
-.. index:: Setting Up Full ONAP using Containers
-
-====================================
-**Setting Up ONAP using Kubernetes**
-====================================
-
-.. _installing-onap-k8s:
-
-**Context**
-===========
-
-The recommended ONAP deployment is based on Kubernetes and Docker containers.
-This method is also called deployment through OOM.
-
-The following is the recommended component version.
-
- =========== =========
- Software Version
- =========== =========
- Kubernetes 1.11.2
- Helm 2.9.1
- kubectl 1.11.2
- Docker 17.03.x
- =========== =========
-
-Creation of Kubernetes cluster is described here:
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
-
-
-The ONAP full installation was validated with the following footprint:
- - 14 VM (1 rancher, 13 k8s nodes)
- - 8 vCPU
- - 16 GB RAM
- - 160 GB Storage
-
-ONAP installation is described here:
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
-
-.. note::
- Prior to deployment of ONAP, there is no need to download manually any Docker container.
- The OOM deployment takes care to automatically download the Docker containers.
-
- It is also possible to deploy a subset of ONAP components on a single VM.
- The VM flavor to be used depends on the number of ONAP components to be
- deployed.
Code Review / doc.git / commitdiff