Refactor cloud region registration logic

[aai/esr-server.git] / docs / platform / installation.rst

diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst
index 6959d04..6282830 100644 (file)
--- a/docs/platform/installation.rst
+++ b/docs/platform/installation.rst
@@ -19,25 +19,29 @@ sudo apt-get install -y docker-engine
 
 docker ps
 
-Run esr-server docker
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Login the ONAP docker registry first: sudo docker login -u docker -p docker nexus3.onap.org:10001
-
-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
-
-Run esr-gui docker
-^^^^^^^^^^^^^^^^^^^^^^^
-
-sudo docker run -p  9519:8080 -d --net=host --name esr-gui nexus3.onap.org:10001/onap/aai/esr-gui
-
-Check status of ESR
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Test whether esr-server is running:
-
-GET  http://ESR_SERVICE_IP:9518/api/aai-esr-server/v1/test 
-
+Run esr-server docker\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Login the ONAP docker registry first: sudo docker login -u docker -p docker nexus3.onap.org:10001\r
+\r
+sudo docker pull nexus3.onap.org:10001/onap/aai/esr-server:latest\r
+\r
+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
+\r
+Run esr-gui docker\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+sudo docker pull nexus3.onap.org:10001/onap/aai/esr-gui:latest\r
+\r
+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
+\r
+Check status of ESR\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Test whether esr-server is running:\r
+\r
+GET  https://ESR_SERVICE_IP:9518/api/aai-esr-server/v1/test \r
+\r
 The returned status should be 200.
 
 Visit ESR portal:
@@ -64,18 +68,29 @@ MultiCloud register to MSB
 
 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"
 
+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"
+
 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"
 
+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"
+
 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"
 
+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"
+
+[Note: serviceName "multicloud-titanium_cloud" is depreciated from ONAP Casablanca Release]
 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"
 
-ESR register to MSB
-^^^^^^^^^^^^^^^^^^^^^^^
+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"
 
-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"
+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"
 
-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"
+ESR register to MSB\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+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
+\r
+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"
 
 ESR usage
 ^^^^^^^^^^^^^^^^^^^^^^^
@@ -88,4 +103,4 @@ http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/sdncontroller/sdncView.html
 
 http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/vim/vimView.html
 
-http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/ems/emsView.html
\ No newline at end of file
+http://MSB_SERVER_IP:80/iui/aai-esr-gui/extsys/ems/emsView.html