README.md

Diego BBS API Docs

Diego's Bulletin Board System (BBS) is the central data store and orchestrator of a Diego cluster. It communicates via protocol-buffer-encoded RPC-style calls over HTTP.

Diego clients communicate with the BBS via an ExternalClient interface. This interface allows clients to create, read, update, delete, and subscribe to events about Tasks and LRPs.

Table of Contents

• API Overview
• Overview of Domains
• Overview of Tasks
  • Defining Tasks
  • Task Examples
• Overview of Long Running Processes (LRPs)
  • Defining LRPs
  • LRP Examples
• Overview of Cells
• Actions
• The Container Runtime Environment
• External API Reference
  • Tasks
  • LRPs
  • Cells
  • Events
  • Domains
• Internal API Reference
  • Tasks
  • LRPs
• Fields common to Tasks and LRPs