Skip to content

Commit

Permalink
MOSIP-37357 Corrected readme
Browse files Browse the repository at this point in the history
Signed-off-by: kameshsr <[email protected]>
  • Loading branch information
kameshsr committed Nov 8, 2024
1 parent 995c07f commit 74b5fa3
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 17 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ defined here.
```
## Test
Automated functional tests available in [Functional Tests repo](https://github.com/mosip/mosip-functional-tests).
Automated functional tests available in [Functional Tests](api-test).
## APIs
API documentation is available [here](https://mosip.github.io/documentation/).
Expand Down
50 changes: 42 additions & 8 deletions partner/partner-management-service/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Partner management service

## Overview
This repository contains the source code for partner management service. For an overview refer [here](https://nayakrounak.gitbook.io/mosip-docs/modules/partner-management).

## Databases
Refer to [SQL scripts](../../db_scripts).

## Build & run (for developers)
The project requires JDK 21.0.3
and mvn version - 3.9.6
Expand All @@ -11,7 +15,12 @@ and mvn version - 3.9.6
$ cd partner
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
2. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
```
### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration
```
mosip.datasource.authdevice.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
Expand All @@ -25,12 +34,6 @@ spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
### Spring boot 3.x onwards we need to specify the below property to unmask values in actuator env url
management.endpoint.env.show-values=ALWAYS
1. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
```
### Configuration
[partner-management-default.properties](https://github.com/mosip/mosip-config/blob/dev-integration/partner-management-default.properties)
Expand All @@ -45,4 +48,35 @@ defined here.
<artifactId>kernel-auth-adapter</artifactId>
<version>${kernel.auth.adapter.version}</version>
</dependency>
```
```
## 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)
50 changes: 42 additions & 8 deletions partner/policy-management-service/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Policy management service

## Overview
This repository contains the source code for policy management service. For an overview refer [here](https://nayakrounak.gitbook.io/mosip-docs/modules/partner-management).

## Databases
Refer to [SQL scripts](../../db_scripts).

## Build & run (for developers)
The project requires JDK 21.0.3
and mvn version - 3.9.6
Expand All @@ -11,7 +15,12 @@ and mvn version - 3.9.6
$ cd partner
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
2. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
```
### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration
```
mosip.datasource.authdevice.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
Expand All @@ -25,12 +34,6 @@ spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
### Spring boot 3.x onwards we need to specify the below property to unmask values in actuator env url
management.endpoint.env.show-values=ALWAYS
1. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
```
### Configuration
[policy-management-default.properties](https://github.com/mosip/mosip-config/blob/dev-integration/policy-default.properties)
Expand All @@ -45,4 +48,35 @@ defined here.
<artifactId>kernel-auth-adapter</artifactId>
<version>${kernel.auth.adapter.version}</version>
</dependency>
```
```
## 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)

0 comments on commit 74b5fa3

Please sign in to comment.