Web front-end for the register an overseas entity and tell us about its beneficial owners service. Link to the live page here
Web front-end for the file an overseas entity update statement service. Link to the live page here
Web front-end for the apply to remove an overseas entity from the register service. Link to the live page here
Simplified view of the architecture and does not show all services, components and infrastructure
Project Structure and Code Style
The only local development mode available, that includes account, redis and other important service/dependency is only possible through our development orchestrator service in Docker CHS Development, that uses tilt.
- 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-web(this will allow you to make changes in real time). - Run docker using
tilt upin the docker-chs-development directory. - Use spacebar in the command line to open tilt window - wait for overseas-entities-web to become green.(If you have credential errors then you may not be logged into
eu-west-2.) - Open your browser and go to http://chs.local/register-an-overseas-entity/starting-new for the ROE Registration journey, http://chs.local/update-an-overseas-entity/continue-with-saved-filing for the ROE Update journey or http://chs.local/update-an-overseas-entity/continue-with-saved-filing?journey=remove for the ROE Remove journey (each of these is the first page that would be displayed, if navigating from the GOV UK external ROE guidance screens).
Environment variables used to configure this service in docker are located in the file services/modules/overseas-entities/overseas-entities-web.docker-compose.yaml
- node v18 (engines block in package.json is used to enforce this)(Concourse pipeline builds using Node 18 and live runs on Node 18)
- npm 8 (engines block in package.json is used to enforce this)
- Docker
- To compile the project use
make build - To test the project use
make test - or
make clean build test
Ensure that you are logged into the AWS eu-west2 region:
aws ecr get-login-password --region eu-west-2 | docker login --username AWS --password-stdin 416670754337.dkr.ecr.eu-west-2.amazonaws.com
and then run:
DOCKER_BUILDKIT=0 docker build --build-arg SSH_PRIVATE_KEY="$(cat ~/.ssh/id_rsa)" --build-arg SSH_PRIVATE_KEY_PASSPHRASE -t 416670754337.dkr.ecr.eu-west-2.amazonaws.com/local/overseas-entities-web .
| Method | Path | Description |
|---|---|---|
| GET | /register-an-overseas-entity |
Returns the landing page for the Register an overseas entity, starting point to different other pages to register an OE. URLs path here. |
| GET | /update-an-overseas-entity |
Returns the landing page for updating an overseas entity. URLs path here. |
| GET | /update-an-overseas-entity/continue-with-saved-filing?journey=remove |
Returns the landing page for removing an overseas entity. URLs path here. |
| GET | /register-an-overseas-entity/healthcheck |
Returns responds with HTTP code 200 and a OK message body |
| Key | Description | Example Value |
|---|---|---|
| ACCOUNT_URL | URL to account service | http://account-ch-gov-uk:4000 |
| API_URL | URL to API call | http://api.chs.local:4001 |
| CACHE_SERVER | Redis cache server | redis |
| CDN_HOST | CDN host | cdn.chs.local |
| CHS_API_KEY | CHS API key for SDK call | key |
| CHS_URL | CHS local url | http://chs.local |
| COOKIE_DOMAIN | The domain of the cookie | chs.local |
| COOKIE_NAME | The name of the cookie | __SID |
| COOKIE_SECRET | The shared secret used in validating/calculating the session cookie signature | secret |
| INTERNAL_API_URL | Internal API URL | http://api.chs.local:4001 |
| LANDING_PAGE_URL | Register OE landing Page | /register-an-overseas-entity/sold-land-filter?start=0 |
| UPDATE_LANDING_PAGE_URL | Update OE landing Page | /update-an-overseas-entity/overseas-entity-query |
| REMOVE_LANDING_PAGE_URL | Remove OE landing Page | /update-an-overseas-entity/continue-with-saved-filing?journey=remove |
| LOG_LEVEL | LOG level | DEBUG |
| OAUTH2_CLIENT_ID | OAUTH2 client ID | client ID |
| OAUTH2_CLIENT_SECRET | OAUTH2 client secret | secret |
| PAYMENT_FEE | Payment Fee | 234.00 |
| UPDATE_PAYMENT_FEE | Update Payment Fee | 234.00 |
| PIWIK_URL | Matomo URL | https://matomo.platform.aws.chdev.org |
| PIWIK_SITE_ID | Matomo Site ID | 24 |
| PIWIK_START_GOAL_ID | Matomo Start goal ID | 3 |
| PIWIK_UPDATE_START_GOAL_ID | Matomo Update Start goal ID | 10 |
| PIWIK_REMOVE_START_GOAL_ID | Matomo Remove Start goal ID | 19 |
| PIWIK_RELEVANT_PERIOD_START_GOAL_ID | Matomo Relevant Period Start goal ID | 33 |
| SHOW_SERVICE_OFFLINE_PAGE | Feature Flag | false |
| VF01_FORM_DOWNLOAD_URL | Overseas entity verification checks statement URL | https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/1095139/OE_VF01.pdf |
Terraform is run via a concourse ci pipeline and is used in place of AWS Cloud Formation for both provisioning and for deploying the cluster and services.
The configuration is contained in 5 files:
- data: Specifies the resources to be read as input into the configuration
- locals: Contains internal configuration variables including the docker config variable keys mapped to the variable names
- main: The main configuration file
- variables: Contains variable names and types - the values are contained in the profiles for each environment
- vault: Credentials for the hashicorp vault
NB: All variables under the headings below are based on the contents of the variables file and do not include locals.
| Key | Description |
|---|---|
| aws_bucket | The bucket used to store the current terraform state files |
| remote_state_bucket | Alternative bucket used to store the remote state files from ch-service-terraform |
| state_prefix | The bucket prefix used with the remote_state_bucket files |
| deploy_to | Bucket namespace used with remote_state_bucket and state_prefix |
| Key | Description |
|---|---|
| environment | The environment name, defined in environment's vars |
| aws_region | The AWS region for deployment |
| aws_profile | The AWS profile to use for deployment |
| kms_alias |
| Key | Description |
|---|---|
| docker_registry | The FQDN of the Docker registry |
| Key | Description | Example Value |
|---|---|---|
| desired_task_count | The desired ECS task count for this service | 1 |
| required_cpus | The required cpu resource for this service. 1024 here is 1 vCPU | 128 |
| required_memory | The required memory for this service | 256 |
| Key | Description | Example Value |
|---|---|---|
| overseas_entities_web_version | The version of the overseas entities web container to run. | 1.0 |
| account_local_url | Used in place of ACCOUNT_URL | https://account.cidev.aws.chdev.org |
| cache_pool_size | Size of cache pool | 8 |
| default_session_expiration | Lifetime of sessions | 3600 |
| redirect_uri | Redirect users to homepage when trying to access other pages directly | / |
- Use the Visual Studio Code IDE for development.
- Use the preformatted
PULL_REQUEST_TEMPLATEby adding meaningful description - Make sure test coverage is well above
80% - Do not disable husky pre checks locally
- Use one of the main CH slack channel if you get stuck
- Use MVC pattern when adding a new page/endpoint, including validation, authentication and navigation checks all together, otherwise featureflag it please. Example can be found on the following PR here and doc description here
- Happy coding
This code is open source software licensed under the MIT License.