Skip to content

v1.1.0

Latest
Latest

Choose a tag to compare

View all tags
@swaminathanvasanth swaminathanvasanth released this 15 Nov 07:04
· 21 commits to main since this release
v1.1.0
c10968b
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Version Summary

Version Number : v1.1.0 [tag: v1.1.0]
Date: 15-November-2024

Projects / Repos Included in this release: DX DMP APD Server, DX Deployment and installation, DX's Documentation

Release Summary :

Data Exchange DMP APD Server v1.1.0 is released with the following enhancements

  • Included wiki with extended documentation for the following
    • Architecture
    • Usage guides
    • Configuration Mapping
    • Prerequisites
  • Updated Verify Policy
  • Added JWT leeway to allow time synchronization
  • Software License:

Test Reports:

Please find the release test details and reports [here] (https://jenkins.iudx.io/job/iudx%20DMP%20APD%20(master)%20pipeline/81/)

External Dependencies Installation

DMP APD Server uses the following external dependencies

  • PostgreSQL
  • RabbitMQ

Find the installations of the above along with the configurations to modify the database url, port and associated credentials in the appropriate sections here

Getting Started

Docker Based

  1. Install docker and docker-compose
  2. Clone this repo
  3. Build the images
    ./docker/build.sh
  4. Modify the docker-compose.yml file to map the config file you just created
  5. Start the server in production (prod) or development (dev) mode using docker-compose
    docker-compose up prod

Maven Based

  1. Install java 11 and maven
  2. Use the maven exec plugin based starter to start the server
    mvn clean compile exec:java@rs-apd-server

JAR based

  1. Install java 11 and maven
  2. Set Environment variables
export DMP_APD_URL=https://<dmp-apd-domain-name>
export LOG_LEVEL=INFO
  1. Use maven to package the application as a JAR
    mvn clean package -Dmaven.test.skip=true
  2. 2 JAR files would be generated in the target/ directory
    • iudx.data.marketplace-cluster-0.0.1-SNAPSHOT-fat.jar - clustered vert.x containing micrometer metrics
    • iudx.data.marketplace-dev-0.0.1-SNAPSHOT-fat.jar - non-clustered vert.x and does not contain micrometer metrics

Running the clustered JAR

Note: The clustered JAR requires Zookeeper to be installed. Refer here to learn more about how to set up Zookeeper. Additionally, the zookeepers key in the config being used needs to be updated with the IP address/domain of the system running Zookeeper.

The JAR requires 3 runtime arguments when running:

  • --config/-c : path to the config file
  • --hostname/-i : the hostname for clustering
  • --modules/-m : comma separated list of module names to deploy

e.g. java -jar target/iudx.data.marketplace-cluster-0.0.1-SNAPSHOT-fat.jar --host $(hostname) -c secrets/all-verticles-configs/config-dev.json -m iudx.data.marketplace.postgres.PostgresVerticle,iudx.data.marketplace.product.ProductVerticle ,iudx.data.marketplace.authenticator.AuthenticationVerticle ,iudx.data.marketplace.consumer.ConsumerVerticle,iudx.data.marketplace.auditing.AuditingVerticle

Use the --help/-h argument for more information. You may additionally append an DMP_APD_JAVA_OPTS environment variable containing any Java options to pass to the application.

e.g.

$ export DMP_APD_JAVA_OPTS="-Xmx4096m"
$ java $DMP_APD_JAVA_OPTS -jar target/iudx.data.marketplace-cluster-0.0.1-SNAPSHOT-fat.jar ...

Running the non-clustered JAR

The JAR requires 1 runtime argument when running:

  • --config/-c : path to the config file

e.g. java -Dvertx.logger-delegate-factory-class-name=io.vertx.core.logging.Log4j2LogDelegateFactory -jar target/iudx.data.marketplace-dev-0.0.1-SNAPSHOT-fat.jar -c secrets/all-verticles-configs/config-dev.json

Use the --help/-h argument for more information. You may additionally append an DMP_APD_JAVA_OPTS environment variable containing any Java options to pass to the application.

e.g.

$ export DMP_APD_JAVA_OPTS="-Xmx1024m"
$ java $DMP_APD_JAVA_OPTS -jar target/iudx.data.marketplace-dev-0.0.1-SNAPSHOT-fat.jar ...

License

With this release, all DX Softwares will be distributed under Apache 2.0 License

What's Changed

Full Changelog: v1.0.0...v1.1.0

Contributors

tanvi029, shreelakshmijoshi, and karthickp432001
Assets 2
Loading