README.md

BBS

Bulletin Board System (BBS) is the API to access the database for Diego. 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.

Note

This repository should be imported as code.cloudfoundry.org/bbs.

Docs

• BBS API Overview
• The components of a Diego Cell overview
• Cells API
• Overview of Tasks
• Defining Tasks
• Task Examples
• Tasks API
• Tasks Internal API
• Overview of LRPs: Long Running Processes
• Defining LRPs
• LRP Examples
• LRP API Reference
• Actual LRPs Internal API
• BBS DB Schema
• BBS API Versioning Conventions
• BBS Migrations
• Domains
• Container Runtime Environment Variables
• BBS Events
• Actions
• BBS Models

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Diego area.

Important

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.