|
| 1 | +# Scripts de Configuración |
| 2 | + |
| 3 | +## Orden de Ejecución |
| 4 | + |
| 5 | +**IMPORTANTE:** Los scripts deben ejecutarse en este orden: |
| 6 | + |
| 7 | +1. **setup_rabbitmq.sh** - Configura RabbitMQ (exchange, queue y binding) |
| 8 | +2. **setup_minio_events.sh** - Configura MinIO para enviar eventos a RabbitMQ |
| 9 | + |
| 10 | +## setup_rabbitmq.sh |
| 11 | + |
| 12 | +Script para configurar RabbitMQ con el exchange, queue y binding necesarios para recibir eventos de MinIO. |
| 13 | + |
| 14 | +### Requisitos Previos |
| 15 | + |
| 16 | +1. **rabbitmqadmin instalado** (el script intentará descargarlo automáticamente si no está disponible) |
| 17 | +2. **RabbitMQ corriendo** con el plugin de management habilitado |
| 18 | + |
| 19 | +### Uso |
| 20 | + |
| 21 | +```bash |
| 22 | +cd DocsManager/scripts |
| 23 | +./setup_rabbitmq.sh |
| 24 | +``` |
| 25 | + |
| 26 | +### Qué hace el script |
| 27 | + |
| 28 | +1. Verifica/descarga `rabbitmqadmin` si no está instalado |
| 29 | +2. Crea el exchange `minio-events` (tipo: direct, durable) |
| 30 | +3. Crea la queue `document.process` (durable) |
| 31 | +4. Crea el binding entre el exchange y la queue |
| 32 | +5. Muestra la configuración resultante |
| 33 | + |
| 34 | +## setup_minio_events.sh |
| 35 | + |
| 36 | +Script para configurar eventos de MinIO hacia RabbitMQ. Cuando se crea un archivo en el bucket `goland-bucket` dentro de la carpeta especificada en `MINIO_FOLDER` (por defecto `rag-docs/`), MinIO publicará automáticamente un mensaje en la cola de RabbitMQ. |
| 37 | + |
| 38 | +### Requisitos Previos |
| 39 | + |
| 40 | +1. **MinIO Client (mc) instalado:** |
| 41 | + ```bash |
| 42 | + # macOS |
| 43 | + brew install minio/stable/mc |
| 44 | + |
| 45 | + # Linux |
| 46 | + wget https://dl.min.io/client/mc/release/linux-amd64/mc |
| 47 | + chmod +x mc |
| 48 | + sudo mv mc /usr/local/bin/ |
| 49 | + ``` |
| 50 | + |
| 51 | +2. **MinIO corriendo** y accesible |
| 52 | +3. **RabbitMQ corriendo** y accesible |
| 53 | +4. **RabbitMQ ya configurado** (ejecutar `setup_rabbitmq.sh` primero) |
| 54 | + |
| 55 | +### Uso |
| 56 | + |
| 57 | +#### Opción 1: Usando variables de entorno del archivo .env |
| 58 | + |
| 59 | +El script automáticamente carga las variables del archivo `.env` en el directorio raíz de DocsManager: |
| 60 | + |
| 61 | +```bash |
| 62 | +cd DocsManager |
| 63 | +./scripts/setup_minio_events.sh |
| 64 | +``` |
| 65 | + |
| 66 | +#### Opción 2: Usando variables de entorno directamente |
| 67 | + |
| 68 | +```bash |
| 69 | +export MINIO_ENDPOINT=localhost:9000 |
| 70 | +export MINIO_ACCESS_KEY=minioadmin |
| 71 | +export MINIO_SECRET_KEY=minioadmin |
| 72 | +export MINIO_BUCKET=goland-bucket |
| 73 | +export MINIO_FOLDER=rag-docs |
| 74 | +export RABBITMQ_HOST=rabbitmq |
| 75 | +export RABBITMQ_USER=guest |
| 76 | +export RABBITMQ_PASSWORD=guest |
| 77 | +export QUEUE_NAME=document.process |
| 78 | + |
| 79 | +./scripts/setup_minio_events.sh |
| 80 | +``` |
| 81 | + |
| 82 | +### Variables de Entorno |
| 83 | + |
| 84 | +El script utiliza las siguientes variables (con valores por defecto): |
| 85 | + |
| 86 | +| Variable | Descripción | Valor por Defecto | |
| 87 | +|----------|-------------|-------------------| |
| 88 | +| `MINIO_ENDPOINT` | Endpoint de MinIO (host:puerto) | `localhost:9000` | |
| 89 | +| `MINIO_ACCESS_KEY` | Clave de acceso de MinIO | `minioadmin` | |
| 90 | +| `MINIO_SECRET_KEY` | Clave secreta de MinIO | `minioadmin` | |
| 91 | +| `MINIO_BUCKET` | Nombre del bucket | `goland-bucket` | |
| 92 | +| `MINIO_FOLDER` | Carpeta dentro del bucket donde se monitorean los eventos | `rag-docs` | |
| 93 | +| `MINIO_USE_SSL` | Usar SSL para MinIO | `false` | |
| 94 | +| `RABBITMQ_HOST` | Host de RabbitMQ | `rabbitmq` | |
| 95 | +| `RABBITMQ_PORT` | Puerto de RabbitMQ | `5672` | |
| 96 | +| `RABBITMQ_USER` | Usuario de RabbitMQ | `guest` | |
| 97 | +| `RABBITMQ_PASSWORD` | Contraseña de RabbitMQ | `guest` | |
| 98 | +| `QUEUE_NAME` | Nombre de la cola | `document.process` | |
| 99 | + |
| 100 | +### Qué hace el script |
| 101 | + |
| 102 | +1. Verifica que `mc` esté instalado |
| 103 | +2. Carga variables de entorno desde `.env` (si existe) |
| 104 | +3. Configura un alias de MinIO |
| 105 | +4. Verifica la conexión a MinIO |
| 106 | +5. Crea el bucket si no existe |
| 107 | +6. Configura la notificación AMQP hacia RabbitMQ |
| 108 | +7. Reinicia MinIO para aplicar cambios |
| 109 | +8. Configura eventos para archivos en la carpeta especificada en `MINIO_FOLDER` dentro del bucket |
| 110 | +9. Muestra un resumen de la configuración |
| 111 | + |
| 112 | +### Formato del Mensaje |
| 113 | + |
| 114 | +Cuando MinIO detecta un nuevo archivo en la carpeta especificada en `MINIO_FOLDER` (por defecto `rag-docs/`), publica un mensaje JSON en RabbitMQ con el siguiente formato: |
| 115 | + |
| 116 | +```json |
| 117 | +{ |
| 118 | + "EventName": "s3:ObjectCreated:Put", |
| 119 | + "Key": "rag-docs/uuid.pdf", |
| 120 | + "Records": [ |
| 121 | + { |
| 122 | + "eventVersion": "2.0", |
| 123 | + "eventSource": "minio:s3", |
| 124 | + "awsRegion": "", |
| 125 | + "eventTime": "2025-01-XX...", |
| 126 | + "eventName": "s3:ObjectCreated:Put", |
| 127 | + "s3": { |
| 128 | + "bucket": { |
| 129 | + "name": "goland-bucket" |
| 130 | + }, |
| 131 | + "object": { |
| 132 | + "key": "rag-docs/uuid.pdf", |
| 133 | + "size": 12345 |
| 134 | + } |
| 135 | + } |
| 136 | + } |
| 137 | + ] |
| 138 | +} |
| 139 | +``` |
| 140 | + |
| 141 | +### Verificar la Configuración |
| 142 | + |
| 143 | +Para verificar que los eventos están configurados: |
| 144 | + |
| 145 | +```bash |
| 146 | +mc event list myminio/goland-bucket |
| 147 | +``` |
| 148 | + |
| 149 | +### Solución de Problemas |
| 150 | + |
| 151 | +1. **Error: "mc: command not found"** |
| 152 | + - Instala MinIO Client siguiendo las instrucciones en "Requisitos Previos" |
| 153 | + |
| 154 | +2. **Error: "No se pudo conectar a MinIO"** |
| 155 | + - Verifica que MinIO esté corriendo |
| 156 | + - Verifica que el endpoint y las credenciales sean correctas |
| 157 | + - Si MinIO está en Docker, usa `localhost` o el nombre del servicio |
| 158 | + |
| 159 | +3. **Error: "RabbitMQ connection failed"** |
| 160 | + - Verifica que RabbitMQ esté corriendo |
| 161 | + - Verifica que el host y puerto sean correctos |
| 162 | + - Si RabbitMQ está en Docker, usa el nombre del servicio (`rabbitmq`) en lugar de `localhost` |
| 163 | + |
| 164 | +4. **Los eventos no se disparan** |
| 165 | + - Verifica que los archivos se suban a la ruta especificada en `MINIO_FOLDER` dentro del bucket |
| 166 | + - Verifica que la cola `document.process` exista en RabbitMQ |
| 167 | + - Revisa los logs de MinIO para ver si hay errores |
| 168 | + |
| 169 | +### Notas |
| 170 | + |
| 171 | +- El script reinicia MinIO, lo que puede causar una breve interrupción del servicio |
| 172 | +- Los eventos solo se disparan para archivos nuevos (PUT), no para actualizaciones |
| 173 | +- El prefijo especificado en `MINIO_FOLDER` es obligatorio - los archivos fuera de esta carpeta no generarán eventos |
| 174 | +- Por defecto, `MINIO_FOLDER` está configurado como `rag-docs`, pero puedes cambiarlo usando la variable de entorno |
| 175 | + |
0 commit comments