You are viewing the RapidMiner Server documentation for version 9.0 - Check here for latest version
Job Agents
RapidMiner Job Agent is the consumer endpoint application for the scaled execution of jobs. It starts and manages execution environments, handles their logs and distributes information across these execution instances. Being a CLI application, you can simply download, unpack and start the agent from the command line of your operating system.
Installation
Obtain an Agent
Job Agents are tied to one execution queue (See Administration > Process execution queues) and can be downloaded from the queue configuration page on server by clicking Install. Each agent is pre-configured based on the queue it was downloaded for. For example, if you download an agent from the link provided under DEFAULT queue, that agent will connect to server and fetch jobs from that queue.
Example on how to extract a Job Agent archive:
unzip job-agent-QueueName.zip -d rapidminer-jobagent-9.0.0/
Job Agents are configurated automatically. If you wish to adjust the default configuration, please visit the Job Agent Administration page for more information.
Run
To run the agent, execute the bin/rapidminer-jobagent. This will start the agent by setting:
- the base directory (
baseDir) of the agent to the current root of the distribution package - the configuration directory to
{baseDir}/home/config/ - the agent's persistent storage's directory to
{baseDir}/home/data/ - the extensions directory to
{baseDir}/home/resources/extensions/ - the used Job Container engine to the jar file located in
{baseDir}/lib/container/
Stop Agent
To stop the agent, you can use the stop script bin/stop-job-agent. This script will forcibly shut down all your running
jobs and the agent itself.
Make sure the user who is executing the stop script is allowed to stop the Job Agent process, e.g. stopping the Job Agent of the Windows Service will require admin rights.
To stop the agent-bundled Job Agent go to the job-agent/ folder in the RapidMiner Server base directory and run the bin/stop-job-agent from there.