Handles CRUD functions for disqualified officers.
Common commands used for development and running locally can be found in the Makefile, each make target has a
description which can be listed by running make help.
Target Description
------ -----------
all Calls methods required to build a locally runnable version, typically the build target
build Pull down any dependencies and compile code into an executable if required
clean Reset repo to pre-build state (i.e. a clean checkout state)
package Create a single versioned deployable package (i.e. jar, zip, tar, etc.). May be dependent on the
build target being run before package
sonar Run sonar scan
test Run all test-* targets (convenience method for developers)
test-unit Run unit tests
| URL | Description |
|---|---|
| /disqualified-officers/healthcheck | Health check URL returns 200 if service is running |
| /disqualified-officers/natural/{officerId}/internal | Save or update a natural disqualified officer record |
| /disqualified-officers/corporate/{officerId}/internal | Save or update a corporate disqualified officer record |
The code present in this repository is used to define and deploy a dockerised container in AWS ECS. This is done by calling a module from terraform-modules. Application specific attributes are injected and the service is then deployed using Terraform via the CICD platform 'Concourse'.
| Application specific attributes | Value | Description |
|---|---|---|
| ECS Cluster | public-data | ECS cluster (stack) the service belongs to |
| Load balancer | {env}-chs-apichgovuk {env}-chs-apichgovuk-private |
The load balancer that sits in front of the service |
| Concourse pipeline | Pipeline link Pipeline code |
Concourse pipeline link in shared services |
- Please refer to the ECS Development and Infrastructure Documentation for detailed information on the infrastructure being deployed.
- Ensure the terraform runner local plan executes without issues. For information on terraform runners please see the Terraform Runner Quickstart guide.
- If you encounter any issues or have questions, reach out to the team on the #platform slack channel.
- Any secrets required for this service will be stored in Vault. For any updates to the Vault configuration, please consult with the #platform team and submit a workflow request.