Skip to content

Commit

Permalink
Create README.md (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanotorresi authored Oct 3, 2024
1 parent ef11a54 commit d14f2d9
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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](https://github.com/trento-project/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](https://github.com/trento-project/wanda/blob/main/guides/) until migrated somewhere else (if ever).

You can start learning more by consulting the [specification document](https://github.com/trento-project/wanda/blob/main/guides/specification.md).

## Contributing

TBD

## License

Copyright 2024 SUSE LLC

Licensed under the GNU General Public License (the "License"); you may not use
any of the source code in this project repository except in compliance with the License.

This software is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the [License](LICENSE) file for more details on copying permissions and limitations.

0 comments on commit d14f2d9

Please sign in to comment.