MOSIP uses DB for all relational data storage. The DB creation SQL scripts are located under /db_scripts
the folder of the module repository. In , Postgres is installed as a docker inside the cluster. However, in production deployment, typically, Postgres will be installed external to the cluster.
Entity relationships diagrams for all databases used in MOSIP are given below.
Connection details
{module_name
}_database_url
{module_name
}_database_username
{module_name
}_database_password
Hibernate configurations
javax.persistence.jdbc.driver
hibernate.dialect
hibernate.jdbc.lob.non_contextual_creation
hibernate.hbm2ddl.auto
hibernate.show_sql
hibernate.format_sql
hibernate.connection.charSet
hibernate.cache.use_second_level_cache
hibernate.cache.use_query_cache
hibernate.cache.use_structured_entries
hibernate.generate_statistics
logging.level.org.hibernate.SQL
logging.level.org.hibernate.type
These are some of the reference settings of a production database. It is expected that these are reviewed and finalized for a given deployment.
Object Store is a storage module for MOSIP named as Khazana. The module is an abstraction of storage layer used across Registration Client, Packet Manager, Datashare or Durian for packets and biometric data.
Khazana provides following adapters to store objects
POSIX - Supports storage of packets on a filesystem. Its typically used by registration client to store packets locally on the machine. This adapter is not receommended for usage in low latency environments like packet manager.
S3 - S3 is one of the well known API for object stores. AWS Java S3 Client is used in Khazana to support any S3 compliant object storage solutions.
Object Store is used for following purpose wihin mosip
Registration Client - Encrypted packets
Pre-registration - Uploaded Documents
Idrepo - Individual's biometrics and documents
Datashare - On demand individual's biometrics, documents and other information.
As part of our sandbox deployment we have provided an example use case with minio for on-prem deployment and AWS S3 with AWS deployment. Object Store is installed as part of default sandbox deployment.
Note: Please note its important to choose the right partner for object storage and work with them to scale acordingly. Please follow the hardware estimate for Object Store based on respective Object store products.
The below is the list of S3 Java API's used by MOSIP. This can be used to understand the vendor compatibility. Khazana does not use any internal business logic and is purely an storage abstraction layer.
getConnection(bucketName).getObject(bucketName, finalObjectName)
getConnection(bucketName).getObjectMetadata(bucketName, finalObjectName)
doesBucketExistV2(bucketName)
createBucket(bucketName)
getObjectMetadata()
getObjectMetadata().getUserMetadata()
addUserMetadata(m.getKey(), m.getValue())
PutObjectRequest(bucketName, finalObjectName, s3Object.getObjectContent(), objectMetadata)
getRequestClientOptions()
setReadLimit(readlimit)
putObject(putObjectRequest)
deleteObject(bucketName, objectName)
listObjects(account, searchPattern)
getObjectSummaries()
listObjects(searchPattern)
getObjectSummaries()
doesObjectExist(bucketName, finalObjectName)
GetObjectTaggingRequest(bucketName,finalObjectName)
getObjectTagging(getObjectTaggingRequest)
SetObjectTaggingRequest(bucketName,finalObjectName,objectTagging)
setObjectTagging(setObjectTaggingRequest)