1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 http://creativecommons.org/licenses/by/4.0
10 .. index:: Setting Up Full ONAP
13 ========================
14 **Setting Up Full ONAP**
15 ========================
17 .. _demo-installing-running-onap:
21 ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack.
23 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.
25 The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure (cf MultiCloud project).
27 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.
29 The installation requires some manual taks to setup the DCAE components.
36 ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release.
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/>`_.
40 You can use your private Cloud infrastructure.
42 The following OpenStack components must be deployed in the infrastructure:
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>`_
56 *Designate* component is usually not deployed using standard OpenStack installers.
57 Please find a guide to deploy and configure *Designate*
65 The OpenStack infrastructure must enable internet access.
69 The following table presents the mapping between the created VM and the ONAP components, and provides informtaion about he VM (flavor and image):
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 =================== ================= ======= ============
107 The ONAP installation requires the following footprint:
114 .. Note: the default flavor size may be optimized. The ONAP community is working to provide adpted flavors for basic ONAP installation.
116 .. Note: you should also reserve some resourcse for the VNFs to be deployed.
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
126 - Set of flavors: small, medium, large, medium, large, xlarge, xxlarge
128 .. Note that floating IP may be private IP.
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 confiured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage.
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).
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>`_
146 The following files must be downloaded:
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
151 The environment file must be customized as decribed in the following sections.
153 .. Note Amsterdam release files
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.
162 The HEAT template is composed of two sections: (i) parameters, and (ii)
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
170 The resource section contains the definition of:
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
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.
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.
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:
198 **Global parameters**
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)
210 openstack_region parameter is set to RegionOne (OpenStack default). If
211 your OpenStack is using another Region, please modify this parameter.
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
221 openstack network list | grep ext | awk '{print $2}'
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:
229 user@ubuntu:~$ ssh-keygen -t rsa
231 The following operations to create the public/private key pair occur:
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.
243 openstack_username, openstack_tenant_id (password), and
244 openstack_api_key are user's credentials to access the
245 OpenStack-based cloud.
247 **Images and flavors parameters**
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
259 To get the images in your OpenStack environment, use the following
260 OpenStack CLI command:
264 openstack image list | grep 'ubuntu'
266 To get the flavor names used in your OpenStack environment, use the
267 following OpenStack CLI command:
271 openstack flavor list
273 **Network parameters**
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
282 You can use the Google Public DNS 8.8.8.8 and 4.4.4.4 address or your internal DNS servers
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.
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.
299 DCAE spins up ONAP's data collection and analytics system in two phases.
301 The first is the launching of 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.
303 There are two groups of parameters.
305 The first group relates to the launching of DCAE VMs, including parameters such as the keystone URL and additional VM image IDs/names.
306 Hence these parameters need to be provided to DCAE.
307 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).
309 The second group of configuration parameters relate to DNS As A Service support (DNSaaS).
310 DCAE requires DNSaaS for registering its VMs into organization-wide DNS service.
311 For OpenStack, DNSaaS is provided by Designate, as mentioned above.
312 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.
313 For the latter case, a number of parameters are needed to configure MultiCloud to use the correct Designate service.
315 These parameters are described below:
319 dcae_keystone_url: PUT THE MULTIVIM PROVIDED KEYSTONE API URL HERE
320 dcae_centos_7_image: PUT THE CENTOS7 VM IMAGE NAME HERE FOR DCAE LAUNCHED CENTOS7 VM
321 dcae_domain: PUT THE NAME OF DOMAIN THAT DCAE VMS REGISTER UNDER
322 dcae_public_key: PUT THE PUBLIC KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS
323 dcae_private_key: PUT THE SECRET KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS
325 dnsaas_config_enabled: PUT WHETHER TO USE PROXYED DESIGNATE
326 dnsaas_region: PUT THE DESIGNATE PROVIDING OPENSTACK'S REGION HERE
327 dnsaas_keystone_url: PUT THE DESIGNATE PROVIDING OPENSTACK'S KEYSTONE URL HERE
328 dnsaas_tenant_name: PUT THE TENANT NAME IN THE DESIGNATE PROVIDING OPENSTACK HERE (FOR R1 USE THE SAME AS openstack_tenant_name)
329 dnsaas_username: PUT THE DESIGNATE PROVIDING OPENSTACK'S USERNAME HERE
330 dnsaas_password: PUT THE DESIGNATE PROVIDING OPENSTACK'S PASSWORD HERE
335 The ONAP platform can be instantiated via Horizon (OpenStack dashboard)
338 **Instantiation via Horizon:**
340 - Login to Horizon URL with your personal credentials
341 - Click "Stacks" from the "Orchestration" menu
342 - Click "Launch Stack"
343 - Paste or manually upload the HEAT template file (onap_openstack.yaml) in the "Template Source" form
344 - Paste or manually upload the HEAT environment file (onap_openstack.env) in the "Environment Source" form
345 - Click "Next" - Specify a name in the "Stack Name" form
346 - Provide the password in the "Password" form
349 **Instantiation via Command Line:**
351 - 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):
355 apt-get install python-dev python-pip
356 pip install python-heatclient # Install heat client
357 pip install python-openstackclient # Install the Openstack client to support multiple services
359 - Create a file (named i.e. ~/openstack/openrc) that sets all the
360 environmental variables required to access your OpenStack tenant:
364 export OS_AUTH_URL=INSERT THE AUTH URL HERE
365 export OS_USERNAME=INSERT YOUR USERNAME HERE
366 export OS_TENANT_ID=INSERT YOUR TENANT ID HERE
367 export OS_REGION_NAME=INSERT THE REGION HERE
368 export OS_PASSWORD=INSERT YOUR PASSWORD HERE
370 - Run the script from command line:
374 source ~/openstack/openrc
376 - In order to install the ONAP platform, type:
380 heat stack-create STACK_NAME -f PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE # Old HEAT client, OR
381 openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME # New Openstack client
384 .. Note The Heat template deployment may take time (up to one hour) depending on your hardware environment.
388 The HEAT template deployed the onap-dcae-bootstrap virtual machine.
390 .. Note To provide the manual tasks to configure the local environment
393 Test the installation
394 ---------------------
395 Every ONAP component offers a HealthCheck REST API. The Robot Virtual Machine (*onap-robot*) can be used to test that every components run smoothly.
396 Run the following command to perform the HealthCheck:
400 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
402 This testsuite will execute 30 tests towards the various ONAP components.
404 After the installation, it is possible to deploy the various use-cases described `ONAP wiki <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
408 If all the tests are not OK, many causes are possible.
409 Here is a simple procedure to detect where the problem occurs:
411 * Check the OpenStack Virtual Machine logs
412 * Connect to the Virtual Machine and check that the various containers are running.
414 The list of containers are described on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_
415 . In case some containers are missing, check the docker logs using the following command:
420 sudo docker logs <containerid>
422 **Portal configuration**
423 ========================
424 The current ONAP installation is using the *onap.org* domain.
425 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):
429 <onap-policy_ip> policy.api.simpledemo.onap.org
430 <onap-portal_ip> portal.api.simpledemo.onap.org
431 <onap-sdc_ip> sdc.api.simpledemo.onap.org
432 <onap-vid_ip> vid.api.simpledemo.onap.org
433 <onap-aai-inst1_ip> aai.api.simpledemo.onap.org
434 <onap-aai-inst2_ip> aai.ui.simpledemo.onap.org
437 You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line:
441 openstack server list
443 Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
445 Various users are predefined as presented in the following table:
457 The password is *demo123456!*
459 Go to the `Portal component user guide <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/index.html>`_
461 Other UI documentation:
462 - `CLAMP <http://onap.readthedocs.io/en/latest/submodules/clamp.git/docs/index.html>`_
463 - `SDC <http://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html>`_
464 - `UI Use-Case <http://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/index.html>`_
470 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>`_
472 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
473 http://creativecommons.org/licenses/by/4.0