base-deployment-controller 0.1.0__py3-none-any.whl

base_deployment_controller-0.1.0.dist-info/METADATA

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: base-deployment-controller
+Version: 0.1.0
+Summary: REST API to control the basic operations of a deployment
+Author: Tknika
+License: Creative Commons Atribución-NoComercial (CC BY-NC)
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.128.0
+Requires-Dist: uvicorn[standard]>=0.40.0
+Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: websockets>=16.0
+Requires-Dist: python-on-whales>=0.80.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: requests>=2.31.0; extra == "dev"
+
+# Base Deployment Controller
+
+REST API para la gestión básica de un deployment.
+
+## Características
+
+- **Gestión del deployment**: Inicia, detiene y borrar el deploy (`compose.yaml`)
+- **Gestión de variables de entorno**: Lee configuración de `x-env-vars` en `compose.yaml` y permite actualizar valores en `.env`
+- **Control de contenedores**: Inicia, detiene y reinicia contenedores del deploy
+- **Logs en tiempo real**: WebSocket para streaming de logs de contenedores
+- **Validación de tipos**: Valida automáticamente valores según schemas (regex, rangos, enums)
+
+## Requisitos
+
+- Python 3.8+
+- Docker y Docker Compose
+
+## Instalación
+
+```bash
+# Crear entorno virtual
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Instalar como librería
+pip install base-deployment-controller
+```
+
+## Uso
+
+### Iniciar el servidor (demo)
+
+```bash
+# Ejecutar la app demo desde la raíz del repo
+python3 main.py
+```
+
+El servidor estará disponible en `http://localhost:8000`
+
+### Uso como librería
+
+#### Uso básico (factory)
+
+```python
+from base_deployment_controller import create_app
+
+app = create_app(
+  compose_file="compose.yaml",
+  env_file=".env",
+)
+```
+
+#### Uso avanzado (builder + routers personalizados)
+
+```python
+from fastapi import APIRouter
+from base_deployment_controller import AppBuilder
+
+custom_router = APIRouter(prefix="/custom")
+
+builder = AppBuilder("compose.yaml", ".env")
+app = builder.register_router(custom_router).build()
+```
+
+### API Endpoints
+
+#### GET /
+Obtiene información sobre el deploy:
+
+```bash
+curl http://localhost:8000/
+```
+
+#### POST /up|down|stop
+Controla el deploy:
+
+```bash
+# Levanta todos los servicio del deploy
+curl -X POST http://localhost:8000/up
+```
+
+#### GET /envs
+Obtiene todas las variables de entorno con sus valores actuales:
+
+```bash
+curl http://localhost:8000/envs
+```
+
+#### PUT /envs
+Actualiza variables de entorno. Usa `restart_services` (por defecto `true`) para controlar si se reinician los servicios afectados.
+
+```bash
+# Actualización múltiple
+curl -X PUT http://localhost:8000/envs \
+  -H "Content-Type: application/json" \
+  -d '{"variables": {"MCC": "214", "MNC": "07"}, "restart_services": false}'
+```
+
+#### GET /containers
+Lista el estado de todos los contenedores:
+
+```bash
+curl http://localhost:8000/containers
+```
+
+#### POST /containers/{name}/start|stop|restart
+Controla un contenedor específico:
+
+```bash
+# Reiniciar el MME
+curl -X POST http://localhost:8000/containers/mme/restart
+```
+
+#### WebSocket /containers/{container_name}/logs
+Logs en tiempo real via WebSocket:
+
+```javascript
+const ws = new WebSocket('ws://localhost:8000/containers/mme/logs');
+ws.onmessage = (event) => {
+  console.log(event.data);
+};
+```
+
+#### GET /ping
+Health check del servicio:
+
+```bash
+curl http://localhost:8000/ping
+```
+
+## Documentación Interactiva
+
+FastAPI genera automáticamente documentación interactiva:
+
+- **Swagger UI**: http://localhost:8000/docs
+- **ReDoc**: http://localhost:8000/redoc
+
+## Arquitectura
+
+### Configuración de Tres Niveles
+
+1. **compose.yaml**: Define servicios y dependencias
+2. **x-env-vars**: Schema maestro con validaciones
+3. **.env**: Valores en tiempo de ejecución
+
+## Validación de Tipos
+
+Las variables se validan según el schema de `x-env-vars`:
+
+- **String con regex**: `"string:0;^\d{3}$"` - MCC debe ser 3 dígitos
+- **Integer con rango**: `"integer:0;2048"` - MAX_NUM_UE entre 0-2048
+- **Enum**: `"enum:tun,tap"` - UPF_TUNTAP_MODE solo acepta tun o tap
+
+## Seguridad
+
+- Solo permite actualizar variables existentes en el schema
+- No permite agregar nuevas variables
+- No permite eliminar variables
+- Valida todos los valores antes de escribir en `.env`
+
+## Licencia
+
+Este proyecto es parte del controlador de despliegue 5G de Tknika.

base_deployment_controller-0.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+base_deployment_controller/__init__.py,sha256=1mvqShjmMTmJTYF7PLWBNwXPTtk-0Qba2Q6cQRYGRRs,1722
+base_deployment_controller/builder.py,sha256=VLwUTuIaeHdiMU1MZkVN4wo6NH2tsHLu6Ir-cWR2aOA,2938
+base_deployment_controller/models/__init__.py,sha256=a_mKXUYVzyeMuy4fCdGsYs9YWXC4UicDlT449wsj3TA,839
+base_deployment_controller/models/compose.py,sha256=BWkABpPjT70cRPKlHSqbnlAHSSUbLmxM67fHjNW844g,364
+base_deployment_controller/models/container.py,sha256=5Wy1Vf3c_YsnJxMYzsRt982DEr1hY1_k18TCjSouuIo,1195
+base_deployment_controller/models/deployment.py,sha256=LnayxI_975PPK2cjwJXhLnMHJU53a5JtDpboM2tpN4Q,1902
+base_deployment_controller/models/environment.py,sha256=qFDti4aUqK_BuJQz-QHZ1LpnvS2ACh-LRwW7HtlGztc,1542
+base_deployment_controller/routers/__init__.py,sha256=Oe96tG8Jcw1S6m40Di68DkCr3UbjSEruFikk9bocj4c,238
+base_deployment_controller/routers/container.py,sha256=L2xYBVZf398DkmXr5Qu6U7Up2sYLY-DxS7ZOx5Xh50I,15433
+base_deployment_controller/routers/deployment.py,sha256=7tOXkNrhRXbVFKUqBDmqp_rSojzqecAzU8yP1AqbNbo,9623
+base_deployment_controller/routers/environment.py,sha256=3uq8WSYAz2cZOW4LLvPaVBBDITn6OfSU8v-Q2YUFjwQ,6439
+base_deployment_controller/services/__init__.py,sha256=kiU1CafpZEhO2V0Z1YSv4SW7gi8gvhf7-cPHSh4ETJo,127
+base_deployment_controller/services/config.py,sha256=jMJXrNvznNoCciFbb_kCQee6XMqV7ouVpo2ql6oIqaU,21165
+base_deployment_controller-0.1.0.dist-info/METADATA,sha256=w9ufhsCAU7nmSe_x8l0DUVDeBDqadJDiXZDdDcwaLck,4483
+base_deployment_controller-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+base_deployment_controller-0.1.0.dist-info/top_level.txt,sha256=L43ihN7K4QcA-cdy6KnHcBJOtI-zceJ9Zqh5z1kgia0,27
+base_deployment_controller-0.1.0.dist-info/RECORD,,

base_deployment_controller-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

base_deployment_controller-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+base_deployment_controller