AAI-esr-server
------------------------------------------------
-ESR provide a way to register external system which not included in ONAP system, mainly inclouded VIM/VNFM/EMS/thirdparty SDNC. esr-server as the backend of exteral system register service mainly include the system register information preprocessing, system available check.
+ESR provide a way to register external system which not included in ONAP system, mainly inclouded VIM/VNFM/EMS/thirdparty SDNC. esr-server as the backend of external system register service mainly include the system register information preprocessing, system available check.
ESR comprises two modules: the esr server module and the esr gui module. And both esr service and esr gui belongs A&AI.
--- /dev/null
+ESR server Component Offered APIs
+==================================
+The esr server module provides the following APIs.
+
+* VIM register
+* VIM query
+* VIM update
+* VIM Deletion
+* VNFM register
+* VNFM query
+* VNFM update
+* VNFM Deletion
+* EMS register
+* EMS query
+* EMS update
+* EMS Deletion
+* thirdparty SDNC register
+* thirdparty SDNC query
+* thirdparty SDNC update
+* thirdparty SDNC Deletion
+
+
Multi-Cloud
^^^^^^^^^^^
-ESR will call the API from Multi-Cloud to update the cloud-region infomation after put the VIM data to A&AI.
+ESR will call the API from Multi-Cloud to update the cloud-region information after put the VIM data to A&AI.
#. Update VIM Info:
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 runing:
-
-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:
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": "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": "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
^^^^^^^^^^^^^^^^^^^^^^^
* [AAI-225] - aai/esr-server daily build failed
* [AAI-278] - AAI throws exception about mismatch keys adding esr-system-info to cloud-region
* [AAI-377] - esr-gui docker build failed
-* [AAI-393] - The jjb defiend in a error way that cause CSIT build failed.
+* [AAI-393] - The jjb defined in a error way that cause CSIT build failed.
* [AAI-398] - If a cloud-region didn't contain a external system info, there will be an null pointer error
* [AAI-400] - Register ServiceTest to microservice
* [AAI-407] - There is an error to startup esr-gui docker
Task
^^^^
-* [AAI-67] - Upload the server-end seed code to ONAP repostory
+* [AAI-67] - Upload the server-end seed code to ONAP repository
* [AAI-68] - Upload the ESR gui seed code to ONAP repository
* [AAI-69] - Remove the original SDNC related function from Amsterdan release.
* [AAI-70] - Collect the schema of ESR for ONAP in Amsterdam release
* [AAI-358] - Change util method from static to unstatic
* [AAI-359] - Fix the return data of del and query list API
* [AAI-360] - Realize delete vim API
-* [AAI-361] - Update VIM after register finishied.
+* [AAI-361] - Update VIM after register finished.
* [AAI-362] - Clean the Config files
* [AAI-363] - Add unit test for app configuration
* [AAI-365] - change the objectToString method to un-static
</modules>
<properties>
- <dropwizard.version>1.2.2</dropwizard.version>
+ <dropwizard.version>1.3.0</dropwizard.version>
<swagger.version>1.5.3</swagger.version>
<jersey.version>2.16</jersey.version>
<jaxrs.consumer.version>5.0</jaxrs.consumer.version>
<win64outputdir>target/assembly/${win64id}</win64outputdir>
<version.output>target/version</version.output>
<aai.esr.server.project.version>${project.version}</aai.esr.server.project.version>
- <maven.build.timestamp.format>yyMMdd-HHmmss</maven.build.timestamp.format>
+ <maven.build.timestamp.format>yyyyMMdd'T'HHmmss'Z'</maven.build.timestamp.format>
</properties>
<build>
<plugins>
<groupId>io.fabric8</groupId>
<artifactId>docker-maven-plugin</artifactId>
<version>0.16.5</version>
+ <dependencies>
+ <dependency>
+ <groupId>com.github.jnr</groupId>
+ <artifactId>jnr-unixsocket</artifactId>
+ <version>0.13</version>
+ </dependency>
+ </dependencies>
<inherited>false</inherited>
<configuration>
<images>
<dockerFile>${basedir}/target/version/Dockerfile</dockerFile>
<tags>
<tag>${project.version}</tag>
- <tag>${project.version}-STAGING-${maven.build.timestamp}</tag>
+ <tag>${project.version}-${maven.build.timestamp}</tag>
<tag>${project.docker.latesttag.version}</tag>
</tags>
</build>
RUN apt-get install -y openjdk-8-jdk
#configure the JDK
-RUN sed -i 's|#networkaddress.cache.ttl=-1|networkaddress.cache.ttl=10|' /usr/lib/jvm/java-8-openjdk-amd64/jre/lib/security/java.security
-ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64
-ENV PATH $PATH:/usr/lib/jvm/java-8-openjdk-amd64/jre/bin:/usr/lib/jvm/java-8-openjdk-amd64/bin
+RUN sed -i 's|#networkaddress.cache.ttl=-1|networkaddress.cache.ttl=10|' /usr/lib/jvm/java-8-openjdk-$(dpkg --print-architecture)/jre/lib/security/java.security
+ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-$(dpkg --print-architecture)
+ENV PATH $PATH:/usr/lib/jvm/java-8-openjdk-$(dpkg --print-architecture)/jre/bin:/usr/lib/jvm/java-8-openjdk-$(dpkg --print-architecture)/bin
ENV CLASSPATH .:${JAVA_HOME}/lib:${JRE_HOME}/lib
ENV JRE_HOME ${JAVA_HOME}/jre
MSB_PORT=`echo $MSB_ADDR | cut -d: -f 2`
sed -i "s|msbDiscoveryIp.*|msbDiscoveryIp: $MSB_IP|" /home/esr/conf/extsys.yml
-sed -i "s|msbServerAddr.*|msbServerAddr: http://$MSB_IP:443|" /home/esr/conf/extsys.yml
+sed -i "s|msbServerAddr.*|msbServerAddr: http://$MSB_IP|" /home/esr/conf/extsys.yml
cat /home/esr/conf/extsys.yml