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 OpenStack.
  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 OpenStack tenants or based on top of VMware based infrastructure (cf MultiCloud project).
  24
  25 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.
  26
  27 **Requirements**
  28 ================
  29
  30 OpenStack
  31 ---------
  32 ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release.
  33
  34 The following Open Stack components must be deployed in the infrastructure:
  35  - *Cinder*
  36  - *Designate*
  37  - *Glance*
  38  - *Heat*
  39  - *Horizon*
  40  - *Keystone*
  41  - *Neutron*
  42  - *Nova*
  43
  44 To deploy OpenStack, 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 The OpenStack infrastructure must enable internet access.
  52
  53 ONAP components
  54 ---------------
  55 The following table presents the mapping between the created VM and the ONAP components, and provides informtaion about he VM (flavor and image):
  56
  57     ===================  =================   =======  ============
  58     VM name              ONAP project(s)     Flavor   Image
  59     ===================  =================   =======  ============
  60     onap-aai-inst1       AAI                 xlarge   Ubuntu 14.04
  61     onap-aai-inst2       AAI/UI              xlarge   Ubuntu 14.04
  62     onap-appc            APPC, CCSDK         large    Ubuntu 14.04
  63     onap-clamp           CLAMP               medium   Ubuntu 16.04
  64     onap-dns-server      *Internal DNS*      small    Ubuntu 14.04
  65     onap-message-router  DMAAP               large    Ubuntu 14.04
  66     onap-multi-service   MSB, VF-C, VNFSDK   xxlarge  Ubuntu 16.04
  67     onap-policy          Policy              xlarge   Ubuntu 14.04
  68     onap-portal          Portal, CLI         large    Ubuntu 14.04
  69     onap-robot           Integration         medium   Ubuntu 16.04
  70     onap-sdc             SDC                 xlarge   Ubuntu 16.04
  71     onap-sdnc            SDNC, CCSDK         large    Ubuntu 14.04
  72     onap-so              SO                  large    Ubuntu 16.04
  73     onap-vid             VID                 medium   Ubuntu 14.04
  74     onap-dcae-bootstrap  DCAE, Holmes        small    Ubuntu 14.04
  75     dcaeorcl00           DCAE/Orchestr.      medium   CentOS 7
  76     dcaecnsl00           DCAE/Consul         medium   Ubuntu 16.04
  77     dcaecnsl01           DCAE/Consul         medium   Ubuntu 16.04
  78     dcaecnsl02           DCAE/Consul         medium   Ubuntu 16.04
  79     dcaedokp00           DCAE/Policy Hand.   medium   Ubuntu 16.04
  80     dcaedoks00           DCAE/VES, Holmes    medium   Ubuntu 16.04
  81     dcaepgvm00           DCAE/Postrges       medium   Ubuntu 16.04
  82     dcaecdap00           DCAE/CDAP           large    Ubuntu 16.04
  83     dcaecdap01           DCAE/CDAP           large    Ubuntu 16.04
  84     dcaecdap02           DCAE/CDAP           large    Ubuntu 16.04
  85     dcaecdap03           DCAE/CDAP           large    Ubuntu 16.04
  86     dcaecdap04           DCAE/CDAP           large    Ubuntu 16.04
  87     dcaecdap05           DCAE/CDAP           large    Ubuntu 16.04
  88     dcaecdap06           DCAE/CDAP           large    Ubuntu 16.04
  89     ===================  =================   =======  ============
  90
  91 Footprint
  92 ---------
  93 The ONAP installation requires the following footprint:
  94  - 29 VM
  95  - 148 vCPU
  96  - 336 GB RAM
  97  - 3 TB Storage
  98  - 29 floating IP
  99
 100 .. Note: the default flavor size may be optimized. The ONAP community is working to provide adpted flavors for basic ONAP installation.
 101
 102 .. Note: you should also reserve some resourcse for the VNFs to be deployed.
 103
 104 Artifacts
 105 ---------
 106 The following artifacts must be deployed on the OpenStack infrastructure.
 107  - a public SSH key to access the various VM
 108  - private SSH key and public key SSH key for the DCAE VM
 109  - Ubuntu 14.04 image
 110  - Ubuntu 16.04 image
 111  - CentOS 7 image
 112  - Set of flavors: small, medium, large, medium, large, xlarge, xxlarge
 113
 114 .. Note that floating IP may be private IP.
 115
 116 .. Note Basic flavors can reuse the default flavors as defined by `OpenStack <https://docs.openstack.org/horizon/latest/admin/manage-flavors.html>`_
 117    The xxlarge flavor should be confiured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage.
 118
 119 Security
 120 --------
 121 The default installation assumes that the Default security group is configured to enable full access between the ONAP components.
 122 Depending on your environment, we may need to open some security groups (eg when using the portal from your desktop).
 123
 124 The following tables presents the ports exposed by the various components:
 125
 126 TODO list the ports
 127
 128 **Deployment**
 129 ==============
 130
 131 Instantiation
 132 -------------
 133 - 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>`_
 134
 135 - The Heat template deployment may take time (up to one hour) depending on your hardware environment.
 136
 137 Test the installation
 138 ---------------------
 139 Every ONAP component offers a HealthCheck REST API. The *Robot Virtual Machine* can be used to test that every components run smoothly.
 140 Run the following command to perform the HealthCheck:
 141
 142 .. code-block:: bash
 143
 144   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
 145
 146 This testsuite will execute 31 tests towards the various ONAP components.
 147
 148 Detect problems
 149 ---------------
 150 If all the tests are not OK, many causes are possible.
 151 Here is a simple procedure to detect where the problem occurs:
 152
 153 * Check the OpenStack Virtual Machine logs
 154 * Connect to the Virtual Machine and check that the various containers are running.
 155
 156 The list of containers are described in the following section. In case some containers are missing, check the docker logs using the following command:
 157
 158 .. code-block:: bash
 159
 160  sudo docker ps -a
 161  sudo docker logs <containerid>
 162
 163
 164 **Portal configuration**
 165 ========================
 166 The current ONAP installation is using the *onap.org* domain.
 167 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):
 168
 169 .. code-block:: bash
 170
 171  <onap-policy_ip>      policy.api.simpledemo.onap.org
 172  <onap-portal_ip>      portal.api.simpledemo.onap.org
 173  <onap-sdc_ip>         sdc.api.simpledemo.onap.org
 174  <onap-vid_ip>         vid.api.simpledemo.onap.org
 175  <onap-aai-inst1_ip>   aai.api.simpledemo.onap.org
 176  <onap-aai-inst2_ip>   aai.ui.simpledemo.onap.org
 177
 178
 179 You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line:
 180
 181 .. code-block:: bash
 182
 183  openstack server list
 184
 185 Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
 186
 187 Various users are predefined as presented in the following table:
 188
 189   .. csv-table::
 190    :header: Role, Login
 191    :widths: 20, 20
 192
 193     Superuser,demo
 194     Designer,cs0008
 195     Tester,jm0007
 196     Governor,gv0001
 197     Ops,op0001
 198
 199 The password is *demo123456!*
 200
 201 Go to the `Portal component user guide <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/index.html>`_
 202
 203 Other UI documentation:
 204  - `CLAMP  <http://onap.readthedocs.io/en/latest/submodules/clamp.git/docs/index.html>`_
 205  - `SDC http://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html>`_
 206  - `UI Use-Case <http://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/index.html>`_
 207
 208
 209 **Components**
 210 ==============
 211
 212 The following table presents the list of containers for every Virtual Machine
 213
 214   .. csv-table::
 215    :header: Virtual Machine, Container, Description
 216    :widths: 15, 20, 20
 217
 218     onap-appc,sdnc_dgbuilder_container
 219     ,appc_controller_container
 220     ,sdnc_db_container
 221
 222 TODO: list all the containers
 223
 224 TODO: update the deployment figure available on the wiki ?
 225
 226 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 227    http://creativecommons.org/licenses/by/4.0
 228    Copyright 2017 ONAP
 229
 230
 231 .. contents::