Documentation for MSB

Architecture,delivery,ui,installation,log,release note.

Issue-Id: MSB-80, MSB-81, MSB-82
Change-Id: I90d40a3cff37bb0c513551f79ec401bc16463b7c
Signed-off-by: HuabingZhao <zhao.huabing@zte.com.cn>

6 files changed, 85 insertions, 27 deletions

diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst
index f90d8bc..9fd6b0a 100644
--- a/docs/platform/architecture.rst
+++ b/docs/platform/architecture.rst
@@ -8,6 +8,7 @@ MSB itself doesn’t depend on a specific environment. It can work in any bare m
 MSB mainly comprises three parts: Discovery, API Gateway and MSB Client SDK. MSB also provide a swagger SDK which could generate swagger REST service description files.
 
 .. image:: images/msb-architecture.png
+
 Registry is the storage of service information, MSB leverage Consul as the service registry.
 MSB Discovery provides REST APIs for service discovery and registration.
 Service Gateway provides service request routing, load balancing and centralized Auth. It can be deployed as external Gateway or Internal Gateway.
diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst
index 27b3770..4ce3f68 100644
--- a/docs/platform/delivery.rst
+++ b/docs/platform/delivery.rst
@@ -6,4 +6,12 @@ Delivery
 
 Describe how functions are packaged into run-time components. For some components a block diagram may be useful.
 
-**TO BE DONE**
\ No newline at end of file
+:Docker:
+ - MSB Discovery
+ - MSB API Gateway
+Docker containers can be downloaded from ONAP docker repository https://nexus3.onap.org/.
+ 
+:jar:
+ - MSB Client SDK
+ - Swagger SDK
+Jars can be downloaded from ONAP docker repository https://nexus.onap.org/.
diff --git a/docs/platform/human-interfaces.rst b/docs/platform/human-interfaces.rst
index e8501d0..c7e45f0 100644
--- a/docs/platform/human-interfaces.rst
+++ b/docs/platform/human-interfaces.rst
@@ -3,13 +3,17 @@
 
 Human Interfaces
 ----------------
-Provide info on the targeted user, interface types, ports/protocols to access, etc.
+MSB provides a Web GUI Portal for users.
+Users can register services and browse all the registered services. If the registered service support swagger, user can see the REST API documentation and test the registered services via the swagger UI integrated in MSB.
 
 Target Users
 ^^^^^^^^^^^^
+ONAP Administrator.
 
 Interface Type
 ^^^^^^^^^^^^^^
+Web GUI.
 
 Access
-^^^^^^
\ No newline at end of file
+^^^^^^
+Http://MSB_API_GATEWAY_IP:80/msb
\ No newline at end of file
diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst
index 5181980..e433961 100644
--- a/docs/platform/installation.rst
+++ b/docs/platform/installation.rst
@@ -8,42 +8,80 @@ Run MSB on the a single host using host network
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This deployment approach is only for testing. MSB is consist of multiple microservices, for testing, the easiest way is to run them in the same host by using host network.  
-1. Run the Consul dockers.
-sudo docker run -d --net=host --name msb_consul consul 
 
-2. Run the MSB dockers.
-Login the ONAP docker registry first: docker login -u docker -p docker nexus3.onap.org:10001
+- Run the Consul dockers
 
-sudo docker run -d --net=host --name msb_discovery nexus3.onap.org:10001/onap/msb/msb_discovery
-sudo docker run -d --net=host -e "ROUTE_LABELS=visualRange:1" --name msb_internal_apigateway nexus3.onap.org:10001/onap/msb/msb_apigateway
-3. Explore the MSB portal.
-http://127.0.0.1/msb
+::
 
-4. Register your REST service to MSB via curl
-For testing, we can register the services via curl. MSB is working with OOM team to register the services automatically when deploying the ONAP components.
-curl -X POST \
--H "Content-Type: application/json" \
--d '{"serviceName": "aai", "version": "v8", "url": "/aai/v8","protocol": "REST", "path": "/aai/v8", "nodes": [ {"ip": "10.74.215.65","port": "8443"}]}' \
-"http://127.0.0.1:10081/api/microservices/v1/services”
+  sudo docker run -d --net=host --name msb_consul consul 
 
