Host agent configuration reference

The host agent reads its configuration from /etc/edb/acp-host-agent/acp-host-agent.conf. Set variables using KEY=value syntax, one per line. Lines beginning with # are comments. See Installing the host agent for setup instructions.

# =============================================================================
# WEM Connection (REQUIRED)
# =============================================================================
# host:port of WEM's relay to its internal job-execution engine. This address
# is WEM's listen port plus 1 (for example, WEM on 8080 -> wem-host:8081).
WEM_CONNECT_ADDRESS=localhost:8081

# Task queue(s) this agent polls for activities (optional).
# Leave unset to self-register with WEM instead, which derives a queue
# automatically from the cluster's segment configuration. Comma-separate
# multiple queues if you do set this manually. Supported queue names:
#   coordinator-tasks       - WHPG coordinator-node operations
#   standby-tasks           - WHPG standby-node operations
#   dr-standby-tasks        - WHPG DR-standby operations (always manual, see below)
#   segment-<N>-<p|m>-tasks - a specific segment's operations, for example
#                             segment-3-p-tasks (always manual, see below)
# WEM_TASK_QUEUES=

# =============================================================================
# Agent Identity (optional)
# =============================================================================
# Stable per-host identifier sent as this agent's worker identity.
# Leave unset to auto-derive from the DMI product UUID or NIC MAC address.
# AGENT_ID=

# Directory where the agent's enrollment keypair is stored. Must be writable
# by the acp-host-agent OS user.
# AGENT_STATE_DIR=/var/lib/edb/acp-host-agent

# =============================================================================
# WEM Database (optional)
# =============================================================================
# WHPG database the agent's psql invocations connect to for WEM data.
# WEM_DATABASE=wem

# =============================================================================
# WarehousePG Hub (optional)
# =============================================================================
# WarehousePG data directory (for example, /data/whpg/gpseg-1). If unset,
# the agent derives it by querying the local cluster itself
# (psql -U gpadmin -d postgres -c "SHOW data_directory;"). Set this variable
# explicitly only if that derivation is unreliable in your environment.
# WHPG_DATA_DIR=

# Path to the WarehousePG installation (for example, /usr/local/greenplum-db).
# Required for this agent to handle Cluster Management actions (start, stop,
# restart, and gprecoverseg). Leave unset on hosts that don't need these
# actions dispatched through the host agent.
# GPHOME=

# =============================================================================
# Logging
# =============================================================================
# Log level: error|warn|info|debug|trace, or per-target directives.
AGENT_LOG_LEVEL=info

WEM connection

VariableRequiredDefaultDescription
WEM_CONNECT_ADDRESSYeslocalhost:8081Host:port of WEM's relay to its internal job-execution engine. Set this parameter to WEM's listen port plus 1. The shipped default assumes the host agent runs on the same host as WEM. If it doesn't, set this parameter to WEM's hostname or IP address, for example WEM_CONNECT_ADDRESS=wem-host:8081.
WEM_TASK_QUEUESNo—Task queue or queues this agent polls for activities. Comma-separate multiple queues. Leave unset to self-register with WEM instead, which derives a queue automatically for the coordinator (coordinator-tasks), the standby coordinator (standby-tasks), and each segment host (segment-<content>-<p|m>-tasks, for example segment-3-p-tasks), based on the cluster's segment configuration. Set this manually only for a DR standby coordinator (dr-standby-tasks), since WEM can't introspect a DR cluster's segment configuration to derive this automatically. If a host isn't found in the segment configuration and no queue is set, registration fails until you set this variable explicitly.

WEM database

VariableRequiredDefaultDescription
WEM_DATABASENowemWHPG database the agent's psql invocations connect to for WEM data, such as log-scan results. Set this to the same value as WHPG_DATABASE. The agent's passwordless sudo permissions are scoped to that exact database name, so changing this parameter causes privileged operations to fail with sudo: a password is required. WEM creates this database automatically if it doesn't already exist.

WarehousePG Hub

VariableRequiredDefaultDescription
WHPG_DATA_DIRNoDerived from the local clusterWarehousePG data directory, for example /data/whpg/gpseg-1. WEM derives this value by running psql -U gpadmin -d postgres -c "SHOW data_directory;" against the local cluster. Set this parameter explicitly only if that derivation is unreliable in your environment.

Agent identity

By default, the host agent derives its unique identifier from the host's DMI product UUID or NIC MAC address. Set AGENT_ID only if the default derivation produces inconsistent results across restarts.

On first start, the agent also generates a join token at /etc/edb/acp-host-agent/join-token. An admin approving a new agent in the Host Agents tab can compare this value against what WEM shows for the pending registration. If WEM_AGENT_JOIN_SECRET is pre-provisioned to match this file's contents, the agent skips manual approval entirely.

VariableDefaultDescription
AGENT_IDDerived from DMI product UUID or NIC MAC addressStable per-host identifier sent as this agent's worker identity. Override only if the default derivation produces inconsistent results.
AGENT_STATE_DIR/var/lib/edb/acp-host-agentDirectory where the agent's enrollment keypair is stored. Must be writable by the acp-host-agent OS user.

Logging

Control the verbosity of host agent logs. Use debug or trace for troubleshooting, and error or warn in production to reduce noise.

VariableDefaultDescription
AGENT_LOG_LEVELinfoLog level filter. Valid values: error, warn, info, debug, trace.

Could this page be better? Report a problem or suggest an addition!