- Prerequisites
- Quick start
- Using CCD
- Idam Stub
- Compose branches
- Compose projects
- Under the hood
- Containers
- Local development
- Troubleshooting
- Variables
- Remarks
- License
Memory and CPU allocations may need to be increased for successful execution of ccd applications altogether. (On Preferences / Advanced)
- Azure CLI - minimum version 2.0.57
- [jq Json Processor] (https://stedolan.github.io/jq)
The following documentation assumes that the current directory is ccd-docker
.
Checkout ccd-docker
project:
git clone git@github.com:hmcts/ccd-docker.git
Login to the Azure Container registry:
./ccd login
Note:
if you experience any error with the above command, try az login
first
For Azure Authentication for pulling latest docker images
Pulling latest Docker images:
./ccd compose pull
Running initialisation steps:
Note: required only on the first run. Once executed, it doesn't need to be executed again
./ccd init
Creating and starting the containers:
./ccd compose up -d
Usage and commands available:
./ccd
Environment variables for CCD Data Store API and CCD Definition Store API can be done by executing the following script.
Windows : ./bin/set-environment-variables.sh
Mac : source ./bin/set-environment-variables.sh
Note: some users of zsh 'Oh My Zsh' experienced issues. Try switching to bash for this step
To persist the environment variables in Mac, copy the contents of env_variables_all.txt
file into ~/.bash_profile.
A prefix 'export' will be required for each of environment variable.
Once the containers are running, CCD's frontend can be accessed at http://localhost:3451.
However, 6 more steps are required to correctly configure SIDAM and CCD before it can be used:
An oauth2 client should be configured for ccd-gateway application, on SIDAM Web Admin. You need to login to the SIDAM Web Admin with the URL and logic credentials here: https://tools.hmcts.net/confluence/x/eQP3P
Navigate to Home > Manage Services > Add a new Service
On the Add Service screen the following fields are required:
label : <any>
description : <any>
client_id : ccd_gateway
client_secret : ccd_gateway_secret
new redirect_uri (click 'Add URI' before saving) : http://localhost:3451/oauth2redirect
After defining the above client/service, the following roles must be defined under this client/service (Home > Manage Roles > select your service > Role Label) (some of these roles are used in the automated functional test):
* ccd-import
* caseworker
* caseworker-autotest1
* caseworker-autotest2
The following roles are additionally required for the new automated functional tests.
* caseworker-befta_jurisdiction_1
* caseworker-befta_jurisdiction_2
* caseworker-befta_jurisdiction_3
* caseworker-befta_jurisdiction_2-solicitor_1
* caseworker-befta_jurisdiction_2-solicitor_2
* caseworker-befta_jurisdiction_2-solicitor_3
* caseworker-befta_jurisdiction_3-solicitor
Don't worry about the Assignable roles section when adding roles
Once the roles are defined under the client/service, go to the service configuration for the service you created in Step 1 (Home > Manage Services > select your service) and select ccd-import
role radio option under Private Beta Role section
Any business-related roles like caseworker
,caseworker-<jurisdiction>
etc to be used in CCD later must also be defined under the client configuration at this stage.
A script is provided that sets up some initial users and roles for running functional tests. Execute the following:
./bin/create-initial-roles-and-users.sh
A user with import role should be created using the following command:
./bin/idam-create-caseworker.sh ccd-import ccd.docker.default@hmcts.net Pa55word11 Default CCD_Docker
This call will create a user in SIDAM with ccd-import role. This user will be used to acquire a user token with "ccd-import" role.
Before a definition can be imported, roles referenced in a case definition Authorisation tabs must be defined in CCD using:
./bin/ccd-add-role.sh <role> [classification]
Parameters:
role
: Name of the role, e.g:caseworker-divorce
.classification
: Optional. One ofPUBLIC
,PRIVATE
orRESTRICTED
. Defaults toPUBLIC
.
A caseworker user can be created in IDAM using the following command:
./bin/idam-create-caseworker.sh <roles> <email> [password] [surname] [forename]
Parameters:
roles
: a comma-separated list of roles. Roles must be existing IDAM roles for the CCD domain. Every caseworker requires at least it's coarse-grained jurisdiction role (caseworker-<jurisdiction>
).email
: Email address used for logging in.password
: Optional. Password for logging in. Defaults toPa55word11
. Weak passwords that do not match the password criteria by SIDAM will cause use creation to fail, and such failure may not be expressly communicated to the user.
For example:
./bin/idam-create-caseworker.sh caseworker-probate,caseworker-probate-solicitor probate@hmcts.net
-
A. Before running CCD Data Store tests, execute the CCD Definition store test cases first so that case definitions are loaded from CCD_CNP_27.xlsx.
-
B. Set the TEST_URL environment variable to match the service the functional tests should executed against:
For ccd-definition-store-api functional tests the set TEST_URL=http://localhost:4451 For ccd-data-store-api functional tests set TEST_URL=http://localhost:4452
To reduce impact on performances, case definitions are imported via the command line rather than using CCD's dedicated UI:
./bin/ccd-import-definition.sh <path_to_definition>
Parameters:
path_to_definition
: Path to.xlsx
file containing the case definition.
Note: For CCD to work, the definition must contain the caseworker's email address created at step 1.
If the import fails with an error of the form:
Validation errors occurred importing the spreadsheet.
- Invalid IdamRole 'caseworker-cmc-loa1' in AuthorisationCaseField tab, case type 'MoneyClaimCase', case field 'submitterId', crud 'CRUD'
Then the indicated role, here caseworker-cmc-loa1
, must be added to CCD (See 4. Add Initial Roles).
Back to http://localhost:3451, you can now log in with the email and password defined at 5. Add Initial Case Worker Users.
If you left the password out when creating the caseworker, by default it's set to: Pa55word11
.
If you see only a grey screen after entering your user credentials in the login page, you may need to set profile settings in ccd_user_profile database by adding a single line for the user in the below tables:
1- user_profile
2- user_profile_jurisdiction
It's possible to disable the Idam containers and run CCD with an Idam Stub provided by ccd-test-stubs-service. This is useful as a back up plan for when docker Idam is broken or when you local machine is running low on memory and you don't want to spin up the whole Idam containers
make sure 'sidam', 'sidam-local', 'sidam-local-ccd' docker compose files are not enabled. How you do that depends on your currently active compose files. When no active compose files are present, the default ones are executed. But if there's any active, then the defautl ones are ignored. For example:
./ccd enable show
Currently active compose files:
backend
frontend
sidam
sidam-local
sidam-local-ccd
Default compose files:
backend
frontend
sidam
sidam-local
sidam-local-ccd
In this case sidam is currently explicitly enabled. To disable it:
./ccd disable sidam sidam-local sidam-local-ccd
If you are instead running with the default compose file as in:
./ccd enable show
Default compose files:
backend
frontend
sidam
sidam-local
sidam-local-ccd
You must explicitly enable only CCD compose files but exclude sidam:
./ccd enable backend frontend
./ccd enable show
Currently active compose files:
backend
frontend
Default compose files:
backend
frontend
sidam
sidam-local
sidam-local-ccd
in the '.env' file, uncomment:
#IDAM_STUB_SERVICE_NAME=http://ccd-test-stubs-service:5555
#IDAM_STUB_LOCALHOST=http://localhost:5555
To allow definition imports to work ('ccd-import-definition.sh') you need to:
export IDAM_STUB_LOCALHOST=http://localhost:5555
unset IDAM_STUB_LOCALHOST
Idam Stub comes with a set of default Idam roles. To customise the Idam roles follow the instructions in 'backend.yml' ccd-test-stubs-service
./ccd enable sidam sidam-local sidam-local-ccd
or just revert to the default:
./ccd enable default
in the '.env' file, make sure the following env vars are commented:
#IDAM_STUB_SERVICE_NAME=http://ccd-test-stubs-service:5555
#IDAM_STUB_LOCALHOST=http://localhost:5555
then from the command line:
unset IDAM_STUB_LOCALHOST
#assuming no containers running and Idam is enabled
#start with Idam
./ccd compose up -d
#services started
./ccd compose stop
#enable Idam Stub follwing the steps in 'Enable Idam Stub'
#start with Idam Stub
./ccd compose up -d
#services started
you also can issue a 'down' when Idam Stub is enabled without risking of losing Idam data, since it's disabled
./ccd compose down
enable Idam follwing the steps in 'Revert to Idam'
#start with Idam. This will now create new CCD containers and reuse the old Idam ones
./ccd compose up -d
NOTE:
By default, all CCD containers are running with the latest
tag, built from the master
branch.
Using the set
command, branches can be changed per project.
Usage of the command is:
./ccd set <project> <branch> [file://local_repository_path]
<project>
must be one of:- ccd-data-store-api
- ccd-definition-store-api
- ccd-user-profile-api
- ccd-api-gateway
- ccd-case-management-web
- ccd-test-stubs-service
<branch>
must be an existing remote branch for the selected project.[file://local_repository_path]
path of the local repository in case you want to switch to a local branch
Branches for a project can be listed using:
./ccd branches <project>
When switching to a branch, a Docker image is built locally and the Docker compose configuration is updated.
However, to make that configuration effective, the Docker containers must be updated using:
./ccd compose up -d
When a project has been switched to a branch, it can be reverted to master
in 2 ways:
./ccd set <project> master
or
./ccd unset <project> [<projects...>]
The only difference is that unset
allows for multiple projects to be reset to master
.
In both cases, like with the set
command, for the reset to be effective it requires the containers to be updated:
./ccd compose up -d
To know which branches are currently used, the status
command can be used:
./ccd status
The 2nd part of the output indicates the current branches. The output can either be of the form:
No overrides, all using master
when no branches are used; or:
Current overrides: ccd-case-management-web branch:RDM-2414 hash:ced648d
when branches are in use.
ℹ️ In addition to the status
command, the current status is also displayed for every compose
commands.
By default, ccd-docker
runs the most commonly used backend and frontend projects required:
- Back-end:
- sidam-api: Strategic identity and access control
- service-auth-provider-api: Service-to-service security layer
- ccd-user-profile-api: Users/jurisdictions association and usage preferences
- ccd-definition-store-api: CCD's dynamic case definition repository
- ccd-data-store-api: CCD's cases repository
- ccd-test-stubs-service: CCD's testing support for stubbing http calls (service callbacks etc)
- Front-end:
- idam-web-public: SIDAM's login UI
- ccd-api-gateway: Proxy with SIDAM and S2S integration
- ccd-case-management-web: Caseworker UI
Optional compose files will allow other projects to be enabled on demand using the enable
and disable
commands.
-
To enable document-management-store-app
./ccd enable backend frontend dm-store
- run docker-compose
./ccd compose up -d
- create Blob Store in Azurite
./bin/document-management-store-create-blob-store-container.sh
-
To enable elastic search
- NOTE: we recommend at lest 6GB of memory for Docker when enabling elasticsearch
./ccd enable elasticsearch
(assumingbackend
is already enabled, otherwise enable it)- export ES_ENABLED_DOCKER=true
- verify that Data Store is able to connect to elasticsearch:
curl localhost:4452/health
-
To enable ccd-definition-designer-api
./ccd enable backend ccd-definition-designer-api
- run docker-compose
./ccd compose up -d
- verify that ccd-definition-designer-api is up and running by
curl localhost:4544/health
When switching to a branch with the set
command, the following actions take place:
- The given branch is cloned in the temporary
.workspace
folder - If required, the project is built
- A docker image is built
- The Docker image is tagged as
hmcts/<project>:<branch>-<git hash>
- An entry is added to file
.tags.env
exporting an environment variable<PROJECT>_TAG
with a value<branch>-<git hash>
matching the Docker image tag
The .tags.env
file is sourced whenever the ccd compose
command is used and allows to override the Docker images version used in the Docker compose files.
Hence, to make that change effective, the containers must be updated using ./ccd compose up
.
When switching a project to master
branch, the branch override is removed using the unset
command detailed below.
Given a list of 1 or more projects, for each project:
- If
.tags.env
contains an entry for the project, the entry is removed
Similarly to when branches are set, for a change to .tags.env
to be applied, the containers must be updated using ./ccd compose up
.
Retrieve from .tags.env
the branches and compose files currently enabled and display them.
./ccd compose [<docker-compose command> [options]]
The compose command acts as a wrapper around docker-compose
and accept all commands and options supported by it.
ℹ️ For the complete documentation of Docker Compose CLI, see Compose command-line reference.
Here are some useful commands:
./ccd compose up [-d]
This command:
- Create missing containers
- Recreate outdated containers (= apply configuration changes)
- Start all enabled containers
The -d
(detached) option start the containers in the background.
./ccd compose down [-v] [project]
This stops and destroys all composed containers.
If provided, the -v
option will also clean the volumes.
Destroyed containers cannot be restarted. New containers will need to be built using the up
command.
./ccd compose ps [<project>]
Gives the current state of all or specified composed projects.
./ccd compose logs [-f] [<project>]
Displays the logs for all or specified composed projects.
The -f
(follow) option allows to follow the tail of the logs.
./ccd compose start [<project>]
./ccd compose stop [<project>]
Start or stop all or specified composed containers. Stopped containers can be restarted with the start
command.
up
command should be used to that end.
./ccd compose pull [project]
Fetch the latest version of an image from its source. For the new version to be used, the associated container must be re-created using the up
command.
OAuth 2 clients must be explicitly declared in service sidam-api
with their ID and secret.
A client is defined as an environment variable complying to the pattern:
environment:
IDAM_API_OAUTH2_CLIENT_CLIENT_SECRETS_<CLIENT_ID>: <CLIENT_SECRET>
The CLIENT_SECRET
must then also be provided to the container used by the client service.
ℹ️ To prevent duplication, the client secret should be defined in the .env
file and then used in the compose files using string interpolation "${<VARIABLE_NAME>}"
.
Micro-services names and secret keys must be registered as part of service-auth-provider-api
configuration by adding environment variables like:
environment:
MICROSERVICE_KEYS_<SERVICE_NAME>: <SERVICE_SECRET>
The SERVICE_SECRET
must then also be provided to the container running the micro-service.
ℹ️ To prevent duplication, the client secret should be defined in the .env
file and then used in the compose files using string interpolation "${<VARIABLE_NAME>}"
.
To use UK address lookup feature an API key for https://postcodeinfo.service.justice.gov.uk is required. When API key is available it needs to be set on host side under ADDRESS_LOOKUP_TOKEN
variable name.
Store holding the case type definitions, which are a case's states, events and schema as well as its display configuration for rendering in CCD's UI.
Store where the versioned instances of cases are recorded.
Display preferences for the CCD users.
Service to facilitate testing of external http calls using wiremock. It returns canned responses for requests matching the predefined criteria. Currently used for:
- exposing a set of default callbacks that can be invoked for testing purposes
- Idam Stub
API gateway securing interactions between ccd-case-management-web
and the back-end services.
Caseworker frontend, exposed on port 3451
.
The provided Docker compose files can be used to get up and running for local development.
However, while working, it is more convenient to run a project directly on the localhost rather than having to rebuild a docker image and a container. This means mixing a locally-run project, the one being worked on, with projects running in Docker containers.
Given their unique configuration and dependencies, the way to achieve this varies slightly from one project to the other.
Here's the overall approach:
As is, the containers are configured to use one another. Thus, the first step to replace a container by a locally running instance is to update all references to this container in the compose files.
For instances, to use a local data store, references in ccd-api-gateway
service (file compose/frontend.yml
) must be changed from:
PROXY_AGGREGATED: http://ccd-data-store-api:4452
PROXY_DATA: http://ccd-data-store-api:4452
to, for Mac OS:
PROXY_AGGREGATED: http://docker.for.mac.localhost:4452
PROXY_DATA: http://docker.for.mac.localhost:4452
or to, for Windows:
PROXY_AGGREGATED: http://docker.for.win.localhost:4452
PROXY_DATA: http://docker.for.win.localhost:4452
The docker.for.mac.localhost
and docker.for.win.localhost
hostnames point to the host computer (your localhost running Docker).
For other systems, the host IP address could be used.
Once the compose files have been updated, the new configuration can be applied by running:
./ccd compose up -d
The local project properties must be reviewed to use the containers and comply to their configuration.
Mainly, this means:
- Database: pointing to the locally exposed port for the associated DB. This port used to be 5000 but has been changed to 5050 after SIDAM integration, which came to use 5000 for sidam-api application.
- SIDAM: pointing to the locally exposed port for SIDAM
- S2S:
- pointing to the locally exposed port for
service-auth-provider-api
⚠️ using the right key, as defined inservice-auth-provider-api
container
- pointing to the locally exposed port for
- URLs: all URLs should be updated to point to the corresponding locally exposed port
ERROR: Get <docker_image_url>: unauthorized: authentication required
If you see this above authentication issue while pulling images, please follow below commands,
Install Azure-CLI locally,
brew update && brew install azure-cli
and to update a Azure-CLI locally,
brew update azure-cli
then, login to MS Azure,
az login
and finally, Login to the Azure Container registry:
./ccd login
On windows platform, we are installing the Azure CLI using executable .msi file. If "az login" command throws an error like "Access Denied", please follow these steps. We will need to install the az cli using Python PIP.
- If Microsoft Azure CLI is already installed, uninstall it from control panel.
- Setup the Python(version 2.x/3.x) on windows machine. PIP is bundled with Python.
- Execute the command "pip install azure-cli" using command line. It takes about 20 minutes to install the azure cli.
- Verify the installation using the command az --version.
ccd-network could not be found error:
- if you get "CCD: ERROR: Network ccd-network declared as external, but could not be found. Please create the network manually using docker network create ccd-network"
./ccd init
CCD UI not loading:
- it might take few minutes for all the services to startup
wait few minutes and then retry accessing CCD UI
- sometimes happens that some of the back-ends (data store, definition store, user profile) cannot startup because the database liquibase lock is stuck.
check on the back-end log if there's the following exception: 'liquibase.exception.LockException: Could not acquire change log lock' Execute the following command on the database: UPDATE DATABASECHANGELOGLOCK SET LOCKED=FALSE, LOCKGRANTED=null, LOCKEDBY=null where ID=1;
- it's possible that some of the services cannot start or crash because of lack of availabel memory. This especially when starting Idam and or ElasticSearch
give more memory to Docker. Configurable under Preferences -> Advanced
DM Store issues:
- "uk.gov.hmcts.dm.exception.AppConfigurationException: Cloub Blob Container does not exist"
./bin/document-management-store-create-blob-store-container.sh
Here are the important variables exposed in the compose files:
Variable | Description |
---|---|
IDAM_KEY_CCD_DATA_STORE | IDAM service-to-service secret key for ccd_data micro-service (CCD Data store), as registered in service-auth-provider-api |
IDAM_KEY_CCD_GATEWAY | IDAM service-to-service secret key for ccd_gw micro-service (CCD API Gateway), as registered in service-auth-provider-api |
IDAM_KEY_CCD_DEFINITION_STORE | IDAM service-to-service secret key for ccd_definition micro-service (CCD Definition store), as registered in service-auth-provider-api |
IDAM_KEY_CCD_ADMIN | IDAM service-to-service secret key for ccd_admin micro-service (CCD Admin Web), as registered in service-auth-provider-api |
DATA_STORE_S2S_AUTHORISED_SERVICES | List of micro-service names authorised to call this service, comma-separated, as registered in service-auth-provider-api |
DEFINITION_STORE_S2S_AUTHORISED_SERVICES | List of micro-services authorised to call this service, comma-separated, as registered in service-auth-provider-api |
USER_PROFILE_S2S_AUTHORISED_SERVICES | List of micro-services authorised to call this service, comma-separated, as registered in service-auth-provider-api |
DATA_STORE_TOKEN_SECRET | Secret for generation of internal event tokens |
APPINSIGHTS_INSTRUMENTATIONKEY | Secret for Microsoft Insights logging, can be a dummy string in local |
STORAGEACCOUNT_PRIMARY_CONNECTION_STRING | (If dm-store is enabled) Secret for Azure Blob Storage. It is pointing to dockerized Azure Blob Storage emulator. |
STORAGE_CONTAINER_DOCUMENT_CONTAINER_NAME | (If dm-store is enabled) Container name for Azure Blob Storage |
AM_DB | Access Management database name |
AM_DB_USERNAME | Access Management database username |
AM_DB_PASSWORD | Access Management database password |
WIREMOCK_SERVER_MAPPINGS_PATH | Path to the WireMock mapping files. If not set, it will use the default mappings from the project repository. Note: If setting the variable, please keep all WireMock json stub files in a directory named mappings and exclude this directory in the path. For e.g. if you place the mappings in /home/user/mappings then export WIREMOCK_SERVER_MAPPINGS_PATH=/home/user. Stop the service and start service using command ./ccd compose up -d ccd-test-stub-service . If switching back to repository mappings please unset the variable using command unset WIREMOCK_SERVER_MAPPINGS_PATH |
- A container can be configured to call a localhost host resource with the localhost shortcut added for docker containers recently. However the shortcut must be set according the docker host operating system.
# for Mac
docker.for.mac.localhost
# for Windows
docker.for.win.localhost
Remember that once you changed the above for a particular app you have to make sure the container configuration for that app does not try to automatically start the dependency that you have started locally. To do that either comment out the entry for the locally running app from the depends_on section of the config or start the app with --no-deps flag.
- If you happen to run
docker-compose up
before setting up the environment variables, you will probably get error while starting the DB. In that case, clear the containers but also watch out for volumes created to be cleared to get a fresh start since some initialisation scripts don't run if you have already existing volume for the container.
$ docker volume list
DRIVER VOLUME NAME
# better be empty
This project is licensed under the MIT License - see the LICENSE file for details.