From: Gildas Lanilis Date: Thu, 7 Jun 2018 01:32:27 +0000 (-0700) Subject: Clarify deployment instructions X-Git-Tag: 2.0.0-ONAP~51^2 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F79%2F50879%2F3;p=doc.git Clarify deployment instructions For the 2 supported deployment Fix wording Change-Id: I179f514ffd982692eadb35bf514a625c49f77ad4 Issue-ID: DOC-277 Signed-off-by: Gildas Lanilis --- diff --git a/docs/guides/onap-developer/settingup/onap_heat.rst b/docs/guides/onap-developer/settingup/onap_heat.rst index bdcd212d0..f16453da1 100644 --- a/docs/guides/onap-developer/settingup/onap_heat.rst +++ b/docs/guides/onap-developer/settingup/onap_heat.rst @@ -10,10 +10,9 @@ .. index:: Setting Up Full ONAP using Virtual Machines - -=============================================== -**Setting Up Full ONAP using Virtual Machines** -=============================================== +============================== +**Setting Up ONAP using Heat** +============================== .. _installing-onap-heat: @@ -21,7 +20,7 @@ =========== 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** diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst index a3a1b5bc7..faac85ad7 100644 --- a/docs/guides/onap-developer/settingup/onap_individual.rst +++ b/docs/guides/onap-developer/settingup/onap_individual.rst @@ -16,7 +16,8 @@ **Context** =========== From a developer perspective, ONAP can be installed component per component. -For details, refer to :ref:`the installation procedure available for each component`. +For details, refer to :ref:`the installation procedure available for each +component`. 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. @@ -25,4 +26,5 @@ 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 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`. diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst index 7cb0d93a8..813168f3f 100644 --- a/docs/guides/onap-developer/settingup/onap_oom.rst +++ b/docs/guides/onap-developer/settingup/onap_oom.rst @@ -5,19 +5,19 @@ .. index:: Setting Up Full ONAP using Containers -========================================= -**Setting Up Full ONAP using Containers** -========================================= +==================================== +**Setting Up ONAP using Kubernetes** +==================================== .. _installing-onap-k8s: **Context** =========== -The recommended installation is based on Kubernetes to deploy ONAP -components using containers. +The recommended ONAP deployment is based on Kubernetes and Docker containers. +This method is also called deployment through OOM. -You must use the following version for the various sofware components. +The following is the recommended component version. =========== ========= Software Version @@ -52,6 +52,9 @@ ONAP installation is described here: ../../../../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.