| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Architecture — BuildStream 2.2.0+3.gc7274d41d documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" /> |
| |
| |
| <!--[if lt IE 9]> |
| <script src="_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=f96d84dc"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Overview of modules" href="arch_overview.html" /> |
| <link rel="prev" title="Contributing to the UI" href="hacking/ui.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> |
| BuildStream |
| </a> |
| <div class="version"> |
| 2.2.0+3.gc7274d41d |
| </div> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="main_about.html">About</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="main_install.html">Installing from Source</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="main_using.html">Using</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="main_core.html">Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="main_porting.html">Porting guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING.html">Contributing</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Architecture</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="arch_overview.html">Overview of modules</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_program_flow.html">Overview of program flow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_data_model.html">Data model</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_dependency_model.html">Dependency model</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_scheduler.html">Scheduler</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_cachekeys.html">Cache keys</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_caches.html">Caches</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_sandboxing.html">Sandboxing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_remote_execution.html">Remote execution</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="main_glossary.html">Glossary</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">BuildStream</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item active">Architecture</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/main_architecture.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="architecture"> |
| <h1>Architecture<a class="headerlink" href="#architecture" title="Link to this heading"></a></h1> |
| <p>This section provides details on the overall BuildStream architecture.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="arch_overview.html">Overview of modules</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="arch_program_flow.html">Overview of program flow</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="arch_data_model.html">Data model</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="arch_data_model.html#project">Project</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_data_model.html#element">Element</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_data_model.html#source">Source</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_data_model.html#context">Context</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_data_model.html#workspaces">Workspaces</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="arch_dependency_model.html">Dependency model</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="arch_dependency_model.html#scope">Scope</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="arch_scheduler.html">Scheduler</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="arch_scheduler.html#jobs">Jobs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_scheduler.html#resources">Resources</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_scheduler.html#queues">Queues</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_scheduler.html#queue-internals">Queue internals</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_scheduler.html#id1">Scheduler</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="arch_cachekeys.html">Cache keys</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="arch_cachekeys.html#structure">Structure</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_cachekeys.html#cache-key-types">Cache key types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_cachekeys.html#strict-build-plan">Strict build plan</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_cachekeys.html#non-strict-build-plan">Non-strict build plan</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="arch_caches.html">Caches</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="arch_caches.html#content-addressable-storage-cas">Content Addressable Storage (CAS)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_caches.html#artifact-caches">Artifact caches</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_caches.html#source-caches">Source caches</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="arch_sandboxing.html">Sandboxing</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="arch_sandboxing.html#introduction">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_sandboxing.html#what-elements-can-and-can-t-do-in-the-sandbox">What elements can and can’t do in the sandbox</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_sandboxing.html#platform-notes">Platform notes</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="arch_remote_execution.html">Remote execution</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="arch_remote_execution.html#sandbox-extension">Sandbox extension</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_remote_execution.html#artifact-caches-and-other-storage">Artifact caches and other storage</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="arch_remote_execution.html#use-of-sandboxes-outside-builds">Use of sandboxes outside builds</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="hacking/ui.html" class="btn btn-neutral float-left" title="Contributing to the UI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="arch_overview.html" class="btn btn-neutral float-right" title="Overview of modules" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2017-2022, The Apache Software Foundation.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
