| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="generator" content="Docusaurus v2.0.0-alpha.70"> |
| <link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache Submarine Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache Submarine Blog Atom Feed"><title data-react-helmet="true">Submarine Server Implementation | Apache Submarine</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Submarine Server Implementation | Apache Submarine"><meta data-react-helmet="true" name="description" content="<!--"><meta data-react-helmet="true" property="og:description" content="<!--"><meta data-react-helmet="true" property="og:url" content="https://submarine.apache.org//docs/designDocs/submarine-server/architecture"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://submarine.apache.org//docs/designDocs/submarine-server/architecture"><link rel="stylesheet" href="/styles.058db332.css"> |
| <link rel="preload" href="/styles.d28ad9a6.js" as="script"> |
| <link rel="preload" href="/runtime~main.5ca17d9d.js" as="script"> |
| <link rel="preload" href="/main.4fdf81d8.js" as="script"> |
| <link rel="preload" href="/1.ecdfe063.js" as="script"> |
| <link rel="preload" href="/2.ff74b3cd.js" as="script"> |
| <link rel="preload" href="/1be78505.ae15da12.js" as="script"> |
| <link rel="preload" href="/c4f5d8e4.93f03c17.js" as="script"> |
| <link rel="preload" href="/79.c30128b5.js" as="script"> |
| <link rel="preload" href="/78.25baa806.js" as="script"> |
| <link rel="preload" href="/935f2afb.4fd644c9.js" as="script"> |
| <link rel="preload" href="/17896441.bdc3ce75.js" as="script"> |
| <link rel="preload" href="/ada24b13.dd878683.js" as="script"> |
| </head> |
| <body> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <nav aria-label="Skip navigation links"><button type="button" tabindex="0" class="skipToContent_11B0">Skip to main content</button></nav><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg aria-label="Menu" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/"><img src="https://github.com/apache/submarine/blob/master/website/docs/assets/128-black.png?raw=true" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="https://github.com/apache/submarine/blob/master/website/docs/assets/128-black.png?raw=true" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--dark_3ARp navbar__logo"><strong class="navbar__title">Apache Submarine</strong></a><a class="navbar__item navbar__link navbar__link--active" href="/docs/">Docs</a><a class="navbar__item navbar__link" href="/docs/api/environment">API</a><a class="navbar__item navbar__link" href="/docs/download">Download</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/apache/submarine" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__item navbar__link">Apache</a><ul class="dropdown__menu"><li><a href="http://www.apache.org/foundation/how-it-works.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache Software Foundation</a></li><li><a href="http://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache License</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_2N3Q"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_3NWk">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_3NWk">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Search" aria-label="Search" class="navbar__search-input search-bar"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="https://github.com/apache/submarine/blob/master/website/docs/assets/128-black.png?raw=true" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="https://github.com/apache/submarine/blob/master/website/docs/assets/128-black.png?raw=true" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--dark_3ARp navbar__logo"><strong class="navbar__title">Apache Submarine</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link navbar__link--active" href="/docs/">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/api/environment">API</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/download">Download</a></li><li class="menu__list-item"><a href="https://github.com/apache/submarine" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li><li class="menu__list-item menu__list-item--collapsed"><a role="button" class="menu__link menu__link--sublist">Apache</a><ul class="menu__list"><li class="menu__list-item"><a href="http://www.apache.org/foundation/how-it-works.html" target="_blank" rel="noopener noreferrer" class="menu__link">Apache Software Foundation</a></li><li class="menu__list-item"><a href="http://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="menu__link">Apache License</a></li><li class="menu__list-item"><a href="http://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="menu__link">Sponsorship</a></li><li class="menu__list-item"><a href="http://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="menu__link">Thanks</a></li></ul></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_vMrn"><div class="docSidebarContainer_3Ak5" role="complementary"><div class="sidebar_3gvy"><div class="menu menu--responsive thin-scrollbar menu_1yIk"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_1CUI" width="24" height="24" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Getting Started</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/">Submarine Local Deployment</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/gettingStarted/kind">Setup a Kubernetes cluster using KinD</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/gettingStarted/notebook">Notebook Tutorial</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/gettingStarted/python-sdk">Submarine Python SDK</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">User Docs</a><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">API documentation</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/api/experiment">Experiment REST API</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/api/environment">Environment REST API</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/api/experiment-template">Experiment Template REST API</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/api/notebook">Notebook REST API</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">Submarine SDK</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/submarine-sdk/experiment-client">Experiment Client</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/submarine-sdk/model-client">Model Client</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/submarine-sdk/tracking">Tracking</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">Submarine Security</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/submarine-security/spark-security/README">Submarine Spark Security Plugin</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/submarine-security/spark-security/build-submarine-spark-security-plugin">Building Submarine Spark Security Plugin</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">Others</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/others/mlflow">MLflow UI</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/others/tensorboard">Tensorboard</a></li></ul></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Administrator Docs</a><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">Submarine on Yarn</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/adminDocs/yarn/README">Running Submarine on YARN</a></li></ul></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Developer Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/README">Project Architecture</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/Dependencies">Dependencies for Submarine</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/BuildFromCode">How to Build Submarine</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/Development">Development Guide</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/IntegrationTestK8s">How to Run Integration K8s Test</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/IntegrationTestE2E">How to Run Frontend Integration Test</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Community</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/community/README">Apache Submarine Community</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/community/HowToCommit">Guide for Apache Submarine Committers</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/community/contributing">How To Contribute to Submarine</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">Design Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/designDocs/architecture-and-requirements">Architecture and Requirment</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/designDocs/implementation-notes">Implementation Notes</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/designDocs/environments-implementation">Environments Implementation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/designDocs/experiment-implementation">Experiment Implementation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/designDocs/notebook-implementation">Notebook Implementation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/designDocs/storage-implementation">Storage Implementation</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!" tabindex="0">Submarine Server</a><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/designDocs/submarine-server/architecture">Submarine Server Implementation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/designDocs/submarine-server/experimentSpec">Generic Expeiment Spec</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="0">WIP Design Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/wip-designs/submarine-launcher">Submarine Launcher</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/wip-designs/submarine-clusterServer">Cluster Server Design - High-Availability</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/wip-designs/security-implementation">Security Implementation</a></li></ul></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Releases</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/releases/submarine-release-0.2.0">Apache Submarine Release 0.2.0</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/releases/submarine-release-0.3.0">Apache Submarine Release 0.3.0</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/releases/submarine-release-0.4.0">Apache Submarine Release 0.4.0</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/releases/submarine-release-0.5.0">Apache Submarine Release 0.5.0</a></li></ul></li></ul></div></div></div><main class="docMainContainer_2iGs"><div class="container padding-vert--lg docItemWrapper_1bxp"><div class="row"><div class="col docItemCol_U38p"><div class="docItemContainer_a7m4"><article><header><h1 class="docTitle_Oumm">Submarine Server Implementation</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="architecture-overview"></a>Architecture Overview<a class="hash-link" href="#architecture-overview" title="Direct link to heading">#</a></h2><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +---------------Submarine Server ---+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | +------------+ +------------+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | |Web Svc/Prxy| |Backend Svc | | +--Submarine Asset +</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | +------------+ +------------+ | |Project/Notebook |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | ^ ^ | |Model/Metrics |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +---|---------|---------------------+ |Libraries/Dataset |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | | +------------------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | +--|-Compute Cluster 1---+ +--Image Registry--+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> + | | | | User's Images |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> User / | + | | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> Admin | User Notebook Instance | +------------------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | Experiment Runs |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +------------------------+ +-Data Storage-----+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | S3/HDFS, etc. |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +----Compute Cluster 2---+ | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +------------------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> ...</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><p>Here's a diagram to illustrate the Submarine's deployment.</p><ul><li>Submarine Server consists of web service/proxy, and backend services. They're like "control planes" of Submarine, and users will interact with these services.</li><li>Submarine server could be a microservice architecture and can be deployed to one of the compute clusters. (see below, this will be useful when we only have one cluster). </li><li>There're multiple compute clusters that could be used by Submarine service. For user's running notebook instance, jobs, etc. they will be placed to one of the compute clusters by user's preference or defined policies.</li><li>Submarine's asset includes project/notebook(content)/models/metrics/dataset-meta, etc. can be stored inside Submarine's own database.</li><li>Datasets can be stored in various locations such as S3/HDFS. </li><li>Users can push container (such as Docker) images to a preconfigured registry in Submarine, so Submarine service can know how to pull required container images.</li><li>Image Registry/Data-Storage, etc. are outside of Submarine server's scope and should be managed by 3rd party applications.</li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="submarine-server-and-its-apis"></a>Submarine Server and its APIs<a class="hash-link" href="#submarine-server-and-its-apis" title="Direct link to heading">#</a></h2><p>Submarine server is designed to allow data scientists to access notebooks, submit/manage jobs, manage models, create model training workflows, access datasets, etc.</p><p>Submarine Server exposed UI and REST API. Users can also use CLI / SDK to manage assets inside Submarine Server.</p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +----------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | CLI |+---+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +----------+ v +----------------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +--------------+ | Submarine |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +----------+ | REST API | | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | SDK |+>| |+> Server |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +----------+ +--------------+ | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> ^ +----------------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +----------+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | UI |+---+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +----------+</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><p>REST API will be used by the other 3 approaches. (CLI/SDK/UI) </p><p>The REST API Service handles HTTP requests and is responsible for authentication. It acts as the caller for the JobManager component.</p><p>The REST component defines the generic job spec which describes the detailed info about job. For more details, refer to <a href="https://docs.google.com/document/d/1kd-5UzsHft6gV7EuZiPXeWIKJtPqVwkNlqMvy0P_pAw/edit#" target="_blank" rel="noopener noreferrer">here</a>. (Please note that we're converting REST endpoint description from Java-based REST API to swagger definition, once that is done, we should replace the link with swagger definition spec).</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="proposal"></a>Proposal<a class="hash-link" href="#proposal" title="Direct link to heading">#</a></h2><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +---------------------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+ | +--------+ +----+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">| | | |runtime1+-->+job1| |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">| workbench +---+ +----------------------------------+ | +--------+ +----+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">| | | | +------+ +---------------------+ | +-->+ +--------+ +----+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+ | | | | | +------+ +-------+ | | | | |runtime2+-->+job2| |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | | | | | | YARN | | K8s | | | | | +--------+ +----+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+ | | | | | +------+ +-------+ | | | | YARN Cluster |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">| | | | | | | submitter | | | +---------------------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">| CLI +------>+ | REST | +---------------------+ +---+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">| | | | | | +---------------------+ | | +---------------------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+ | | | | | +-------+ +-------+ | | | | +--------+ +----+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | | | | | |PlugMgr| |monitor| | | | | | +-->+job1| |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+ | | | | | +-------+ +-------+ | | | | | | +----+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">| | | | | | | JobManager | | +-->+ |operator| +----+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">| SDK +---+ | +------+ +---------------------+ | | | +-->+job2| |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">| | +----------------------------------+ | +--------+ +----+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+ | K8s Cluster |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> client server +---------------------+</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><p>We propose to split the original core module in the old layout into two modules, CLI and server as shown in FIG. The submarine-client calls the REST APIs to submit and retrieve the job info. The submarine-server provides the REST service, job management, submitting the job to cluster, and running job in different clusters through the corresponding runtime.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="submarine-server-components"></a>Submarine Server Components<a class="hash-link" href="#submarine-server-components" title="Direct link to heading">#</a></h2><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"> |
| </span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +----------------------Submarine Server--------------------------------+</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | +-----------------+ +------------------+ +--------------------+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | | Experiment | |Notebook Session | |Environment Mgr | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | | Mgr | |Mgr | | | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | +-----------------+ +------------------+ +--------------------+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | +-----------------+ +------------------+ +--------------------+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | | Model Registry | |Model Serving Mgr | |Compute Cluster Mgr | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | | | | | | | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | +-----------------+ +------------------+ +--------------------+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | +-----------------+ +------------------+ +--------------------+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | | DataSet Mgr | |User/Team | |Metadata Mgr | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | | | |Permission Mgr | | | |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> | +-----------------+ +------------------+ +--------------------+ |</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> +----------------------------------------------------------------------+</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="experiment-manager"></a>Experiment Manager<a class="hash-link" href="#experiment-manager" title="Direct link to heading">#</a></h3><p>TODO</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="notebook-sessions-manager"></a>Notebook Sessions Manager<a class="hash-link" href="#notebook-sessions-manager" title="Direct link to heading">#</a></h3><p>TODO</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="environment-manager"></a>Environment Manager<a class="hash-link" href="#environment-manager" title="Direct link to heading">#</a></h3><p>TODO</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="model-registry"></a>Model Registry<a class="hash-link" href="#model-registry" title="Direct link to heading">#</a></h3><p>TODO</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="model-serving-manager"></a>Model Serving Manager<a class="hash-link" href="#model-serving-manager" title="Direct link to heading">#</a></h3><p>TODO</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="compute-cluster-manager"></a>Compute Cluster Manager<a class="hash-link" href="#compute-cluster-manager" title="Direct link to heading">#</a></h3><p>TODO</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="dataset-manager"></a>Dataset Manager<a class="hash-link" href="#dataset-manager" title="Direct link to heading">#</a></h3><p>TODO</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="userteam-permissions-manager"></a>User/team permissions manager<a class="hash-link" href="#userteam-permissions-manager" title="Direct link to heading">#</a></h3><p>TODO</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="metadata-manager"></a>Metadata Manager<a class="hash-link" href="#metadata-manager" title="Direct link to heading">#</a></h3><p>TODO</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="componentsservices-outside-of-submarine-servers-scope"></a>Components/services outside of Submarine Server's scope<a class="hash-link" href="#componentsservices-outside-of-submarine-servers-scope" title="Direct link to heading">#</a></h2><p>TODO: Describe what are the out-of-scope components, which should be handled and managed outside of Submarine server. Candidates are: Identity management, data storage, metastore storage, etc.</p></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/apache/submarine/edit/master/website/docs/designDocs/submarine-server/architecture.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" role="img" viewBox="0 0 40 40" class="iconEdit_2LL7"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav" aria-label="Blog list page navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/designDocs/storage-implementation"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Storage Implementation</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/designDocs/submarine-server/experimentSpec"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Generic Expeiment Spec »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_2xL- thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#architecture-overview" class="table-of-contents__link">Architecture Overview</a></li><li><a href="#submarine-server-and-its-apis" class="table-of-contents__link">Submarine Server and its APIs</a></li><li><a href="#proposal" class="table-of-contents__link">Proposal</a></li><li><a href="#submarine-server-components" class="table-of-contents__link">Submarine Server Components</a><ul><li><a href="#experiment-manager" class="table-of-contents__link">Experiment Manager</a></li><li><a href="#notebook-sessions-manager" class="table-of-contents__link">Notebook Sessions Manager</a></li><li><a href="#environment-manager" class="table-of-contents__link">Environment Manager</a></li><li><a href="#model-registry" class="table-of-contents__link">Model Registry</a></li><li><a href="#model-serving-manager" class="table-of-contents__link">Model Serving Manager</a></li><li><a href="#compute-cluster-manager" class="table-of-contents__link">Compute Cluster Manager</a></li><li><a href="#dataset-manager" class="table-of-contents__link">Dataset Manager</a></li><li><a href="#userteam-permissions-manager" class="table-of-contents__link">User/team permissions manager</a></li><li><a href="#metadata-manager" class="table-of-contents__link">Metadata Manager</a></li></ul></li><li><a href="#componentsservices-outside-of-submarine-servers-scope" class="table-of-contents__link">Components/services outside of Submarine Server's scope</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/api/environment">API docs</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/apache-submarine" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow</a></li><li class="footer__item"><a href="https://s.apache.org/slack-invite" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a href="https://medium.com/@apache.submarine" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog</a></li><li class="footer__item"><a href="https://github.com/apache/submarine" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2021 Apache Submarine is Apache2 Licensed software.</div></div></div></footer></div> |
| <script src="/styles.d28ad9a6.js"></script> |
| <script src="/runtime~main.5ca17d9d.js"></script> |
| <script src="/main.4fdf81d8.js"></script> |
| <script src="/1.ecdfe063.js"></script> |
| <script src="/2.ff74b3cd.js"></script> |
| <script src="/1be78505.ae15da12.js"></script> |
| <script src="/c4f5d8e4.93f03c17.js"></script> |
| <script src="/79.c30128b5.js"></script> |
| <script src="/78.25baa806.js"></script> |
| <script src="/935f2afb.4fd644c9.js"></script> |
| <script src="/17896441.bdc3ce75.js"></script> |
| <script src="/ada24b13.dd878683.js"></script> |
| </body> |
| </html> |
