Full Installation Guide
Complete DIGIT Installation step-by-step Instructions across various Infra types like Public & Private Clouds

Basics

While Quickstart Guide would have helped you to get your hands dirty and build the Kubernetes cluster on a local/single VM instance - which you can consider for either local development, or to understand the details involved in infra and deployment.
However, DIGIT is a cloud-native platform and at the same time cloud agnostic. Depending on the scale and performance running DIGIT on production requires advanced capabilities like HA, DRS, autoscaling, resiliency, etc. All these capabilities are supported by the commercial clouds like AWS, Google, Azure, VMware, OpenStack, etc.. and also the private clouds like NIC and a few SDCs implemented clouds. These cloud providers provide the Kubernetes-as-a-managed-service that makes the entire infra setup and management seamless and automated, like infra-as-code, config-as-code.

Pre-reads

Prerequisites:

  • Unlike quickstart, full installation requires state/user specific configurations ready before proceeding with the deployment.
  • You need to have the fully qualified DNS (URL) (Should not be dummy)
  • Persistent storage depending on the cloud you are using for the Kafka, ES, etc.
  • Either a standalone or a hosted PostGres DB above v11.x
  • MDMS with the master data like Roles, Access, Actions, tenants, etc. Sample is here​
  • Gov services specific Configs like persister, searcher configs etc. Sample is here
  • GeoLocation provider configs (Google Location API), SMS Gateway, Payment Gateway, etc.
  • ​fork both the mdms, and config repos into your GitHub account
  • Create a github user account it should be different than your repo forked github organization account. Once a user account is ready generate the ssh authentication key( generate new SSH key and add it to above user account.
  • Above newly created user should have access to the mdms and config forked repo.

1. Choose Your Cloud

Choose your cloud and follow the instructions to set up a Kubernetes cluster before moving on to deployment.

2. Deploy DIGIT

Post infra setup (Kubernetes Cluster), the deployment involves 2 stages and 2 modes. Check out the stages first and then the modes. As part of a sample exercise, we will deploy the PGR module. However, deployment steps are similar. The prerequisites have to be configured accordingly.

The 2 Stages

Stage 1: Prepare an <env.yaml> master config file, you can provide any name to this file. The file has the following configurations and this env file needs to be in line with your cluster name.
  • each service global, local env variables
  • credentials, secrets (You need to encrypt using sops and create a <env>-secret.yaml separately)
  • Number of replicas/scale of individual services (Depending on whether dev or prod)
  • mdms, config repos (Master Data, ULB, Tenant details, Users, etc)
  • sms g/w, email g/w, payment g/w
  • GMap key (In case you are using Google Map services in your PGR, PT, TL, etc)
  • S3 Bucket for Filestore
  • URL/DNS on which the DIGIT will be exposed
  • SSL Certificate for the above URL
  • End-points configs (Internal/external)
Stage 2: Run the digit_setup deployment script and simply answer the questions that it asks.
1
cd DIGIT-DevOps/deploy-as-code/egov-deployer
2
​
3
go run digit_setup.go
4
​
5
#Be prepared for the following questions
6
1. Do you have the Kubernetes Setup?
7
2. Provide the path of the intented env kubeconfig file
8
3. Which version of the DIGIT that you want to install
9
4. What DIGIT Modules that you choose to install (Choose PGR)
10
5. All, done, Now do you want to preview the deployment manifests
11
6. Are you good to proceed with the DIGIT Installation
12
​
13
All Done.
Copied!
All Done, wait and watch for 10 min, you'll have the DIGIT setup completed and the application will be running on the given URL.

The 2 Modes of Deployment

Essentially, DIGIT deployment means that we need to generate Kubernetes manifests for each individual service. We use the tool called Helm, which is an easy, effective and customizable packaging and deployment solution. So depending on where and which env you initiate the deployment there are 2 modes that you can deploy.
  1. 1.
    From local machine - whatever we are trying in this sample exercise so far.
  2. 2.
    Advanced: From CI/CD System like Jenkins - Depending on how you want to set up your CI/CD and the expertise the steps will vary, however here you can find how we have set up CI/CD on Jenkins and the pipelines are created automatically without any manual intervention.

3. Post Deployment Steps

Post-deployment - the application is now accessible from the configured domain.
To try out PGR employee login - Create a sample tenant, city, user to login and assign LME employee role using the seed script.
  • Run the kubectl port-forwarding of the egov-user service from Kubernetes cluster to your localhost. This gives you access to egov-user service directly and you can now interact with the API directly.
1
kubectl port-forward svc/egov-user 8080:8080 -n egov
2
Forwarding from 127.0.0.1:8080 -> 8080
3
Forwarding from [::1]:8080 -> 8080
Copied!
  • Seed the sample data.
  • Ensure you have the postman to run the following seed data API. If not, Install postman on your local machine.
  • Import the following postman collection into the postman and run it. This collection has the seed data that enable sample test users and localisation data.

4. Assessment of the DIGIT Deployment

By now we have successfully completed the DIGIT setup on the cloud. Use the URL that you mentioned in your env.yaml Eg: https://mysetup.digit.org and create a grievance to ensure the PGR module deployed is working fine. Refer to the product documentation below for the steps.
Credentials:
  1. 1.
    Citizen: You can use your default mobile number (9999999999) to sign in using the default Mobile OTP 123456.
  2. 2.
    Employee: Username: GRO and password: [email protected]
Post grievance creation and assignment of the same to LME, capture the screenshot of the same and share it to ensure your setup is working fine.

5. Destroy the Cluster

Post validating the PGR functionality share the API response of the following request to assess the correctness of successful DIGIT PGR Deployment.
Finally, clean up the DIGIT Setup if you wish, using the following command. This will delete the entire cluster and other cloud resources that were provisioned for the DIGIT Setup.
1
cd DIGIT-DevOps/infra-as-code/terraform/my-digit-eks
2
terraform destroy
Copied!

Conclusion

All Done, we have successfully created infra on the cloud, deployed DIGIT, bootstrapped DIGIT, performed a transaction on PGR and finally destroyed the cluster.
Last modified 7d ago