PlainID Agent

  • Updated on Mar 27, 2024
  • 1 minute(s) read
Prev Next

The PlainID Agent is a service in the PAA that is in charge of connecting the PAA to the Platform and obtaining all the configurations and policies from the cloud to the PAA.

Installation Guide

The requirement settings are to set the following Environment variables.
These settings can be found on the Tenant Settings screen of the Platform.

  • TENANT_ID - Tenant ID (Tenant Settings > Hybrid Agent Keys)
  • CLIENT_SECRET_KEY - Agent Secret key (Tenant Settings > Hybrid Agent Keys)
  • PAA_ID - PAA ID (Tenant Settings > Policy Authorization Agents)
  • REDIS_HOST - Redis host
  • REDIS_PORT - Redis port
  • REDIS_PASS - Redis pass (default is with no password)

Environment Variables

Client

These settings can be found on the Tenant Settings screen of the Platform.

  • TENANT_ID - Tenant ID (Tenant Settings > Customer Hosted Settings)
  • CLIENT_SECRET_KEY - Agent Secret key (Tenant Settings > Customer Hosted Settings)
  • PAA_ID - PAA ID (Tenant Settings > Policy Authorization Agents)

Management

  • REDIS_HOST - Runtime redis host
  • REDIS_PORT - Runtime redis port
  • REDIS_PASS - RunTime redis password (default is redispass)
  • HOSTNAME - Host of the service (default is localhost)
  • REDISYNC_VMARGS - Java Virtual Machine arguments for Redisync

Log Levels And Format

The available log levels are: error, warn, info, trace, and debug

  • LOGGING_ROOT_LEVEL - Root logging level (default is error)
  • LOGGING_SPRING_LEVEL - Spring logging level (default is info)
  • LOGGING_PLAINID_LEVEL - PlainID logging level (default is debug)

Agent Communications

These parameters are used to configure the connection of the PlainID Agent to the PlainID Policy Administration Point.

Configuration Parameter Environment Variable Description
tunnel.serverUrl REMOTE_WARP URL of the remote agent on the PlainID PAP - see table below
tunnel.numberOfConnections NUMBER_OF_CONNECTIONS Number of agent connections to cloud (default is 1)
tunnel.proxyHost PROXY_HOST Proxy host if proxy is used (default is null)
tunnel.proxyPort PROXY_PORT Proxy port if proxy is used (default is 888)

The tunnel.serverUrl should be set according to your PlainID Policy Administration Point Tenant Address, you can use either WSS or HTTPS tunnel:

Tenant Location WSS URL HTTPS URL
United States wss://remote.us1.plainid.io/wstunnel https://remote.us1.plainid.io/httptunnel
Europe wss://remote.eu1.plainid.io/wstunnel https://remote.eu1.plainid.io/httptunnel
Canada wss://remote.ca1.plainid.io/wstunnel https://remote.ca1.plainid.io/httptunnel

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 plaindid-agent.jar