PBMS Installation

The instructions here pertain to the deployment of PBMS and associated components on the Kubernetes cluster using PBMS Helm chart. All the components are installed in the same namespace.

Prerequisites

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

• Kubernetes cluster is up and running

• Nginx server is configured (skip this for OpenG2P-in-a-box)

• Namespace is created (via Rancher under a Project)

• Project Owner access on the OpenG2P namespace

• Istio gateway is set up in the namespace

Installation using Rancher UI

1. Log in to the Rancher Admin Console and select your target cluster.

2. Navigate to Apps → Repositories and click Create to add a new repository:

   • Name: openg2p

   • Target HTTPS Index URL: https://openg2p.github.io/openg2p-helm/rancher

   • Click Create

   
3. On the top-right, select the namespace where you want to install PBMS.

4. To view prerelease charts (if required), click your user avatar → Preferences → Include Prerelease Versions.

   
5. Navigate to Apps → Charts and locate the chart:

   • Name: OpenG2P PBMS (3.0.0)

   • Description: A Helm chart for OpenG2P PBMS

   
6. Click the chart, choose version 3.0.0, and click Install.

7. On the next screen:

   • Installation Name: openg2p-pbms (or any preferred name)

   • Enable Customise Helmbox before installation → click Next

8. In the General Settings section, configure the following:

   • Hostname: Set the PBMS URL (e.g., pbms.dev.openg2p.org)

   • PostgreSQL Host: Provide the hostname of the PostgreSQL instance (or use the internal one if enabled)

   • Keycloak Base URL: Enter your Keycloak URL (e.g., https://keycloak.openg2p.sandbox.net)

   • Email Service Name: Provide the email service name used in PBMS

9. In the Registry Settings section:

   • Registry DB: Provide the PostgreSQL database name for Registry

   • Registry DB User: Enter the DB username

   • Registry DB Secret: Specify the Kubernetes secret name containing the DB password

   • Registry DB Secret Key: Enter the key name within the secret containing the user password

10. Configure Odoo Settings :

    • OIDC Client ID: Provide the OIDC client ID for PBMS (Odoo)

    • OIDC Client Secret: Provide the OIDC client secret for PBMS (Odoo)

11. Click Next → go to Helm Options.

    • Disable the Wait flag

12. Click Install.

13. Monitor pods in your namespace until they reach the Running state.

    

Installation using CLI

1. Clone the OpenG2P PBMS Deployment Repository

2. Update Helm Dependencies

3. Review and update values.yaml as needed:

   • global.hostname: Public hostname for PBMS (e.g., pbms.dev.openg2p.org)

   • global.keycloakBaseUrl: Base URL for Keycloak authentication

   • global.postgresqlHost: PostgreSQL host (e.g., openg2p-commons-postgresql)

   • global.registryDB* and global.pbmsDB*: Registry and PBMS database credentials

   • odoo.image.tag: PBMS version or custom image tag

   • istio.virtualservice.host: Hostname when Istio is enabled

   You can override values inline using --set or pass a custom file with -f.

4. Install the Helm chart

   Replace <release-name> with a unique name (e.g., pbms-dev) and <namespace> with the target Kubernetes namespace.

5. Verify deployment

6. Upgrade the deployment when changing configuration

   You can view current values using:

Post-Installation Configuration

1. Get the Odoo service URL (usually from ingress or Istio VirtualService):

2. Log in to Odoo using admin credentials (configured in Keycloak or Odoo setup).

3. Activate the PBMS modules under Apps:

   • Ensure “OpenG2P PBMS Core”, “OpenG2P PBMS Background Tasks”, and other required extensions are installed.

   • Update module list if they aren’t visible:

4. Validate Redis and Minio connectivity:

   • Ensure Redis pod is running and reachable by the Celery worker.

   • Verify Minio access credentials match the Helm values and Odoo configuration.

5. Confirm database migrations:

   • Review logs of Odoo pod for any migration errors:

6. (Optional) Apply PBMS demo or seed data:

Tear down

To completely cleanup PBMS installation, note the following: Helm uninstall will not delete the database and secrets created. Secret for user does not get deleted (and rightly so). If you re-run the Helm while database still exists, it just brings up Odoo without any issues - it does not re-initalize the database.

To tear down completely:

1. Helm uninstall via command line or Rancher (Apps -> Installed Apps --> Delete)

2. Delete pbms secret in the namespace

3. Drop pbms_db and user from Postgres

   1. Login into Postgres as admin (via port fowarding or directly from Rancher). Use the postgres-password key in openg2p-commons-postgresql secret to get the password

   2. drop database pbms_db;

   3. drop role pbms_db_user;