v5.5.0

Version Summary

Version Number : v5.5.0 [tag: v5.5.0]
Date: 28-March-2024

Projects / Repos Included in this release: IUDX Resource Server Proxy, IUDX Deployment and installation, IUDX's Documentation

Release Summary :

India Urban Data Exchange (IUDX) | Resource Server Proxy v5.5.0 is released with enhanced features.

Highlights:

• Data access using Async APIs
• Consent and Data Logging
• End to End encryption
• Updated Software Client libraries
• Updated Auditing Flow
• Updated Software Testing
  • Updated Postman Collection
  • Included REST Assured based integration testing
  • Improved test coverage
• Software License:
  • With this release, all IUDX Softwares will be distributed under Apache 2.0 License

API Docs

The api docs can be found here.

How to use the Release:

External Dependencies Installation

The resource server proxy connects with various external dependencies namely

• ELK stack
• PostgreSQL
• ImmuDB

Once the above setup is ready as mentioned in the deployment, you can install the IUDX Resource Server Proxy.

Docker based Installation

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 Installation

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

JAR based Installation

1. Install java 11 and maven
2. Use maven to package the application as a JAR
   mvn clean package -Dmaven.test.skip=true
3. 2 JAR files would be generated in the target/ directory
   • iudx.rs.proxy-cluster-0.0.1-SNAPSHOT-fat.jar - clustered vert.x containing micrometer metrics
   • iudx.rs.proxy-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.rs.proxy-cluster-0.0.1-SNAPSHOT-fat.jar --host $(hostname) -c configs/config.json -m iudx.rs.proxy.database.DatabaseVerticle,iudx.rs.proxy.authenticator.AuthenticationVerticle ,iudx.rs.proxy.metering.MeteringVerticle,iudx.rs.proxy.database.postgres.PostgresVerticle

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

e.g.

$ export RS_JAVA_OPTS="-Xmx4096m"
$ java $RS_JAVA_OPTS -jar target/iudx.rs.proxy-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.rs.[proxy]-dev-0.0.1-SNAPSHOT-fat.jar -c configs/config.json

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

e.g.

$ export RS_JAVA_OPTS="-Xmx1024m"
$ java $RS_JAVA_OPTS -jar target/iudx.rs.proxy-dev-0.0.1-SNAPSHOT-fat.jar ...

Enabling Data Encryption in transit

All the count and search APIs have a feature to get encrypted data.
The user could provide a publicKey in the header, with the value that is generated from lazySodium sealed box or PyNaCl sealed box.
The header value should be in url-safe base64 format.
The encrypted data could be decrypted using the lazysodium sealed box by supplying the private and public key.

License

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

Issues and Suggestions

Any Release related issues/suggestions, please raise here
For all other issues/suggestions related specific projects, please raise them to the respective project repo/issues.

What's Changed

• modification in adaptor code(python file) by @ankitmashu in #57
• Adex : consent logs for adex RSP by @ananjaykumar2 in #56
• api_docs updated with async api by @ankitmashu in #59
• Updated adaptor code by @ankitmashu in #60
• Enhancement/async api by @ananjaykumar2 in #58
• Adapter file for surat-itms data by @Kranthi-Guribilli in #61
• Adapter code for pune- flood data by @DivyaSreeMunagavalasa in #62
• Example config file by @DivyaSreeMunagavalasa in #67
• Modify/pii access policy by @ananjaykumar2 in #69
• removed catalogueSeverce uses by @ananjaykumar2 in #70
• fixed: null value for ppbNumber by @ananjaykumar2 in #73
• pom update by @ankitmashu in #74
• Software updates by @Kranthi-Guribilli in #72
• improved checkstyle and pmd by @ankitmashu in #76
• License information update by @sushanthakumar in #68
• Resolve adapter-script issue in handling time formats by @Kranthi-Guribilli in #77
• rs-proxy jenkins pipeline by @pranavv0 in #71
• Readme with pipeline badges by @pranavv0 in #78

New Contributors

• @Kranthi-Guribilli made their first contribution in #61
• @DivyaSreeMunagavalasa made their first contribution in #62
• @sushanthakumar made their first contribution in #68
• @pranavv0 made their first contribution in #71

Full Changelog: v5.0.0...v5.5.0