diff options
author | Rich Bennett <rb2745@att.com> | 2018-09-01 09:48:13 -0400 |
---|---|---|
committer | Rich Bennett <rb2745@att.com> | 2018-09-01 09:54:19 -0400 |
commit | 52b5c09262b614e10bc223dd1811f81760a3337e (patch) | |
tree | 2873aa58ac84715ba8187b7e27e7829044871d3e /docs/guides/onap-developer/settingup | |
parent | 40e2182b5f8ce2952abb176bd539bf32ce164464 (diff) |
Cherry pick beijing improvements to master
Replicating changes made when finalizing Beijing branch
in the doc master branch.
Change-Id: Ib1da658aef8cb84f896c6abac23631579ec0b80c
Issue-ID: DOC-280
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/guides/onap-developer/settingup')
-rw-r--r-- | docs/guides/onap-developer/settingup/index.rst | 23 | ||||
-rw-r--r-- | docs/guides/onap-developer/settingup/onap_heat.rst | 22 | ||||
-rw-r--r-- | docs/guides/onap-developer/settingup/onap_individual.rst | 35 | ||||
-rw-r--r-- | docs/guides/onap-developer/settingup/onap_oom.rst | 59 |
4 files changed, 116 insertions, 23 deletions
diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst index f9b4881fe..d905a79c8 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. + +The various installations can be found here: .. toctree:: :maxdepth: 1 :titlesonly: - onap_heat.rst 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 afbbd6bf8..f3b545a88 100644 --- a/docs/guides/onap-developer/settingup/onap_heat.rst +++ b/docs/guides/onap-developer/settingup/onap_heat.rst @@ -10,18 +10,17 @@ .. index:: Setting Up Full ONAP using Virtual Machines +============================== +**Setting Up ONAP using Heat** +============================== -=============================================== -**Setting Up Full ONAP using Virtual Machines** -=============================================== - -.. _demo-installing-running-onap: +.. _installing-onap-heat: **Context** =========== ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Beijng Release over virtual machines is based -on OpenStack HEAT Template. +on OpenStack Heat Template. The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure. For details, refer @@ -30,6 +29,11 @@ based on top of VMware based infrastructure. For details, refer The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant). +.. note:: + Prior to deployment of ONAP, there is no need to download manually any Docker Container. + The Heat deployment takes care to automatically download the Docker Containers. + + .. _demo-installing-running-onap-requirements: **Requirements** @@ -148,9 +152,9 @@ Both following files must be downloaded and configured to match your configuration: - Template file: - https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml + https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml?h=beijing - Environment file: - https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env + https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env?h=beijing The environment file must be customized as described in the following sections. @@ -408,7 +412,7 @@ command: ======================== The current ONAP installation is using the *onap.org* domain. To use the portal on your desktop, you must configure the following information -in your *host* file (located in /etc/hosts for Linux or +in your *hosts* file (located in /etc/hosts for Linux or /windows/system32/drivers/etc/hosts for Windows): .. code-block:: bash 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..8bd92d8a9 --- /dev/null +++ b/docs/guides/onap-developer/settingup/onap_individual.rst @@ -0,0 +1,35 @@ +.. This work is licensed undera Creative Commons Attribution 4.0 +.. International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017-2018 ONAP + + +.. 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/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 Docker releases are specified by a list of project artifact versions + in a :ref:`manifest<doc-release-manifest>`. diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst index d793376fa..813168f3f 100644 --- a/docs/guides/onap-developer/settingup/onap_oom.rst +++ b/docs/guides/onap-developer/settingup/onap_oom.rst @@ -3,23 +3,58 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 ONAP +.. index:: Setting Up Full ONAP using Containers -.. contents:: - :depth: 2 -.. +==================================== +**Setting Up ONAP using Kubernetes** +==================================== -.. index:: Setting Up Full ONAP using Containers +.. _installing-onap-k8s: +**Context** +=========== -========================================= -**Setting Up Full ONAP using Containers** -========================================= +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. -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018 ONAP + =========== ========= + Software Version + =========== ========= + Kubernetes 1.8.10 + Helm 2.8.2 + kubectl 1.8.10 + 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 requires the following footprint: + - 4 VM + - 32 vCPU + - 128 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. -.. contents::
\ No newline at end of file + 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. |