docs/guides/onap-developer/settingup/fullonap.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2    http://creativecommons.org/licenses/by/4.0
   3    Copyright 2017 ONAP
   4
   5
   6 .. contents::
   7    :depth: 2
   8 ..
   9
  10
  11 ========================
  12 **Setting Up Full ONAP**
  13 ========================
  14
  15 .. _demo-installing-running-onap:
  16
  17 **Context**
  18 ===========
  19 ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on Open Stack.
  20
  21 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.
  22
  23 The VNFs managed by ONAP may be deployed in different Open Stack tenants or based on top of VMware based infrastructure (cf MultiCloud project).
  24
  25 Figure 1
  26
  27 The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant)
  28
  29
  30 **Requirements**
  31 ================
  32
  33 OpenStack
  34 ---------
  35 ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release.
  36
  37 The following Open Stack components must be deployed in the infrastructure:
  38  - *Cinder*
  39  - *Designate*
  40  - *Glance*
  41  - *Horizon*
  42  - *Keystone*
  43
  44 To deploy Open Stack, you can use various solutions:
  45  - `OpenStack installer <https://docs.openstack.org/install-guide/>`_
  46  - `OPNFV Cross Community Continuous Integration - XCI installer <http://docs.opnfv.org/en/latest/infrastructure/xci.html>`_
  47
  48 *Designate* component is usually not deployed using standard OpenStack installers.
  49 Please find a guide to deploy and configure *Designate*
  50
  51 Footprint
  52 ---------
  53 The ONAP installation requires the following footprint:
  54  - xx VM
  55  - xxx vCPU
  56  - xxx RAM
  57  - xxx Storage
  58  - xxx floating IP
  59  - a public SSH key
  60  - a private SSH key
  61
  62 Note that floating IP may be private IP.
  63
  64 Security
  65 --------
  66 The default installation assumes that the Default security group is configured to enable full access between the ONAP components.
  67 Depending on your environment, we may need to open some security groups (eg when using the portal from your desktop)
  68
  69 The following YAML file presents the ports exposed by the various components:
  70
  71 .. code-block:: yaml
  72
  73  ---
  74  aai:
  75   - 8889
  76
  77 TODO Generate the YAML file with installation
  78
  79 TODO Provide a command to create the security groups
  80
  81 **Deployment**
  82 ==============
  83
  84 Instantiation
  85 -------------
  86 - To deploy ONAP, use the Heat template and follow the described guidelines in integration project.
  87
  88 - The Heat template deployment may take time (up to one hour) depending on your hardware environment.
  89
  90 Test the installation
  91 ---------------------
  92 Every ONAP component offers a HealthCheck REST API. The *Robot Virtual Machine* can be used to test that every components run smoothly.
  93 Run the following command to perform the HealthCheck:
  94
  95 .. code-block:: bash
  96
  97   docker exec -it openecompete_container /var/opt/OpenECOMP_ETE/runTags.sh -i health h -d ./html -V /share/config/integration_robot_properties.py -V /share/config/integration_preload_parameters.py -V /share/config/vm_properties.py
  98
  99 This testsuite will execute 31 tests towards the various ONAP components.
 100
 101 Detect problems
 102 ---------------
 103 If all the tests are not OK, many causes are possible.
 104 Here is a simple procedure to detect where the problem occurs:
 105
 106 * Check the OpenStack Virtual Machine logs
 107 * Connect to the Virtual Machine and check that the various containers are running.
 108
 109 The list of containers are described in the following section. In case some containers are missing, check the docker logs using the following command:
 110
 111 .. code-block:: bash
 112
 113  sudo docker ps -a
 114  sudo docker logs <containerid>
 115
 116
 117 **Portal configuration**
 118 ========================
 119 The current ONAP installation is using the onap.org domain.
 120 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):
 121
 122 .. code-block:: bash
 123
 124  104.239.249.17   policy.api.simpledemo.onap.org
 125  104.130.31.25    portal.api.simpledemo.onap.org
 126  104.239.249.15   sdc.api.simpledemo.onap.org
 127  104.130.170.142  vid.api.simpledemo.onap.org
 128  104.239.249.72   aai.api.simpledemo.onap.org
 129  TODO ADD ui.aai
 130
 131 You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line:
 132
 133 .. code-block:: bash
 134
 135  openstack server list
 136
 137 Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
 138
 139 Go to the Portal component user guide.
 140
 141 Other UI documentation:
 142  - CLAMP
 143  - SDC Portal
 144  - UI Case
 145
 146
 147 **Components**
 148 ==============
 149
 150 The following YAML file presents the list of containers for every Virtual Machine
 151
 152 .. code-block:: yaml
 153
 154  aai:
 155    - traversal
 156    - be
 157    - fe
 158  appc
 159    - fe
 160
 161
 162