ungleich-game/README.md

## Notes to myself

* Notes in ungleich-marketing.org / Quiz

## 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
- Minimal core logic - checks can check "anything"

### Planned features (game)

- Allow registration
- Allow deep (i.e. functionality based) checks of services
- Define points (or monitoring severity)




## How to play

### Monitoring

Test base:

```
python check-cli.py
```

### Game (not implemented)

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

## Documentation

- Raise CheckException on parameter wrong

## How to write a check

- Your command must return with exit code = 0
- Output will be saved by cmon, but not interpreted

## TODOs

- last result: select checkname where result = true
- last success: select checkname where result = true