Quickstart Installation helps you jump start with the DIGIT basic installation steps with the limited functionalities.
DIGIT Quickstart setup gives you the ability to set up DIGIT Infra on a local machine/VM quickly. These are not meant for production use as is. However, this quickstart flow can make you familiar with most of the production-grade setup.
Quickstart is recommended for basic infra types like a local machine, setting up on a single VM, etc. We need to create a Lightweight Kubernetes (k3d ) cluster which does not really need a full-fledged cloud setup or multiple VMs. See the open source project k3d to learn more. You can install k3d on a local or on a VM when you have all the below pre-requisites and hardware requirements met.
To install k3d, make sure your instance meets the following h/w requirements that have sufficient CPU and Memory for both your default systems and for the DIGIT Setup requirement
Apart from the regular system usage, DIGIT should have a dedicated CPU/Memory requirement as below.
You must have admin/sudoer access before you proceed.
OS: Ubuntu 18.04 or Debian 10 or Windows 10 or Mac OSX
Local machine or VM or bare metal
8 vCPUs (recommend 8+)
16 GiB of RAM (recommend 20+)
30 GiB of HDD (recommend 40+)
NAT or Bridged networking with access to the internet
Before proceeding with DIGIT quickstart. Check the machine's remaining CPU/Memory capacity. To check the same you can use the following commands to determine - the commands vary from OS to OS, so select the OS-specific instructions.
Note: The above commands output provides you with the total memory/CPU and unused/free/available memory/CPU details. Make sure your unused/free/available memory meets the following:
Memory: 8GB
CPU: >30%
Once the above prerequisites are met, proceed with the following steps
Quickstart Infra is recommended to jump start with minimal DIGIT services to get a sense of the various installation steps and system requirements.
Depending on the H/W requirement of the machine that you want to try Quickstart DIGIT setup, choose the below options for the instructions.
If the above steps are completed successfully, your cluster is now up and running ready to proceed with the DIGIT Deployment.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Deploying DIGIT platform services
Now that the Infra set-up is complete, proceed with the DIGIT Deployment. Following tools need to be installed on the machine before proceeding with the DIGIT Services deployment.
What we'll deploy in Quickstart:
DIGIT's core platform services
Gov Service/s
DIGIT uses golang scripts to simplify the deployment process, an automated way by leveraging helm package manager to deploy the containerized services onto Kubernetes. Ensure that the below prerequisites are met before you proceed.
To install (required v1.13.3) follow these links - or or
All DIGIT services are packaged using helm charts, Install helm using the link
is a CLI to connect to the kubernetes cluster from your machine
Install for making api calls
IDE Code for better code visualization/editing capabilities
to run digit bootstrap scripts
After cloning the repo CD into the folder DIGIT-DevOps and type the "code ." command that will open the visual editor and opens all the files from the repo DIGIT-DevOps
Create your deployment config file, you can use the following template to update if any custom values to be changed (if you know the impact), otherwise, for the quickstart, you can run it as it is), navigate to the following file in your local repo.
4. Add the following entries in your host file /etc/hosts depending on your OS, instructions can be found below.
When you find the host file in your local machine, add the following lines to it, save and close the file.
127.0.0.1 quickstart.local.digit
Those who are using Cloud VM/Instance. Add the below entry to the host file in your local machine/laptop. Replace <Public_IP> with your VM/Instance Public IP.
<Public_IP> quickstart.local.digit
Now we have all the deployments configs ready, we can now run the following command and provide the necessary details asked and this interactive installer will take care of the rest.
Run the deployer go script from the following directory
2. Check all the pods are running and ready using the below command
Note: If kafka and zookeeper pods go into crashloopbackoff state due to a permission issue, use the below commands.
In windows
In Linux/Mac
3. You can now test the Digit application status in the command prompt/terminal by using the below command.
Note: Initially pgr-services would be in crashloopbackoff state, but after performing the below Post Deployment Steps pgr-services will start running.
Post deployment, now the application will be accessible from the configured domain.
To try out PGR employee login, Lets create a sample tenant, city, user to login and assign LME employee role through the seed script
2. Seed the sample data
Import the following postman collection into the postman and run it, this will have the seed data that enable sample test users and localisation data.
To test the kubernetes operations through kubectl from your local machine, please execute the below commands.
You have successfully completed the DIGIT Infra, Deployment setup and Installed a DIGIT - PGR module.
Use the below credentials to login into the complaint section
Username: GRO
Password: eGov@4321
City: CITYA
While you want to destroy the setup after you have explored/experienced the DIGIT quickstart you can tear down the entire setup using the following instructions
OutPut:
By deleting the cluster it automatically deletes all the DIGIT deployment components and free up the system resources.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Clone the following , you may need to and then run it to your machine.
/Linux
We have to do the of the egov-user service running from kubernetes cluster to your localhost, this will now give you access to egov-user service directly and interact with the api directly.
Ensure you have the postman to run the following seed data api, if not on your local
All content on this page by is licensed under a .
