Skip to content

The disqualified-officers-delta-consumer is responsible for transforming officer disqualification data from the disqualification-data kafka topic as part of chips and chs data sync.

License

Notifications You must be signed in to change notification settings

companieshouse/disqualified-officers-delta-consumer

Repository files navigation

disqualified-officers-delta-consumer

The disqualified-officers-delta-consumer is responsible for transforming officer disqualification data from the disqualified-officers-delta kafka topic as part of chips and chs data sync.

Build tools

Build

Common commands used for development and running locally can be found in the Makefile.

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

Building the docker image

mvn compile jib:dockerBuild

Endpoints

URL Description
/disqualified-officers-delta-consumer/healthcheck Health check URL returns 200 if service is running

Terraform ECS

What does this code do?

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 data-sync ECS cluster (stack) the service belongs to
Load balancer N/A consumer service The load balancer that sits in front of the service
Concourse pipeline Pipeline link
Pipeline code
Concourse pipeline link in shared services

Contributing

Testing

  • 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.

Vault Configuration Updates

  • 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.

Useful Links

About

The disqualified-officers-delta-consumer is responsible for transforming officer disqualification data from the disqualification-data kafka topic as part of chips and chs data sync.

Resources

License

Stars

Watchers

Forks

Packages

No packages published