RunWhen Platform Documentation

RunWhen's Engineering Assistants suggest and run automated troubleshooting tasks written by (paid) experts for root cause analysis and remediation. Engineering Assistants replace the need for runbooks, and can autonomously respond to existing alerts, tickets and help requests from your dev teams.

The documentation is aligned with the three major parts of the RunWhen Architecture has three moving parts:

1. RunWhen Platform - The services that make up the RunWhen UI and back-end APIs. This is typically SaaS though a self-hosted is available.

2. RunWhen Local - An agent that assists in both initial set-up and then subsequently runs tasks when instructed by the platform. This is an open source project typically self-hosted in your own Kubernetes cluster, though a laptop version and a SaaS version is available to get started.

3. RunWhen Author Tools - The tools used by the expert community automating tasks for the Platform. These is built on Github codespaces and a RunWhen-hosted CI/CD pipeline.

As a mental model, the RunWhen Platform is the "brain" of the Engineering Assistants where inputs are received and decisions about what to do next are made. RunWhen Local is the "laptop" of the Engineering Assistant where tasks are run. The author's task libraries are the "capabilities" of the Engineering Assistants.