From: Eric Debeau Date: Mon, 19 Nov 2018 19:47:29 +0000 (+0000) Subject: Update SettingUp section X-Git-Tag: elalto.1.5.2~8409^2 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=0f2c28396a6390160f09960c834c2912336b1f44;p=doc.git Update SettingUp section Rewrite index.rst to reflect OOM as the main installer Move text from onap_oom.rst to index.rst Issue-ID: DOC-340 Change-Id: Ie29547bc8c72c15a680393f63df35227a90116a1 Signed-off-by: Eric Debeau --- diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst index d905a79c8..d9139c7e6 100644 --- a/docs/guides/onap-developer/settingup/index.rst +++ b/docs/guides/onap-developer/settingup/index.rst @@ -1,36 +1,85 @@ .. 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 `_. - ============ === ==== =========== ============ - 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 diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst index 8bd92d8a9..f218846af 100644 --- a/docs/guides/onap-developer/settingup/onap_individual.rst +++ b/docs/guides/onap-developer/settingup/onap_individual.rst @@ -3,7 +3,6 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017-2018 ONAP - .. index:: Setting Up ONAP individual components @@ -23,13 +22,10 @@ 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 `_. - * 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`. diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst deleted file mode 100644 index fabdd2709..000000000 --- a/docs/guides/onap-developer/settingup/onap_oom.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. 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.