From: Gildas Lanilis Date: Tue, 21 Nov 2017 01:18:00 +0000 (-0800) Subject: Update Master RN and Setting up ONAP X-Git-Tag: 1.0.0-Amsterdam~30^2 X-Git-Url: https://gerrit.onap.org/r/gitweb?p=doc.git;a=commitdiff_plain;h=7b727a59bb7a41a2b477205ca2d57c12f236cdc5 Update Master RN and Setting up ONAP -Update Release Notes on developers skill required for independant installation -Update ONAP getting star with typo, links and clarifications Issue-Id: DOC-150 Change-Id: I59b3bad9eda994b65d13a99f33d8edb3396740c2 Signed-off-by: Gildas Lanilis --- diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/fullonap.rst index 48236bce6..86fc31cd1 100644 --- a/docs/guides/onap-developer/settingup/fullonap.rst +++ b/docs/guides/onap-developer/settingup/fullonap.rst @@ -18,15 +18,15 @@ **Context** =========== -ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack. +ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack HEAT Template. -Using the Amsterdam Release installer, ONAP components may be deployed in a single tenant or multiple tenants. One tenant for all the components except DCAE, and another tenant dedicated to the DCAE components. +Using the Amsterdam HEAT Template installer, ONAP can be deployed in a single tenant or multiple tenants. One tenant for all the components except DCAE, and another tenant dedicated to the DCAE components. -The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure (cf MultiCloud project). +The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure. For details, refer :ref:`to MultiCloud project`. -The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) with DCAE componntes deployed in High Availability mode. +The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) with DCAE components deployed in High Availability mode. -The installation requires some manual taks to setup the DCAE components. +The installation requires some manual tasks to setup the DCAE components. **Requirements** ================ @@ -54,7 +54,7 @@ To deploy OpenStack, you can use various solutions: - `OPNFV Cross Community Continuous Integration - XCI installer `_ *Designate* component is usually not deployed using standard OpenStack installers. -Please find a guide to deploy and configure *Designate* +Use the procedure below to deploy and configure *Designate* .. toctree:: :maxdepth: 1 @@ -66,7 +66,7 @@ The OpenStack infrastructure must enable internet access. ONAP components --------------- -The following table presents the mapping between the created VM and the ONAP components, and provides informtaion about he VM (flavor and image): +The following table presents the mapping between the created VM and the ONAP components, and provides VM information (flavor and image): =================== ================= ======= ============ VM name ONAP project(s) Flavor Image @@ -109,15 +109,15 @@ The ONAP installation requires the following footprint: - 148 vCPU - 336 GB RAM - 3 TB Storage - - 29 floating IP + - 29 floating IP addresses -.. Note: the default flavor size may be optimized. The ONAP community is working to provide adpted flavors for basic ONAP installation. +.. Note: The default flavor size may be optimized. The ONAP community is working to update flavors of basic ONAP installation. -.. Note: you should also reserve some resourcse for the VNFs to be deployed. +.. Note: You should also reserve some resources for the VNFs to be deployed. Artifacts --------- -The following artifacts must be deployed on the OpenStack infrastructure. +The following artifacts must be deployed on the OpenStack infrastructure: - a public SSH key to access the various VM - private SSH key and public key SSH key for the DCAE VM - Ubuntu 14.04 image @@ -125,17 +125,17 @@ The following artifacts must be deployed on the OpenStack infrastructure. - CentOS 7 image - Set of flavors: small, medium, large, medium, large, xlarge, xxlarge -.. Note that floating IP may be private IP. +.. Note: The floating IP may be private IP. -.. Note Basic flavors can reuse the default flavors as defined by `OpenStack `_ - The xxlarge flavor should be confiured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage. +.. Note: Basic flavors can reuse the default flavors as defined by `OpenStack `_ + The xxlarge flavor should be configured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage. Security -------- The default installation assumes that the Default security group is configured to enable full access between the ONAP components. Depending on your environment, we may need to open some security groups (eg when using the portal from your desktop). -The list of various services and ports used can be found on the `ONAP wiki `_ +The list of various services and ports used can be found on the `ONAP wiki `_. **Deployment** ============== @@ -143,12 +143,12 @@ The list of various services and ports used can be found on the `ONAP wiki `_. +After the installation, it is possible to deploy the various use-cases described in `ONAP wiki `_. Detect problems --------------- @@ -412,7 +407,7 @@ Here is a simple procedure to detect where the problem occurs: * Connect to the Virtual Machine and check that the various containers are running. The list of containers are described on the `ONAP wiki `_ -. In case some containers are missing, check the docker logs using the following command: +. In case some containers are missing, check the Docker logs using the following command: .. code-block:: bash @@ -434,7 +429,7 @@ To use the portal on your desktop, you must configure the following information aai.ui.simpledemo.onap.org -You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line: +You can use the Horizon dashboard to get the IP addresses associated with the Virtual Machines or use the following command line: .. code-block:: bash diff --git a/docs/release/index.rst b/docs/release/index.rst index dea4fed1c..ae74f412c 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -116,7 +116,9 @@ From a complete demo solution perspective. This installs the whole ONAP, refer t Advanced installation to install individual components ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -From a developer perspective. ONAP can be installed component per component, refer to :ref:`the installation procedure available for each component`. +From a developer perspective, ONAP can be installed component per 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. +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/. @@ -176,7 +178,7 @@ There are 2 ways to report a bug in ONAP. * If you don't know you are facing a bug or have a question, post your question into the `Ask question `_. You will need a Linux Foundation ID to login and post your question. Get a Linux Foundation Identity using this `quick procedure `_. -You may consider these `recommendations `_ to elaborate the issue you are facing and this `guideline `_ to register into the ONAP Discuss mailing list. +You may consider these `recommendations `_ to elaborate the issue you are facing. .. Include files referenced by link in the toctree as hidden