PIP Operator Service

The PIP Operator Service manages, deploys, and maps data sources within the PlainID environment. It supports integration with multiple Data Sources, JDBC drivers, and logging/monitoring APIs while maintaining runtime stability across Kubernetes or standalone deployments.

This guide provides a complete reference for installation, environment configuration, health checks, JDBC integration, Docker customization, and logging.

Configuration

Before starting, configure the required Environment Variables. The following table lists the minimum required Redis-related settings for running the PIP Operator Service:

For staging or production environments, use a managed Redis instance.

Notice: Redis must enable notify-keyspace-events. Either allow the application to modify Redis configuration or configure it manually.

Environment Variables

The following environment variables are required to manage and configure the PIP Operator Service. They are grouped by functionality for clarity.

Management

These variables control server ports, authentication, transaction management, and Redis connections:

VDB

These variables configure the Virtual Database (VDB) connection, protocol, and bind address:

Logging

Use these variables to define log levels and formats for different components of the PIP Operator Service:

Proxy

These settings control the proxy server behavior:

Agent

Variables used by the client-side PAA Agent:

Health-check

URL

http://<host>:<port>/actuator/health

OK Response

{
  "status": "UP"
}

Java

The PlainID Agent runs with Java 21 and above.

Command Line

java -jar pip-operator-1.0.jar

PIP Operator Service Health Check

The PIP Operator Service GET request retrieves the PAA's PIP Operator health status.

K8:

Standalone:

Authorization

• None

Header

• None

Standalone Parameters

Service Response:

{
  "status": "UP",
  "components": {
    "diskSpace": {
      "status": "UP",
      "details": {
        "total": 101203873792,
        "free": 92163268608,
        "threshold": 10485760,
        "exists": true
      }
    },
    "livenessState": {
      "status": "UP"
    },
    "ping": {
      "status": "UP"
    },
    "readinessState": {
      "status": "UP"
    },
    "vdbSettingsState": {
      "status": "UP"
    }
  },
  "groups": [
    "liveness",
    "readiness"
  ]
}

Preloading JDBC Drivers

In some scenarios, you may need to integrate with external data sources that require JDBC drivers not included by default. This section explains how to load third-party drivers into the pip-operator by modifying the container's startup command.

Modifying pipOperator Start Command

To pre-load JDBC drivers:

pipOperator:
  command: [
    - /bin/sh
    - -ec
    - |
      curl -o /app/lib/sample.driver.one.jar https://www.provider-one.com/sample.driver.one.jar && \
      curl -o /app/lib/sample.driver.two.jar https://www.provider-two.com/sample.driver.two.jar && \
      java ${JVM_OPTS} -cp $JAR_NAME -Djava.net.preferIPv4Stack=true -Dloader.path=/app/lib/ -Dloader.main=com.plainid.pipoperator.Starter org.springframework.boot.loader.launch.PropertiesLauncher]

The java command must be last, or the pip-operator will fail to start.

Using a Custom Dockerfile

You can extend the default plainid/pip-operator image to include additional libraries or third-party drivers required for your deployment.

FROM plainid/pip-operator:5.0.16
ADD third-party-driver.jar /app/lib/

Build the new image:

docker build -t plainid/pip-operator:5.0.16-custom-drivers .

Run the container to verify:

docker run -it plainid/pip-operator:5.0.16-custom-drivers ls /app/lib

Expected output:

pip-auth-extensions-1.1.0.jar  third-party-driver.jar

Use this image in your deployment configuration (values-custom.yaml) to ensure drivers are available at runtime.

PIP Operator Logging API

The PIP Operator Logger API lets you retrieve and update log levels for deployed PIP Operator services.

Logging Configuration

Temporary changes made with the API are reset on service restart. For persistent changes, configure log levels through Helm or Standalone settings:

• Helm: .Values.pipOperator.logLevel
• Standalone: PIP Operator Environment Variables

Authentication

These APIs require JWT authentication with Tenant Admin permissions.

PAA Logger Endpoints

Retrieve loggers

GET https://api.{region}.plainid.io/pip-mgmt/1.0/monitor/loggers/pip-operator/{PAA_ID}
GET https://api.{region}.plainid.io/pip-mgmt/1.0/monitor/loggers/pip-operator/{PAA_ID}/{LOGGER_NAME}

• Replace {region} with us1, ca1, or eu1
• {PAA_ID}: found in Policy Authorization Agent details
• {LOGGER_NAME}: optional, retrieves one specific logger

Append ?configured=false to include all loggers, not just configured ones.

Example GET response (PIP Operator):

{
  "data": {
    "levels": ["OFF","TRACE","DEBUG","INFO","WARN","ERROR"],
    "loggers": {
      "org.teiid.RUNTIME": {
        "configuredLevel": "INFO",
        "effectiveLevel": "INFO"
      },
      "root": {
        "configuredLevel": "INFO",
        "effectiveLevel": "INFO"
      }
    }
  }
}

Response Fields

Modify log levels

POST https://api.{region}.plainid.io/pip-mgmt/1.0/monitor/loggers/pip-operator/{PAA_ID}/{LOGGER_NAME}

Example Request

{
  "configuredLevel": "TRACE"
}

Example Response

{
  "data": {
    "configuredLevel": "TRACE",
    "effectiveLevel": "TRACE"
  }
}