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