Admin

Overview

This repository contains the source code MOSIP Admin module. For an overview refer here. The module exposes API endpoints. For a reference front-end UI implementation refer to Admin UI github repo

Admin module contains following services:

1. Admin Service
2. Masterdata Service
3. Sync Data Service
4. Hotlist Service

Databases

Refer to SQL scripts.

Build & run (for developers)

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
   

2. Build Docker for a service:

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

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

Configuration

admin module uses the following configuration files that are accessible in this repository. Please refer to the required released tagged version for configuration. Configuration-Admin and Configuration-Application defined here.

Deploy

To deploy Admin on Kubernetes cluster using Dockers refer to Sandbox Deployment.

Test

Automated functional tests available in Functional Tests repo.

APIs

API documentation is available here.

License

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