Merge "Update settingup doc"

1 files changed, 117 insertions, 48 deletions

diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/fullonap.rst
index 61921add2..5436cc638 100644
--- a/docs/guides/onap-developer/settingup/fullonap.rst
+++ b/docs/guides/onap-developer/settingup/fullonap.rst
@@ -16,16 +16,13 @@
 
 **Context**
 ===========
-ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on Open Stack.
+ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack.
 
-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 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.
 
-The VNFs managed by ONAP may be deployed in different Open Stack tenants or based on top of VMware based infrastructure (cf MultiCloud project).
-
-Figure 1
-
-The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant)
+The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure (cf 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.
 
 **Requirements**
 ================
@@ -38,52 +35,102 @@ The following Open Stack components must be deployed in the infrastructure:
  - *Cinder*
  - *Designate*
  - *Glance*
+ - *Heat*
  - *Horizon*
  - *Keystone*
+ - *Neutron*
+ - *Nova*
 
-To deploy Open Stack, you can use various solutions:
+To deploy OpenStack, you can use various solutions:
  - `OpenStack installer <https://docs.openstack.org/install-guide/>`_
  - `OPNFV Cross Community Continuous Integration - XCI installer <http://docs.opnfv.org/en/latest/infrastructure/xci.html>`_
 
 *Designate* component is usually not deployed using standard OpenStack installers.
-Please find a guide to deploy and configure *Designate*
+Please find a guide to deploy and configure *Designate*.
+
+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):
+
+    ===================  =================   =======  ============
+    VM name              ONAP project(s)     Flavor   Image
+    ===================  =================   =======  ============
+    onap-aai-inst1       AAI                 xlarge   Ubuntu 14.04
+    onap-aai-inst2       AAI/UI              xlarge   Ubuntu 14.04
+    onap-appc            APPC, CCSDK         large    Ubuntu 14.04
+    onap-clamp           CLAMP               medium   Ubuntu 16.04
+    onap-dns-server      *Internal DNS*      small    Ubuntu 14.04
+    onap-message-router  DMAAP               large    Ubuntu 14.04
+    onap-multi-service   MSB, VF-C, VNFSDK   xxlarge  Ubuntu 16.04
+    onap-policy          Policy              xlarge   Ubuntu 14.04
+    onap-portal          Portal, CLI         large    Ubuntu 14.04
+    onap-robot           Integration         medium   Ubuntu 16.04
+    onap-sdc             SDC                 xlarge   Ubuntu 16.04
+    onap-sdnc            SDNC, CCSDK         large    Ubuntu 14.04
+    onap-so              SO                  large    Ubuntu 16.04
+    onap-vid             VID                 medium   Ubuntu 14.04
+    onap-dcae-bootstrap  DCAE, Holmes        small    Ubuntu 14.04
+    dcaeorcl00           DCAE/Orchestr.      medium   CentOS 7
+    dcaecnsl00           DCAE/Consul         medium   Ubuntu 16.04
+    dcaecnsl01           DCAE/Consul         medium   Ubuntu 16.04
+    dcaecnsl02           DCAE/Consul         medium   Ubuntu 16.04
+    dcaedokp00           DCAE/Policy Hand.   medium   Ubuntu 16.04
+    dcaedoks00           DCAE/VES, Holmes    medium   Ubuntu 16.04
+    dcaepgvm00           DCAE/Postrges       medium   Ubuntu 16.04
+    dcaecdap00           DCAE/CDAP           large    Ubuntu 16.04
+    dcaecdap01           DCAE/CDAP           large    Ubuntu 16.04
+    dcaecdap02           DCAE/CDAP           large    Ubuntu 16.04
+    dcaecdap03           DCAE/CDAP           large    Ubuntu 16.04
+    dcaecdap04           DCAE/CDAP           large    Ubuntu 16.04
+    dcaecdap05           DCAE/CDAP           large    Ubuntu 16.04
+    dcaecdap06           DCAE/CDAP           large    Ubuntu 16.04
+    ===================  =================   =======  ============
 
 Footprint
 ---------
 The ONAP installation requires the following footprint:
