<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-designDocs/submarine-server/architecture">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="Docusaurus v2.0.0-beta.18">
<title data-rh="true">Submarine Server Implementation | Apache Submarine</title><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://submarine.apache.org//docs/next/designDocs/submarine-server/architecture"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Submarine Server Implementation | Apache Submarine"><meta data-rh="true" name="description" content="&lt;!--"><meta data-rh="true" property="og:description" content="&lt;!--"><link data-rh="true" rel="icon" href="/img/submarine.ico"><link data-rh="true" rel="canonical" href="https://submarine.apache.org//docs/next/designDocs/submarine-server/architecture"><link data-rh="true" rel="alternate" href="https://submarine.apache.org//docs/next/designDocs/submarine-server/architecture" hreflang="en"><link data-rh="true" rel="alternate" href="https://submarine.apache.org//docs/next/designDocs/submarine-server/architecture" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.80258812.css">
<link rel="preload" href="/assets/js/runtime~main.c55a74e9.js" as="script">
<link rel="preload" href="/assets/js/main.f510e8bc.js" as="script">
</head>
<body class="navigation-with-keyboard">
<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">
<div role="region"><a href="#" class="skipToContent_ZgBM">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/icons/128.png" alt="Apache Submarine Site Logo" class="themedImage_W2Cr themedImage--light_TfLj"><img src="/img/icons/128.png" alt="Apache Submarine Site Logo" class="themedImage_W2Cr themedImage--dark_oUvU"></div><b class="navbar__title">Apache Submarine</b></a><a class="navbar__item navbar__link navbar__link--active" href="/docs/next/gettingStarted/quickstart">Docs</a><a class="navbar__item navbar__link" href="/docs/next/api/environment">API</a><a class="navbar__item navbar__link" href="/docs/next/download">Download</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/next/gettingStarted/quickstart">master 🏃</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/next/designDocs/submarine-server/architecture">master 🏃</a></li><li><a class="dropdown__link" href="/docs/designDocs/submarine-server/architecture">0.6.0</a></li><li><a class="dropdown__link" href="/versions">All versions</a></li></ul></div><a href="https://github.com/apache/submarine" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Apache</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/foundation/how-it-works.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache Software Foundation<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache License<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="toggle_S7eR colorModeToggle_vKtC"><button class="clean-btn toggleButton_rCf9 toggleButtonDisabled_Pu9x" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_v35p"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_nQuB"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></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></nav><div class="main-wrapper"><div class="docPage_P2Lg"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_RiI4" type="button"></button><aside class="theme-doc-sidebar-container docSidebarContainer_rKC_"><div class="sidebar_RiAD"><nav class="menu thin-scrollbar menu_izAj"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/next/gettingStarted/quickstart">Getting Started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/next/userDocs/submarine-sdk/experiment-client">User Docs</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/next/devDocs/">Developer Docs</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/next/community/">Community</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/next/designDocs/architecture-and-requirements">Design Docs</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/designDocs/architecture-and-requirements">Architecture and Requirment</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/designDocs/implementation-notes">Implementation Notes</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/designDocs/environments-implementation">Environments Implementation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/designDocs/experiment-implementation">Experiment Implementation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/designDocs/notebook-implementation">Notebook Implementation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/designDocs/storage-implementation">Storage Implementation</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/next/designDocs/submarine-server/architecture">Submarine Server</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/next/designDocs/submarine-server/architecture">Submarine Server Implementation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/next/designDocs/submarine-server/experimentSpec">Generic Experiment Spec</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/next/designDocs/wip-designs/submarine-launcher">WIP Design Docs</a></div></li></ul></li></ul></nav></div></aside><main class="docMainContainer_TCnq"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_DM6M"><div class="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is unreleased documentation for <!-- -->Apache Submarine<!-- --> <b>master 🏃</b> version.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/designDocs/submarine-server/architecture">latest version</a></b> (<!-- -->0.6.0<!-- -->).</div></div><div class="docItemContainer_vinB"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Xlws" aria-label="breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/">🏠</a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><span class="breadcrumbs__link" itemprop="item name">Design Docs</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><span class="breadcrumbs__link" itemprop="item name">Submarine Server</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="item name">Submarine Server Implementation</span><meta itemprop="position" content="3"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: master 🏃</span><div class="tocCollapsible_jdIR theme-doc-toc-mobile tocMobile_TmEX"><button type="button" class="clean-btn tocCollapsibleButton_Fzxq">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Submarine Server Implementation</h1></header><h2 class="anchor anchorWithStickyNavbar_mojV" id="architecture-overview">Architecture Overview<a class="hash-link" href="#architecture-overview" title="Direct link to heading">​</a></h2><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx" style="color:#bfc7d5;background-color:#292d3e"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#bfc7d5"><span class="token plain">    +---------------Submarine Server ---+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">    |                                   |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">    | +------------+ +------------+     |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">    | |Web Svc/Prxy| |Backend Svc |     |    +--Submarine Asset +</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">    | +------------+ +------------+     |    |Project/Notebook  |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">    |   ^         ^                     |    |Model/Metrics     |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">    +---|---------|---------------------+    |Libraries/Dataset |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">        |         |                          +------------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">        |         |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">        |      +--|-Compute Cluster 1---+    +--Image Registry--+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">        +      |  |                     |    |   User&#x27;s Images  |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">      User /   |  +                     |    |                  |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">      Admin    | User Notebook Instance |    +------------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">               | Experiment Runs        |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">               +------------------------+    +-Data Storage-----+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">                                             | S3/HDFS, etc.    |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">               +----Compute Cluster 2---+    |                  |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">                                             +------------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">                        ...</span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" title="Copy" class="copyButton_eDfN clean-btn"><span class="copyButtonIcons_W9eQ" aria-hidden="true"><svg class="copyButtonIcon_XEyF" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_i9w9" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div><p>Here&#x27;s a diagram to illustrate the Submarine&#x27;s deployment.</p><ul><li>Submarine Server consists of web service/proxy, and backend services. They&#x27;re like &quot;control planes&quot; 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&#x27;re multiple compute clusters that could be used by Submarine service. For user&#x27;s running notebook instance, jobs, etc. they will be placed to one of the compute clusters by user&#x27;s preference or defined policies.</li><li>Submarine&#x27;s asset includes project/notebook(content)/models/metrics/dataset-meta, etc. can be stored inside Submarine&#x27;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&#x27;s scope and should be managed by 3rd party applications.</li></ul><h2 class="anchor anchorWithStickyNavbar_mojV" id="submarine-server-and-its-apis">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="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx" style="color:#bfc7d5;background-color:#292d3e"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#bfc7d5"><span class="token plain">           +----------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">           | CLI      |+---+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">           +----------+    v              +----------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">                         +--------------+ | Submarine      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">           +----------+  | REST API     | |                |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">           | SDK      |+&gt;|              |+&gt;  Server        |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">           +----------+  +--------------+ |                |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">                           ^              +----------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">           +----------+    |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">           | UI       |+---+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">           +----------+</span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" title="Copy" class="copyButton_eDfN clean-btn"><span class="copyButtonIcons_W9eQ" aria-hidden="true"><svg class="copyButtonIcon_XEyF" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_i9w9" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></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&#x27;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 class="anchor anchorWithStickyNavbar_mojV" id="proposal">Proposal<a class="hash-link" href="#proposal" title="Direct link to heading">​</a></h2><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx" style="color:#bfc7d5;background-color:#292d3e"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">|           |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">| workbench +---+   +----------------------------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">|           |   |   | +------+ +---------------------+ |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+   |   | |      | |      +-------+      | |     +---------------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">                |   | |      | |      |  K8s  |      | |     | +--------+   +----+ |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+   |   | |      | |      +-------+      | |     | |        +--&gt;+job1| |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">|           |   |   | |      | |      submitter      | |     | |        |   +----+ |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">|    CLI    +------&gt;+ | REST | +---------------------+ +----&gt;+ |operator|   +----+ |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">|           |   |   | |      | +---------------------+ |     | |        +--&gt;+job2| |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+   |   | |      | | +-------+ +-------+ | |     | +--------+   +----+ |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">                |   | |      | | |PlugMgr| |monitor| | |     |     K8s Cluster     |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+   |   | |      | | +-------+ +-------+ | |     +---------------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">|           |   |   | |      | |      JobManager     | |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">|    SDK    +---+   | +------+ +---------------------+ |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">|           |       +----------------------------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">+-----------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   client                          server</span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" title="Copy" class="copyButton_eDfN clean-btn"><span class="copyButtonIcons_W9eQ" aria-hidden="true"><svg class="copyButtonIcon_XEyF" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_i9w9" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></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 class="anchor anchorWithStickyNavbar_mojV" id="submarine-server-components">Submarine Server Components<a class="hash-link" href="#submarine-server-components" title="Direct link to heading">​</a></h2><div class="codeBlockContainer_I0IT theme-code-block"><div class="codeBlockContent_wNvx" style="color:#bfc7d5;background-color:#292d3e"><pre tabindex="0" class="prism-code language-text codeBlock_jd64 thin-scrollbar"><code class="codeBlockLines_mRuA"><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   +----------------------Submarine Server--------------------------------+</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | +-----------------+ +------------------+ +--------------------+      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | |  Experiment     | |Notebook Session  | |Environment Mgr     |      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | |  Mgr            | |Mgr               | |                    |      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | +-----------------+ +------------------+ +--------------------+      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   |                                                                      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | +-----------------+ +------------------+ +--------------------+      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | |  Model Registry | |Model Serving Mgr | |Compute Cluster Mgr |      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | |                 | |                  | |                    |      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | +-----------------+ +------------------+ +--------------------+      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   |                                                                      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | +-----------------+ +------------------+ +--------------------+      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | | DataSet Mgr     | |User/Team         | |Metadata Mgr        |      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | |                 | |Permission Mgr    | |                    |      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   | +-----------------+ +------------------+ +--------------------+      |</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">   +----------------------------------------------------------------------+</span><br></span></code></pre><button type="button" aria-label="Copy code to clipboard" title="Copy" class="copyButton_eDfN clean-btn"><span class="copyButtonIcons_W9eQ" aria-hidden="true"><svg class="copyButtonIcon_XEyF" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_i9w9" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div><h3 class="anchor anchorWithStickyNavbar_mojV" id="experiment-manager">Experiment Manager<a class="hash-link" href="#experiment-manager" title="Direct link to heading">​</a></h3><p>TODO</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="notebook-sessions-manager">Notebook Sessions Manager<a class="hash-link" href="#notebook-sessions-manager" title="Direct link to heading">​</a></h3><p>TODO</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="environment-manager">Environment Manager<a class="hash-link" href="#environment-manager" title="Direct link to heading">​</a></h3><p>TODO</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="model-registry">Model Registry<a class="hash-link" href="#model-registry" title="Direct link to heading">​</a></h3><p>TODO</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="model-serving-manager">Model Serving Manager<a class="hash-link" href="#model-serving-manager" title="Direct link to heading">​</a></h3><p>TODO</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="compute-cluster-manager">Compute Cluster Manager<a class="hash-link" href="#compute-cluster-manager" title="Direct link to heading">​</a></h3><p>TODO</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="dataset-manager">Dataset Manager<a class="hash-link" href="#dataset-manager" title="Direct link to heading">​</a></h3><p>TODO</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="userteam-permissions-manager">User/team permissions manager<a class="hash-link" href="#userteam-permissions-manager" title="Direct link to heading">​</a></h3><p>TODO</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="metadata-manager">Metadata Manager<a class="hash-link" href="#metadata-manager" title="Direct link to heading">​</a></h3><p>TODO</p><h2 class="anchor anchorWithStickyNavbar_mojV" id="componentsservices-outside-of-submarine-servers-scope">Components/services outside of Submarine Server&#x27;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><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row 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" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_dcUD" aria-hidden="true"><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 class="col lastUpdated_foO9"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/next/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/next/designDocs/submarine-server/experimentSpec"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Generic Experiment Spec</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_cNA8 thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#architecture-overview" class="table-of-contents__link toc-highlight">Architecture Overview</a></li><li><a href="#submarine-server-and-its-apis" class="table-of-contents__link toc-highlight">Submarine Server and its APIs</a></li><li><a href="#proposal" class="table-of-contents__link toc-highlight">Proposal</a></li><li><a href="#submarine-server-components" class="table-of-contents__link toc-highlight">Submarine Server Components</a><ul><li><a href="#experiment-manager" class="table-of-contents__link toc-highlight">Experiment Manager</a></li><li><a href="#notebook-sessions-manager" class="table-of-contents__link toc-highlight">Notebook Sessions Manager</a></li><li><a href="#environment-manager" class="table-of-contents__link toc-highlight">Environment Manager</a></li><li><a href="#model-registry" class="table-of-contents__link toc-highlight">Model Registry</a></li><li><a href="#model-serving-manager" class="table-of-contents__link toc-highlight">Model Serving Manager</a></li><li><a href="#compute-cluster-manager" class="table-of-contents__link toc-highlight">Compute Cluster Manager</a></li><li><a href="#dataset-manager" class="table-of-contents__link toc-highlight">Dataset Manager</a></li><li><a href="#userteam-permissions-manager" class="table-of-contents__link toc-highlight">User/team permissions manager</a></li><li><a href="#metadata-manager" class="table-of-contents__link toc-highlight">Metadata Manager</a></li></ul></li><li><a href="#componentsservices-outside-of-submarine-servers-scope" class="table-of-contents__link toc-highlight">Components/services outside of Submarine Server&#39;s scope</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/gettingStarted/quickstart">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"><div class="footer__title">Community</div><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<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://s.apache.org/slack-invite" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><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<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="footerLogoLink_gHmE"><img src="https://hadoop.apache.org/asf_logo_wide.png" alt="Apache Open Source Logo" class="themedImage_W2Cr themedImage--light_TfLj footer__logo"><img src="https://hadoop.apache.org/asf_logo_wide.png" alt="Apache Open Source Logo" class="themedImage_W2Cr themedImage--dark_oUvU footer__logo"></a></div><div class="footer__copyright">Apache Submarine, Submarine, Apache, the Apache feather logo, and the Apache Submarine project logo are
       either registered trademarks or trademarks of the Apache Software Foundation in the United States and other
        countries.<br> Copyright © 2022 Apache Submarine is Apache2 Licensed software.</div></div></div></footer></div>
<script src="/assets/js/runtime~main.c55a74e9.js"></script>
<script src="/assets/js/main.f510e8bc.js"></script>
</body>
</html>