Initial commit
Some checks failed
Run linters on applied template / Python 3.13 lint and build (push) Failing after 41s
Some checks failed
Run linters on applied template / Python 3.13 lint and build (push) Failing after 41s
This is a FastAPI backend microservice template used with `copier` utility. Features of applied template are: - Configuration file processing logic - Metrics and tracing (both optional) configuration available - Debug endpoints - Database migration commands, prepared Alembic environment - Database usage example in ping_db endpoint - gitea sanity check pipeline
This commit is contained in:
21
deploy/README.md
Normal file
21
deploy/README.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# deploy example
|
||||
|
||||
This is a complete deployment example with following services:
|
||||
|
||||
- `postgres` database (with initialization and rootless user):
|
||||
- 5432 port exposure commented
|
||||
- `api` (with data migrations) with 8080 port exposure:
|
||||
- configured by [configs/api.yaml](./configs/api.yaml)
|
||||
- exposes 8080 port
|
||||
- 9090 metrics port not exposed
|
||||
- `prometheus` to collect metrics
|
||||
- configured by [configs/prometheus.yaml](./configs/prometheus.yaml)
|
||||
- exposes 9090 port with prometheus UI (optional)
|
||||
- `grafana` as a powerful UI for metrics visualization
|
||||
- exposes 3000 port, default user:password is `admin`:`admin`
|
||||
- prometheus metrics are available at `http://prometheus:9090`
|
||||
- `jaeger` to collect and show traces
|
||||
- exposes UI at port 16686
|
||||
- `otel` (OpenTELemetry) agent working as proxy for jaeger
|
||||
- configured by [configs/otel.yaml](./configs/otel.yaml)
|
||||
- does not expose 4317/4318 ports as containers use it inside the internal network
|
||||
Reference in New Issue
Block a user