Skip to content

Commit 3f63671

Browse files
committed
organise files
1 parent 215c6e0 commit 3f63671

File tree

8 files changed

+30
-19
lines changed

8 files changed

+30
-19
lines changed

Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ ARG PYTHON_VERSION=3.12
33
# Base image
44
FROM python:${PYTHON_VERSION}-alpine AS base
55

6+
ARG CONFIGS_FILE
67
ENV VIRTUAL_ENV=/opt/venv \
78
PATH="/opt/venv/bin:$PATH"
89

Makefile

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,55 @@
11
# Development
22
build-dev:
3-
docker compose -f docker-compose-dev.yaml build sentinela-dev
3+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml build sentinela-dev
44

55
pull-dev:
6-
docker compose -f docker-compose-dev.yaml pull --quiet postgres motoserver
6+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml pull --quiet postgres motoserver
77

88
migrate-dev:
9-
docker compose -f docker-compose-dev.yaml run --rm --service-ports sentinela-dev alembic upgrade head
9+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml run --rm --service-ports sentinela-dev alembic upgrade head
1010

1111
run-dev:
12-
docker compose -f docker-compose-dev.yaml up sentinela-dev
12+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml up sentinela-dev
1313

1414
run-shell-dev:
15-
docker compose -f docker-compose-dev.yaml run --rm --service-ports sentinela-dev /bin/sh
15+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml run --rm --service-ports sentinela-dev /bin/sh
1616

1717
test-dev:
18-
docker compose -f docker-compose-dev.yaml run --rm sentinela-dev pytest
18+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml run --rm sentinela-dev pytest
1919

2020
down-dev:
21-
docker compose -f docker-compose-dev.yaml down
21+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml down
2222

2323
# Local development setup
2424
build-local:
25-
docker compose -f docker-compose-local.yaml build sentinela-local
25+
docker compose --project-directory . -f ./docker/docker-compose-local.yaml build sentinela-local
2626

2727
migrate-local:
28-
docker compose -f docker-compose-local.yaml run --rm --service-ports sentinela-local alembic upgrade head
28+
docker compose --project-directory . -f ./docker/docker-compose-local.yaml run --rm --service-ports sentinela-local alembic upgrade head
2929

3030
run-local:
31-
docker compose -f docker-compose-local.yaml up sentinela-local
31+
docker compose --project-directory . -f ./docker/docker-compose-local.yaml up sentinela-local
3232

3333
down-local:
34-
docker compose -f docker-compose-local.yaml down
34+
docker compose --project-directory . -f ./docker/docker-compose-local.yaml down
3535

3636
# Scalable setup for production-like environment
3737
build-scalable:
38-
docker compose -f docker-compose-scalable.yaml build sentinela-controller
38+
docker compose --project-directory . -f ./docker/docker-compose-scalable.yaml build sentinela-controller
3939

4040
migrate-scalable:
41-
docker compose -f docker-compose-scalable.yaml run --rm --service-ports sentinela-controller alembic upgrade head
41+
docker compose --project-directory . -f ./docker/docker-compose-scalable.yaml run --rm --service-ports sentinela-controller alembic upgrade head
4242

4343
run-scalable:
44-
docker compose -f docker-compose-scalable.yaml up sentinela-controller sentinela-executor
44+
docker compose --project-directory . -f ./docker/docker-compose-scalable.yaml up sentinela-controller sentinela-executor
4545

4646
down-scalable:
47-
docker compose -f docker-compose-scalable.yaml down
47+
docker compose --project-directory . -f ./docker/docker-compose-scalable.yaml down
4848

4949
# Development utilities
5050
linter:
51-
docker compose -f docker-compose-dev.yaml run --rm --no-deps sentinela-dev ruff check
52-
docker compose -f docker-compose-dev.yaml run --rm --no-deps sentinela-dev ruff format --check --diff
51+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml run --rm --no-deps sentinela-dev ruff check
52+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml run --rm --no-deps sentinela-dev ruff format --check --diff
5353

5454
mypy:
55-
docker compose -f docker-compose-dev.yaml run --rm --no-deps sentinela-dev mypy --install-types --non-interactive
55+
docker compose --project-directory . -f ./docker/docker-compose-dev.yaml run --rm --no-deps sentinela-dev mypy --install-types --non-interactive
File renamed without changes.
File renamed without changes.

docker-compose-dev.yaml renamed to docker/docker-compose-dev.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,13 @@ services:
2222
context: .
2323
dockerfile: Dockerfile
2424
target: sentinela_dev
25+
args:
26+
CONFIGS_FILE: configs/configs.yaml
2527
image: sentinela-dev:latest
2628
ports:
2729
- 8000:8000
2830
environment:
31+
CONFIGS_FILE: configs/configs.yaml
2932
SAMPLE_SLACK_CHANNEL: C07NCL94SDT
3033
SAMPLE_SLACK_MENTION: U07NFGGMB98
3134
SLACK_WEBSOCKET_ENABLED: true

docker-compose-local.yaml renamed to docker/docker-compose-local.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ services:
1111
context: .
1212
dockerfile: Dockerfile
1313
target: sentinela
14+
args:
15+
CONFIGS_FILE: configs/configs.yaml
1416
image: sentinela-local:latest
1517
ports:
1618
- 8000:8000
@@ -21,6 +23,7 @@ services:
2123
retries: 3
2224
start_period: 2s
2325
environment:
26+
CONFIGS_FILE: configs/configs.yaml
2427
SAMPLE_SLACK_CHANNEL: C07NCL94SDT
2528
SAMPLE_SLACK_MENTION: U07NFGGMB98
2629
SLACK_WEBSOCKET_ENABLED: true

docker-compose-scalable.yaml renamed to docker/docker-compose-scalable.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ services:
2222
context: .
2323
dockerfile: Dockerfile
2424
target: sentinela
25+
args:
26+
CONFIGS_FILE: configs/configs-scalable.yaml
2527
image: sentinela-scalable:latest
2628
ports:
2729
- 8000:8000
@@ -50,6 +52,8 @@ services:
5052
context: .
5153
dockerfile: Dockerfile
5254
target: sentinela
55+
args:
56+
CONFIGS_FILE: configs/configs-scalable.yaml
5357
image: sentinela-scalable:latest
5458
deploy:
5559
mode: replicated

docs/how_to_run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ For a more scalable deployment, it is recommended to use separate containers for
7474
- Hard to monitor the application.
7575
- Running the database locally increases the risk of data loss.
7676

77-
1. Set the `replicas` parameter in the `docker-compose-scalable.yml` file to the desired number of executors.
77+
1. Set the `replicas` parameter in the `docker/docker-compose-scalable.yml` file to the desired number of executors.
7878
2. Set the secrets in the `.env.secrets` file, as specified in the [Configuration](./configuration.md) documentation.
7979
3. Migrate the database to the latest version. This is only necessary when running for the first time or after updates.
8080
```shell

0 commit comments

Comments
 (0)