Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(README): bump versions + telegraf #99

Merged
merged 2 commits into from
Jul 25, 2023
Merged

docs(README): bump versions + telegraf #99

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f2c202
docs: update README.md
shantanoo-desai Jun 6, 2023
f14571e
docs: update README.md
shantanoo-desai Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.md
View file
Open in desktop
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 All @@ -142,4 +150,3 @@ Komponist is licensed under __Affero GNU Public License v3.0__.
[0]: https://docs.docker.com/compose/compose-v2/
[1]: https://docs.docker.com/get-docker/
[2]: docs/Development.md