Ajustes X-Ray

[milo19980525]

Se requiere ajustar el repositorio de Utilsoas para que el funcionamiento con X-Ray sea lo más transversal posible y cumpla con los requisitos básicos de seguridad.

Especificaciones técnicas

• El repositorio donde se encuentran las funcionalidades a actualizar es: https://github.com/udistrital/utils_oas.
• Verificar el uso de variables de entorno para la URL del servicio X-Ray.

Sub Tareas

• [x] Se debe revisar la estructura de las APIs (mid y crud) encontradas en la OATI, verificando cuales son los métodos que estos utilizan para hacer peticiones HTTP, con el propósito que sean migrados al repositorio: https://github.com/udistrital/utils_oas.
• [x] Una vez migradas las funcionalidades implementadas de manera individual para 5 APIs que no hayan sido implementadas previamente realizar los cambios requeridos para que funcione X-Ray en pruebas.
• [x] Analizar alternativas para almacenamiento y recuperación de variables de entorno (github secrets, parameter_store).
• [ ] Implementación del uso de variable de entorno para ocultar URL de servicio X-Ray.

Criterios de aceptación

• [ ] Se migran los servicios particulares para conexión HTTP a Utilsoas.
• [x] Se prueban los servicios migrados en al menos 5 APIs en entorno de pruebas
• [ ] Se implementa una variable de entorno para ocultar url del servicio de X-Ray.

Requerimientos

• [X] Prueba de concepto de X-Ray.
• [X] Implementación X-Ray en varias APIs.

Dependencias

• No presenta.

Definition of Ready - DoR

• [ ] Está refinada y estimada en puntos de historia por el equipo.
• [x] Incluye la descripción y criterios de aceptación, con el detalle funcional y especificaciones técnicas, de forma entendible por cualquier miembro del equipo.
• [x] No tiene bloqueos que impidan su ejecución.
• [x] Las dependencias entán identificadas y resueltas.
• [x] Puede ser probada dentro del Sprint.

Definition of Done - DoD - Desarrollo

• [ ] Criterios de aceptación cumplidos.
• [ ] Documentación de issue realizada.
• [ ] Aprobada p

[a52290451]

Actualización de estado de actividades

1. Se completa la migración de métodos de utilidades para las APIs:
   • cumplidos_dve_mid.
   • resoluciones_mid_v2.
2. Se completa el refactor de las siguientes APIs, asociado con el consumo de los métodos migrados a utils_oas/request:
   • cumplidos_dve_mid.
   • resoluciones_mid_v2.
3. Se completa parcialmente las pruebas de migración y refactor en las APIs:
   • cumplidos_dve_mid.
   • resoluciones_mid_v2.

Observaciones

1. X-Ray queda completamente funcional en las APIs refactorizadas.
2. Para completar las pruebas funcionales, se requiere probar los métodos POST de las APIs.
3. la API "resoluciones_mid_v2" requiere una actualización en la variable de entorno: "RESOLUCIONES_MID_V2_PROTOCOL_ADMIN" con el valor "http://"".

El historial de APIs Migradas, Refactorizadas y Probadas se puede consultar en:

https://udistritaleduco-my.sharepoint.com/:x:/g/personal/computo_udistrital_edu_co/EWjfag326S1AijrW8TKL7dQBz_B7Qy7BQ2AQD7aePZYHMw?e=VFW1jZ

Nota: El desarrollo se encuentra en local ya que no es posible actualizar el repositorio "utils_oas" hasta no completar todas las pruebas de los métodos migrados.

[milo19980525]

@a52290451 por favor comentar estado actual

[a52290451]

Actualización de estado de actividades

Migración de utilidades comunes en APIs a repositorio "utils_oas/request"

Se realiza la migración de funciones relacionadas con utilidades y peticiones entrantes y salientes, así como el refactor de los métodos y consumos en las siguientes APIs:

• cumplidos_dve_mid
• resoluciones_mid_v2
• titan_api_mid
• novedades_mid
• evaluacion_mid

Formato de migración de Utilidades de APIS MID

Nota:

• Para todas las APIs falta probar las peticiones de tipo POST, para esto se requiere información adicional en algunos casos.
• Se requiere revisar una petición en novedades mid que esta fallando con un error desconocido.
• Falta subir los cambios señalados a ambiente de pruebas en cada caso, una vez se completen las pruebas pertinentes, sin embargo, se debe tener cuidado con los cambios realizados especialmente en "utils_oas" ya que estos afectan a todas las APIs que consumen los métodos.

[a52290451]

Actualización de estado de actividades

Evaluación de Alternativas para el Almacenamiento y Recuperación de Variables de Entorno.

Se examinan diversas opciones para el manejo de variables de entorno, destacando la consideración de almacenarlas en GitHub y acceder a ellas desde el mismo repositorio. Para este propósito, se han creado los siguientes registros a nivel de organización:

Secret: DAEMON_ADDR_AWS_XRAY_1 Variable: DAEMON_ADDR_AWS_XRAY_2

Este enfoque se enfrenta a la complejidad de consumir estas variables desde un API en Go. Hasta la fecha, esta tarea no ha producido resultados positivos, dado que el código de las APIs se empaqueta y se envía a AWS, donde se crea un entorno de ejecución específico. En este entorno, las variables de entorno son leídas para el API en cuestión.

Dada la falta de viabilidad de esta solución, se procede a explorar la alternativa de establecer una variable de entorno global en AWS, accesible por cualquier API, como siguiente paso en la búsqueda de una solución más eficiente.