Environment Installation

The instructions here pertain to the deployment of commons on the Kubernetes cluster using OpenG2P-Commons. All the components are installed in the same namespace.

Prerequisites

Before you deploy, make sure the following are in place:

• ✅ Infrastruction setup is completed

• ✅ Environment has been setup with common resources installed.

• ✅ Domain name esignet.<your environment>.<your domain name> (e.g. esignet.qa.openg2p.org) is available along with SSL certificate for the domain (the wild certificate should have already been loaded during Infrastructure setup)

• ✅ Project Owner access on the OpenG2P namespace

Installation using Rancher UI

1. Log in to Rancher admin console.

2. Select your cluster.

3. Under Apps -> Repositories click on Create to add a repository.

4. Provide Name as openg2p and target HTTPS Index URL as https://openg2p.github.io/openg2p-helm/rancher and click Create.

   
5. To display prerelease versions of OpenG2P apps, click on your user avatar in the upper right corner of the Rancher dashboard. Then click on Include Prerelease Versions under Preferences under Helm Charts.

   
6. Select the namespace in which you would like to install Registry, from the namespace filter on the top-right.

7. Navigate to Apps->Charts page on Rancher. You should see OpenG2P commons Helm charts listed.

   
8. Proceed to Install OpenG2P Commons chart select the latest version to be installed, and click Install.

9. On the next screen, choose a name for installation, like Commons. Select the checkbox Customise Helm options before install, and click Next.

10. Go through each app's configuration page, and configure the following:

    1. Configure a hostname for each app in the following way. <appname>.<base-hostname> , where base hostname is the wildcard hostname chosen during Istio namespace setup. Example: esignet.dev.openg2p.org and odk.dev.openg2p.org , etc. <appname> is arbitrary - default names have been provided.

    2. Keycloak Base Url is your organization-wide Keycloak URL. (Ex: keycloak.<your domain>.org)

    3. OIDC Client details are asked. Create Keycloak Client, refer to Keycloak Client Creation guide.

11. Click Next to reach Helm Options page. Disable wait flag. Click on Install.

12. Wait for all the pods to get into Running state. This may take several minutes.

    

Once deployed, the OpenG2P Commons services such as PostgreSQL, MinIO, Keymanager, OpenSearch, and others will be automatically set up and available for dependent applications.

Post Installation

Keycloak

Assigning roles to users

Create Keycloak client roles for the following components and assign them to users:

Assigning roles to clients

• For Social Registry to be able to access Keymanager APIs, create a realm role in Keycloak with the name "KEYMANAGER_ADMIN" and assign this as a service account role to the Social Registry Keycloak client.

Modules

Install the modules and other utility apps individually using their respective instructions:

1. Registry

2. PBMS

3. SPAR

4. G2P Bridge

5. Beneficiary Portal