# How to Install DIVOC ## Assumptions * Use a Debian-based Linux distribution (preferably Ubuntu) * Experience in running simple shell and bash commands ## Pre-requisites * Debian-based OS (Ubuntu) * sshpass * Ansible * GIT * kubectl * List of servers and ability to access them using key-based authentication * Server map to list servers against software * Access to the DIVOC installer repository * Access to the implementation-specific DIVOC code ## Suggested servers for HA setup The sizing and count of the servers can change based on the load requirements. However, for a truly HA setup, the following are the minimum requirements: ### Postgres and etcd 3 servers for HA setup: one master and 2 replicas. The etcd cluster can also be set up on the same servers. ### Kubernetes 6 servers: 3 for control plane (or master node can be relatively smaller sized instances) and 3 worker nodes (for deploying the application). ### Kafka and Zookeeper 3 servers containing both Zookeeper and Kafka (Ideally Zookeeper and Kafka need to be installed on separate servers but we should be fine to install both on the same machine). ### Redis 3 servers ### Elasticsearch 3 servers #### Docker-registry 1 server ## Overview There are three scripts that need to be run to complete the DIVOC installation process: 1. Installing the prerequisites and setting various hardware clusters as detailed above. 2. Building the pushing the docker images to the appropriate registry. 3. Deploying code from the registry into Kubernetes cluster. ## Installation dependencies 1. Clone the repository available at [**https://github.com/egovernments/divoc-installer**](https://github.com/egovernments/divoc-installer). 2. Create an inventory file from the sample inventory file located at [**https://github.com/egovernments/divoc-installer/blob/master/inventory.example.ini**](https://github.com/egovernments/divoc-installer/blob/master/inventory.example.ini). 3. Add the inventory details as per the comments present in the file. 4. Run the install.sh present within the divoc-installer with the elevated privileges (we can also use nohup for running in the background): {% hint style="info" %} sudo sh install.sh -i \ {% endhint %} * It will install the dependencies like python3, ansible, etc. * It will install the applications and configure them on the servers mentioned in the inventory file. ## Build Docker images * Run the build.sh file with elevated privileges. {% hint style="info" %} sudo sh build.sh -d \ -r \ {% endhint %} * Default values for the Docker repository are from dockerhub. * The Default value for the GIT repo is the master branch of the [**https://github.com/egovernments/DIVOC.git**](https://github.com/egovernments/DIVOC). ## **Install DIVOC application** 1. The sample default Kubernetes deployment files are available at [**https://github.com/egovernments/divoc-installer/tree/master/kube-deployment-config-example**](https://github.com/egovernments/divoc-installer/tree/master/kube-deployment-config-example)**.** 2. Make a copy of the folder and change the internal script files to have the following configurations. It is recommended that you maintain your own configuration in a separate Github repository so that you have version control and backup (you require only the example folder, not the full repository). a. Within the divoc-installer director, open the divoc-config.yaml file present within the deployment configuration directory and make the following changes: \- DB\_HOST \- DB\_USER \- DB\_PASS \- DB\_PORT \- KAFKA\_BOOTSTRAP\_SERVERS \- REDIS\_URL \- CLICKHOUSE\_URL \- AUTH\_PRIVATE\_KEY \- AUTH\_PUBLIC\_KEY \- CERTIFICATE\_NAMESPACE \- CERTIFICATE\_NAMESPACE\_V2 \- CERTIFICATE\_CONTROLLER\_ID \- CERTIFICATE\_PUBKEY\_ID \- CERTIFICATE\_DID \- CERTIFICATE\_ISSUER \- CERTIFICATE\_BASE\_URL \- CERTIFICATE\_FEEDBACK\_BASE\_URL \- CERTIFICATE\_INFO\_BASE\_URL \- CERTIFICATE\_PUBLIC\_KEY \- CERTIFICATE\_PRIVATE\_KEY \- CITIZEN\_PORTAL\_URL b. Modify registry-deployment.yaml to change the following: \- connectionInfo\_password \- connectionInfo\_uri \- connectionInfo\_username \- elastic\_search\_enabled \- registry\_base\_apis\_enable \- taskExecutor\_index\_queueCapacity \- auditTaskExecutor\_queueCapacity \- Signature\_enabled c. Modify keycloak-deployment.yaml to add the following information: \- DB\_ADDR \- DB\_DATABASE \- DB\_PASSWORD \- DB\_PORT \- DB\_USER \- DB\_VENDOR \- KEYCLOAK\_USER \- KEYCLOAK\_PASSWORD \- ENABLE\_OTP\_MESSAGE \- KAFKA\_BOOTSTRAP\_SERVERS 3\. Run the deploy script to deploy the application on Kubernetes. {% hint style="info" %} sudo sh deploy.sh -i \ -p \ -d \ -k \ -s \ {% endhint %} ## Post installation ### Create indexes on database tables The indexes for efficient querying of the database tables do not get automatically created and hence need to be created manually. Execute registry\_index.sql is present within the DIVOC codebase on the database. A restart of the registry service is required for this change to reflect. **Note:** Database tables are only created when the first API request is received. [![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/)*All content on this page by* [*eGov Foundation*](https://egov.org.in/) *is licensed under a* [*Creative Commons Attribution 4.0 International License*](http://creativecommons.org/licenses/by/4.0/)*.* --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://divoc.digit.org/platform/installation/setting-up-divoc-in-k8-cluster/how-to-install-divoc.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.