You are viewing the RapidMiner Server documentation for version 9.5 - Check here for latest version

Docker image for Job Agent

The documentation below describes the following Docker image:

Job Agent for RapidMiner Server (rapidminer/rapidminer-execution-jobagent:latest)

For Docker images, see Docker Hub.

Description

This image contains a Job Agent that can be attached to any RapidMiner Server with a matching version number.

Environment variables

The Job Agent Container accepts the following environment variables during startup:

RAPIDMINER_SERVER_HOST: the hostname of RapidMiner Server
RAPIDMINER_SERVER_PORT: the port of RapidMiner Server (default: 8080)
RAPIDMINER_SERVER_PROTOCOL: the protocol (HTTP or HTTPS) used to contact RapidMiner Server
JOBAGENT_QUEUE_ACTIVEMQ_URI: the URI of the Active MQ (usually it is embedded in RapidMiner Server). Example value: failover:(tcp://host.of.the.rapidminer.server:5672)
JOBAGENT_QUEUE_ACTIVEMQ_USERNAME: the Active MQ username
JOBAGENT_QUEUE_ACTIVEMQ_PASSWORD: the Active MQ password
JOBAGENT_AUTH_SECRET: The auth secret used to authenticate to RapidMiner Server (a BASE64 encoded string)
JOBAGENT_CONTAINER_COUNT: The number of Job Containers assigned to the Job Agent
JOBAGENT_CONTAINER_MEMORYLIMIT: The amount of memory provided to the Job Containers
JOB_QUEUE: The name of the queue the Job Agent connects to

Good to know

The RapidMiner Job Agent requires some memory. On Windows hosts, please make sure that the Docker Engine is configured to run with enough memory.

Examples

In the following script, all the terms with <brackets> need to be replaced with values that are defined by you and are unique to your configuration.

Example configuration for docker-compose

The following example docker-compose.yml file can be used with docker-compose:

version: '3'
services:
  job-agent:
    image: rapidminer/rapidminer-execution-jobagent:latest
    environment:
      - RAPIDMINER_SERVER_HOST=<host.of.the.rapidminer.server>
      - RAPIDMINER_SERVER_PORT=8080
      - RAPIDMINER_SERVER_PROTOCOL=http
      - JOBAGENT_QUEUE_ACTIVEMQ_URI=failover:(tcp://<host.of.the.rapidminer.server>:5672)
      - JOBAGENT_QUEUE_ACTIVEMQ_USERNAME=<amq-username>
      - JOBAGENT_QUEUE_ACTIVEMQ_PASSWORD=<amq-password>
      - JOBAGENT_AUTH_SECRET=c29tZS1hdXRoLXNlY3JldAo=
      - JOBAGENT_CONTAINER_COUNT=1
      - JOB_QUEUE=DEFAULT
      - JOBAGENT_CONTAINER_MEMORYLIMIT=4096

Categories

Versions