How to Install DIVOC for V3.0
Components to be deployed
DB: Postgres DB
Kafka & Zookeeper: The verifiable credential (VC) generation process is an asynchronous process. The initial VC generation process checks for the validity of the payload and pushes the incoming payload in Kafka queues, which then get consumed and signed asynchronously.
Keycloak: It is the access management service used to restrict the access of resources only to authenticated users.
Registry: Registry by Sunbird-RC is used for tenant creation, schema creation, and VC generation, update, and revocation flows. It is also responsible for persistence in DB.
Sunbird-Certificate-signer: This service is used for signing the event payload and it returns a signed credential.
Sunbird-Certificate-API: This service is used for downloading certificates (VCs in JSON+LD format, QR codes, certificates in PDF format, etc).
File-Storage (MinIO): This service is used for storing the uploaded context files, and template files. Either the cloud storage or the volume mounted on the server can be attached and accessed via this service.
VC-Management-Service: This is a wrapper service that exposes the rest endpoints of the registry for tenant creation, schema creation, upload context, and upload template.
VC-Certification-Service: This is a wrapper service that exposes the rest endpoints of the registry for VC creation, VC download, VC update, VC revoke, etc.
VC-Certify-Consumer: This service has Kafka consumers, which consume an event payload and make a request to the registry for either signing and persisting a new VC or updating and revoking an existing VC record.
Deployment steps
Set up a DB with the name ‘registry.’ It should be accessible in the k8s cluster.
Set up a Redis server, which should be accessible by DIVOC services in the k8s cluster.
Set up the Kafka service and see if it is reachable from within the k8s cluster slave nodes
Create topics “vc-certify”, “vc-remove-suspension”, “post-vc-certify”
bin/kafka-topics.sh --create --topic --replication-factor 2 --partitions 8 --bootstrap-server :9092 --config retention.ms=2592000000
4. Create a folder for MinIO storage on the server for volume mounting, (or) set up cloud storage (eg:s3) and create a bucket.
5. Generate an ECDSA keypair
ECDSA keys can be generated by running the unit tests from this project locally. Add the log statements after line 91 (from the link given below) to print the generated ed25519 keys https://github.com/digitalbazaar/ed25519-verification-key-2018/blob/c5b961af60f3ab5e87e47740d2da742a885d2f10/tests/unit/Ed25519VerificationKey2018.spec.js#L91
- console.log('private key:', ldKeyPair.privateKeyBase58);
- console.log('public key:', ldKeyPair.publicKeyBase58);
Use the logged private and public key pair printed in the console.
6. Create a config map with the environment variables (Configmap YML file available in infra/Kubernetes folder).
7. Bring up the services (All the required deployment and service files are available in the infra/Kubernetes folder):
Bring up keycloak service using the deployment files
Setup Ingress using ingress yml file
Access Keycloak UI using <ingressURL>/auth
Import src-realm-export.json file and create a new realm sunbird-rc
Select clients > admin-api > credentials > Regenerate Client Secret
Update the client secret in environment variables by editing the config map
Bring up the services in this order:
i. File-storage
ii. Registry
iii. SB-Certificate-Signer
iv. SB-Certificate-API
v. VC-Management-service
vi. VC-Certification-service
vii. VC-Certify-Consumer
Last updated
