Skip to content

Checks for Trento to be executed by Wanda. Previously part of Wanda itself

License

Notifications You must be signed in to change notification settings

trento-project/checks

Repository files navigation

Trento Checks

Trento Checks are the way Trento provides continous infractructure compliance.

They are implemented with a declarative, YAML-based DSL aiming at expressing some expectations on the configuration of a target system, or a group of target systems.

The Checks are then executed by our Trento checks engine, Wanda.

Usage

The Checks code was originally hosted together with Wanda itself and only later decoupled in this repository, so most of the related documentation will remain there until migrated somewhere else (if ever).

You can start learning more by consulting the specification document.

Developing Checks

Wanda architecture aims to simplify testing Checks Executions and adding new ones.

Starting a local environment

Start the environment with:

$ docker-compose up -d

Wanda is exposed on port 4000 and the API documentation is available at http://localhost:4000/swaggerui

Note that the message broker must be reachable by Wanda and all the targets.

Adding new Checks

Built-in Checks can be found in the Catalog directory at ./checks/

To implement new checks and test them:

Contributing

See CONTRIBUTING.md

License

See the LICENSE notice.