Skip to main content
Version: 3.4.0

Glossary

There a few terms to be familiar with when dealing with Hotrod:

Hotrod

A distributed data processing and routing system, it is composed of 3 (software) components:

  • Hotrod Server (Invoked with: hotrod run server)

    The server component and central part of a Hotrod deployment which:

    • Keeps track of one or more agents
    • Keeps track of Pipes
    • Provides user management and authentication
  • Hotrod Agent (Invoked with: hotrod run agent)

    The software component that executes pipes. An agent:

    • Queries Hotrod Server for new, removed, and changed pipes.
    • Uses that information to deploy, remove, or update services on a given agent.
    • Sends logs and metrics data to the Hotrod Server.
  • Hotrod Command Line Interface (CLI)

    A tool to administer Hotrod.

  • Hotrod User Interface (UI)

    The user interface to administer Hotrod.

Pipe

A data processing service that is managed by Hotrod and deployed by a Hotrod Agent. The instructions for how this data is processed is called a pipe definition, which is written using the pipes language contained in a YAML formatted file.

Agent

A substrate on which pipes can be attached (deployed). Agents are logical identifiers created on the Hotrod Server and have a unique name and id property.