Mosip-compliance-toolkit

This repository contains the source code for MOSIP Compliance-toolkit services. For an overview refer here. The modules exposes API endpoints. For a reference front-end UI implementation refer to Compliance-toolkit UI github repo

Mosip-compliance-toolkit is used to test following biometric components:

1. Biomtric devices
2. Biometric SDK

Database

See DB guide.

Config-Server

To run Compliance-toolkit services, run Config Server. All properties mentioned is mosip-compliance-toolkit/src/main/resources/application.properties can be overwritten in config server file compliance-toolkit-default.properties

Build & run (for developers)

Prerequisites:

1. Config Server
2. JDK 1.11
3. Build and install:

   $ cd mosip-compliance-toolkit
   $ mvn clean install -Dgpg.skip=true
   

4. Build Docker for a service:

   $ cd <service folder>
   $ docker build -f Dockerfile
   

Installing in k8s cluster using helm

Pre-requisites

1. Set the kube config file of the Mosip cluster having dependent services is set correctly in PC.
2. Make sure DB setup is done.
3. Add compliance-toolkit-default.properties in required branch of config repo.
4. Below are the dependent services required for compliance toolkit service:

   Chart	Chart version
   Clamav	2.4.1
   Keycloak	7.1.18
   Keycloak-init	12.0.1-beta
   Postgres	10.16.2
   Postgres Init	12.0.1-beta
   Minio	10.1.6
   Config-server	12.0.1-beta
   Artifactory server	12.0.1-beta
   Auditmanager service	12.0.1-beta
   Authmanager service	12.0.1-beta
   Keymanager service	12.0.1-beta
   Notifier service	12.0.1-beta
   Partner manager service	12.0.1-beta

Install

• Install kubectl and helm utilities.
• Run the keycloak-init.sh script to create the mosip-toolkit-client keycloak client. You can skip this step if you have already done it.
• Keycloak-init.sh will create a user 'mpartner-default-abis' and its temporary password is 'abcd1234'.

  cd helm
  ./keycloak-init.sh
  

• Run the install.sh to deploy complaince-toolkit.

  cd helm
  ./install.sh [cluster-kubeconfig-file]
  

Restart

cd helm
./restart.sh [cluster-kubeconfig-file]

Delete

cd helm
./delete.sh [cluster-kubeconfig-file]

License

This project is licensed under the terms of Mozilla Public License 2.0.