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 .. index:: Setting Up Full ONAP
  11
  12
  13 ========================
  14 **Setting Up Full ONAP**
  15 ========================
  16
  17 .. _demo-installing-running-onap:
  18
  19 **Context**
  20 ===========
  21 ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack HEAT Template.
  22
  23 Using the Amsterdam HEAT Template installer, ONAP can 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.
  24
  25 The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure. For details, refer :ref:`to MultiCloud project<index-multicloud>`.
  26
  27 The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) with DCAE components deployed in High Availability mode.
  28
  29 The installation requires some manual tasks to setup the DCAE components.
  30
  31 **Requirements**
  32 ================
  33
  34 OpenStack
  35 ---------
  36 ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release.
  37
  38 You can use various Cloud providers offering OpenStack based solutions. A list of available Cloud providers on the `OpenStack marketplace <https://www.openstack.org/marketplace/public-clouds/>`_.
  39
  40 You can use your private Cloud infrastructure.
  41
  42 The following OpenStack components must be deployed in the infrastructure:
  43  - *Cinder*
  44  - *Designate*
  45  - *Glance*
  46  - *Heat*
  47  - *Horizon*
  48  - *Keystone*
  49  - *Neutron*
  50  - *Nova*
  51
  52 To deploy OpenStack, you can use various solutions:
  53  - `OpenStack installer <https://docs.openstack.org/install-guide/>`_
  54  - `OPNFV Cross Community Continuous Integration - XCI installer <http://docs.opnfv.org/en/latest/infrastructure/xci.html>`_
  55
  56 *Designate* component is usually not deployed using standard OpenStack installers.
  57 Use the procedure below to deploy and configure *Designate*
  58
  59 .. toctree::
  60    :maxdepth: 1
  61
  62    install-designate.rst
  63
  64
  65 The OpenStack infrastructure must enable internet access.
  66
  67 ONAP components
  68 ---------------
  69 The following table presents the mapping between the created VM and the ONAP components, and provides VM information (flavor and image):
  70
  71     ===================  =================   =======  ============
  72     VM name              ONAP project(s)     Flavor   Image
  73     ===================  =================   =======  ============
  74     onap-aai-inst1       AAI                 xlarge   Ubuntu 14.04
  75     onap-aai-inst2       AAI/UI              xlarge   Ubuntu 14.04
  76     onap-appc            APPC, CCSDK         large    Ubuntu 14.04
  77     onap-clamp           CLAMP               medium   Ubuntu 16.04
  78     onap-dns-server      *Internal DNS*      small    Ubuntu 14.04
  79     onap-message-router  DMAAP               large    Ubuntu 14.04
  80     onap-multi-service   MSB, VF-C, VNFSDK   xxlarge  Ubuntu 16.04
  81     onap-policy          Policy              xlarge   Ubuntu 14.04
  82     onap-portal          Portal, CLI         large    Ubuntu 14.04
  83     onap-robot           Integration         medium   Ubuntu 16.04
  84     onap-sdc             SDC                 xlarge   Ubuntu 16.04
  85     onap-sdnc            SDNC, CCSDK         large    Ubuntu 14.04
  86     onap-so              SO                  large    Ubuntu 16.04
  87     onap-vid             VID                 medium   Ubuntu 14.04
  88     onap-dcae-bootstrap  DCAE, Holmes        small    Ubuntu 14.04
  89     dcaeorcl00           DCAE/Orchestr.      medium   CentOS 7
  90     dcaecnsl00           DCAE/Consul         medium   Ubuntu 16.04
  91     dcaecnsl01           DCAE/Consul         medium   Ubuntu 16.04
  92     dcaecnsl02           DCAE/Consul         medium   Ubuntu 16.04
  93     dcaedokp00           DCAE/Policy Hand.   medium   Ubuntu 16.04
  94     dcaedoks00           DCAE/VES, Holmes    medium   Ubuntu 16.04
  95     dcaepgvm00           DCAE/Postrges       medium   Ubuntu 16.04
  96     dcaecdap00           DCAE/CDAP           large    Ubuntu 16.04
  97     dcaecdap01           DCAE/CDAP           large    Ubuntu 16.04
  98     dcaecdap02           DCAE/CDAP           large    Ubuntu 16.04
  99     dcaecdap03           DCAE/CDAP           large    Ubuntu 16.04
 100     dcaecdap04           DCAE/CDAP           large    Ubuntu 16.04
 101     dcaecdap05           DCAE/CDAP           large    Ubuntu 16.04
 102     dcaecdap06           DCAE/CDAP           large    Ubuntu 16.04
 103     ===================  =================   =======  ============
 104
 105 Footprint
 106 ---------
 107 The ONAP installation requires the following footprint:
 108  - 29 VM
 109  - 148 vCPU
 110  - 336 GB RAM
 111  - 3 TB Storage
 112  - 29 floating IP addresses
 113
 114 .. Note: The default flavor size may be optimized. The ONAP community is working to update flavors of basic ONAP installation.
 115
 116 .. Note: You should also reserve some resources for the VNFs to be deployed.
 117
 118 Artifacts
 119 ---------
 120 The following artifacts must be deployed on the OpenStack infrastructure:
 121  - a public SSH key to access the various VM
 122  - private SSH key and public key SSH key for the DCAE VM
 123  - Ubuntu 14.04 image
 124  - Ubuntu 16.04 image
 125  - CentOS 7 image
 126  - Set of flavors: small, medium, large, medium, large, xlarge, xxlarge
 127
 128 .. Note: The floating IP may be private IP.
 129
 130 .. Note: Basic flavors can reuse the default flavors as defined by `OpenStack <https://docs.openstack.org/horizon/latest/admin/manage-flavors.html>`_
 131    The xxlarge flavor should be configured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage.
 132
 133 Security
 134 --------
 135 The default installation assumes that the Default security group is configured to enable full access between the ONAP components.
 136 Depending on your environment, we may need to open some security groups (eg when using the portal from your desktop).
 137
 138 The list of various services and ports used can be found on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_.
 139
 140 **Deployment**
 141 ==============
 142
 143 Source files
 144 ------------
 145
 146 Both following files must be downloaded and configured to match your configuration:
 147
 148 - Template file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml
 149 - Environment file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env
 150
 151 The environment file must be customized as described in the following sections.
 152
 153 .. Note Amsterdam release files
 154
 155 Description
 156 -----------
 157
 158 The ONAP HEAT template spins up all the components expect the DCAE. The template,
 159 onap_openstack.yaml, comes with an environment file,
 160 onap_openstack.env, in which all the default values are defined.
 161
 162 The HEAT template is composed of two sections: (i) parameters, and (ii)
 163 resources.
 164 The parameter section contains the declaration and
 165 description of the parameters that will be used to spin up ONAP, such as
 166 public network identifier, URLs of code and artifacts repositories, etc.
 167 The default values of these parameters can be found in the environment
 168 file.
 169
 170 The resource section contains the definition of:
 171
 172 - ONAP Private Management Network, which ONAP components use to communicate with each other and with VNFs
 173 - ONAP Virtual Machines (VMs)
 174 - Public/private key pair used to access ONAP VMs
 175 - Virtual interfaces towards the ONAP Private Management Network
 176 - Disk volumes
 177
 178 Each VM specification includes Operating System image name, VM size
 179 (i.e. flavor), VM name, etc. Each VM has two virtual network interfaces:
 180 one towards the public network and one towards the ONAP Private
 181 Management network, as described above. Furthermore, each VM runs a
 182 post-instantiation script that downloads and installs software
 183 dependencies (e.g. Java JDK, gcc, make, Python, ...) and ONAP software
 184 packages and Docker containers from remote repositories.
 185
 186 When the HEAT template is executed, the OpenStack HEAT engine creates
 187 the resources defined in the HEAT template, based on the parameters
 188 values defined in the environment file.
 189
 190 Environment file
 191 ----------------
 192
 193 Before running HEAT, it is necessary to customize the environment file.
 194 Indeed, some parameters, namely public_net_id, pub_key,
 195 openstack_tenant_id, openstack_username, and openstack_api_key,
 196 need to be set depending on the user's environment:
 197
 198 **Global parameters**
 199
 200 ::
 201
 202  public_net_id:       PUT YOUR NETWORK ID/NAME HERE
 203  pub_key:             PUT YOUR PUBLIC KEY HERE
 204  openstack_tenant_id: PUT YOUR OPENSTACK PROJECT ID HERE
 205  openstack_username:  PUT YOUR OPENSTACK USERNAME HERE
 206  openstack_api_key:   PUT YOUR OPENSTACK PASSWORD HERE
 207  horizon_url:         PUT THE HORIZON URL HERE
 208  keystone_url:        PUT THE KEYSTONE URL HERE (do not include version number)
 209
 210 openstack_region parameter is set to RegionOne (OpenStack default). If
 211 your OpenStack is using another Region, please modify this parameter.
 212
 213 public_net_id is the unique identifier (UUID) or name of the public
 214 network of the cloud provider. To get the public_net_id, use the
 215 following OpenStack CLI command (ext is the name of the external
 216 network, change it with the name of the external network of your
 217 installation)
 218
 219 ::
 220
 221  openstack network list  | grep ext |  awk '{print $2}'
 222
 223 pub_key is string value of the public key that will be installed in
 224 each ONAP VM. To create a public/private key pair in Linux, please
 225 execute the following instruction:
 226
 227 ::
 228
 229  user@ubuntu:~$ ssh-keygen -t rsa
 230
 231 The following operations create the public/private key pair:
 232
 233 ::
 234
 235  Generating public/private rsa key pair.
 236  Enter file in which to save the key (/home/user/.ssh/id_rsa):
 237  Created directory '/home/user/.ssh'.
 238  Enter passphrase (empty for no passphrase):
 239  Enter same passphrase again:
 240  Your identification has been saved in /home/user/.ssh/id_rsa.
 241  Your public key has been saved in /home/user/.ssh/id_rsa.pub.
 242
 243 openstack_username, openstack_tenant_id (password), and
 244 openstack_api_key are user's credentials to access the
 245 OpenStack-based cloud.
 246
 247 **Images and flavors parameters**
 248
 249 ::
 250
 251  ubuntu_1404_image: PUT THE UBUNTU 14.04 IMAGE NAME HERE
 252  ubuntu_1604_image: PUT THE UBUNTU 16.04 IMAGE NAME HERE
 253  flavor_small:       PUT THE SMALL FLAVOR NAME HERE
 254  flavor_medium:      PUT THE MEDIUM FLAVOR NAME HERE
 255  flavor_large:       PUT THE LARGE FLAVOR NAME HERE
 256  flavor_xlarge:      PUT THE XLARGE FLAVOR NAME HERE
 257  flavor_xxlarge:     PUT THE XXLARGE FLAVOR NAME HERE
 258
 259 To get the images in your OpenStack environment, use the following
 260 OpenStack CLI command:
 261
 262 ::
 263
 264         openstack image list | grep 'ubuntu'
 265
 266 To get the flavor names used in your OpenStack environment, use the
 267 following OpenStack CLI command:
 268
 269 ::
 270
 271         openstack flavor list
 272
 273 **Network parameters**
 274
 275 ::
 276
 277  dns_list: PUT THE ADDRESS OFTHE EXTERNAL DNS HERE (e.g. a comma-separated list of IP addresses in your /etc/resolv.conf in UNIX-based Operating Systems). THIS LIST MUST INCLUDE THE DNS SERVER THAT OFFERS DNS AS AS SERVICE (see DCAE section below for more details)
 278  external_dns: PUT THE FIRST ADDRESS OF THE EXTERNAL DNS LIST HERE oam_network_cidr: 10.0.0.0/16
 279  dns_forwarder: PUT THE IP OF DNS FORWARDER FOR ONAP DEPLOYMENT'S OWN DNS SERVER
 280  oam_network_cidr: 10.0.0.0/16
 281
 282 You can use the Google Public DNS 8.8.8.8 and 4.4.4.4 address or your internal DNS servers.
 283
 284 ONAP installs a DNS server used to resolve IP addresses in the ONAP OAM private network.
 285 ONAP Amsterdam Release also requires OpenStack Designate DNS support for the DCAE platform, so as to allow IP address discovery and communication among DCAE elements.
 286 This is required because the ONAP HEAT template only installs the DCAE bootstrap container, which will in turn install the entire DCAE platform.
 287 As such, at installation time, the IP addresses of the DCAE components are unknown.
 288
 289 The DNS server that ONAP installs needs to be connected to the Designate DNS to allow communication between the DCAE elements and the other ONAP components.
 290 To this end, dns\_list, external\_dns, and dns\_forwarder should all have the IP address of the Designate DNS.
 291 These three parameters are redundant, but still required for Amsterdam Release. Originally, dns\_list and external\_dns were both used to circumvent some limitations of older OpenStack versions.
 292 In future releases, the DNS settings and parameters in HEAT will be consolidated.
 293 The Designate DNS is configured to access the external DNS.
 294 As such, the ONAP DNS will forward to the Designate DNS the queries from ONAP components to the external world.
 295 The Designate DNS will then forward those queries to the external DNS.
 296
 297 **DCAE Parameters**
 298
 299 DCAE spins up ONAP's data collection and analytics system in two phases.
 300
 301 The first phase consists of launching a bootstrap VM that is specified in the ONAP HEAT template, as described above. This VM requires a number of deployment-specific configuration parameters being provided so that it can subsequently bring up the DCAE system.
 302
 303 There are two groups of parameters:
 304
 305 - The first group relates to the launching of DCAE VMs, including parameters such as the keystone URL and additional VM image IDs/names. Hence these parameters need to be provided to DCAE. Note that although DCAE VMs will be launched in the same tenant as the rest of ONAP, because DCAE may use MultiCloud node as the agent for interfacing with the underlying cloud, it needs a separate keystone URL (which points to MultiCloud node instead of the underlying cloud).
 306
 307
 308 - The second group of configuration parameters relate to DNS As A Service support (DNSaaS). DCAE requires DNSaaS for registering its VMs into organization-wide DNS service. For OpenStack, DNSaaS is provided by Designate, as mentioned above. Designate support can be provided via an integrated service endpoint listed under the service catalog of the OpenStack installation; or proxyed by the ONAP MultiCloud service. For the latter case, a number of parameters are needed to configure MultiCloud to use the correct Designate service.
 309
 310 These parameters are described below:
 311
 312 ::
 313
 314  dcae_keystone_url: PUT THE MULTIVIM PROVIDED KEYSTONE API URL HERE
 315  dcae_centos_7_image: PUT THE CENTOS7 VM IMAGE NAME HERE FOR DCAE LAUNCHED CENTOS7 VM
 316  dcae_domain: PUT THE NAME OF DOMAIN THAT DCAE VMS REGISTER UNDER
 317  dcae_public_key: PUT THE PUBLIC KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS
 318  dcae_private_key: PUT THE SECRET KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS
 319
 320  dnsaas_config_enabled: PUT WHETHER TO USE PROXYED DESIGNATE
 321  dnsaas_region: PUT THE DESIGNATE PROVIDING OPENSTACK'S REGION HERE
 322  dnsaas_keystone_url: PUT THE DESIGNATE PROVIDING OPENSTACK'S KEYSTONE URL HERE
 323  dnsaas_tenant_name: PUT THE TENANT NAME IN THE DESIGNATE PROVIDING OPENSTACK HERE (FOR R1 USE THE SAME AS openstack_tenant_name)
 324  dnsaas_username: PUT THE DESIGNATE PROVIDING OPENSTACK'S USERNAME HERE
 325  dnsaas_password: PUT THE DESIGNATE PROVIDING OPENSTACK'S PASSWORD HERE
 326
 327 Instantiation
 328 -------------
 329
 330 The ONAP platform can be instantiated via Horizon (OpenStack dashboard)
 331 or Command Line.
 332
 333 **Instantiation via Horizon:**
 334
 335 - Login to Horizon URL with your personal credentials
 336 - Click "Stacks" from the "Orchestration" menu
 337 - Click "Launch Stack"
 338 - Paste or manually upload the HEAT template file (onap_openstack.yaml) in the "Template Source" form
 339 - Paste or manually upload the HEAT environment file (onap_openstack.env) in the "Environment Source" form
 340 - Click "Next" - Specify a name in the "Stack Name" form
 341 - Provide the password in the "Password" form
 342 - Click "Launch"
 343
 344 **Instantiation via Command Line:**
 345
 346 - Install the HEAT client on your machine, e.g. in Ubuntu (ref. http://docs.openstack.org/user-guide/common/cli-install-openstack-command-line-clients.html):
 347
 348 ::
 349
 350  apt-get install python-dev python-pip
 351  pip install python-heatclient        # Install heat client
 352  pip install python-openstackclient   # Install the Openstack client to support multiple services
 353
 354 -  Create a file (named i.e. ~/openstack/openrc) that sets all the
 355    environmental variables required to access your OpenStack tenant:
 356
 357 ::
 358
 359  export OS_AUTH_URL=INSERT THE AUTH URL HERE
 360  export OS_USERNAME=INSERT YOUR USERNAME HERE
 361  export OS_TENANT_ID=INSERT YOUR TENANT ID HERE
 362  export OS_REGION_NAME=INSERT THE REGION HERE
 363  export OS_PASSWORD=INSERT YOUR PASSWORD HERE
 364
 365 -  Run the script from command line:
 366
 367 ::
 368
 369  source ~/openstack/openrc
 370
 371 -  In order to install the ONAP platform, type:
 372
 373 ::
 374
 375  heat stack-create STACK_NAME -f PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE       # Old HEAT client, OR
 376  openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME  # New Openstack client
 377
 378
 379 .. Note The HEAT template deployment may take time (up to one hour) depending on your hardware environment.
 380
 381 Deploy DCAE
 382 -----------
 383 The HEAT template deployed the onap-dcae-bootstrap virtual machine.
 384
 385 .. Note To provide the manual tasks to configure the local environment
 386
 387
 388 Test the installation
 389 ---------------------
 390 Every ONAP component offers a HealthCheck REST API. The Robot Virtual Machine (*onap-robot*) can be used to test that every components run smoothly.
 391 Run the following command to perform the HealthCheck:
 392
 393 .. code-block:: bash
 394
 395   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
 396
 397 This test suite will execute 30 tests towards the various ONAP components.
 398
 399 After the installation, it is possible to deploy the various use-cases described in `ONAP wiki <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
 400
 401 Detect problems
 402 ---------------
 403 If all the tests are not OK, many causes are possible.
 404 Here is a simple procedure to detect where the problem occurs:
 405
 406 * Check the OpenStack Virtual Machine logs
 407 * Connect to the Virtual Machine and check that the various containers are running.
 408
 409 The list of containers are described on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_
 410 . In case some containers are missing, check the Docker logs using the following command:
 411
 412 .. code-block:: bash
 413
 414  sudo docker ps -a
 415  sudo docker logs <containerid>
 416
 417 **Portal configuration**
 418 ========================
 419 The current ONAP installation is using the *onap.org* domain.
 420 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):
 421
 422 .. code-block:: bash
 423
 424  <onap-policy_ip>      policy.api.simpledemo.onap.org
 425  <onap-portal_ip>      portal.api.simpledemo.onap.org
 426  <onap-sdc_ip>         sdc.api.simpledemo.onap.org
 427  <onap-vid_ip>         vid.api.simpledemo.onap.org
 428  <onap-aai-inst1_ip>   aai.api.simpledemo.onap.org
 429  <onap-aai-inst2_ip>   aai.ui.simpledemo.onap.org
 430
 431
 432 You can use the Horizon dashboard to get the IP addresses associated with the Virtual Machines or use the following command line:
 433
 434 .. code-block:: bash
 435
 436  openstack server list
 437
 438 Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
 439
 440 Various users are predefined as presented in the following table:
 441
 442   .. csv-table::
 443    :header: Role, Login
 444    :widths: 20, 20
 445
 446     Superuser,demo
 447     Designer,cs0008
 448     Tester,jm0007
 449     Governor,gv0001
 450     Ops,op0001
 451
 452 The password is *demo123456!*
 453
 454 Go to the `Portal component user guide <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/index.html>`_
 455
 456 Other UI documentation:
 457  - `CLAMP  <http://onap.readthedocs.io/en/latest/submodules/clamp.git/docs/index.html>`_
 458  - `SDC <http://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html>`_
 459  - `UI Use-Case <http://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/index.html>`_
 460
 461
 462 **Components**
 463 ==============
 464
 465 The list of various services and ports used can be found on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_
 466
 467 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 468    http://creativecommons.org/licenses/by/4.0
 469    Copyright 2017 ONAP
 470
 471
 472 .. contents::