1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 http://creativecommons.org/licenses/by/4.0
11 ========================
12 **Setting Up Full ONAP**
13 ========================
15 .. _demo-installing-running-onap:
19 ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack.
21 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.
23 The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure (cf MultiCloud project).
25 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.
32 ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release.
34 The following Open Stack components must be deployed in the infrastructure:
44 To deploy OpenStack, you can use various solutions:
45 - `OpenStack installer <https://docs.openstack.org/install-guide/>`_
46 - `OPNFV Cross Community Continuous Integration - XCI installer <http://docs.opnfv.org/en/latest/infrastructure/xci.html>`_
48 *Designate* component is usually not deployed using standard OpenStack installers.
49 Please find a guide to deploy and configure *Designate*.
51 The OpenStack infrastructure must enable internet access.
55 The following table presents the mapping between the created VM and the ONAP components, and provides informtaion about he VM (flavor and image):
57 =================== ================= ======= ============
58 VM name ONAP project(s) Flavor Image
59 =================== ================= ======= ============
60 onap-aai-inst1 AAI xlarge Ubuntu 14.04
61 onap-aai-inst2 AAI/UI xlarge Ubuntu 14.04
62 onap-appc APPC, CCSDK large Ubuntu 14.04
63 onap-clamp CLAMP medium Ubuntu 16.04
64 onap-dns-server *Internal DNS* small Ubuntu 14.04
65 onap-message-router DMAAP large Ubuntu 14.04
66 onap-multi-service MSB, VF-C, VNFSDK xxlarge Ubuntu 16.04
67 onap-policy Policy xlarge Ubuntu 14.04
68 onap-portal Portal, CLI large Ubuntu 14.04
69 onap-robot Integration medium Ubuntu 16.04
70 onap-sdc SDC xlarge Ubuntu 16.04
71 onap-sdnc SDNC, CCSDK large Ubuntu 14.04
72 onap-so SO large Ubuntu 16.04
73 onap-vid VID medium Ubuntu 14.04
74 onap-dcae-bootstrap DCAE, Holmes small Ubuntu 14.04
75 dcaeorcl00 DCAE/Orchestr. medium CentOS 7
76 dcaecnsl00 DCAE/Consul medium Ubuntu 16.04
77 dcaecnsl01 DCAE/Consul medium Ubuntu 16.04
78 dcaecnsl02 DCAE/Consul medium Ubuntu 16.04
79 dcaedokp00 DCAE/Policy Hand. medium Ubuntu 16.04
80 dcaedoks00 DCAE/VES, Holmes medium Ubuntu 16.04
81 dcaepgvm00 DCAE/Postrges medium Ubuntu 16.04
82 dcaecdap00 DCAE/CDAP large Ubuntu 16.04
83 dcaecdap01 DCAE/CDAP large Ubuntu 16.04
84 dcaecdap02 DCAE/CDAP large Ubuntu 16.04
85 dcaecdap03 DCAE/CDAP large Ubuntu 16.04
86 dcaecdap04 DCAE/CDAP large Ubuntu 16.04
87 dcaecdap05 DCAE/CDAP large Ubuntu 16.04
88 dcaecdap06 DCAE/CDAP large Ubuntu 16.04
89 =================== ================= ======= ============
93 The ONAP installation requires the following footprint:
100 .. Note: the default flavor size may be optimized. The ONAP community is working to provide adpted flavors for basic ONAP installation.
102 .. Note: you should also reserve some resourcse for the VNFs to be deployed.
106 The following artifacts must be deployed on the OpenStack infrastructure.
107 - a public SSH key to access the various VM
108 - private SSH key and public key SSH key for the DCAE VM
112 - Set of flavors: small, medium, large, medium, large, xlarge, xxlarge
114 .. Note that floating IP may be private IP.
116 .. Note Basic flavors can reuse the default flavors as defined by `OpenStack <https://docs.openstack.org/horizon/latest/admin/manage-flavors.html>`_
117 The xxlarge flavor should be confiured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage.
121 The default installation assumes that the Default security group is configured to enable full access between the ONAP components.
122 Depending on your environment, we may need to open some security groups (eg when using the portal from your desktop).
124 The following tables presents the ports exposed by the various components:
133 - To deploy ONAP, use the Heat template and follow the described guidelines in `Integration project <http://onap.readthedocs.io/en/latest/submodules/integration.git/docs/index.html>`_
135 - The Heat template deployment may take time (up to one hour) depending on your hardware environment.
137 Test the installation
138 ---------------------
139 Every ONAP component offers a HealthCheck REST API. The *Robot Virtual Machine* can be used to test that every components run smoothly.
140 Run the following command to perform the HealthCheck:
144 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
146 This testsuite will execute 31 tests towards the various ONAP components.
150 If all the tests are not OK, many causes are possible.
151 Here is a simple procedure to detect where the problem occurs:
153 * Check the OpenStack Virtual Machine logs
154 * Connect to the Virtual Machine and check that the various containers are running.
156 The list of containers are described in the following section. In case some containers are missing, check the docker logs using the following command:
161 sudo docker logs <containerid>
164 **Portal configuration**
165 ========================
166 The current ONAP installation is using the *onap.org* domain.
167 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):
171 <onap-policy_ip> policy.api.simpledemo.onap.org
172 <onap-portal_ip> portal.api.simpledemo.onap.org
173 <onap-sdc_ip> sdc.api.simpledemo.onap.org
174 <onap-vid_ip> vid.api.simpledemo.onap.org
175 <onap-aai-inst1_ip> aai.api.simpledemo.onap.org
176 <onap-aai-inst2_ip> aai.ui.simpledemo.onap.org
179 You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line:
183 openstack server list
185 Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
187 Various users are predefined as presented in the following table:
199 The password is *demo123456!*
201 Go to the `Portal component user guide <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/index.html>`_
203 Other UI documentation:
204 - `CLAMP <http://onap.readthedocs.io/en/latest/submodules/clamp.git/docs/index.html>`_
205 - `SDC http://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html>`_
206 - `UI Use-Case <http://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/index.html>`_
212 The following table presents the list of containers for every Virtual Machine
215 :header: Virtual Machine, Container, Description
218 onap-appc,sdnc_dgbuilder_container
219 ,appc_controller_container
222 TODO: list all the containers
224 TODO: update the deployment figure available on the wiki ?
226 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
227 http://creativecommons.org/licenses/by/4.0