ChaosEngine app nominate randomly a different MoD and On-call person for every Gameday. The On-Call person is different from the normal process, so the team can practice and act independently when the time comes.
The Chaos Engine App is integrated in Mattermost and you can create:
- Chaos Configure
/chaos-engine configure --scheme "<sqlite3 | postgres | postgresql>" --url "<valid database URL for the specified scheme>" - Chaos Teams create
/chaos-engine team create --name sre --member @spiros - Chaos Teams add another member
/chaos-engine team create --name sre --member @bar - Chaos Teams list
/chaos-engine team list - Chaos Gamedays create
/chaos-engine gameday create --name "Chaos: K8s Node failures" --team sre --schedule-at "2021-25-08 07:00:00" - Chaos Gameday Start
/chaos-engine gameday start --id nopcyfhsd7fhpf3g1978mibd3w - Chaos Gameday Complete
/chaos-engine gameday complete --id nopcyfhsd7fhpf3g1978mibd3w - Chaos Gameday Cancel
/chaos-engine gameday cancel --id nopcyfhsd7fhpf3g1978mibd3w - Chaos Gameday list
/chaos-engine gameday list
Here are available configuration to run the app:
| Name | Default | Description |
|---|---|---|
| debug | false | debug logging |
| address | :3000 | listening address |
| app.type | http | mattermost app type |
| app.root_url | http://localhost:3000 | the root url of the app |
| app.secret | secretkey | The secret key to install the app in Mattermost and JWT authentication |
| db.scheme | nil | the scheme, supports sqlite3, postgres, postgresql |
| db.url | nil | the database URL which can be sqlite DB or Postgres DSN e.g: sqlite3://engine.db |
| db.idle_conns | 2 | the number of idle connections |
| db.max_open_conns | 1 | the max number of open connections |
| db.max_conn_lifetime | 1 | the max connection lifetime |
Run the server:
make run
By default the application if you run will use sqlite3 database (for local dev only) and will listen to :3000 and the root url
will be http://localhost:3000
There are two ways to override the defaults.
config.ymlfile only for local development- environment variables with prefix
CHAOS_ENGINE_*
An example with config.yml for local dev only:
debug: true
environment: prod
address: ":3001"
# mattermost app config
app:
type: http
root_url: "http://localhost:3000"
# database config
db:
scheme: sqlite3
url: "sqlite3://mytestdb.db"An example with environment variables:
CHAOS_ENGINE_DEBUG=true
CHAOS_ENGINE_ADDRESS=":3000"
CHAOS_ENGINE_APP_TYPE="http"
CHAOS_ENGINE_DB_SCHEME="sqlite3"Linting the codebase:
make lint
Run the tests:
make test
You can run this docker-compose to run
Mattermost and install your app with the following slash command.
/apps install http http://localhost:3000/manifest