HMPPS Incident Reporting API

This application is api and database that owns incident report data for prisons.

Running locally against dev/T3 services

This is straight-forward as authentication is delegated down to the calling services in dev environment. Environment variables to be set are as follows:

API_BASE_URL_OAUTH=https://sign-in-dev.hmpps.service.justice.gov.uk/auth
API_BASE_URL_PRISON=https://prison-api-dev.prison.service.justice.gov.uk
INCIDENT_REPORTING_API_CLIENT_ID=[choose a suitable hmpps-auth client]
INCIDENT_REPORTING_API_CLIENT_SECRET=

Start the database and other required services via docker-compose with:

docker compose -f docker-compose-local.yml up

Then run the API.

Connecting to AWS resources from a local port

There are custom gradle tasks that make it easier to connect to AWS resources (RDS and ElastiCache Redis) in Cloud Platform from a local port:

./gradlew portForwardRDS
# and
./gradlew portForwardRedis

These could be useful to, for instance, clear out a development database or edit data live.

They require kubectl to already be set up to access the kubernetes cluster; essentially these tasks are just convenience wrappers.

Both accept the --environment argument to select between dev, preprod and prod namespaces or prompt for user input when run.

Both also accept the --port argument to choose a different local port, other than the resource’s default.

Architecture

Architecture decision records start here