Deployment

Deploying OpenG2P SPAR on Kubernetes using Helm charts.

SPAR is deployed over Kubernetes infrastructure that offers production-grade deployment along with powerful security, access control and operational features. Learn more about the deployment architecture here.

Deployment is largely automated. Once the cluster and environment are in place, the entire SPAR subsystem — the Mapper Partner API, the Beneficiary Portal API, the PostgreSQL database/role and the Keycloak client — installs from a single Helm chart (spar) via the Rancher UI. No manual database, Keycloak or post-install configuration is required.

Deployment steps

1. Infrastructure setup

2. Environment creation

3. SPAR installation

SPAR installation

After steps 1 and 2, Rancher is up and running, so it is recommended to deploy SPAR from the Rancher UI.

Prerequisites

1. Infrastructure and environment are created as given above. The commons environment provides the shared services SPAR depends on — PostgreSQL and the Istio gateway. SPAR verifies partner signatures in-process, so it needs no runtime key service.

2. You have full admin rights to the cluster and the Rancher UI.

Installation

1. Login to the Rancher console.

2. Select the cluster and namespace (environment).

3. Under Apps → Repositories, make sure the OpenG2P charts repository is added — the shared GitLab Helm registry (https://gitlab.com/api/v4/projects/<CHARTS_PROJECT_ID>/packages/helm/stable), not the old openg2p.github.io/openg2p-helm GitHub Pages repo. See Helm & Docker Versioning and CI for the exact URL.

4. Under Apps → Charts, refresh all repositories.

5. To show moving (pre-release) versions, click your user avatar (top-right) → Preferences → enable Include Prerelease Versions.

6. Select the "OpenG2P SPAR" chart.

7. Select the version (3-digit versions denote frozen releases; versions with a -develop tag are moving versions).

8. On Install Step 1:

   1. select the namespace;

   2. give the installation a name — spar recommended (the database and role are derived from this name);

   3. select Customize Helm options before install;

   4. Next.

9. On the Helm Options page, disable the wait flag, then Install.

10. Wait for all pods to come up successfully (Running / Completed).

Post install check

With the default hostnames shown (namespace trial):

1. Open https://spar.<namespace>.openg2p.org/api/mapper/docs — the SPAR Mapper Partner API Swagger UI should load.

2. Open https://beneficiary.<namespace>.openg2p.org/api/bene-portal/docs — the Beneficiary Portal API Swagger UI should load.

The bare API base path (e.g. /api/mapper/) returns a 404 by design — there is no route there. Use /docs, or a specific endpoint.

Reference

• Helm Chart — what the chart contains, all parameters, and the command-line install option (for advanced / developer use).

• Keycloak Client — why the OIDC client is required and how it is created.

• Domain Names and Certificates

• Teardown / Uninstall — completely remove a release.