API service for submitting overseas entity registrations
In order to run the service locally you will need the following:
To checkout and build the service:
- Clone Docker CHS Development and follow the steps in the README.
- Run ./bin/chs-dev modules enable overseas-entities
- Run ./bin/chs-dev development enable overseas-entities-api (this will allow you to make changes).
- Run docker using "tilt up" in the docker-chs-development directory.
- Use spacebar in the command line to open tilt window - wait for overseas-entities-api to become green.
- Open your browser and go to page http://chs.local/register-an-overseas-entity
- If you are using the api directly, then use this url: http://chs.local/overseas-entities
These instructions are for a local docker environment.
The full path for each public endpoints that requires a transaction id begins with the app url:
${API_URL}/overseas-entities
| Method | Path | Description |
|---|
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-create | 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.