This is a project to integrate the dqualizer project with the Chaos Toolkit (CTK). This project enables the execution of CTK chaos experiments on the running host by providing an HTTP endpoint to receive CTK chaos experiment definitions. We integrate functionality to execute Chaos Monkey for Spring Boot actions and implement functionality to monitor and terminate local system processes. This project was created as part of my master's thesis, "Domain-Driven Resilience Testing of Business-Critical Application Systems" (https://zenodo.org/records/10964241).
- Python 3.11
- pip
- Clone the repository:
git clone https://github.com/LeHenningo/Dqualizer-CTK
- Execute the
dqualizer_resilience_setup.sh(If you also want to install the dqualizer project, comment in lines 9-11) - Follow the hints echoed by
dqualizer_resilience_setup.sh
If you want to use this API without dqualizer, you must manually set up a MySQL database for authentication.
Start the Resilience Execution API by executing python3 src/python/resilienceExecutionApi.py.
Endpoint: POST /execute_experiment
Description: Validates and executes the supplied CTK chaos experiment.
To use the API, you need to authenticate using credentials for a MySQL database.
Include the credentials in the header of every request:
"dbUsername": "aDBUser",
"dbPassword": "aDBPw",
"username": "demoUser",
"password": "demo"
Header
POST /execute_experiment
Host: http://localhost:3323
Authorization:
dbUsername: aDBUser,
dbPassword: aDBPw,
username: demoUser,
password: demo
Content-Type: application/json
Body
{
"title": "A new chaos experiment",
"description": "This is a new chaos experiment",
"method": ...
}
See https://chaostoolkit.org/reference/api/experiment/ for the CTK chaos experiment structure.
{
"status_code": "200",
"title": "New Post",
"status": "Experiment was executed and terminated with status: completed",
"info": "See Python logs, (experiment journal) and dashboards for result infos"
}