2019-04-14 18:06:45 +00:00
|
|
|
## Objective
|
|
|
|
|
|
|
|
This codebase is for preparing the ungleich game, which heavily relies
|
|
|
|
on checking other people's VMs.
|
|
|
|
|
|
|
|
The (not so) hidden objective is to create the base for "cmon",
|
|
|
|
our new monitoring system that does not suck.
|
|
|
|
|
|
|
|
### Planned features (monitoring)
|
|
|
|
|
|
|
|
- full parallel execution
|
|
|
|
- history support -> possible grafana interface
|
|
|
|
- easy to create and extend checks
|
|
|
|
- Requirements: python3 + binaries for certain checks
|
2019-04-14 18:30:04 +00:00
|
|
|
- Minimal core logic - checks can check "anything"
|
2019-04-14 18:06:45 +00:00
|
|
|
|
|
|
|
### Planned features (game)
|
|
|
|
|
|
|
|
- Allow registration
|
|
|
|
- Allow deep (i.e. functionality based) checks of services
|
|
|
|
- Define points (or monitoring severity)
|
|
|
|
|
|
|
|
|
2019-04-14 16:50:42 +00:00
|
|
|
## How to play
|
|
|
|
|
2019-04-14 18:08:07 +00:00
|
|
|
### Monitoring
|
|
|
|
|
|
|
|
Test base:
|
|
|
|
|
|
|
|
```
|
|
|
|
python check-cli.py
|
|
|
|
```
|
|
|
|
|
|
|
|
### Game (not implemented)
|
|
|
|
|
2019-04-14 16:50:42 +00:00
|
|
|
ungleich register --name your-user-name --email your@email
|
|
|
|
--first-name Yourfirstname --last-name YourLastName
|
|
|
|
|
|
|
|
ungleich play-game --game register --ip
|
|
|
|
ungleich play-game --game dns-forward --ip
|
2019-04-14 17:13:22 +00:00
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
2019-04-14 18:06:45 +00:00
|
|
|
- Rais CheckException on parameter wrong
|
2019-04-14 17:13:22 +00:00
|
|
|
|
|
|
|
## TODOs
|
|
|
|
|
|
|
|
- last result: select checkname where result = true
|
|
|
|
- last success: select checkname where result = true
|