- - xx VM
- - xxx vCPU
- - xxx RAM
- - xxx Storage
- - xxx floating IP
- - a public SSH key
- - a private SSH key
+ - 29 VM
+ - 148 vCPU
+ - 336 GB RAM
+ - 3 TB Storage
+ - 29 floating IP
 
-Note that floating IP may be private IP.
+.. Note: the default flavor size may be optimized. The ONAP community is working to provide adpted flavors for basic ONAP installation.
 
-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) 
+.. Note: you should also reserve some resourcse for the VNFs to be deployed.
+
+Artifacts
+---------
+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
+ - Ubuntu 16.04 image
+ - CentOS 7 image
+ - Set of flavors: small, medium, large, medium, large, xlarge, xxlarge
 
-The following YAML file presents the ports exposed by the various components:
+.. Note that floating IP may be private IP.
 
-.. code-block:: yaml
+.. Note Basic flavors can reuse the default flavors as defined by `OpenStack <https://docs.openstack.org/horizon/latest/admin/manage-flavors.html>`_
+   The xxlarge flavor should be confiured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage.
 
- ---
- aai:
-  - 8889
+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).
 
-TODO Generate the YAML file with installation
+The following tables presents the ports exposed by the various components:
 
-TODO Provide a command to create the security groups
+TODO list the ports
 
 **Deployment**
 ==============
 
 Instantiation
 -------------
-- To deploy ONAP, use the Heat template and follow the described guidelines in integration project.
+- To deploy ONAP, use the Heat template and follow the described guidelines in `Integration project <http://onap.readthedocs.io/en/latest/submodules/integration.git/docs/index.html>`_
 
 - The Heat template deployment may take time (up to one hour) depending on your hardware environment.
 
@@ -116,17 +163,18 @@ The list of containers are described in the following section. In case some cont
 
 **Portal configuration**
 ========================
-The current ONAP installation is using the onap.org domain.
+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/host for Linux or /windows/system32/drivers/etc/hosts for Windows):
 
 .. code-block:: bash
 
- 104.239.249.17   policy.api.simpledemo.onap.org
- 104.130.31.25    portal.api.simpledemo.onap.org
- 104.239.249.15   sdc.api.simpledemo.onap.org
- 104.130.170.142  vid.api.simpledemo.onap.org
- 104.239.249.72   aai.api.simpledemo.onap.org
- TODO ADD ui.aai
+ <onap-policy_ip>      policy.api.simpledemo.onap.org
+ <onap-portal_ip>      portal.api.simpledemo.onap.org
+ <onap-sdc_ip>         sdc.api.simpledemo.onap.org
+ <onap-vid_ip>         vid.api.simpledemo.onap.org
+ <onap-aai-inst1_ip>   aai.api.simpledemo.onap.org
+ <onap-aai-inst2_ip>   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:
 
@@ -136,27 +184,48 @@ You can use the Horizon dashboard to get the IP adresses associated with the Vir
 
 Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
 
-Go to the Portal component user guide.
+Various users are predefined as presented in the following table:
+
+  .. csv-table::
+   :header: Role, Login
+   :widths: 20, 20
+
+    Superuser,demo
+    Designer,cs0008
+    Tester,jm0007
+    Governor,gv0001
+    Ops,op0001
+
+The password is *demo123456!*
+
+Go to the `Portal component user guide <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/index.html>`_
 
 Other UI documentation:
- - CLAMP
- - SDC Portal
- - UI Case
+ - `CLAMP  <http://onap.readthedocs.io/en/latest/submodules/clamp.git/docs/index.html>`_
+ - `SDC http://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html>`_
+ - `UI Use-Case <http://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/index.html>`_
 
 
 **Components**
 ==============
 
-The following YAML file presents the list of containers for every Virtual Machine
+The following table presents the list of containers for every Virtual Machine
 
-.. code-block:: yaml
+  .. csv-table::
+   :header: Virtual Machine, Container, Description
+   :widths: 15, 20, 20
 
- aai:
-   - traversal
-   - be
-   - fe
- appc
-   - fe
+    onap-appc,sdnc_dgbuilder_container
+    ,appc_controller_container
+    ,sdnc_db_container
 
+TODO: list all the containers
 
+TODO: update the deployment figure available on the wiki ?
 
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+   http://creativecommons.org/licenses/by/4.0
+   Copyright 2017 ONAP
+
+
+.. contents::