Deployment
SPAR Deployment
Last updated
Was this helpful?
SPAR Deployment
Last updated
Was this helpful?
The instructions here pertain to the deployment of all SPAR components on the Kubernetes cluster using. The charts install SPAR components along with the Postgresql server specific to SPAR. All the components are installed in the same namespace. The deployment may be achieved by the following methods:
Using Rancher UI
Using command line
Before you deploy SPAR, make sure the following are available:
(required only if SPAR Self Service API is being installed)
Cluster Owner permission on your cluster
Namespace in which you would be installing SPAR is created on the cluster
Log in to Rancher admin console.
Select your cluster.
Under Apps -> Repositories click on Create to add a repository.
Provide Name as "openg2p" and target HTTPS Index URL as and click Create.
Navigate to Apps->Charts page on Rancher. You should see OpenG2P SPAR Helm chart listed.
Click on the Helm chart, select the version to be installed and click Install.
Select the namespace in which you would like the chart to be installed (you will need to create a namespace upfront if it does not already exist) and select the checkbox Customise Helm options before install.
Click Next and then Install.
Install the following utilities on your machine:
kubectl
, istioctl
, helm
, jq
, curl
, wget
, git
, bash
, envsubst
.
Run.
After installation, SPAR is accessible over following URLs based on the SPAR_HOSTNAME
given above:
SPAR Self Service UI: https://spar.openg2p.sandbox.net
SPAR Self Service API: https://spar.openg2p.sandbox.net/spar/v1
SPAR Mapper: https://spar.openg2p.sandbox.net/mapper/v1
Postgresql is installed as part of the above procedure in the same namespace. The default database created is spardb.
Create OIDC Client for SPAR in eSignet. Follow the method suggested by the ID Provider.
If using mock eSignet, use this API to create OIDC client.
During OIDC client creation, you will be asked for (or given) a client ID and private key JWK as client secret.
Edit the SPAR DB, login_provider
table and modify the authorization_parameters
row of the first entry, with:
appropriate URLs for authorize_endpoint
, token_endpoint
, validate_endpoint
, jwks_endpoint
, and redirect_uri
fields.
above client ID under the client_id
field.
and above private key jwk under the client_assertion_jwk
field.
Seed/edit metadata of banks, wallets, branches, etc for the SPAR self-service portal in database. TODO: Elaborate.
TBD
Provide Global Hostname of the installation. Refer to for mapping the hostname.
Select the components to be installed and the eSignet base URL. The latter is required only if you are installing .
Clone the repo. Switch to the branch of interest. Navigate to deployment
directory.