> For the complete documentation index, see [llms.txt](https://docs.rierino.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rierino.com/devops/microservices/service-runners/defining-a-runner.md).

# Defining a Runner

<figure><img src="/files/drmkO1wm5ydBVvd1zb3R" alt=""><figcaption><p>Runner Definition</p></figcaption></figure>

Clicking on the edit icon displays runner definition form, which has the first tab with the following data fields:

* **Name:** Descriptive name for the runner, which will be used as the label on runner screen and listings.
* **Status\*:** Whether the runner is currently active or not.
* **Domain:** Used for grouping runners within logical business domains (e.g. admin, cms).
* **Base Runners:** List of runners this runner should inherit elements and settings from. This configuration allows reuse of predefined lists of runner elements for functionalities shared among different runners (such as receiving commands, running queries), instead of copying same list of elements to each individually. Typically used base runners include:
  * Samza Base: Includes global configurations for all Samza runners
  * Spring Base: Includes global configurations for all Spring runners
  * Query Base: Includes state configurations for all runners with query handlers
  * Variable Base: Includes state configurations for all runners using variables (e.g. query and saga handlers)
  * Saga Base: Includes state configurations for all runners with saga handlers
  * Command Base: Includes stream configurations for all runners which should be listening to commands (i.e. effectively all runners)
* **Description:** Verbal description of the runner, used for referential purposes and documentation.

{% file src="/files/YmDM1DD5wC5D8TLq4soo" %}
Example Runner Definition (Can be Imported on Runner Screen)
{% endfile %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.rierino.com/devops/microservices/service-runners/defining-a-runner.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.