summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/settingup
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2018-06-05 22:45:51 +0000
committerEric Debeau <eric.debeau@orange.com>2018-06-05 22:48:04 +0000
commit4f36fca628b68db603ddd95ab53b9ff4e1c8ab5e (patch)
tree00350f1bc6fe2bb4b62f529cba5c2220d37b2637 /docs/guides/onap-developer/settingup
parentd919cc95101feb8aaa0f2c5783e8f2e1685ae620 (diff)
Update setting up ONAP
Update release note with links to setting up files Update various setting up files Issue-ID: DOC-269 Change-Id: I2149026bdf10c694904a5b95a990775d288b40c1 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Diffstat (limited to 'docs/guides/onap-developer/settingup')
-rw-r--r--docs/guides/onap-developer/settingup/index.rst23
-rw-r--r--docs/guides/onap-developer/settingup/onap_heat.rst2
-rw-r--r--docs/guides/onap-developer/settingup/onap_individual.rst33
-rw-r--r--docs/guides/onap-developer/settingup/onap_oom.rst38
4 files changed, 88 insertions, 8 deletions
diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst
index f9b4881fe..bbd9fa72f 100644
--- a/docs/guides/onap-developer/settingup/index.rst
+++ b/docs/guides/onap-developer/settingup/index.rst
@@ -7,11 +7,30 @@
Setting Up ONAP
===============
-ONAP can be deployed using 2 different solutions:
+ONAP can be deployed using 3 different solutions:
+
+* Installation using Kubernetes (aka OOM). Recommended method.
+* Installation using Heat template.
+* Advanced installation to install individual components.
+
+The following table presents the required resources to deploy ONAP.
+
+ ============ === ==== =========== ============
+ Installation VM vCPU Memory (GB) Storage (GB)
+ ============ === ==== =========== ============
+ Kubernetes 4 32 128 160
+ Heat 20 88 176 1760
+ Individual 1* 1* 2* 20*
+ ============ === ==== =========== ============
+
+(*) For individual deployment, it depends on the components.
.. toctree::
:maxdepth: 1
:titlesonly:
- onap_heat.rst
+Depending on
+
onap_oom.rst
+ onap_heat.rst
+ onap_individual.rst
diff --git a/docs/guides/onap-developer/settingup/onap_heat.rst b/docs/guides/onap-developer/settingup/onap_heat.rst
index 833393d33..bdcd212d0 100644
--- a/docs/guides/onap-developer/settingup/onap_heat.rst
+++ b/docs/guides/onap-developer/settingup/onap_heat.rst
@@ -15,7 +15,7 @@
**Setting Up Full ONAP using Virtual Machines**
===============================================
-.. _demo-installing-running-onap:
+.. _installing-onap-heat:
**Context**
===========
diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst
new file mode 100644
index 000000000..a24f17a23
--- /dev/null
+++ b/docs/guides/onap-developer/settingup/onap_individual.rst
@@ -0,0 +1,33 @@
+.. This work is licensed undera Creative Commons Attribution 4.0
+.. International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017-2018 ONAP
+
+
+.. contents::
+ :depth: 2
+..
+
+.. index:: Setting Up ONAP individual components
+
+
+=========================================
+**Setting Up ONAP individual components**
+=========================================
+
+.. _installing-onap-individual:
+
+**Context**
+===========
+From a developer perspective, ONAP can be installed component per component.
+For details, refer to :ref:`the installation procedure available for each component<index-setting-individual-components>`.
+The advanced installation procedure is recommended only for experienced
+developers who desire to focus their attention on a few components and who
+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 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.
+
+.. contents::
diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst
index d793376fa..a43c600ee 100644
--- a/docs/guides/onap-developer/settingup/onap_oom.rst
+++ b/docs/guides/onap-developer/settingup/onap_oom.rst
@@ -15,11 +15,39 @@
**Setting Up Full ONAP using Containers**
=========================================
+.. _installing-onap-heat:
-.. This work is licensed under a Creative Commons Attribution 4.0
-.. International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2018 ONAP
+**Context**
+===========
+
+The recommended installation is based on Kubernetes to deploy ONAP
+components using containers.
+
+You must use the following version for the various sofware components.
+
+ =========== =======
+ Software Version
+ =========== =======
+ Kubernetes 1.8.10
+ Helm 2.8.2
+ kubectl 1.8.10
+ Docker 17.03.x
+ =========== =======
+
+Creation of Kubernetes cluster is available here:
+ ../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
+
+
+The ONAP full installation requires the following footprint:
+ - 4 VM
+ - 32 vCPU
+ - 128 GB RAM
+ - 160 GB Storage
+ONAP installation is described here:
+ ../../../submodules/oom.git/docs/oom_quickstart_guide.rst
-.. contents:: \ No newline at end of file
+.. note::
+ 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.