From f8e049e4e158103636ab7fe0cdc500fe5c614e57 Mon Sep 17 00:00:00 2001 From: Jannis R Date: Sat, 13 Jan 2024 13:32:52 +0100 Subject: [PATCH] docs: services table: minor tweaks --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index cd7fada5..f8bd475f 100644 --- a/README.md +++ b/README.md @@ -195,34 +195,34 @@ The following table lists all IPL components and their respective Docker Compose | component & functionality | Compose service | permanently running? | host port | public HTTP path | notes | |-------------------------------------------------------------------------------------|----------------------|----------------------|----------:|--------------------|-------| -| HTTP ingress/reverse proxy ([Traefik Proxy](https://doc.traefik.io/traefik/)) | `traefik` | ✔︎ | 8080 | *-* | exposes all other services via HTTP | +| HTTP ingress/reverse proxy ([Traefik Proxy](https://doc.traefik.io/traefik/)) | `traefik` | ✔︎ | 8080 | *n/a* | exposes all other services via HTTP | | HTTP ingress/reverse proxy: admin UI | `traefik` | ✔︎ | 8081 | *-* | allows inspecting Traefik's operating state | | [GeoServer](https://geoserver.org) | `geoserver` | ✔︎ | 8600 | `/geoserver` | serves geospatial data sources via WMS, WFS, WMTS, etc. | | [OCPDB](https://github.com/binary-butterfly/ocpdb): API | `ocpdb-flask` | ✔︎ | 7000 | `/ocpdb` | aggregates charge point data sources | | OCPDB: background worker | `ocpdb-worker` | ✔︎ | *-* | *-* | fetches & imports 3rd-party data | -| OCPDB: initialization script | `ocpdb-init` | | *-* | *-* | runs once on startup | -| OCPDB: database ([PostgreSQL](https://www.postgresql.org)) | `ocpdb-db` | ✔︎ | *-* | *-* | +| OCPDB: initialization script | `ocpdb-init` | | *-* | *n/a* | runs once on startup | +| OCPDB: database ([PostgreSQL](https://www.postgresql.org)) | `ocpdb-db` | ✔︎ | *-* | *n/a* | | OCPDB: task/message queue ([RabbitMQ](https://www.rabbitmq.com)) | `ocpdb-rabbitmq` | ✔︎ | *-* | *-* | | | [ParkApi](https://github.com/ParkenDD/park-api-v3): API | `park-api-flask` | ✔︎ | 7500 | `/park-api` | aggregates parking lot data sources | | ParkAPI: background worker | `park-api-worker` | ✔︎ | *-* | *-* | fetches & imports 3rd-party data | -| ParkAPI: initialization script | `park-api-init` | | *-* | *-* | runs once on startup | -| ParkAPI: database ([PostgreSQL](https://www.postgresql.org)) | `park-api-db` | ✔︎ | *-* | *-* | +| ParkAPI: initialization script | `park-api-init` | | *-* | *n/a* | runs once on startup | +| ParkAPI: database ([PostgreSQL](https://www.postgresql.org)) | `park-api-db` | ✔︎ | *-* | *n/a* | | ParkAPI: task/message queue ([RabbitMQ](https://www.rabbitmq.com)) | `park-api-rabbitmq` | ✔︎ | *-* | *-* | | | ParkAPI: heartbeat | `park-api-heartbeat` | ✔︎ | *-* | *-* | | | GBFS: [Lamassu](https://github.com/entur/lamassu) | `lamassu` | ✔︎ | 8500 | `/sharing` | aggregates [GBFS](https://gbfs.org) vehicle sharing data sources | | GBFS: Lamassu (admin UI) | `lamassu` | ✔︎ | 9002 | *-* | allows inspecting Lamassu's operating state | -| GBFS: Lamassu database ([Redis](https://redis.io)) | `redis` | ✔︎ | *-* | *-* | +| GBFS: Lamassu database ([Redis](https://redis.io)) | `redis` | ✔︎ | *-* | *n/a* | | [Dagster](https://docs.dagster.io/getting-started): task runner | `dagster-pipeline` | ✔︎ | *-* | *-* | runs (custom Python) tasks, collects their logs | | Dagster: task scheduler | `dagster-daemon` | ✔︎ | *-* | *-* | orchestrates [DAGs](https://en.wikipedia.org/wiki/Directed_acyclic_graph) of tasks | | Dagster: UI | `dagster-dagit` | ✔︎ | 3000 | *-* | shows logs & results of the scripts | -| Dagster: database ([PostgreSQL](https://www.postgresql.org)) | `dagster-postgresql` | ✔︎ | *-* | *-* | +| Dagster: database ([PostgreSQL](https://www.postgresql.org)) | `dagster-postgresql` | ✔︎ | *-* | *n/a* | | [IPL Proxy](https://github.com/mobidata-bw/ipl-proxy) | `transformer-proxy` | ✔︎ | 8400 | *-* | on-the-fly patching of HTTP resources from 3rd parties; used by OCPDB, x2gbfs, etc. | -| GBFS/RadVIS: database ([PostgreSQL](https://www.postgresql.org)) | `ipl-db` | ✔︎ | 5432 | *-* | stores fetched GBFS & RadVIS data | +| GBFS/RadVIS: database ([PostgreSQL](https://www.postgresql.org)) | `ipl-db` | ✔︎ | 5432 | *n/a* | stores fetched GBFS & RadVIS data | | GTFS: API ([PostgREST](https://postgrest.org/)) | `gtfs-api` | ✔︎ | 4000 | `/gtfs` | serves [GTFS](https://gtfs.org/schedule/) data as an API | | GTFS: documentation ([Stoplight Elements](https://github.com/stoplightio/elements)) | `gtfs-swagger-ui` | ✔︎ | 4001 | `/docs/gtfs` | UI documenting the GTFS API | | GTFS: importer ([`postgis-gtfs-importer`](https://github.com/mobidata-bw/postgis-gtfs-importer)) | `gtfs-importer` | | *-* | *-* | downloads, cleans & imports GTFS into the database; started by a Dagster task | -| GTFS: database ([PostgreSQL](https://www.postgresql.org)) | `gtfs-db` | ✔︎ | *-* | *-* | stores imported GTFS data | -| database proxy ([pgbouncer](https://www.pgbouncer.org)) | `pgbouncer` | ✔︎ | 6432 | *-* | proxies services' connections to databases (`dagster-postgresql`, `gtfs-db`, etc.) | +| GTFS: database ([PostgreSQL](https://www.postgresql.org)) | `gtfs-db` | ✔︎ | *-* | *n/a* | stores imported GTFS data | +| database proxy ([pgbouncer](https://www.pgbouncer.org)) | `pgbouncer` | ✔︎ | 6432 | *n/a* | proxies services' connections to databases (`dagster-postgresql`, `gtfs-db`, etc.) | | static data: web server ([Caddy](https://caddyserver.com)) | `caddy` | ✔︎ | 6999 | `/datasets` | serves static datasets | | meta files: web server ([Caddy](https://caddyserver.com)) | `well-known-uris` | ✔︎ | 6998 | `/.well-known`, `/robots.txt`, `/favicon.ico` | miscellaneous files, not datasets | | ingress: requests log importer ([GoAccess](https://goaccess.io)) | `goaccess` | | *-* | *-* | computes request statistics from the ingress requests log; started manually/externally |