Skip to content
GitLab
Menu
Why GitLab
Pricing
Contact Sales
Explore
Why GitLab
Pricing
Contact Sales
Explore
Sign in
Get free trial
Primary navigation
Search or go to…
Project
buildgrid
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Privacy statement
Keyboard shortcuts
?
What's new
6
Snippets
Groups
Projects
Show more breadcrumbs
BuildGrid
buildgrid
Commits
1f020b77
Commit
1f020b77
authored
6 years ago
by
Finn
Browse files
Options
Downloads
Patches
Plain Diff
Add an Architecture section with diagrams.
parent
8cbc66eb
No related branches found
No related tags found
No related merge requests found
Pipeline
#34479422
failed
6 years ago
Stage: test
Stage: post
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/source/architecture.rst
+11
-0
11 additions, 0 deletions
docs/source/architecture.rst
docs/source/architecture_overview.rst
+201
-0
201 additions, 0 deletions
docs/source/architecture_overview.rst
docs/source/index.rst
+1
-0
1 addition, 0 deletions
docs/source/index.rst
with
213 additions
and
0 deletions
docs/source/architecture.rst
0 → 100644
+
11
−
0
View file @
1f020b77
.. _architecture:
Architecture
============
This section provides details of the overall BuildGrid architecture.
.. toctree::
:maxdepth: 3
architecture_overview.rst
\ No newline at end of file
This diff is collapsed.
Click to expand it.
docs/source/architecture_overview.rst
0 → 100644
+
201
−
0
View file @
1f020b77
.. _architecture-overview:
Remote execution overview
=========================
Remote execution aims to speed up a build process and to rely on two separate
but related concepts that are remote caching and remote execution itself. Remote
caching allows users to share build outputs while remote execution allows the running
of operations on a remote cluster of machines which may be more powerful than what
the user has access to locally.
The `Remote Execution API`_ (REAPI) describes a `gRPC`_ + `protocol-buffers`_
interface that has three main services for remote caching and execution:
- A ``ContentAddressableStorage`` (CAS) service: a remote storage end-point
where content is addressed by digests, a digest being a pair of the hash and
size of the data stored or retrieved.
- An ``ActionCache`` (AC) service: a mapping between build actions already
performed and their corresponding resulting artifact.
- An ``Execution`` service: the main end-point allowing one to request build
job to be perform against the build farm.
The `Remote Worker API`_ (RWAPI) describes another `gRPC`_ + `protocol-buffers`_
interface that allows a central ``BotsService`` to manage a farm of pluggable workers.
BuildGrid is combining these two interfaces in order to provide a complete
remote caching and execution service. The high level architecture can be
represented like this:
.. graphviz::
:align: center
digraph remote_execution_overview {
node [shape = record,
width=2,
height=1];
ranksep = 2
compound=true
edge[arrowtail="vee"];
edge[arrowhead="vee"];
client [label = "Client",
color="#0342af",
fillcolor="#37c1e8",
style=filled,
shape=box]
subgraph cluster_controller{
label = "Controller";
labeljust = "c";
fillcolor="#42edae";
style=filled;
controller [label = "{ExecutionService|BotsInterface\n}",
fillcolor="#17e86a",
style=filled];
}
subgraph cluster_worker0 {
label = "Worker 1";
labeljust = "c";
color="#8e7747";
fillcolor="#ffda8e";
style=filled;
bot0 [label = "{Bot|Host-tools}"
fillcolor="#ffb214",
style=filled];
}
subgraph cluster_worker1 {
label = "Worker 2";
labeljust = "c";
color="#8e7747";
fillcolor="#ffda8e";
style=filled;
bot1 [label = "{Bot|BuildBox}",
fillcolor="#ffb214",
style=filled];
}
client -> controller [
dir = "both",
headlabel = "REAPI",
labelangle = 20.0,
labeldistance = 9,
labelfontsize = 15.0,
lhead=cluster_controller];
controller -> bot0 [
dir = "both",
labelangle= 340.0,
labeldistance = 7.5,
labelfontsize = 15.0,
taillabel = "RWAPI ",
lhead=cluster_worker0,
ltail=cluster_controller];
controller -> bot1 [
dir = "both",
labelangle= 20.0,
labeldistance = 7.5,
labelfontsize = 15.0,
taillabel = " RWAPI",
lhead=cluster_worker1,
ltail=cluster_controller];
}
BuildGrid can be split up into separate endpoints. It is possible to have
a separate ``ActionCache`` and the ``CAS`` from the ``Controller``. The
following diagram shows a typical setup.
.. graphviz::
:align: center
digraph remote_execution_overview {
node [shape=record,
width=2,
height=1];
// rank=same actioncache controller cas
compound=true
graph [nodesep=1,
ranksep=2]
edge[arrowtail="vee"];
edge[arrowhead="vee"];
client [label="Client",
color="#0342af",
fillcolor="#37c1e8",
style=filled,
shape=box]
cas [label="CAS",
color="#840202",
fillcolor="#c1034c",
style=filled,
shape=box]
subgraph cluster_controller{
label="Controller";
labeljust="c";
fillcolor="#42edae";
style=filled;
controller [label="{ExecutionService|BotsInterface\n}",
fillcolor="#17e86a",
style=filled];
}
actioncache [label="ActionCache",
color="#133f42",
fillcolor="#219399",
style=filled,
shape=box]
subgraph cluster_worker0 {
label="Worker";
labeljust="c";
color="#8e7747";
fillcolor="#ffda8e";
style=filled;
bot0 [label="{Bot}"
fillcolor="#ffb214",
style=filled];
}
client -> controller [
dir="both"];
client -> cas [
dir="both",
lhead=cluster_controller];
controller -> bot0 [
dir="both",
lhead=cluster_worker0];
//ltail=cluster_controller];
cas -> bot0 [
dir="both",
lhead=cluster_worker0];
actioncache -> controller [
dir="both"];
client -> actioncache [
dir="both",
constraint=false,
];
}
.. _Remote Execution API: https://github.com/bazelbuild/remote-apis/blob/master/build/bazel/remote/execution/v2
.. _gRPC: https://grpc.io
.. _protocol-buffers: https://developers.google.com/protocol-buffers
.. _Remote Worker API: https://github.com/googleapis/googleapis/tree/master/google/devtools/remoteworkers/v1test2
This diff is collapsed.
Click to expand it.
docs/source/index.rst
+
1
−
0
View file @
1f020b77
...
...
@@ -19,6 +19,7 @@ Remote execution service implementing Google's REAPI and RWAPI.
using.rst
reference.rst
contributing.rst
architecture.rst
resources.rst
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment