Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
romanov committed Sep 6, 2022
1 parent 3019ac5 commit c0e2bfb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 19 deletions.
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![CodeFactor](https://www.codefactor.io/repository/github/northpowered/simplesla/badge)](https://www.codefactor.io/repository/github/northpowered/simplesla)

[![Docker Image CI/CD](https://github.com/northpowered/SimpleSLA/actions/workflows/docker-image.yml/badge.svg)](https://github.com/northpowered/SimpleSLA/actions/workflows/docker-image.yml)
# SimpleSLA

Easy SLA control system for distribiuted networks
Expand Down Expand Up @@ -29,6 +29,12 @@ TODO:
- Tests

## Usage

### Running from source
> pip install -r requirements.txt
> python3 main.py -c config.yml
### In CLI mode
```bash
python3 main.py -c CONFIG

Expand All @@ -42,31 +48,21 @@ optional arguments:
Logging path {stdout,FILE}
--version show programs version number and exit
```
### Using docker image
> docker pull ghcr.io/northpowered/simple-sla:latest
> docker run --name simple-sla ghcr.io/northpowered/simple-sla:latest
## SLA statuses

| Status | Int value | Reccomended color | Description |
| Status | Int value | Recommended color | Description |
| ----------- | ----------- |------------------ |------------ |
| NoData | 0 | Black | No recieved data or parcing error |
| Normal | 1 | Green | Target is available and RTT less then policy |
| Warning | 2 | Yellow | Target is available and RTT bigger then policy |
| Error | 3 | Red | Target is unavailable |
| OutOfService| 4 | Green | Target is available and policy was not defined |

### Install:

```bash
pip install -r requirements.txt
python3 main.py -c config.yml
```
### Docker

```bash
docker build -t simplesla:yourtag .
docker run -p "8800:8800" simplesla:yourtag
```

### Configuration
## Configuration

All config is represented in YAML format

Expand Down
6 changes: 3 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ networks:
driver: bridge

services:
sla-simplesla:
image: "simplesla:latest"
container_name: sla-simplesla
simple-sla:
image: "ghcr.io/northpowered/simple-sla:latest"
container_name: simple-sla
restart: always
environment:
- SSLA_LL=INFO
Expand Down

0 comments on commit c0e2bfb

Please sign in to comment.