Refactor cloud region registration logic
[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\r
23 ^^^^^^^^^^^^^^^^^^^^^^^\r
24 \r
25 Login the ONAP docker registry first: sudo docker login -u docker -p docker nexus3.onap.org:10001\r
26 \r
27 sudo docker pull nexus3.onap.org:10001/onap/aai/esr-server:latest\r
28 \r
29 sudo docker run -i -t -d -p 9518:9518 -e MSB_ADDR=${MSB_SERVER_IP}:80 --name esr_server nexus3.onap.org:10001/onap/aai/esr-server:latest\r
30 \r
31 Run esr-gui docker\r
32 ^^^^^^^^^^^^^^^^^^^^^^^\r
33 \r
34 sudo docker pull nexus3.onap.org:10001/onap/aai/esr-gui:latest\r
35 \r
36 docker run -i -t -d -p 9519:8080 -e MSB_ADDR=${MSB_SERVER_IP}:80 --name esr_gui nexus3.onap.org:10001/onap/aai/esr-gui:latest\r
37 \r
38 Check status of ESR\r
39 ^^^^^^^^^^^^^^^^^^^^^^^\r
40 \r
41 Test whether esr-server is running:\r
42 \r
43 GET  https://ESR_SERVICE_IP:9518/api/aai-esr-server/v1/test \r
44 \r
45 The returned status should be 200.
46
47 Visit ESR portal:
48
49 http://ESR_SERVER_IP:9519/esr-gui/extsys/vnfm/vnfmView.html
50
51 http://ESR_SERVER_IP:9519/esr-gui/extsys/sdncontroller/sdncView.html
52
53 http://ESR_SERVER_IP:9519/esr-gui/extsys/vim/vimView.html
54
55 http://ESR_SERVER_IP:9519/esr-gui/extsys/ems/emsView.html
56
57 A&AI register to MSB
58 ^^^^^^^^^^^^^^^^^^^^^^^
59
60 NOTE: The way bellow is register to MSB by hand, it is a temporary method. Later it will be registered automatic by MSB.
61
62 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"
63
64 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"
65
66 MultiCloud register to MSB
67 ^^^^^^^^^^^^^^^^^^^^^^^
68
69 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"
70
71 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "multicloud", "version": "v1", "url": "/api/multicloud/v1","protocol": "REST",  "nodes": [ {"ip": "'$MultiCloud_IP'","port": "9001"}]}' "http://$MSB_SERVER_IP:10081/api/microservices/v1/services"
72
73 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"
74
75 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "multicloud-vio", "version": "v1", "url": "/api/multicloud-vio/v1","protocol": "REST",  "nodes": [ {"ip": "'$MultiCloud_IP'","port": "9004"}]}' "http://$MSB_SERVER_IP:10081/api/microservices/v1/services"
76
77 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"
78
79 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "multicloud-ocata", "version": "v1", "url": "/api/multicloud-ocata/v1","protocol": "REST",  "nodes": [ {"ip": "'$MultiCloud_IP'","port": "9006"}]}' "http://$MSB_SERVER_IP:10081/api/microservices/v1/services"
80
81 [Note: serviceName "multicloud-titanium_cloud" is depreciated from ONAP Casablanca Release]
82 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"
83
84 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "multicloud-titaniumcloud", "version": "v0", "url": "/api/multicloud-titaniumcloud/v0","protocol": "REST",  "nodes": [ {"ip": "'$MultiCloud_IP'","port": "9005"}]}' "http://$MSB_SERVER_IP:10081/api/microservices/v1/services"
85
86 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "multicloud-titaniumcloud", "version": "v1", "url": "/api/multicloud-titaniumcloud/v1","protocol": "REST",  "nodes": [ {"ip": "'$MultiCloud_IP'","port": "9005"}]}' "http://$MSB_SERVER_IP:10081/api/microservices/v1/services"
87
88 ESR register to MSB\r
89 ^^^^^^^^^^^^^^^^^^^^^^^\r
90 \r
91 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "aai-esr-server", "version": "v1", "url": "/api/aai-esr-server/v1","protocol": "REST", "enable_ssl":"true", "visualRange":"1", "nodes": [ {"ip": "ESR_SERVER_IP","port": "9518"}]}' "http://MSB_SERVER_IP:10081/api/microservices/v1/services"\r
92 \r
93 curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "aai-esr-gui", "version": "v1", "url": "/esr-gui","path": "/iui/aai-esr-gui","protocol": "UI",  "nodes": [ {"ip": "ESR_SERVER_IP","port": "9519"}]}' "http://MSB_SERVER_IP:10081/api/microservices/v1/services"
94
95 ESR usage
96 ^^^^^^^^^^^^^^^^^^^^^^^
97
98 Visit ESR portal to manage the external systems.
99
100 http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/vnfm/vnfmView.html
101
102 http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/sdncontroller/sdncView.html
103
104 http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/vim/vimView.html
105
106 http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/ems/emsView.html