Despliegues de la API

Esta sección documenta las opciones de despliegue de la API del Conector SQL

El Conector SQL funciona a través de un servicio que usted coloca entre Power Omni y su instancia de SQL Server.

Este servicio es responsable de:

  • Exponer los procedures de una base de datos como un esquema OpenAPI
  • Proporcionar endpoints HTTP para ejecutar estos procedures
  • Convertir los resultados de la ejecución a un formato aceptado por Power Omni (incluidos los errores de la base de datos)

El desarrollo y el mantenimiento de este conector son responsabilidad de Power Tuning, pero es usted, o su equipo, quien decide cómo y dónde se ejecutará.

Es una aplicación Node.Js, disponible mediante una imagen docker de Linux, lo que facilita su despliegue prácticamente en cualquier entorno, en la nube o on-premises.

Esta sección ofrece algunas guías sobre cómo realizar los despliegues, para que usted tenga una orientación. Utilice la navegación lateral y elija el método que más le convenga.

Acerca de la imagen Docker

La API del servicio de integración se distribuye en una imagen docker construida por el equipo de Power Tuning. Independientemente de cómo la despliegue, las mismas variables de entorno están disponibles para la configuración. Consulte la tabla a continuación:

VariableDescripción
SQL_CONNECTIONCadena de conexión a la instancia de SQL Server
PUBLIC_URLSURL pública por la cual la API será accesible. El servicio generará el esquema OpenAPI usando esta URL y es la que Omni utilizará al invocar el procedure
KEYSLista de ApiKeys separadas por ";". Utilice valores aleatorios y robustos. Para reforzar la seguridad, se pueden utilizar otros servicios que generen apikeys cifradas
CUSTOM_AUTHSCHEMECadena con un yaml que especifica un Auth Scheme alternativo que se usará al generar el esquema OpenAPI. Utilice solo si necesita otro tipo de autenticación distinto de ApiKey. Es una configuración avanzada que debe realizarse con el apoyo de Power Tuning
AUTO_RELOADModifica el AutoReload, especificando la frecuencia, en milisegundos, con la que la API cargará los procedures modificados. Con base en este tiempo, la API consulta periódicamente la base de datos identificando los procedures que fueron modificados y recreando el esquema.

Actualizado