PIP Operator Service
- 11 Feb 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
PIP Operator Service
- Updated on 11 Feb 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
The PIP Operator Service is used for managing, deploying, and mapping data sources.
Installation Guide
- Setup environment variables:
REDIS_HOST
- Redis hostREDIS_PORT
- Redis portREDIS_PASS
- Redis password (default is with no password)
For envrionments like staging and production it is recomended to use an external, managed Redis instance.
Notice: Redis must enable notify-keyspace-events
so either allow configuration changes to redis from the app, or change them yourself manually.
Additional settings can be found under Environmental Variables below.
Environment Variables
Management
SERVER_PORT
- Server PortMANAGEMENT_PORT
- Port for the info and health checksAPP_AUTH_ENABLED
- Enable/disable jwt authentication (default is false)APP_AUTH_JWT
- JWT for authenticationAPP_AUTH_SECRET
- JWT secret keyAPP_AUTH_ISS
- JWT IssuerTRANSACTION_MANAGER_ENABLED
- Enable/disable transaction managerREDIS_HOST
- Redis hostREDIS_PORT
- Redis portREDIS_PASS
- Redis password (default is with no password)REDIS_SSL_ENABLED
- Enable/disable SSL (default is false)REDIS_TIMEOUT_MIL
- Redis connection timeout in milliseconds (default value is 60000)REDIS_POOL_MAX_TOTAL
- This setting controls the max number of connections that can be created at a given time.REDIS_POOL_MAX_IDLE
- This is the max number of connections that can be idle in the pool without being immediately evicted (closed).REDIS_POOL_MIN_IDLE
- This is the number of "warm" connections (e.g. ready for immediate use) that remain in the pool even when load has reducedREDIS_POOL_MIN_EVIC_MI
- This specifies the minimum amount of time a connection may sit idle in the pool before it is eligible for eviction due to idle time.REDIS_POOL_TIME_BETWEEN_EVIC_MIL
- The number of milliseconds to sleep between runs of the idle connection validation, abandoned cleaner and idle pool resizing.REDIS_SETTINGS_KEY_NAME
- The name for the VDB deployed settings key in redis (default is VDBSettings)
VDB
VDB_USERNAME
- Set the username for the jdbc connection (default is pip)VDB_PASSWORD
- Set the username for the jdbc connection (default is pa33word)TRANSPORT_PROTOCOL
- VDB transport protocol (default is teiid)TRANSPORT_BIND_ADDRESS
- Transport bind address (default is 0.0.0.0)
Logging
The available log levels are: error, warn, info, trace, and debug
LOGGING_FORMAT
- Logging format - json or text (default is json)LOGGING_ROOT_LEVEL
- Root logging level (default is error)LOGGING_TOMCAT_LEVEL
- Tomcat logging level (default is error)LOGGING_WEB_LEVEL
- Web logging level (default is error)LOGGING_PLAINID_LEVEL
- PlainID components logging level (default is debug)
Proxy
PROXY_SOCKET_TIMEOUT
- How long should the proxy socket remain open after initial handshake (default is 2 hours)PROXY_SOCKET_BUFFER_SIZE
- Buffer size of the proxy input stream (default is 8192 bytes)PROXY_SERVER_PORT
- Which port the Tiied proxy server should listen to (default is 31350)
Agent
AGENT_URL
- URL of the agent on the client side (default is http://localhost:8761)
Health-check
URL
http://<host>:<port>/actuator/health
OK Response
{
"status": "UP"
}
Java
The PlainID Agent runs with Java 17 and above.
Command Line
java -jar pip-operator-1.0.jar
Was this article helpful?