overlord/README.md

51 lines
1.1 KiB
Markdown

# Overlord
Full management suite for libvirt and kubernetes clusters!
## Running it for yourself
Remember to go get dependencies.
### Config
Create a file in the working directory of Overlord named lord.json.
You may also specify a config file with -c command line argument.
This file may look like this.
Everything is optional!
```json
{
"LibVirtHosts": [
"qemu:///system",
"qemu+ssh://userwithlibvirtgroup@othernode/system"
],
"LibVirtReadOnlyHosts": [
"qemu+ssh://user@privatenode/system"
],
"MongoDbStr": "mongodb://localhost:27017",
"MongoDbName": "overlord",
"LogLevel": 0,
"LogFilePath": "lord.log",
"MatrixCreds": {
"Homeserver": "https://matrix.org",
"Username": "@changme:matrix.org",
"Password": "yourpassword!"
}
}
```
No log file means stdout only!
The loglevels are;
```go
type LogLevel int
const (
TRACE LogLevel = iota
DEBUG
INFO
WARN
ERROR
FATAL
)
```
Use the corresponding integer starting at 0 for TRACE up to 5 for FATAL.
### Docker
Docker compose based development environment in the workings.
There will also be a Overlord docker image.