modulepackage
0.0.0-20250312193752-f6b7ab29c1c3
Repository: https://github.com/cloudfoundry/bbs.git
Documentation: pkg.go.dev
# README
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.
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Code generated by counterfeiter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
Deprecated: use the ActualLRPInstances API instead.
Deprecated: use the ActualLRPInstances API instead.
Deprecated: use the ActualLRPInstances API instead.
Actual LRPs.
No description provided by the author
Cell Presence.
Actual LRP Lifecycle.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Desire LRP Lifecycle.
Deprecated: use DsiredLRPByProcessGuidRoute_r3 instead.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: use DsiredLRPByProcessGuidRoute_r3 instead.
Desired LRPs.
No description provided by the author
Domains.
No description provided by the author
No description provided by the author
Deprecated: use EvacuateRunningActualLRPRoute_r1 instead.
No description provided by the author
No description provided by the author
Deprecated: use LRPInstanceEventStreamRoute_1 instead.
No description provided by the author
Deprecated: use CancelTaskRotue_r0 instead.
No description provided by the author
No description provided by the author
Event StreamingDeprecated: use LRPInstanceEventStreamRoute_1 instead.
Deprecated: use LrpInstanceEventStreamRoute_r1 instead.
No description provided by the author
Ping.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Evacuation.
No description provided by the author
No description provided by the author
Deprecated: use StartActaulLRPRoute_r1 instead.
No description provided by the author
No description provided by the author
Deprecated: use TaskByGuid_r3 instead.
No description provided by the author
Deprecated: use TaskEventStreamRoute_r1 instead.
No description provided by the author
Deprecated: use TaskRoute_r3 instead.
Tasks.
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
# Interfaces
The External InternalClient can be used to access the BBS's public functionality.
The ExternalActualLRPClient is used to access and retire Actual LRPs
*/.
The ExternalDesiredLRPClient is used to access and manipulate Desired LRPs.
The ExternalDomainClient is used to access and update Diego's domains.
The ExternalEventClient is used to subscribe to groups of Events.
The ExternalTaskClient is used to access Diego's ability to run one-off tasks.
The InternalClient interface exposes all available endpoints of the BBS server,
including private endpoints which should be used exclusively by internal Diego
components.