Skip to content

Commit 4bcd113

Browse files
kameshsrkameshsr
authored
MOSIP-37357 Corrected readme (#1025)
* 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 file 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]>
1 parent 75907de commit 4bcd113

File tree

5 files changed

+182
-3
lines changed
  • authentication
  • pre-registration-booking-service
  • registration-processor
    • registration-processor-external-integration-service
    • registration-processor-external-stage

5 files changed

+182
-3
lines changed

‎authentication/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
This code is moved to id-authentication repo and placed under the authentication-internal-service.
1+
This code is moved to id-authentication repo and placed under the authentication-common.

‎authentication/authentication-childauthfilter-impl/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
This code is moved to id-authentication repo and placed under the authentication-internal-service.
1+
This code is moved to id-authentication repo and placed under the authentication-common.

‎pre-registration-booking-service/README.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,73 @@
33
## Overview
44
This service details used by Pre-Registration portal to book an appointment by providing his/her basic appointment details
55

6+
## Databases
7+
Refer to the required released tagged version [SQL scripts](https://github.com/mosip/pre-registration/tree/master/db_scripts).
8+
9+
## Build & run (for developers)
10+
The project requires JDK 21.0.3
11+
and mvn version - 3.9.6
12+
13+
1. Build and install:
14+
```
15+
$ cd pre-registration-booking-service
16+
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
17+
```
18+
2. Build Docker for a service:
19+
```
20+
$ cd <service folder>
21+
$ docker build -f Dockerfile
22+
```
23+
24+
### Add auth-adapter in a class-path to run a master-data service
25+
```
26+
<dependency>
27+
<groupId>io.mosip.kernel</groupId>
28+
<artifactId>kernel-auth-adapter</artifactId>
29+
<version>${kernel.auth.adapter.version}</version>
30+
</dependency>
31+
<dependency>
32+
<groupId>io.mosip.kernel</groupId>
33+
<artifactId>kernel-ref-idobjectvalidator</artifactId>
34+
<version>${kernel.ref.idobjectvalidator.version}</version>
35+
</dependency>
36+
```
37+
38+
## Configuration files
39+
Pre-registration Service uses the following configuration files:
40+
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and
41+
[Configuration-Pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) defined here.
42+
Refer to the required released tagged version.
43+
44+
Need to run the config-server along with the files mentioned above in order to run the pre-registration booking service.
45+
646
## Default context, path, port
747
Refer to [bootstrap properties](src/main/resources/bootstrap.properties)
848
49+
## Deployment in K8 cluster with other MOSIP services:
50+
### Pre-requisites
51+
* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file:
52+
```
53+
export KUBECONFIG=~/.kube/<k8s-cluster.config>
54+
```
55+
### Install
56+
```
57+
$ cd deploy
58+
$ ./install.sh
59+
```
60+
### Delete
61+
```
62+
$ cd deploy
63+
$ ./delete.sh
64+
```
65+
### Restart
66+
```
67+
$ cd deploy
68+
$ ./restart.sh
69+
```
70+
71+
## APIs
72+
API documentation is available [here](https://mosip.github.io/documentation/).
73+
74+
## License
75+
This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-ref-impl/blob/master/LICENSE).

‎registration-processor/registration-processor-external-integration-service/README.md‎

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# registration-processor-external-integration-service
22

3+
## Overview
4+
This service details used by Registration service for external integration service.
5+
36
## Design
47
[Design - Approach for External System Integration](https://github.com/mosip/registration/blob/master/design/registration-processor/Approach_for_external_system_integration.md)
58

@@ -12,4 +15,55 @@ server.servlet.path=/registrationprocessor/v1/eis
1215
```
1316

1417
## Operations done by the Service
15-
1. It returns boolean value true for every non null requests
18+
1. It returns boolean value true for every non-null requests
19+
20+
## Build & run (for developers)
21+
The project requires JDK 21.0.3
22+
and mvn version - 3.9.6
23+
24+
1. Build and install:
25+
```
26+
$ cd registration-processor\registration-processor-external-integration-service
27+
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
28+
```
29+
2. Build Docker for a service:
30+
```
31+
$ cd <service folder>
32+
$ docker build -f Dockerfile
33+
```
34+
35+
## Configuration files
36+
Registration processor external integration Service uses the following configuration files:
37+
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and
38+
[Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here.
39+
Refer to the required released tagged version.
40+
41+
Need to run the config-server along with the files mentioned above in order to run the registration processor external integration service.
42+
43+
## Deployment in K8 cluster with other MOSIP services:
44+
### Pre-requisites
45+
* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file:
46+
```
47+
export KUBECONFIG=~/.kube/<k8s-cluster.config>
48+
```
49+
### Install
50+
```
51+
$ cd deploy
52+
$ ./install.sh
53+
```
54+
### Delete
55+
```
56+
$ cd deploy
57+
$ ./delete.sh
58+
```
59+
### Restart
60+
```
61+
$ cd deploy
62+
$ ./restart.sh
63+
```
64+
65+
## APIs
66+
API documentation is available [here](https://mosip.github.io/documentation/).
67+
68+
## License
69+
This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-ref-impl/blob/master/LICENSE).

‎registration-processor/registration-processor-external-stage/README.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# registration-processor-external-stage
22

3+
## Overview
34
This stage integrates with external system for required external operations
45

56
## Design
@@ -30,3 +31,60 @@ mosip.regproc.external.server.servlet.path=/registrationprocessor/v1/external
3031
```
3132
## Operations in External stage
3233
External validation by sending requests to external integration system
34+
35+
## Build & run (for developers)
36+
The project requires JDK 21.0.3
37+
and mvn version - 3.9.6
38+
39+
1. Build and install:
40+
```
41+
$ cd registration-processor\registration-processor-external-stage
42+
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
43+
```
44+
2. Build Docker for a service:
45+
```
46+
$ cd <service folder>
47+
$ docker build -f Dockerfile
48+
```
49+
50+
### Add auth-adapter in a class-path to run a master-data service
51+
```
52+
<dependency>
53+
<groupId>io.mosip.kernel</groupId>
54+
<artifactId>kernel-auth-adapter</artifactId>
55+
<version>${kernel.auth.adapter.version}</version>
56+
</dependency>
57+
```
58+
59+
## Configuration files
60+
Registration processor external stage uses the following configuration files:
61+
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and
62+
[Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here.
63+
Refer to the required released tagged version.
64+
65+
Need to run the config-server along with the files mentioned above in order to run the registration processor external stage service.
66+
67+
## Deployment in K8 cluster with other MOSIP services:
68+
### Pre-requisites
69+
* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file:
70+
```
71+
export KUBECONFIG=~/.kube/<k8s-cluster.config>
72+
```
73+
### Install
74+
```
75+
$ cd deploy
76+
$ ./install.sh
77+
```
78+
### Delete
79+
```
80+
$ cd deploy
81+
$ ./delete.sh
82+
```
83+
### Restart
84+
```
85+
$ cd deploy
86+
$ ./restart.sh
87+
```
88+
89+
## License
90+
This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-ref-impl/blob/master/LICENSE).

0 commit comments

Comments
 (0)