-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMakefile
More file actions
342 lines (264 loc) · 12.6 KB
/
Copy pathMakefile
File metadata and controls
342 lines (264 loc) · 12.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
# =============================================================================
# Odoo 18 base docker stack — Makefile
#
# Conventions:
# up-<svc> bring service up in the background
# down-<svc> stop & remove service containers
# restart-<svc> down then up
# logs-<svc> tail logs for the container
# shell-<svc> exec into the container
#
# Profiles:
# * dev profile (default docker-compose.yml)
# *-prod prod profile (docker-compose-prod.yml)
#
# Run `make help` for a discoverable list.
# =============================================================================
SHELL := /bin/bash
# --- Tooling --------------------------------------------------------------
DC := docker compose
ENV := --env-file .env
LOGS := docker logs -f --tail=200
EXEC := docker exec -it
# --- Container names ------------------------------------------------------
ODOO_CONTAINER := odoo
NGINX_CONTAINER := nginx
DB_CONTAINER := postgres
DB_BACKUP_CONTAINER := postgres_backup
PGADMIN_CONTAINER := pgadmin
ADMINER_CONTAINER := adminer-postgres
RABBITMQ_CONTAINER := rabbitmq
KAFKA_CONTAINER := kafka
KAFKA_UI_CONTAINER := kafka_ui
REDIS_CONTAINER := redis
REDIS_UI_CONTAINER := redis_commander
PROMETHEUS_CONTAINER := prometheus
GRAFANA_CONTAINER := grafana
# --- Network --------------------------------------------------------------
NETWORK_NAME := backend
NETWORK_NAME_PROD := backend-prod
# --- Compose file shortcuts ----------------------------------------------
DB_COMPOSE := docker_compose/db/docker-compose.yml
DB_COMPOSE_PROD := docker_compose/db/docker-compose-prod.yml
ODOO_COMPOSE := docker_compose/odoo/docker-compose.yml
ODOO_COMPOSE_PROD := docker_compose/odoo/docker-compose-prod.yml
PGADMIN_COMPOSE := docker_compose/pgadmin/docker-compose.yml
PGADMIN_COMPOSE_PROD:= docker_compose/pgadmin/docker-compose-prod.yml
ADMINER_COMPOSE := docker_compose/adminer/docker-compose.yml
ADMINER_COMPOSE_PROD:= docker_compose/adminer/docker-compose-prod.yml
RABBITMQ_COMPOSE := docker_compose/message_brokers/rabbitmq/docker-compose.yml
KAFKA_COMPOSE := docker_compose/message_brokers/kafka/docker-compose.yml
REDIS_COMPOSE := docker_compose/redis/docker-compose.yml
MONITORING_COMPOSE := docker_compose/monitoring/docker-compose.yml
-include .env
export
.DEFAULT_GOAL := help
.PHONY: help \
init network network-prod \
up down restart logs ps \
up-prod down-prod \
up-db up-db-build down-db logs-db shell-db \
up-odoo up-odoo-build down-odoo logs-odoo shell-odoo \
up-pgadmin down-pgadmin logs-pgadmin \
up-adminer down-adminer logs-adminer \
up-rabbitmq down-rabbitmq logs-rabbitmq shell-rabbitmq \
up-kafka down-kafka logs-kafka shell-kafka \
up-brokers down-brokers \
up-redis down-redis logs-redis shell-redis restart-redis cli-redis \
up-monitoring up-monitoring-build down-monitoring logs-monitoring \
backup restore-db load-backup \
install-addon upgrade-addon odoo-shell odoo-psql odoo-test \
health clean-backups stop-all rm-all prune \
lint format
# ============================================================================
# Help
# ============================================================================
help: ## Show this help
@echo ""
@echo "Odoo 18 docker stack — available targets:"
@echo ""
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / { printf " \033[36m%-22s\033[0m %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
@echo ""
# ============================================================================
# Bootstrap
# ============================================================================
init: ## Create .env, network and required folders
./scripts/init.sh
network: ## Ensure the dev docker network exists
@docker network inspect $(NETWORK_NAME) >/dev/null 2>&1 || \
(echo "Creating network $(NETWORK_NAME)..." && docker network create $(NETWORK_NAME))
network-prod: ## Ensure the prod docker network exists
@docker network inspect $(NETWORK_NAME_PROD) >/dev/null 2>&1 || \
(echo "Creating network $(NETWORK_NAME_PROD)..." && docker network create $(NETWORK_NAME_PROD))
# ============================================================================
# Top-level orchestration (dev)
# ============================================================================
up: network up-db up-odoo up-pgadmin up-adminer ## Bring up the core dev stack (db + odoo + ui)
down: down-adminer down-pgadmin down-odoo down-db ## Stop the core dev stack
restart: down up ## Restart core dev stack
up-full: up up-redis up-brokers up-monitoring ## Bring up EVERYTHING (core + redis + brokers + monitoring)
down-full: down-monitoring down-brokers down-redis down ## Tear down EVERYTHING
ps: ## List running containers in this project
@docker ps --filter "network=$(NETWORK_NAME)"
logs: ## Tail logs for odoo + postgres
$(LOGS) $(ODOO_CONTAINER) &
$(LOGS) $(DB_CONTAINER)
# ============================================================================
# Top-level orchestration (prod)
# ============================================================================
up-prod: network-prod ## Bring up the core prod stack
$(DC) -f $(DB_COMPOSE_PROD) $(ENV) up -d
$(DC) -f $(ODOO_COMPOSE_PROD) $(ENV) up -d
$(DC) -f $(ADMINER_COMPOSE_PROD) $(ENV) up -d
down-prod: ## Stop the core prod stack
$(DC) -f $(ADMINER_COMPOSE_PROD) down
$(DC) -f $(ODOO_COMPOSE_PROD) down
$(DC) -f $(DB_COMPOSE_PROD) down
# ============================================================================
# PostgreSQL
# ============================================================================
up-db: network ## Start postgres + backup sidecar
$(DC) -f $(DB_COMPOSE) $(ENV) up -d
up-db-build: network ## Rebuild and start postgres
$(DC) -f $(DB_COMPOSE) $(ENV) build --no-cache
$(DC) -f $(DB_COMPOSE) $(ENV) up -d
down-db: ## Stop postgres
$(DC) -f $(DB_COMPOSE) down
logs-db: ## Tail postgres logs
$(LOGS) $(DB_CONTAINER)
shell-db: ## Open a bash shell inside the postgres container
$(EXEC) $(DB_CONTAINER) bash
# ============================================================================
# Odoo
# ============================================================================
up-odoo: network ## Start Odoo (and nginx in front of it)
$(DC) -f $(ODOO_COMPOSE) $(ENV) up -d
up-odoo-build: network ## Rebuild and start Odoo
$(DC) -f $(ODOO_COMPOSE) $(ENV) build --no-cache
$(DC) -f $(ODOO_COMPOSE) $(ENV) up -d
down-odoo: ## Stop Odoo
$(DC) -f $(ODOO_COMPOSE) down
logs-odoo: ## Tail Odoo logs
$(LOGS) $(ODOO_CONTAINER)
shell-odoo: ## Open a bash shell inside the Odoo container
$(EXEC) $(ODOO_CONTAINER) bash
restart-odoo: down-odoo up-odoo ## Restart Odoo
restart-db: down-db up-db ## Restart PostgreSQL
restart-monitoring: down-monitoring up-monitoring ## Restart the monitoring stack
restart-brokers: down-brokers up-brokers ## Restart RabbitMQ + Kafka
odoo-shell: ## Open the Odoo Python shell (`odoo shell`)
./scripts/shell.sh
odoo-psql: ## Open psql against the Odoo database
./scripts/psql.sh
odoo-test: ## Run Odoo tests for a comma-separated MODULES list (MODULES=base_search_fuzzy)
$(EXEC) $(ODOO_CONTAINER) odoo -c /etc/odoo/odoo.conf -d $(ODOO_DB) \
--test-enable -i $(MODULES) --stop-after-init --no-http
# ============================================================================
# pgAdmin / Adminer
# ============================================================================
up-pgadmin: network ## Start pgAdmin at http://localhost:5050
$(DC) -f $(PGADMIN_COMPOSE) $(ENV) up -d
down-pgadmin: ## Stop pgAdmin
$(DC) -f $(PGADMIN_COMPOSE) down
logs-pgadmin: ## Tail pgAdmin logs
$(LOGS) $(PGADMIN_CONTAINER)
up-adminer: network ## Start Adminer at http://localhost:8080
$(DC) -f $(ADMINER_COMPOSE) $(ENV) up -d
down-adminer: ## Stop Adminer
$(DC) -f $(ADMINER_COMPOSE) down
logs-adminer: ## Tail Adminer logs
$(LOGS) $(ADMINER_CONTAINER)
# ============================================================================
# Message brokers
# ============================================================================
up-brokers: up-rabbitmq up-kafka ## Start both RabbitMQ and Kafka
down-brokers: down-kafka down-rabbitmq ## Stop both brokers
up-rabbitmq: network ## Start RabbitMQ (UI: http://localhost:15672)
$(DC) -f $(RABBITMQ_COMPOSE) $(ENV) up -d
down-rabbitmq: ## Stop RabbitMQ
$(DC) -f $(RABBITMQ_COMPOSE) down
logs-rabbitmq: ## Tail RabbitMQ logs
$(LOGS) $(RABBITMQ_CONTAINER)
shell-rabbitmq: ## Open shell inside RabbitMQ container
$(EXEC) $(RABBITMQ_CONTAINER) bash
up-kafka: network ## Start Kafka (UI: http://localhost:8089)
$(DC) -f $(KAFKA_COMPOSE) $(ENV) up -d
down-kafka: ## Stop Kafka
$(DC) -f $(KAFKA_COMPOSE) down
logs-kafka: ## Tail Kafka logs
$(LOGS) $(KAFKA_CONTAINER)
shell-kafka: ## Open shell inside Kafka container
$(EXEC) $(KAFKA_CONTAINER) bash
# ============================================================================
# Redis
# ============================================================================
up-redis: network ## Start Redis + redis-commander + redis_exporter
$(DC) -f $(REDIS_COMPOSE) $(ENV) up -d
down-redis: ## Stop Redis
$(DC) -f $(REDIS_COMPOSE) down
restart-redis: down-redis up-redis ## Restart Redis
logs-redis: ## Tail Redis logs
$(LOGS) $(REDIS_CONTAINER)
shell-redis: ## Open a shell inside the Redis container
$(EXEC) $(REDIS_CONTAINER) sh
cli-redis: ## Open redis-cli authenticated with $REDIS_PASSWORD
$(EXEC) $(REDIS_CONTAINER) redis-cli -a $(REDIS_PASSWORD)
# ============================================================================
# Monitoring (Prometheus + Grafana + exporters)
# ============================================================================
up-monitoring: network ## Start Prometheus + Grafana + exporters
$(DC) -f $(MONITORING_COMPOSE) $(ENV) up -d
up-monitoring-build: network ## Rebuild and start the monitoring stack
$(DC) -f $(MONITORING_COMPOSE) $(ENV) build --no-cache
$(DC) -f $(MONITORING_COMPOSE) $(ENV) up -d
down-monitoring: ## Stop the monitoring stack
$(DC) -f $(MONITORING_COMPOSE) down
logs-monitoring: ## Tail Prometheus + Grafana logs
$(LOGS) $(PROMETHEUS_CONTAINER) &
$(LOGS) $(GRAFANA_CONTAINER)
# ============================================================================
# Backup / restore
# ============================================================================
backup: ## Run an on-demand pg_dump into ./backups (DB=<name> overrides ODOO_DB)
./scripts/backup-db.sh $(DB)
restore-db: ## Restore from FILE=<path> (use DB=<name> to override target db)
./scripts/restore-db.sh $(FILE) $(DB)
# Legacy alias used by the in-container backup sidecar.
# make load-backup FILE=your_backup_file.dump
load-backup: ## Pg_restore FILE=<filename inside backup container>
@echo "Restoring backup $(FILE) into database $(POSTGRES_DB)..."
docker exec -i $(DB_CONTAINER) pg_restore -U $(POSTGRES_USER) -d $(POSTGRES_DB) "/backups/$(FILE)"
clean-backups: ## Purge backups older than DAYS=<n> (default 14)
./scripts/clean-backups.sh $(DAYS)
# ============================================================================
# Addon helpers
# ============================================================================
install-addon: ## Install ADDON=<name> into ODOO_DB (or DB=<name>)
./scripts/install-addon.sh $(ADDON) $(DB)
upgrade-addon: ## Upgrade ADDON=<name> in ODOO_DB (or DB=<name>)
./scripts/upgrade-addon.sh $(ADDON) $(DB)
# ============================================================================
# Diagnostics / utility
# ============================================================================
health: ## One-line status for every container
./scripts/health-check.sh 2>/dev/null || ./scripts/healthcheck.sh
stop-all: ## Stop every docker container on the host
@docker stop $$(docker ps -q) 2>/dev/null || true
rm-all: ## Remove every stopped container on the host
@docker rm $$(docker ps -aq) 2>/dev/null || true
prune: ## Prune unused images/volumes/networks (asks for confirmation)
docker system prune
# ============================================================================
# Python tooling
# ============================================================================
lint: ## Run ruff + pylint-odoo against src/addons
./scripts/lint-addons.sh
format: ## Run black + isort over src/ and tests/
black src tests
isort src tests
test: ## Run host-side pytest suite (unit tests only)
pytest tests/unit
test-integration: ## Run integration tests against a running stack
RUN_INTEGRATION=1 pytest tests/integration
test-cov: ## Run unit tests with coverage report
pytest tests/unit --cov --cov-report=term-missing