-5.Access the rest service via api gateway
-curl http://127.0.0.1/api/aai/v8/cloud-infrastructure/cloud-regions
+- Run the MSB dockers
+
+Login the ONAP docker registry first: 
+
+::
+
+  docker login -u docker -p docker nexus3.onap.org:10001
+
+Run MSB dockers
+
+::
+
+  docker run -d --net=host --name msb_discovery nexus3.onap.org:10001/onap/msb/msb_discovery
+  docker run -d --net=host -e "ROUTE_LABELS=visualRange:1" --name msb_internal_apigateway nexus3.onap.org:10001/onap/msb/msb_apigateway
+
+- Register your REST service to MSB via curl
+
+For testing, we can register the services via curl. 
+
+::
+
+    curl -X POST \
+    -H "Content-Type: application/json" \
+    -d '{"serviceName": "aai", "version": "v8", "url": "/aai/v8","protocol": "REST", "path": "/aai/v8", "nodes": [ {"ip": "10.74.215.65","port": "8443"}]}' \
+    "http://127.0.0.1:10081/api/microservices/v1/services”
+
+- Access the rest service via api gateway
+
+::
+
+    curl http://127.0.0.1/api/aai/v8/cloud-infrastructure/cloud-regions
+
+- Browse the registered services
+
+  Open MSB Web GUI portal in your browser: http://127.0.0.1/msb, you can see all the registered services. If the registered service support swagger, you can see the REST API documentation and test the registered services via the swagger UI integrated in MSB.
 
 Run MSB using default docker network
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 In case that you don't want to use host network to set up the MSB dockers, you need to export the port and specify the environment variables to let msb components know each other.
-1. Run the Consul dockers.
-sudo docker run -d -p 8500:8500  --name msb_consul consul 
-CONSUL_IP=`sudo docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' msb_consul`
 
-2. Run the MSB dockers.
-Login the ONAP docker registry first: docker login -u docker -p docker nexus3.onap.org:10001
+- Run the Consul dockers
+
+::
+
+    sudo docker run -d -p 8500:8500  --name msb_consul consul 
+    CONSUL_IP=`sudo docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' msb_consul`
+
+
+- Run the MSB dockers
 
-sudo docker run -d  -p 10081:10081  -e CONSUL_IP=$CONSUL_IP --name msb_discovery nexus3.onap.org:10001/onap/msb/msb_discovery
-DISCOVERY_IP=`sudo docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' msb_discovery`
-sudo docker run -d -p 80:80 -e CONSUL_IP=$CONSUL_IP -e SDCLIENT_IP=$DISCOVERY_IP -e "ROUTE_LABELS=visualRange:1" --name msb_internal_apigateway nexus3.onap.org:10001/onap/msb/msb_apigateway
+Login the ONAP docker registry first: 
+
+::
+
+  docker login -u docker -p docker nexus3.onap.org:10001
+
+Run MSB dockers
+
+::
+
+  sudo docker run -d  -p 10081:10081  -e CONSUL_IP=$CONSUL_IP --name msb_discovery nexus3.onap.org:10001/onap/msb/msb_discovery
+  DISCOVERY_IP=`sudo docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' msb_discovery`
+  sudo docker run -d -p 80:80 -e CONSUL_IP=$CONSUL_IP -e SDCLIENT_IP=$DISCOVERY_IP -e "ROUTE_LABELS=visualRange:1" --name msb_internal_apigateway nexus3.onap.org:10001/onap/msb/msb_apigateway
 
 Deploy MSB with kubernetes
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 The chart for MSB running in kubernetes cluster is available here: 
 https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/msb;h=17f8fd89791b81f1e981716dcffdb3e2e90299ae;hb=refs/heads/master
diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst
index 4bda4ba..bcabd73 100644
--- a/docs/platform/log-and-diagnostic-info.rst
+++ b/docs/platform/log-and-diagnostic-info.rst
@@ -8,6 +8,7 @@ Description of how to interact with and diagnose problems with the components as
 
 Where to Access Information
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
+You can use docker command such as docker exec or docker logs to interact with and diagnose problems of MSB.
 
 
 Error / Warning Messages
diff --git a/docs/release-notes/new-features.rst b/docs/release-notes/new-features.rst
index f548910..2bddf16 100644
--- a/docs/release-notes/new-features.rst
+++ b/docs/release-notes/new-features.rst
@@ -2,3 +2,9 @@
 
 New Features
 ------------
+ - Service Registration–RESTFul API
+ - Service Registration-OOM Registrator
+ - Service Registration-MSB SDK
+ - Service Registration-MSB GUI
+ - Service Discovery-API Gateway
+ - Service Discovery-MSB SDK