Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/develop' into test-coverage-dev
Browse files Browse the repository at this point in the history
  • Loading branch information
GOKULRAJ136 committed Nov 14, 2024
2 parents c2e65b5 + 13ce438 commit 89230d7
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 169 deletions.
37 changes: 9 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,15 @@ Admin module contains following services:
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
1. Build and install:
```
$ cd kernel
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
### 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 Docker for a service:
2. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
Expand All @@ -64,28 +52,21 @@ This is to maintain compatibility with existing ANT-style path patterns.
$ cd deploy
$ ./restart.sh
```
### 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-Admin](https://github.com/mosip/mosip-config/blob/develop/admin-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here.
admin module uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master).
Please refer to the required released tagged version for configuration.
[Configuration-Admin](https://github.com/mosip/mosip-config/blob/master/admin-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here.
## Deploy
To deploy Admin on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deployment/sandbox-deployment).
To deploy Admin on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation).
## Test
Automated functional tests available in [Functional Tests repo](https://github.com/mosip/mosip-functional-tests).
Automated functional tests available in [Functional Tests repo](api-test).
## APIs
API documentation is available [here](https://mosip.github.io/documentation/).
API documentation is available [here](https://mosip.github.io/documentation/1.2.0/1.2.0.html).
## License
This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE).
21 changes: 11 additions & 10 deletions admin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
# Admin
Admin module can be accessed only by the privileged group of admin personnel and enables default configurations and seed data to be setup when the MOSIP platform gets initialized.

## Configuration files
admin module uses the following configuration files:
## Configuration
admin module uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master).
Please refer to the required released tagged version for configuration.
```
application-default.properties
admin-default.properties
Expand All @@ -16,29 +17,29 @@ hotlist-default.properties
Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files.

## Databases
Refer to [SQL scripts](db_scripts).
Refer to [SQL scripts](https://github.com/mosip/admin-services/tree/release-1.3.x/db_scripts).

## Build & run (for developers)
The project requires JDK 1.11.
The project requires JDK 21.0.3
and mvn version - 3.9.6
1. Build and install:
```
$ cd kernel
$ 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
```
## Deploy
To deploy Commons services on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deployment/sandbox-deployment).
To deploy Commons services on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation).
## Test
Automated functaionl tests available in [Functional Tests repo](https://github.com/mosip/mosip-functional-tests).
Automated functional tests available in [Functional Tests repo](https://github.com/mosip/admin-services/tree/release-1.3.x/api-test).
## APIs
API documentation is available [here](https://mosip.github.io/documentation/).
API documentation is available [here](https://mosip.github.io/documentation/1.2.0).
## License
This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE).
This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/admin-services/blob/release-1.3.x/LICENSE).
45 changes: 8 additions & 37 deletions admin/admin-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,22 @@
Admin Service can be accessed only by the privileged group of admin personnel, its used to perform bulk data operation.

## Build & run (for developers)
The project requires JDK 1.21.
The project requires JDK 21.0.3
and mvn version - 3.9.6
1. Build and install:
```
$ cd kernel
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
### 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.
### Add auth-adapter with an exclusion of webflux in a class-path to run an admin-service
```
<dependency>
<groupId>io.mosip.kernel</groupId>
<artifactId>kernel-auth-adapter</artifactId>
<version>${kernel.auth.adapter.version}</version>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
</exclusion>
</exclusions>
</dependency>
```
## Configuration files
Admin Service uses the following configuration files:
```
application-default.properties
admin-default.properties
```
## Configuration
[Configuration-Admin](https://github.com/mosip/mosip-config/blob/develop/admin-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here.
Admin Service uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master).
Please refer to the required released tagged version for configuration.
1. [Configuration-Admin](https://github.com/mosip/mosip-config/blob/master/admin-default.properties)
2. [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties)
## APIs
API documentation is available [here](https://mosip.github.io/documentation/1.2.0/admin-service.html).
Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files.
38 changes: 8 additions & 30 deletions admin/hotlist-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,44 +5,22 @@
Hotlist service provides functionality to block/unblock any ids with option of expiry. This hotlisted information will also be published to MOSIP_HOTLIST websub topic.

## Build & run (for developers)
The project requires JDK 1.21.
The project requires JDK 21.0.3
and mvn version - 3.9.6
1. Build and install:
```
$ cd kernel
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
### 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.
### Add auth-adapter in a class-path to run a hotlist-service
```
<dependency>
<groupId>io.mosip.kernel</groupId>
<artifactId>kernel-auth-adapter</artifactId>
<version>${kernel.auth.adapter.version}</version>
</dependency>
```
## Configuration files
Hotlist Service uses the following configuration files:
```
application-default.properties
hotlist-default.properties
```
## Configuration
[Configuration-Hotlist](https://github.com/mosip/mosip-config/blob/develop/hotlist-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here.
Hotlist Service uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master).
Please refer to the required released tagged version for configuration.
1. [Configuration-Hotlist](https://github.com/mosip/mosip-config/blob/master/hotlist-default.properties)
2. [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties)
## APIs
API documentation is available [here](https://mosip.github.io/documentation/1.2.0/hotlist-service.html).
## Default context-path and port
Refer [`bootstrap.properties`](src/main/resources/bootstrap.properties)
40 changes: 9 additions & 31 deletions admin/kernel-masterdata-service/README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,26 @@
# Kernel Masterdata Service

## Overview
This services exposes API to perform CRUD operations on materdata.
This services exposes API to perform CRUD operations on masterdata.

## Build & run (for developers)
The project requires JDK 1.21.
The project requires JDK 21.0.3
and mvn version - 3.9.6
1. Build and install:
```
$ cd kernel
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
### 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.
### Add auth-adapter in a class-path to run a master-data service
```
<dependency>
<groupId>io.mosip.kernel</groupId>
<artifactId>kernel-auth-adapter</artifactId>
<version>${kernel.auth.adapter.version}</version>
</dependency>
```
## Configuration
Master Data Service uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master).
Please refer to the required released tagged version for configuration.
1. [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties)
2. [Configuration-Kernel](https://github.com/mosip/mosip-config/blob/master/kernel-default.properties)
## Configuration files
Master Data Service uses the following configuration files:
```
application-default.properties
kernel-default.properties
```
Need to run the config-server along with the files mentioned above in order to run the master-data service.
## Configuration
[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and
[Configuration-Kernel](https://github.com/mosip/mosip-config/blob/develop/kernel-default.properties) defined here.
## APIs
API documentation is available [here](https://mosip.github.io/documentation/1.2.0/kernel-masterdata-service.html).
Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files.
41 changes: 9 additions & 32 deletions admin/kernel-syncdata-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,25 @@
Sync Data Service can be accessed only by the privileged group of admin personnel and enables default configurations and seed data to be setup when the MOSIP platform gets initialized.

## Build & run (for developers)
The project requires JDK 1.21.
The project requires JDK 21.0.3
and mvn version - 3.9.6
1. Build and install:
```
$ cd kernel
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
### 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.
### Add auth-adapter in a class-path to run a sync-data service
```
<dependency>
<groupId>io.mosip.kernel</groupId>
<artifactId>kernel-auth-adapter</artifactId>
<version>${kernel.auth.adapter.version}</version>
</dependency>
```
## Configuration
Sync Data Service uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master).
Please refer to the required released tagged version for configuration.
1. [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties)
2. [Configuration-Kernel](https://github.com/mosip/mosip-config/blob/master/kernel-default.properties)
3. [Configuration-Sync](https://github.com/mosip/mosip-config/blob/master/syncdata-default.properties)
## Configuration files
Sync Data Service uses the following configuration files:
```
application-default.properties
kernel-default.properties
syncdata-default.properties
```
Need to run the config-server along with the files mentioned above in order to run the sync-data service.
## Configuration
[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties),
[Configuration-Kernel](https://github.com/mosip/mosip-config/blob/develop/kernel-default.properties) and
[Configuration-Sync](https://github.com/mosip/mosip-config/blob/develop/syncdata-default.properties) defined here.
## APIs
API documentation is available [here](https://mosip.github.io/documentation/1.2.0/kernel-syncdata-service.html).
Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files.
2 changes: 1 addition & 1 deletion api-test/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM mosipdev/openjdk-21-jre:latest
FROM mosipid/openjdk-21-jre:21.0.4

ARG SOURCE
ARG COMMIT_HASH
Expand Down

0 comments on commit 89230d7

Please sign in to comment.