Skip to content

Commit

Permalink
Merge pull request #99 from shantanoo-desai/docs
Browse files Browse the repository at this point in the history
docs(README): bump versions + telegraf
  • Loading branch information
shantanoo-desai committed Jul 25, 2023
2 parents ae9b369 + f14571e commit e75247d
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ abstraction. The following are required to make Komponist work:

| Name | Version | Purpose |
|:-----------|:----------:|:-----------------------------------------------------------------:|
| `docker` | `24.0.x` | Container Runtime where your compose stacks will run |
| `docker compose` | `2.18.1` | Docker Compose V2 Plugin for Docker Engine |
| `docker` | `>= 24.0.2` | Container Runtime where your compose stacks will run |
| `docker compose` | `>= 2.20.0` | Docker Compose V2 Plugin for Docker Engine |

Install them on your host accordingly. See [Docker Documentations][1]

### Python Pip Packages

| Name | Version | Purpose |
|:----------|:-------:|:----------------------------------------------------------------------------:|
| `ansible` | `> 2.14.x` | Almost _all_ things within Komponist are achieved via ansible |
| `ansible` | `>= 2.15.x` | Almost _all_ things within Komponist are achieved via ansible |
| `passlib` | `1.7.x` | required for password encryption hashing requirements for certain containers |
| `docker` | `>5.x.x`| required to control single container instances |

Expand All @@ -42,9 +42,16 @@ Currently the following services are available to configure and run:
| __Traefik Reverse-Proxy__ | `2.9.8` |
| __InfluxDB__ | `1.8`<br> `2.6`|
| __TimescaleDB__ | `v15` |
| __Telegraf__ | `1.27.2`|
| __Grafana__ | `9.5.1` |
| __QuestDB__ | `7.1.1` |

These services can be further tuned using the files under the `vars` directory:

| File | Purpose |
|:---------------|:------------------------------------------------|
| `config.yml` | Core service configuration (API) endpoints <br> and container image versions |
| `creds.yml` | Credentials for services (Username/Passwords/Databases) |

### Complete Komponist Stack

Expand Down Expand Up @@ -107,7 +114,7 @@ You can bring the stack up using:
docker compose --project-directory=deploy up -d
```

### Service Endpoints
### Service Endpoints / Information

The following service names can be used to obtain log information using:

Expand All @@ -118,8 +125,9 @@ docker compose --project-directory=deploy logs -f <service_name>
| Service Name | URL |
|:------------:|:-----------------------------:|
| `nodered` | `http://localhost/nodered` |
| `mosquito` | `mqtt://localhost:1883` |
| `mosquitto` | `mqtt://localhost:1883` |
| `traefik` | N/A |
| `telegraf` | N/A |
| `influxdvb1` | `http://localhost/influxdbv1` |
| `influxdbv2` | `http://influxdbv2.localhost` |
| `timescaledb` | Not Configured to an API |
Expand Down

0 comments on commit e75247d

Please sign in to comment.