Mosip-37948 corrected version and readme for release. (#1389)

* MOSIP-37357 Corrected readme (#1375) * MOSIP-37357 Corrected readme Signed-off-by: kameshsr <[email protected]> * MOSIP-37357 Corrected java version Signed-off-by: kameshsr <[email protected]> * MOSIP-37357 corrected readme Signed-off-by: kameshsr <[email protected]> * MOSIP-37357 Corrected readme Signed-off-by: kameshsr <[email protected]> * MOSIP-37357 Corrected readme Signed-off-by: kameshsr <[email protected]> * MOSIP-37357 Corrected Readme Signed-off-by: kameshsr <[email protected]> --------- Signed-off-by: kameshsr <[email protected]> * MOSIP-37948 Corrected version Signed-off-by: kameshsr <[email protected]> --------- Signed-off-by: kameshsr <[email protected]>
mosip · Dec 4, 2024 · e1324ff · e1324ff
1 parent 24391dd
commit e1324ff
Show file tree

Hide file tree

Showing 14 changed files with 294 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -10,20 +10,47 @@ This repository contains source code and design documents for MOSIP ID Authentic
 Refer to [SQL scripts](db_scripts).
 
 ## Build & run (for developers)
-The project requires JDK 1.21. 
+The project requires JDK 21.0.3
+and mvn version - 3.9.6
+
+### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration
+   ```
+   hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+   ```
+This is for better compatibility with future PostgreSQL versions.
+
+### Configure ANT Path Matcher for Spring Boot 3.x compatibility.
+   ```
+   spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
+   ```
+This is to maintain compatibility with existing ANT-style path patterns.
+
 1. Build and install:
     ```
-    $ cd kernel
+    $ cd authentication
     $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
     ```
-1. Build Docker for a service:
+2. Build Docker for a service:
     ```
     $ cd <service folder>
     $ docker build -f Dockerfile
     ```
+### Add auth-adapter in a class-path to run a services
+   ```
+   <dependency>
+       <groupId>io.mosip.kernel</groupId>
+       <artifactId>kernel-auth-adapter</artifactId>
+       <version>${kernel.auth.adapter.version}</version>
+   </dependency>
+   ```
 
 ## Configuration
-Refer to the [configuration guide](docs/configuration.md).
+[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and
+[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and
+[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and
+[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/master/id-authentication-otp-default.properties) and
+[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here.
+
 
 ## Deployment in K8 cluster with other MOSIP services:
 ### Pre-requisites
@@ -48,7 +75,7 @@ Refer to the [configuration guide](docs/configuration.md).
    ```
 
 ## Test
-Automated functional tests available in [Functional Tests repo](https://github.com/mosip/mosip-functional-tests).
+Automated functional tests available in [api-test folder](api-test).
 
 ## APIs
 API documentation is available [here](https://mosip.github.io/documentation/).

diff --git a/authentication/authentication-authtypelockfilter-impl/pom.xml b/authentication/authentication-authtypelockfilter-impl/pom.xml
@@ -4,9 +4,9 @@
 	<parent>
 		<groupId>io.mosip.authentication</groupId>
 		<artifactId>authentication-parent</artifactId>
-		<version>1.2.1-SNAPSHOT</version>
+		<version>1.3.0-SNAPSHOT</version>
 	</parent>
-	<version>1.2.1-SNAPSHOT</version>
+	<version>1.3.0-SNAPSHOT</version>
 	<artifactId>authentication-authtypelockfilter-impl</artifactId>
 	<name>authentication-authtypelockfilter-impl</name>
 	<description>ID Authentication Filter Implementation for Auth Type Lock validation</description>

diff --git a/authentication/authentication-common/pom.xml b/authentication/authentication-common/pom.xml
@@ -6,9 +6,9 @@
 	<parent>
 		<groupId>io.mosip.authentication</groupId>
 		<artifactId>authentication-parent</artifactId>
-		<version>1.2.1-SNAPSHOT</version>
+		<version>1.3.0-SNAPSHOT</version>
 	</parent>
-	<version>1.2.1-SNAPSHOT</version>
+	<version>1.3.0-SNAPSHOT</version>
 	<artifactId>authentication-common</artifactId>
 	<name>authentication-common</name>
 	<properties>

diff --git a/authentication/authentication-core/pom.xml b/authentication/authentication-core/pom.xml
@@ -6,9 +6,9 @@
 	<parent>
 		<groupId>io.mosip.authentication</groupId>
 		<artifactId>authentication-parent</artifactId>
-		<version>1.2.1-SNAPSHOT</version>
+		<version>1.3.0-SNAPSHOT</version>
 	</parent>
-	<version>1.2.1-SNAPSHOT</version>
+	<version>1.3.0-SNAPSHOT</version>
 
 	<artifactId>authentication-core</artifactId>
 	<packaging>jar</packaging>

diff --git a/authentication/authentication-filter-api/pom.xml b/authentication/authentication-filter-api/pom.xml
@@ -4,9 +4,9 @@
 	<parent>
 		<groupId>io.mosip.authentication</groupId>
 		<artifactId>authentication-parent</artifactId>
-		<version>1.2.1-SNAPSHOT</version>
+		<version>1.3.0-SNAPSHOT</version>
 	</parent>
-	<version>1.2.1-SNAPSHOT</version>
+	<version>1.3.0-SNAPSHOT</version>
 	<artifactId>authentication-filter-api</artifactId>
 	<name>authentication-filter-api</name>
 	<description>ID Authentication Filter API</description>

diff --git a/authentication/authentication-hotlistfilter-impl/pom.xml b/authentication/authentication-hotlistfilter-impl/pom.xml
@@ -4,9 +4,9 @@
 	<parent>
 		<groupId>io.mosip.authentication</groupId>
 		<artifactId>authentication-parent</artifactId>
-		<version>1.2.1-SNAPSHOT</version>
+		<version>1.3.0-SNAPSHOT</version>
 	</parent>
-	<version>1.2.1-SNAPSHOT</version>
+	<version>1.3.0-SNAPSHOT</version>
 	<artifactId>authentication-hotlistfilter-impl</artifactId>
 	<name>authentication-hotlistfilter-impl</name>
 	<description>ID Authentication Filter Implementation for Hotlist validation</description>

diff --git a/authentication/authentication-internal-service/README.md b/authentication/authentication-internal-service/README.md
@@ -8,7 +8,8 @@ Any combination of the supported [authentication types](https://docs.mosip.io/1.
 
 ## Modalities
 * Refer [biometric modalities](https://docs.mosip.io/1.2.0/biometrics#modalities).
-* Above authentication types can be allowed/disallowed/mandated by the [configuraion](../../docs/configuration.md#allowed-authentication-types) and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md).
+* Above authentication types can be allowed/disallowed/mandated by the [configuration](../../docs/configuration.md)
+  and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md).
 
 ## Endpoints
 * Internal Authentication - used by Internal MOSIP modules for authenticating an individual's UIN/VID
@@ -40,3 +41,81 @@ GET /idauthentication/v1/internal/authTransactions/individualId/{ID}
 * Bio-SDK HTTP service - for biometric authentication
 * HSM - for retrieving encryption/decryption keys.
 
+## Overview
+This repository contains source code and design documents for MOSIP ID Authentication internal service which is the server-side module to manage [ID Authentication](https://docs.mosip.io/1.2.0/modules/id-authentication-services). The modules exposes API endpoints.
+
+## Databases
+Refer to [SQL scripts](../../db_scripts).
+
+## Build & run (for developers)
+The project requires JDK 21.0.3
+and mvn version - 3.9.6
+
+### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration
+   ```
+   hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+   ```
+This is for better compatibility with future PostgreSQL versions.
+
+### Configure ANT Path Matcher for Spring Boot 3.x compatibility.
+   ```
+   spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
+   ```
+This is to maintain compatibility with existing ANT-style path patterns.
+
+1. Build and install:
+    ```
+    $ cd authentication/authentication-internal-service
+    $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
+    ```
+2. Build Docker for a service:
+    ```
+    $ cd <service folder>
+    $ docker build -f Dockerfile
+    ```
+### Add auth-adapter in a class-path to run a services
+   ```
+   <dependency>
+       <groupId>io.mosip.kernel</groupId>
+       <artifactId>kernel-auth-adapter</artifactId>
+       <version>${kernel.auth.adapter.version}</version>
+   </dependency>
+   ```
+
+## Configuration
+[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and
+[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and
+[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and
+[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here.
+
+
+## Deployment in K8 cluster with other MOSIP services:
+### Pre-requisites
+* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file:
+    ```
+    export KUBECONFIG=~/.kube/<k8s-cluster.config>
+    ```
+### Install
+  ```
+    $ cd deploy
+    $ ./install.sh
+   ```
+### Delete
+  ```
+    $ cd deploy
+    $ ./delete.sh
+   ```
+### Restart
+  ```
+    $ cd deploy
+    $ ./restart.sh
+   ```
+
+## Test
+Automated functional tests available in [Functional Tests](../../api-test).
+
+## APIs
+API documentation is available [here](https://mosip.github.io/documentation/).
+
+## License
+This project is licensed under the terms of [Mozilla Public License 2.0](../../LICENSE).
diff --git a/authentication/authentication-internal-service/pom.xml b/authentication/authentication-internal-service/pom.xml
@@ -7,9 +7,9 @@
 	<parent>
 		<groupId>io.mosip.authentication</groupId>
 		<artifactId>authentication-parent</artifactId>
-		<version>1.2.1-SNAPSHOT</version>
+		<version>1.3.0-SNAPSHOT</version>
 	</parent>
-	<version>1.2.1-SNAPSHOT</version>
+	<version>1.3.0-SNAPSHOT</version>
 	<artifactId>authentication-internal-service</artifactId>
 	<name>authentication-internal-service</name>
 	<properties>

diff --git a/authentication/authentication-otp-service/README.md b/authentication/authentication-otp-service/README.md
@@ -27,3 +27,82 @@ POST /idauthentication/v1/otp/{MISP-LicenseKey}/{Auth-Partner-ID}/{Partner-Api-K
 * WebSub: for getting events for Credential data/ IDentity data/ Partner data/ Master data updates.
 * HSM: for retrieving encryption/decryption keys.
 
+## Overview
+This repository contains source code and design documents for MOSIP ID Authentication OTP service which is the server-side module to manage [ID Authentication](https://docs.mosip.io/1.2.0/modules/id-authentication-services). The modules exposes API endpoints.
+
+## Databases
+Refer to [SQL scripts](../../db_scripts).
+
+## Build & run (for developers)
+The project requires JDK 21.0.3
+and mvn version - 3.9.6
+
+### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration
+   ```
+   hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+   ```
+This is for better compatibility with future PostgreSQL versions.
+
+### Configure ANT Path Matcher for Spring Boot 3.x compatibility.
+   ```
+   spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
+   ```
+This is to maintain compatibility with existing ANT-style path patterns.
+
+1. Build and install:
+    ```
+    $ cd authentication/authentication-otp-service
+    $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
+    ```
+2. Build Docker for a service:
+    ```
+    $ cd <service folder>
+    $ docker build -f Dockerfile
+    ```
+### Add auth-adapter in a class-path to run a services
+   ```
+   <dependency>
+       <groupId>io.mosip.kernel</groupId>
+       <artifactId>kernel-auth-adapter</artifactId>
+       <version>${kernel.auth.adapter.version}</version>
+   </dependency>
+   ```
+
+## Configuration
+[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and
+[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and
+[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and
+[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/master/id-authentication-otp-default.properties) and
+[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here.
+
+
+## Deployment in K8 cluster with other MOSIP services:
+### Pre-requisites
+* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file:
+    ```
+    export KUBECONFIG=~/.kube/<k8s-cluster.config>
+    ```
+### Install
+  ```
+    $ cd deploy
+    $ ./install.sh
+   ```
+### Delete
+  ```
+    $ cd deploy
+    $ ./delete.sh
+   ```
+### Restart
+  ```
+    $ cd deploy
+    $ ./restart.sh
+   ```
+
+## Test
+Automated functional tests available in [api-test folder](../../api-test).
+
+## APIs
+API documentation is available [here](https://mosip.github.io/documentation/).
+
+## License
+This project is licensed under the terms of [Mozilla Public License 2.0](../../LICENSE).
diff --git a/authentication/authentication-otp-service/pom.xml b/authentication/authentication-otp-service/pom.xml
@@ -7,9 +7,9 @@
     <parent>
         <groupId>io.mosip.authentication</groupId>
         <artifactId>authentication-parent</artifactId>
-        <version>1.2.1-SNAPSHOT</version>
+        <version>1.3.0-SNAPSHOT</version>
     </parent>
-    <version>1.2.1-SNAPSHOT</version>
+    <version>1.3.0-SNAPSHOT</version>
     <artifactId>authentication-otp-service</artifactId>
     <name>authentication-otp-service</name>
     <properties>