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