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 your requirements. The recommended 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 multiple tenants. One tenant for all the components except DCAE, 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 single 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 need 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 guidelines in integration project.
  85
  86 - The Heat template deployment may take time (up to one hour) depending on your hardware environment.
  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 components run smoothly.
  91 Run the following command to perform the HealthCheck:
  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
 104 * Check the OpenStack Virtual Machine logs
 105 * Connect to the Virtual Machine and check that the various containers are runnings.
 106
 107 The list of containers are described in the following section. In case some containers are missing, check the docker logs using the following command:
 108
 109 .. code-block:: bash
 110
 111  sudo docker ps -a
 112  sudo docker logs <containerid>
 113
 114
 115 **Portal configuration**
 116 ========================
 117 The current ONAP installation is using the onap.org domain.
 118 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):
 119
 120 .. code-block:: bash
 121
 122  104.239.249.17   policy.api.simpledemo.onap.org
 123  104.130.31.25    portal.api.simpledemo.onap.org
 124  104.239.249.15   sdc.api.simpledemo.onap.org
 125  104.130.170.142  vid.api.simpledemo.onap.org
 126  104.239.249.72   aai.api.simpledemo.onap.org
 127  TODO ADD ui.aai
 128
 129 You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line:
 130
 131 .. code-block:: bash
 132
 133  openstack server list
 134
 135 Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
 136
 137 Go to the Portal component user guide.
 138
 139 Other UI documentation:
 140  - CLAMP
 141  - SDC Portal
 142  - UI Case
 143
 144
 145 **Components**
 146 ==============
 147
 148 The following YAML file presents the list of containers for every Virtual Machine
 149
 150 .. code-block:: yaml
 151
 152  aai:
 153    - traversal
 154    - be
 155    - fe
 156  appc
 157    - fe
 158
 159
 160
 161 ========================================
 162 **Setting Up indiviual ONAP components**
 163 ========================================
 164 It is possible to deploy individual components.
 165
 166 The documentation to install the various components is available here:
 167
 168 TODO Link to installations
 169