Environment Variables for Advanced Setup - 10.3.x (EN)

Introduction

Last modified: May 12, 2025

This guide describes advanced-level configuration methods for QueryPie. this article distinguishes between two types of configuration methods

1. Cases that can be configured by modifying only compose-env

2. Cases that require you to modify the docker-compose.yml file as well

Modifications to the compose-env file

Depending on your situation, you need to modify the compose-env file as shown below.

Common Features

Redis settings

Proxy settings

MySQL Connection Settings

Setting up MySQL connection for QueryPie Tools

If you want to use a different DB account for running QueryPie Server Container and a different DB account for running Tools, utilize this environment variable.

When running QueryPie Server Container, only Data Manipulation Language (SELECT, INSERT, UPDATE, DELETE) permissions can be granted. When running QueryPie Tools, you can temporarily grant limited Data Definition Language (CREATE, ALTER, DROP, TRUNCATE) permissions.

See: [Tools] DB Admin 계정의 필수 권한

Setting up a connection for Oven Storage

To utilize the Oven component to effectively store and handle audit logs, you must apply the following settings.

For more information about utilizing the Oven component, please contact your technical support representative.

Settings for changing QueryPie features

If you want to change the way the QueryPie feature works based on your specific security policies and requirements, you can set the following environment variables.

JDBC Driver for AWS Aurora DB Clusters

QueryPie provides the ability to change the JDBC Driver that QueryPie uses to connect to Meta DB, Snapshot DB, and Log DB. this allows you to use the automatic fail-over feature when using AWS Aurora DB Clusters.

If you are using AWS Aurora DB Clusters, add the following to your compose-env.

Installation Guide for Using DAC HTTPS Proxy (Target DB: Athena, Trino)

For the HTTP Proxy for Athena and Trino, you can apply a valid public TLS certificate. (For QueryPie 10.2.8 or later enhancements, proceed with the setup without changing the docker-compose.yml file. )

As a first step, place the certificate file inside the ./certs/ directory. If the certificate file you received is named localhost_querypie_com.pfx, save it as the path to ./certs/localhost_querypie_com.pfx.

as a second step, in compose-env, add the following entry

PROXY_HTTPS_CERT_PATH with a value of /app/certs/ followed by a filename. The ./certs/ path on the Docker Host will be volume mounted to the /app/certs/ path inside the Container.

finally, restart the QueryPie Container.

Setup guide for offering HTTPS services

refer to the following documents

• Quick Cheatsheet for Setup with Provided Certificate (KO)

modifications to the docker-compose.yml file

modify the docker-compose.yml and compose-env files according to the scenarios described below.

installation guide for using classifier

(Supported since 10.2.0)

add a classifier container to your docker-compose.yml file as shown below.

You can enter the following environment variables to tune AIDD(classifier) speed performance.

uncomment the commented out #- CLASSIFIER_URL=${CLASSIFIER_URL:-http://classifier:8081} part in the queryypie(app) container to make it look like this

Setting up for QueryPie MySQL requiring a TLS connection (see

customer case) kakao Enterprise

When configuring QueryPie MySQL, if you apply MySQL Server that requires TLS connection, you can apply the TLS certificate file through environment variable setting.

• as a first step, place the certificate files for the mysql server connection in the ./certs/ directory. We recommend saving each file with the following names

  • Root CA: mysql_server.crt

  • Client Certificate: mysql_client.pfx (PKCS12 formatted certificate file)

• second, in the compose-env configuration file, set the following environment variables.

• third, in the docker-compose.yml file, the environment: section adds the added environment variables.

  • you will need to add them to both the services → app → environment section and the services → tools → environment section.

after completing the configuration, restart the QueryPie Server Container.

The path ./certs/ on the Docker Host is set to mount to /app/certs/ inside the Container. the file path of the environment variable should be set based on the file path inside the Container.

For detailed configuration instructions, including the procedure to create the Client Certificate file and changes to compose-env and docker-compose.yml, see the following documentation: QueryPie MetaDB SSL 로 연결하기

When connecting Log DB and Snapshot DB to another DB Host, if you use SSL encryption, you can use the following environment variables.

• DB_DRIVER_CLASS Related: ENG_DB_DRIVER_CLASS, LOG_DB_DRIVER_CLASS

• DB_SSL_MODE Related: ENG_DB_SSL_MODE, LOG_DB_SSL_MODE

Installation guide for using NOVA

QueryPie comes with Network Outbound Virtual Access (NOVA) feature by default starting with version 10.2.1. By installing and running the Nova Client in a segmented network area where inbound access is blocked, you can configure a Reverse Proxy environment that can communicate with QueryPie Server. this Nova Client acts as a reverse proxy, allowing QueryPie Server to access databases and systems within the segmented network zone.

Install NOVA Server

add the querypie(app) environment variable in docker-compose.yml as shown below.

add the environment variables to compose-env.

Install NOVA Client

you need to change the settings of novac service in novac-compose.yml like below.

below is a sample command to run a novac container.

Guide to health check API when enabling AWS NLB PPv2

If you want to preserve the origin IP in an inter-VPC communication environment utilizing VPC Endpoint, you can use AWS NLB PPv2.

if you enable NLB PPv2, NLB sends HTTP requests in PPv2 method when calling health check API to TargetGroup. (Reference - https://docs.aws.amazon.com/ko_kr/elasticloadbalancing/latest/network/edit-target-group-attributes.html#health-check-connections)

the existing /readyz health check API on port 80 does not support Proxy Protocol and fails the health check. therefore, we provide an additional /readyz API on port 10080, which can be used as a health check API when PPv2 is enabled.

the health check API of port 10080 is not port bound by default in docker-compose.yml. Modify docker-compose.yml as shown below to enable port binding of port 10080.