API Deployments
This section documents the deployment options for the SQL Connector API
The SQL Connector works through a service that you place between Power Omni and your SQL Server instance.
This Service is responsible for:
Expose the procedures of a database as an OpenAPI schema
Provide HTTP endpoints for executing these procedures
Convert the execution results into a format acceptable by Power Omni (including database errors)
The development and maintenance of this connector is the responsibility of Power Tuning, but it is you, or your team, who decides how and where it will run.
It is a Node.Js application, available through a Linux docker image, which makes it easy for you to deploy it in virtually any environment, cloud or on-premises.
This section provides some guides on how to perform the deployments, so that you have guidance. Use the side navigation and choose the method that is best for you
About the Docker Image
The integration service API is made available in a docker image built by the Power Tuning team. Regardless of how you deploy it, the same environment variables are available for configuration. See the table below:
SQL_CONNECTION
Connection string to the SQL Server instance
PUBLIC_URLS
Public URL through which the API will be accessible. The service will generate the OpenAPI schema using this URL and it is the one that Omni will use when invoking the procedure
KEYS
List of ApiKeys separated by a ";". Use random and strong values. To reinforce security, other services that generate encrypted apikeys can be used
CUSTOM_AUTHSCHEME
String with a yaml specifying an alternative Auth Scheme that will be used when generating the OpenAPI Schema. Use only if you need to use another type of authentication other than ApiKey. It is an advanced configuration to be done with the support of Power Tuning
AUTO_RELOAD
Changes the AutoReload, specifying the frequency, in milliseconds, that the API will load the modified procedures. Based on this time, the API frequently queries the database identifying procedures that were modified and recreating the schema.
Last updated