Update architecture diagram
[aai/esr-server.git] / docs / platform / installation.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3
4 Installation
5 ------------
6
7 Install docker
8 ^^^^^^^^^^^^^^^^^^^^^^^
9
10 sudo apt-add-repository 'deb https://apt.dockerproject.org/repo ubuntu-xenial main'
11
12 sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
13
14 sudo apt-get update
15
16 apt-cache policy docker-engine
17
18 sudo apt-get install -y docker-engine
19
20 docker ps
21
22 Run esr-server docker
23 ^^^^^^^^^^^^^^^^^^^^^^^
24
25 Login the ONAP docker registry first: sudo docker login -u docker -p docker nexus3.onap.org:10001
26
27 sudo docker run -p  9518:9518 -d --net=host --name esr-server -e MSB_ADDR=${MSB_SERVER_IP}:80 nexus3.onap.org:10001/onap/aai/esr-server
28
29 Run esr-gui docker
30 ^^^^^^^^^^^^^^^^^^^^^^^
31
32 sudo docker run -p  9519:8080 -d --net=host --name esr-gui nexus3.onap.org:10001/onap/aai/esr-gui
33
34 Check status of ESR
35 ^^^^^^^^^^^^^^^^^^^^^^^
36
37 Test whether esr-server is runing:
38
39 GET  http://ESR_SERVICE_IP:9518/api/aai-esr-server/v1/test 
40
41 The returned status should be 200.
42
43 Visit ESR portal:
44
45 http://ESR_SERVER_IP:9519/esr-gui/extsys/vnfm/vnfmView.html
46
47 http://ESR_SERVER_IP:9519/esr-gui/extsys/sdncontroller/sdncView.html
48
49 http://ESR_SERVER_IP:9519/esr-gui/extsys/vim/vimView.html
50
51 http://ESR_SERVER_IP:9519/esr-gui/extsys/ems/emsView.html
52
53 A&AI register to MSB
54 ^^^^^^^^^^^^^^^^^^^^^^^
55
56 NOTE: The way bellow is register to MSB by hand, it is a temporary method. Later it will be registered automatic by MSB.
57
58 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "aai-cloudInfrastructure", "version": "v11", "url": "/aai/v11/cloud-infrastructure","protocol": "REST", "enable_ssl":"true", "visualRange":"1", "nodes": [ {"ip": "A&AI_SERVER_IP","port": "8443"}]}' "http://MSB_SERVER_IP:10081/api/microservices/v1/services"
59
60 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "aai-externalSystem", "version": "v11", "url": "/aai/v11/external-system","protocol": "REST", "enable_ssl":"true", "visualRange":"1", "nodes": [ {"ip": "A&AI_SERVER_IP","port": "8443"}]}' "http://MSB_SERVER_IP:10081/api/microservices/v1/services"
61
62 MultiCloud register to MSB
63 ^^^^^^^^^^^^^^^^^^^^^^^
64
65 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "multicloud", "version": "v0", "url": "/api/multicloud/v0","protocol": "REST",  "nodes": [ {"ip": "'$MultiCloud_IP'","port": "9001"}]}' "http://$MSB_SERVER_IP:10081/api/microservices/v1/services"
66
67 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "multicloud-vio", "version": "v0", "url": "/api/multicloud-vio/v0","protocol": "REST",  "nodes": [ {"ip": "'$MultiCloud_IP'","port": "9004"}]}' "http://$MSB_SERVER_IP:10081/api/microservices/v1/services"
68
69 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "multicloud-ocata", "version": "v0", "url": "/api/multicloud-ocata/v0","protocol": "REST",  "nodes": [ {"ip": "'$MultiCloud_IP'","port": "9006"}]}' "http://$MSB_SERVER_IP:10081/api/microservices/v1/services"
70
71 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "multicloud-titanium_cloud", "version": "v0", "url": "/api/multicloud-titanium_cloud/v0","protocol": "REST",  "nodes": [ {"ip": "'$MultiCloud_IP'","port": "9005"}]}' "http://$MSB_SERVER_IP:10081/api/microservices/v1/services"
72
73 ESR register to MSB
74 ^^^^^^^^^^^^^^^^^^^^^^^
75
76 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "aai-esr-server", "version": "v1", "url": "/api/aai-esr-server/v1","protocol": "REST", "visualRange":"1", "nodes": [ {"ip": "ESR_SERVER_IP","port": "9518"}]}' "http://MSB_SERVER_IP:10081/api/microservices/v1/services"
77
78 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "aai-esr-gui", "url": "/esr-gui","protocol": "UI", "visualRange":"1", "path":"/iui/aai-esr-gui", "nodes": [ {"ip": "ESR_SERVER_IP","port": "9519"}]}' "http://MSB_SERVER_IP:10081/api/microservices/v1/services"
79
80 ESR usage
81 ^^^^^^^^^^^^^^^^^^^^^^^
82
83 Visit ESR portal to manage the external systems.
84
85 http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/vnfm/vnfmView.html
86
87 http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/sdncontroller/sdncView.html
88
89 http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/vim/vimView.html
90
91 http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/ems/emsView.html