Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(653)

Unified Diff: logdog/appengine/cmd/coordinator/README.md

Issue 2183233002: Add LogDog project and component documentation. (Closed) Base URL: https://github.com/luci/luci-go@master
Patch Set: Created 4 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « logdog/appengine/README.md ('k') | logdog/client/README.md » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: logdog/appengine/cmd/coordinator/README.md
diff --git a/logdog/appengine/cmd/coordinator/README.md b/logdog/appengine/cmd/coordinator/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..c4489ead400f6a43b3071eb4831b6255bacfade8
--- /dev/null
+++ b/logdog/appengine/cmd/coordinator/README.md
@@ -0,0 +1,48 @@
+LogDog Coordinator
+==================
+
+The LogDog Coordinator is an AppEngine application that serves as a central
+coordinating and interactive authority for a LogDog instance. The Coordinator
+is responsible for:
+
+* Supplying logs to end users through its logs API.
+* Coordinating log stream state throughout its lifecycle.
+* Handling Butler Prefix registration.
+* Acting as a configuration authority for its deployment.
+* Accepting stream registrations from **Collector** instances.
+* Dispatching archival tasks to **Archivist** instances.
+
+## Modules
+
+A **Coordinator** occupies the AppEngine space of a given cloud project, and
+assumes ownership of that project's resources. It is composed of several
+cooperative AppEngine modules.
+
+### Default
+
+The [default](vmuser/) module exposes the
+[Logs API](../../../api/endpoints/coordinator/logs/v1/) for log stream querying
+and consumption.
+
+It is currently an AppEngine Managed VM, since Managed VMs are the only type of
+AppEngine instance that can use gRPC, and gRPC is needed to read from BigTable.
+
+### Services
+
+The [services](services/) module exposes management endpoints to the instance's
+microservices, notably the [Collector](../../../server/cmd/logdog_collector) and
+[Archivist](../../../server/cmd/logdog_archivist) microservices. These endpoints
+are used to coordinate the microservice-managed aspects of the log stream
+lifecycle.
+
+### Backend
+
+The [backend](backend/) module hosts the [Tumble](/tumble) journaled processing
+service, which handles log stream lifecycle transitions and deadlines.
+
+### Static
+
+The [static](static/) module hosts static content, including:
+* The LogDog Web Application
+* The LogDog Lightweight Stream Viewer
+* `rpcexplorer`
« no previous file with comments | « logdog/appengine/README.md ('k') | logdog/client/README.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698