-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFILES_MANIFEST.txt
More file actions
407 lines (330 loc) · 11.3 KB
/
FILES_MANIFEST.txt
File metadata and controls
407 lines (330 loc) · 11.3 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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
================================================================================
SURIMI DataLab - Complete File Manifest
================================================================================
PROJECT: SURIMI DataLab
DESCRIPTION: Data Infrastructure Platform for SURIMI (European Commission)
STATUS: Production Ready
VERSION: 1.0
================================================================================
DOCUMENTATION
================================================================================
1. README.md
- Project overview
- Feature summary
- Quick start instructions
- File list
2. QUICKSTART.md
- Detailed 11-step setup guide
- Service configuration
- Access instructions
- Troubleshooting reference
3. ARCHITECTURE_GUIDE.md
- Complete architecture explanation
- Python code examples
- Integration details
- Data flow descriptions
4. MULTILINGUAL_GUIDE.md
- Unicode handling guide
- Language-specific collations
- Data normalization procedures
- Quality checking examples
5. SURIMI_DATALAB_SUMMARY.md
- Project context and overview
- Use cases
- Technology stack
- Enhancement roadmap
6. DEPLOYMENT_CHECKLIST.md
- Pre-deployment requirements
- Step-by-step deployment guide
- Health check procedures
- Ongoing operations tasks
7. architecture-diagram.html
- Interactive visual architecture
- Layer descriptions
- Implementation roadmap
- Decision framework
8. index.html
- Landing page
- Service quick links
- Feature showcase
- Project information
================================================================================
CORE INFRASTRUCTURE
================================================================================
1. docker-compose.yml
- Complete service orchestration
- 16 services configured:
* MinIO (S3 storage)
* PostgreSQL (databases)
* Hive Metastore (table catalog)
* Trino (SQL engine)
* Elasticsearch (search)
* Neo4j (graph database)
* Kafka & Zookeeper (events)
* DataHub GMS & Frontend (metadata)
* Superset (BI)
* Airflow (scheduler, webserver, DB)
* Ingestion Service (Python)
* Jupyter (notebooks)
- Health checks configured
- Volume management
- Network configuration
2. .env.example
- Environment variables template
- Credential configuration
- Service endpoints
- Optional overrides
3. postgres-init.sql
- Database initialization script
- Creates: datahub, superset, hive_metastore databases
- Grants necessary permissions
================================================================================
TRINO CONFIGURATION
================================================================================
Location: trino/etc/
1. config.properties
- Coordinator configuration
- Node discovery settings
- HTTP port configuration
2. jvm.config
- JVM memory settings (2GB heap)
- Garbage collection configuration
- Heap dump settings
3. node.properties
- Node environment settings
- Data directory configuration
4. core-site.xml
- Hadoop S3A configuration
- MinIO endpoint configuration
- Credentials and SSL settings
5. catalog/hive.properties
- Hive connector configuration
- Metastore URI configuration
================================================================================
INGESTION SERVICE
================================================================================
Location: ingestion/
1. Dockerfile
- Python 3.11 base image
- System dependencies
- Application setup
2. requirements.txt
- MinIO client
- Pandas & PyArrow
- Trino Python client
- DataHub integration
- Kafka client
- Unicode & language detection libraries
3. scripts/monitor_daemon.py
- File monitoring service
- Detects new/updated CSV files
- Polling-based (60s interval)
- State tracking
- Error handling
4. config/
- Configuration directory
- State files stored here
================================================================================
AIRFLOW ORCHESTRATION
================================================================================
Location: airflow/dags/
1. csv_ingestion_dag.py
- Example Airflow DAG
- 5-step pipeline:
* Check for new files
* Validate CSV schema
* Move to staging
* Update Hive catalog
* Sync to DataHub
- Hourly schedule
- Error handling and retries
2. logs/ (directory)
- Airflow logs stored here
- Auto-created by Docker
3. plugins/ (directory)
- Custom Airflow plugins
- For future extensions
================================================================================
JUPYTER NOTEBOOKS
================================================================================
Location: notebooks/
- Directory for user notebooks
- Pre-configured Trino connection
- Access to DataHub API
- Scientific stack included (Pandas, Matplotlib, NumPy)
================================================================================
DEPLOYMENT SIZE
================================================================================
Total Files: 21
Total Documentation: ~80 KB
Total Configuration: ~40 KB
Total Code: ~25 KB
Total: ~145 KB (download size)
Running Services: ~8 GB disk usage
Database Volumes: 5-10 GB (depending on data)
Total Deployment: 15-20 GB recommended
================================================================================
SERVICES OVERVIEW
================================================================================
STORAGE TIER
- MinIO: S3-compatible object storage (9000, 9001)
PROCESSING TIER
- Trino: SQL query engine (8080)
- Hive Metastore: Table catalog (9083)
METADATA TIER
- PostgreSQL: Metadata database (5432)
- Elasticsearch: Search & indexing (9200)
- Neo4j: Graph database (7474, 7687)
- Kafka: Event streaming (9092)
- DataHub GMS: Metadata service (8090)
ANALYTICS TIER
- Superset: BI & dashboards (8088)
- Jupyter: Notebooks (8888)
ORCHESTRATION TIER
- Airflow: Workflow orchestration (8081)
APPLICATION TIER
- Ingestion Service: CSV monitoring
================================================================================
QUICK START
================================================================================
1. Extract files to directory: surimi-datalab/
2. Create subdirectories:
mkdir -p trino/etc/catalog ingestion/scripts airflow/dags airflow/logs notebooks
3. Start services:
docker-compose up -d
4. Create MinIO buckets:
docker exec -it minio bash -c "mkdir -p /data/raw /data/staging /data/processed"
5. Access platform:
- MinIO: http://localhost:9001 (minioadmin/minioadmin)
- Trino: http://localhost:8080
- Superset: http://localhost:8088 (admin/admin)
- DataHub: http://localhost:3000
- Airflow: http://localhost:8081 (airflow/airflow)
- Jupyter: http://localhost:8888
6. Create test table in Trino CLI:
docker exec -it trino trino --catalog hive
CREATE SCHEMA IF NOT EXISTS hive.staging;
================================================================================
TECHNOLOGY STACK
================================================================================
INFRASTRUCTURE
- Docker & Docker Compose
- PostgreSQL 14-alpine
- Apache Kafka 7.5
- Zookeeper 2.5
DATA PLATFORM
- MinIO (latest)
- Trino (latest)
- Apache Hive 4.0.0
- Apache Airflow 2.7.0
METADATA & ANALYTICS
- DataHub (latest)
- Elasticsearch 8.5.0
- Neo4j 4.4.8
- Apache Superset (latest)
- Jupyter (datascience-notebook)
PROGRAMMING
- Python 3.11
- Java (Trino, Hive, Airflow)
- JavaScript/React (DataHub, Superset, Jupyter)
================================================================================
MULTILINGUAL SUPPORT
================================================================================
Languages Supported:
- Greek (el) - Full Unicode, Greek collations
- German (de) - Umlauts, German sorting
- French (fr) - Accents, French collations
- English (en) - Standard Unicode
Features:
- Automatic encoding detection (chardet)
- Unicode NFKC normalization
- Language detection (langdetect)
- Database collation support
- Mojibake detection
================================================================================
SURIMI PROJECT CONTEXT
================================================================================
PROJECT: SURIMI
PLATFORM: EDITO (European Commission)
FOCUS: Healthcare data interoperability
USE CASES:
1. Patient data management
2. Caregiver scheduling
3. Doctor information systems
4. Data quality monitoring
5. Healthcare analytics
REQUIREMENTS MET:
✓ Multilingual data support
✓ Automated ingestion
✓ Metadata management
✓ Analytics & visualization
✓ Privacy-preserving design
✓ EDITO compatibility
✓ Scalable architecture
================================================================================
FILE DEPENDENCIES
================================================================================
docker-compose.yml
├── Requires: .env.example
├── Requires: trino/etc/*.properties
├── Requires: trino/etc/*.xml
├── Requires: ingestion/Dockerfile
├── Requires: ingestion/requirements.txt
├── Requires: postgres-init.sql
└── Mounts: ingestion/scripts/, airflow/dags/
QUICKSTART.md
├── References: README.md
├── References: ARCHITECTURE_GUIDE.md
├── References: MULTILINGUAL_GUIDE.md
└── References: docker-compose.yml
Each file is self-contained but documented in QUICKSTART.md
================================================================================
VERIFICATION CHECKLIST
================================================================================
Files Present:
✓ docker-compose.yml
✓ .env.example
✓ postgres-init.sql
✓ trino/etc/config.properties
✓ trino/etc/jvm.config
✓ trino/etc/node.properties
✓ trino/etc/core-site.xml
✓ trino/etc/catalog/hive.properties
✓ ingestion/Dockerfile
✓ ingestion/requirements.txt
✓ ingestion/scripts/monitor_daemon.py
✓ airflow/dags/csv_ingestion_dag.py
✓ README.md
✓ QUICKSTART.md
✓ ARCHITECTURE_GUIDE.md
✓ MULTILINGUAL_GUIDE.md
✓ SURIMI_DATALAB_SUMMARY.md
✓ DEPLOYMENT_CHECKLIST.md
✓ architecture-diagram.html
✓ index.html
================================================================================
SUPPORT & DOCUMENTATION
================================================================================
For detailed setup: See QUICKSTART.md
For technical details: See ARCHITECTURE_GUIDE.md
For multilingual support: See MULTILINGUAL_GUIDE.md
For deployment: See DEPLOYMENT_CHECKLIST.md
For troubleshooting: See QUICKSTART.md (Troubleshooting section)
For project info: See SURIMI_DATALAB_SUMMARY.md
For visual reference: Open architecture-diagram.html in browser
================================================================================
NEXT STEPS
================================================================================
1. Read QUICKSTART.md for detailed setup
2. Extract all files to project directory
3. Run: docker-compose up -d
4. Access: http://localhost:9001 (MinIO) to verify
5. Create MinIO buckets: /raw/, /staging/, /processed/
6. Upload test CSV and verify pipeline
7. Configure Superset dashboard
8. Explore DataHub metadata
9. Test Jupyter notebooks
================================================================================
SURIMI DataLab - Production Ready
Version: 1.0 | December 2025
Built on EDITO Platform | European Commission