-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy pathMakefile
More file actions
340 lines (244 loc) · 14.6 KB
/
Makefile
File metadata and controls
340 lines (244 loc) · 14.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
SHELL := /usr/bin/env bash
.SHELLFLAGS := -o pipefail -c
DC_START_CMD := up -d
DC_STOP_CMD := stop
DC_DOWN_CMD := down
REMOTE_COMPOSE_FILE ?= services.yml
REMOTE_SSH_KEY ?=
REMOTE_SSH_OPTS ?=
REMOTE_SSH_KEY_ARG = $(if $(strip $(REMOTE_SSH_KEY)),-i $(REMOTE_SSH_KEY),)
HELM_OPENSEARCH_RELEASE ?= cogstack-opensearch
HELM_OPENSEARCH_NAMESPACE ?= cogstack
HELM_OPENSEARCH_CHART ?= ./charts/opensearch
define WITH_ENV
set -a && source ./export_env_vars.sh;
endef
# list all make targets in this file
help: ## List available targets with descriptions
@echo "Available targets:"
@awk '\
function default_desc(target) { \
if (target ~ /^start-/) return "Start a service or service group"; \
if (target ~ /^stop-/) return "Stop a service or service group"; \
if (target ~ /^delete-/) return "Delete related containers/images/volumes"; \
if (target ~ /^git-/) return "Run a git helper script"; \
if (target == "load-env") return "Load variables from export_env_vars.sh"; \
if (target == "show-env") return "Print current environment variables"; \
if (target == "down-all") return "Stop all services from services.yml"; \
if (target == "cleanup") return "Stop all services and remove volumes"; \
return "(no description)"; \
} \
/^[a-zA-Z0-9][a-zA-Z0-9_-]*:/ { \
raw=$$0; \
target=raw; \
sub(/:.*/, "", target); \
if (!(target in seen)) { \
seen[target]=1; \
} \
if (index(raw, "##") > 0) { \
description=raw; \
sub(/^.*##[[:space:]]*/, "", description); \
desc[target]=description; \
} \
} \
END { \
for (target in seen) { \
description=desc[target]; \
if (description == "") description=default_desc(target); \
print target "\t" description; \
} \
} \
' $(lastword $(MAKEFILE_LIST)) | sort | awk -F '\t' '{printf " %-28s %s\n", $$1, $$2}'
.PHONY: help
# utility commands
git-freeze-security: ## Apply restricted git settings for safer shell operations
@../scripts/git_freeze_security.sh
git-unfreeze-security: ## Revert restricted git settings
@../scripts/git_unfreeze_security.sh
git-update-submodules: ## Update submodules recursively in this repository
@../scripts/git_update_submodules_in_repo.sh
load-env: ## Load variables from export_env_vars.sh in a subshell
$(WITH_ENV) echo "Environment variables loaded."
show-env: ## Print sorted environment variables after loading export_env_vars.sh
${WITH_ENV} >/dev/null 2>&1; printenv | sort
helm-template-opensearch: ## Render OpenSearch chart using deploy/elasticsearch.env
helm template $(HELM_OPENSEARCH_RELEASE) $(HELM_OPENSEARCH_CHART) --set-file envFile.raw=./elasticsearch.env
helm-install-opensearch: ## Install/upgrade OpenSearch chart using deploy/elasticsearch.env
helm upgrade --install $(HELM_OPENSEARCH_RELEASE) $(HELM_OPENSEARCH_CHART) --set-file envFile.raw=./elasticsearch.env --namespace $(HELM_OPENSEARCH_NAMESPACE) --create-namespace
remote-deploy-service: ## Deploy one or more services to a remote machine via SSH + docker compose
remote-deploy-service: _check-remote-params
@ssh $(REMOTE_SSH_KEY_ARG) $(REMOTE_SSH_OPTS) "$(REMOTE_HOST)" 'cd "$(REMOTE_REPO_DIR)/deploy" && set -a && source ./export_env_vars.sh && docker compose -f "$(REMOTE_COMPOSE_FILE)" up -d $(REMOTE_SERVICES)'
remote-stop-service: ## Stop one or more services on a remote machine via SSH + docker compose
remote-stop-service: _check-remote-params
@ssh $(REMOTE_SSH_KEY_ARG) $(REMOTE_SSH_OPTS) "$(REMOTE_HOST)" 'cd "$(REMOTE_REPO_DIR)/deploy" && set -a && source ./export_env_vars.sh && docker compose -f "$(REMOTE_COMPOSE_FILE)" stop $(REMOTE_SERVICES)'
remote-delete-service: ## Delete one or more remote service containers via SSH + docker compose rm
remote-delete-service: _check-remote-params
@ssh $(REMOTE_SSH_KEY_ARG) $(REMOTE_SSH_OPTS) "$(REMOTE_HOST)" 'cd "$(REMOTE_REPO_DIR)/deploy" && set -a && source ./export_env_vars.sh && docker compose -f "$(REMOTE_COMPOSE_FILE)" rm -f -s $(REMOTE_SERVICES)'
_check-remote-params:
@if [ -z "$(REMOTE_HOST)" ]; then \
echo "REMOTE_HOST is required (example: REMOTE_HOST=user@machine)"; \
exit 1; \
fi
@if [ -z "$(REMOTE_REPO_DIR)" ]; then \
echo "REMOTE_REPO_DIR is required (example: REMOTE_REPO_DIR=/opt/cogstack_nifi)"; \
exit 1; \
fi
@if [ -z "$(REMOTE_SERVICES)" ]; then \
echo "REMOTE_SERVICES is required (example: REMOTE_SERVICES='nifi nifi-nginx')"; \
exit 1; \
fi
.PHONY: remote-deploy-service remote-stop-service remote-delete-service _check-remote-params helm-template-opensearch helm-install-opensearch
# start services
start-nifi: ## Start NiFi and NiFi nginx (services.yml)
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) nifi nifi-nginx
start-nifi-dev: ## Start NiFi and NiFi nginx (services.dev.yml)
$(WITH_ENV) docker compose -f services.dev.yml $(DC_START_CMD) nifi nifi-nginx
start-nifi-dev-build: ## Build and start NiFi dev services
$(WITH_ENV) docker compose -f services.dev.yml up -d --build nifi nifi-nginx
start-elastic: ## Start elasticsearch-1, elasticsearch-2 and kibana
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) elasticsearch-1 elasticsearch-2 kibana
start-elastic-cluster: ## Start full 3-node Elasticsearch cluster
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) elasticsearch-1 elasticsearch-2 elasticsearch-3
start-elastic-1:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) elasticsearch-1
start-elastic-2:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) elasticsearch-2
start-elastic-3:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) elasticsearch-3
start-metricbeat-1:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) metricbeat-1
start-metricbeat-2:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) metricbeat-2
start-metricbeat-3:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) metricbeat-3
start-filebeat-1:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) filebeat-1
start-filebeat-2:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) filebeat-2
start-filebeat-3:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) filebeat-3
start-kibana:
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) kibana
start-samples: ## Start the sample database service
$(WITH_ENV) docker compose -f services.yml $(DC_START_CMD) samples-db
start-jupyter:
$(WITH_ENV) docker compose -f ../services/cogstack-jupyter-hub/docker/docker-compose.base.yml -f ../services/cogstack-jupyter-hub/docker/docker-compose.prod.yml $(DC_START_CMD) cogstack-jupyter-hub
start-medcat-service:
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-service/docker/docker-compose.yml $(DC_START_CMD) nlp-medcat-service-production
start-medcat-service-deid:
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-service/docker/docker-compose.yml $(DC_START_CMD) nlp-medcat-service-production-deid
start-medcat-trainer:
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-trainer/docker-compose-prod.yml $(DC_START_CMD) medcattrainer nginx solr
start-production-db:
$(WITH_ENV) docker compose -f services.yml ${DC_START_CMD} cogstack-databank-db
start-ocr-services:
$(WITH_ENV) docker compose -f ../services/ocr-service/docker/docker-compose.base.yml -f ../services/ocr-service/docker/docker-compose.prod.yml $(DC_START_CMD) ocr-service ocr-service-text-only
start-git-ea:
$(WITH_ENV) docker compose -f services.yml ${DC_START_CMD} gitea
start-data-infra: start-nifi start-elastic start-samples ## Start core data infrastructure
start-all: start-data-infra start-jupyter start-medcat-service start-ocr-services ## Start all major services
.PHONY: start-all start-data-infra start-nifi start-nifi-dev start-nifi-dev-build start-elastic start-samples start-jupyter
# stop services
#
stop-nifi: ## Stop NiFi and NiFi nginx (services.yml)
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) nifi nifi-nginx
stop-nifi-dev: ## Stop NiFi and NiFi nginx (services.dev.yml)
$(WITH_ENV) docker compose -f services.dev.yml $(DC_STOP_CMD) nifi nifi-nginx
delete-nifi: delete-nifi-containers ## Delete NiFi containers only
delete-nifi-containers: ## Remove NiFi containers from services.yml
$(WITH_ENV) docker compose -f services.yml rm -f -s nifi nifi-nginx
delete-nifi-dev-containers: ## Remove NiFi containers from services.dev.yml
$(WITH_ENV) docker compose -f services.dev.yml rm -f -s nifi nifi-nginx
delete-nifi-images: ## Delete NiFi images referenced in services.yml
$(WITH_ENV) images="$$(docker compose -f services.yml config --images nifi nifi-nginx | sort -u)"; \
if [ -n "$$images" ]; then \
docker image rm -f $$images; \
else \
echo "No NiFi images found in services.yml"; \
fi
delete-nifi-dev-images: ## Delete NiFi images referenced in services.dev.yml
$(WITH_ENV) images="$$(docker compose -f services.dev.yml config --images nifi nifi-nginx | sort -u)"; \
if [ -n "$$images" ]; then \
docker image rm -f $$images; \
else \
echo "No NiFi images found in services.dev.yml"; \
fi
delete-nifi-volumes: ## Delete NiFi volumes
$(WITH_ENV) docker compose -f services.yml $(DC_DOWN_CMD) -v nifi nifi-nginx
delete-elastic: ## Remove Elasticsearch and Kibana containers
$(WITH_ENV) docker compose -f services.yml rm -f -s elasticsearch-1 elasticsearch-2 elasticsearch-3 kibana
delete-elastic-volumes: ## Delete Elasticsearch and Kibana volumes
$(WITH_ENV) docker compose -f services.yml $(DC_DOWN_CMD) -v elasticsearch-1 elasticsearch-2 elasticsearch-3 kibana
delete-databank:
$(WITH_ENV) docker compose -f services.yml rm -f -s cogstack-databank-db cogstack-databank-db-mssql
delete-databank-volumes:
$(WITH_ENV) docker compose -f services.yml $(DC_DOWN_CMD) -v cogstack-databank-db cogstack-databank-db-mssql
delete-samples-db:
$(WITH_ENV) docker compose -f services.yml rm -f -s samples-db
delete-samples-db-volumes:
$(WITH_ENV) docker compose -f services.yml $(DC_DOWN_CMD) -v samples-db
delete-medcat-trainer: ## Remove MedCAT Trainer containers
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-trainer/docker-compose-prod.yml rm -f -s medcattrainer nginx solr
delete-medcat-trainer-volumes: ## Delete MedCAT Trainer volumes
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-trainer/docker-compose-prod.yml $(DC_DOWN_CMD) -v medcattrainer nginx solr
delete-jupyter: ## Remove Jupyter container
$(WITH_ENV) docker compose -f ../services/cogstack-jupyter-hub/docker/docker-compose.base.yml -f ../services/cogstack-jupyter-hub/docker/docker-compose.prod.yml rm -f -s cogstack-jupyter-hub
delete-medcat-service: ## Remove MedCAT service container
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-service/docker/docker-compose.yml rm -f -s nlp-medcat-service-production
delete-medcat-service-deid: ## Remove MedCAT service (deid) container
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-service/docker/docker-compose.yml rm -f -s nlp-medcat-service-production-deid
delete-ocr-services: ## Remove OCR service containers
$(WITH_ENV) docker compose -f ../services/ocr-service/docker/docker-compose.base.yml -f ../services/ocr-service/docker/docker-compose.prod.yml rm -f -s ocr-service ocr-service-text-only
make-delete-jupyter: delete-jupyter ## Alias for delete-jupyter
make-delete-medcat-service: delete-medcat-service ## Alias for delete-medcat-service
make-delete-medcat-service-deid: delete-medcat-service-deid ## Alias for delete-medcat-service-deid
make-delete-ocr-services: delete-ocr-services ## Alias for delete-ocr-services
stop-elastic: ## Stop elasticsearch-1, elasticsearch-2 and kibana
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) elasticsearch-1 elasticsearch-2 kibana
stop-elastic-cluster:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) elasticsearch-1 elasticsearch-2
stop-elastic-1:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) elasticsearch-1
stop-elastic-2:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) elasticsearch-2
stop-elastic-3:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) elasticsearch-3
stop-metricbeat-1:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) metricbeat-1
stop-metricbeat-2:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) metricbeat-2
stop-filebeat-1:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) filebeat-1
stop-filebeat-2:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) filebeat-2
stop-filebeat-3:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) filebeat-3
stop-kibana:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) kibana
stop-samples: ## Stop the sample database service
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) samples-db
stop-jupyter:
$(WITH_ENV) docker compose -f ../services/cogstack-jupyter-hub/docker/docker-compose.base.yml -f ../services/cogstack-jupyter-hub/docker/docker-compose.yml $(DC_STOP_CMD) cogstack-jupyter-hub
stop-medcat-trainer:
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-trainer/docker-compose-prod.yml $(DC_STOP_CMD) medcattrainer nginx solr
stop-medcat-service:
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-service/docker/docker-compose.yml $(DC_STOP_CMD) nlp-medcat-service-production
stop-medcat-service-deid:
$(WITH_ENV) docker compose -f ../services/cogstack-nlp/medcat-service/docker/docker-compose.yml $(DC_STOP_CMD) nlp-medcat-service-production-deid
stop-git-ea:
$(WITH_ENV) docker compose -f services.yml ${DC_STOP_CMD} gitea
stop-ocr-services:
$(WITH_ENV) docker compose -f ../services/ocr-service/docker/docker-compose.base.yml -f ../services/ocr-service/docker/docker-compose.prod.yml $(DC_STOP_CMD) ocr-service ocr-service-text-only
stop-production-db:
$(WITH_ENV) docker compose -f services.yml $(DC_STOP_CMD) cogstack-databank-db
stop-data-infra: stop-nifi stop-elastic stop-samples ## Stop core data infrastructure
stop-all: stop-data-infra stop-jupyter stop-medcat-service stop-ocr-services ## Stop all major services
.PHONY: stop-data-infra stop-nifi stop-nifi-dev delete-nifi delete-nifi-containers delete-nifi-dev-containers delete-nifi-images delete-nifi-dev-images delete-nifi-volumes delete-elastic delete-elastic-volumes delete-databank delete-databank-volumes delete-samples-db delete-samples-db-volumes delete-medcat-trainer delete-medcat-trainer-volumes delete-jupyter delete-medcat-service delete-medcat-service-deid delete-ocr-services make-delete-jupyter make-delete-medcat-service make-delete-medcat-service-deid make-delete-ocr-services stop-elastic stop-samples stop-jupyter
# cleanup
#
down-all: ## Run docker compose down for services.yml
$(WITH_ENV) docker compose -f services.yml $(DC_DOWN_CMD)
# deletes volumes associated with containers
cleanup: ## Run docker compose down -v for services.yml
$(WITH_ENV) docker compose -f services.yml $(DC_DOWN_CMD) -v
.PHONY: down-all cleanup