API service for limited partnerships
In order to run the service locally you will need the following:
To check out and build the service:
- Clone Docker CHS Development and follow the steps in the README.
- Run chs-dev modules enable limited-partnerships
- Run chs-dev development enable limited-partnerships-api (this will allow you to make changes).
- Run docker using "chs-dev up" in the docker-chs-development directory.
- If you are using the api directly, then use this url: http://api.chs.local/limited-partnership
The full path for each public endpoint begins with the url:
${API_URL}/limited-partnership
Localhost API_URL = http://localhost:8080
Docker API_URL = http://api.chs.local
| Method | Path | Description |
|---|---|---|
| GET | /healthcheck | The health check endpoint for this service |
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 | filing-maintain | 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.