Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated README.md files #1040

Merged
merged 1 commit into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 43 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?branch=develop&project=mosip_partner-management-services&metric=alert_status)](https://sonarcloud.io/dashboard?branch=develop&id=mosip_partner-management-services)

## Overview
This repository contains the source code MOSIP Partner Management module. For an overview refer [here](https://docs.mosip.io/1.2.0/modules/partner-management-services). The module exposes API endpoints. For a reference front-end UI implementation refer to [Partner-management UI github repo](https://github.com/mosip/partner-management-portal/)
This repository contains the source code MOSIP Partner Management module. For an overview refer [here](https://docs.mosip.io/1.2.0/modules/partner-management-services). The module exposes API endpoints. For a reference front-end UI implementation refer to [Partner-management UI GitHub repo](https://github.com/mosip/partner-management-portal)

Partnermanagement module contains following services:
Partner management module contains following services:
1. Partner management service
2. Policy management service

Expand All @@ -16,9 +16,10 @@ Refer to [SQL scripts](db_scripts).
The project requires JDK 1.11.
1. Build and install:
```
$ cd kernel
$ cd partner
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```

1. Build Docker for a service:
```
$ cd <service folder>
Expand All @@ -28,8 +29,46 @@ The project requires JDK 1.11.
## Deploy
To deploy PMS on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deployment/sandbox-deployment).

### Configuration
[partner-management-default.properties](https://github.com/mosip/mosip-config/blob/master/partner-management-default.properties)

[application-default.properties](https://github.com/mosip/mosip-config/blob/master/application-default.properties)

defined here.

### 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>
```

## 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 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
66 changes: 65 additions & 1 deletion partner/partner-management-service/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,68 @@
# Partner management service

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

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

## Build & run (for developers)
The project requires JDK 1.11

1. Build and install:
```
$ cd partner/partner-management-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
```

### Configuration
[partner-management-default.properties](https://github.com/mosip/mosip-config/blob/master/partner-management-default.properties)

[application-default.properties](https://github.com/mosip/mosip-config/blob/master/application-default.properties)

defined here.

### 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>
```

## 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)
66 changes: 65 additions & 1 deletion partner/policy-management-service/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,68 @@
# Policy management service

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

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

## Build & run (for developers)
The project requires JDK 1.11.

1. Build and install:
```
$ cd partner/policy-management-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
```

### Configuration
[policy-management-default.properties](https://github.com/mosip/mosip-config/blob/master/policy-default.properties)

[application-default.properties](https://github.com/mosip/mosip-config/blob/master/application-default.properties)

defined here.

### 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>
```

## 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)
Loading