https://admiralty.io/docs/

1<!doctype html>
2<html lang="en">
3<head>
4<meta charset="UTF-8">
5<meta name="viewport" content="width=device-width,initial-scale=1">
6<meta name="generator" content="Docusaurus v2.0.0-alpha.65">
7<link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Admiralty Blog RSS Feed">
8<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Admiralty Blog Atom Feed">
9<link rel="search" type="application/opensearchdescription+xml" title="Admiralty" href="/opensearch.xml">
10<meta name="twitter:site" content="@admiraltyio"><title data-react-helmet="true">Introduction | Admiralty</title><meta data-react-helmet="true" name="docsearch:version" content="current,latest"><meta data-react-helmet="true" property="og:image" content="https://admiralty.io/Admiralty Ver3 - Logomark Only - Transparent (PNG).png"><meta data-react-helmet="true" property="twitter:image" content="https://admiralty.io/Admiralty Ver3 - Logomark Only - Transparent (PNG).png"><meta data-react-helmet="true" name="twitter:image:alt" content="Image for Admiralty"><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:title" content="Introduction | Admiralty"><meta data-react-helmet="true" name="description" content="Admiralty is a system of Kubernetes controllers that intelligently schedules workloads across clusters. It is simple to use and simple to integrate with other tools. It enables many multi-cluster, multi-region, multi-cloud, and hybrid (simply put, global computing) use cases:"><meta data-react-helmet="true" property="og:description" content="Admiralty is a system of Kubernetes controllers that intelligently schedules workloads across clusters. It is simple to use and simple to integrate with other tools. It enables many multi-cluster, multi-region, multi-cloud, and hybrid (simply put, global computing) use cases:"><meta data-react-helmet="true" property="og:url" content="https://admiralty.io/docs/"><link data-react-helmet="true" rel="shortcut icon" href="/Admiralty Ver3 - Logomark Only - Transparent (PNG).png"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link data-react-helmet="true" rel="canonical" href="https://admiralty.io/docs/"><link rel="stylesheet" href="/styles.b08511c4.css">
11<link rel="preload" href="/styles.200ddb04.js" as="script">
12<link rel="preload" href="/runtime~main.184596f8.js" as="script">
13<link rel="preload" href="/main.42bccccb.js" as="script">
14<link rel="preload" href="/1.422d1894.js" as="script">
15<link rel="preload" href="/2.ac375a69.js" as="script">
16<link rel="preload" href="/3.e37cd500.js" as="script">
17<link rel="preload" href="/1be78505.d98eeb35.js" as="script">
18<link rel="preload" href="/50.6040da8c.js" as="script">
19<link rel="preload" href="/935f2afb.747ab213.js" as="script">
20<link rel="preload" href="/17896441.fcbfa7e8.js" as="script">
21<link rel="preload" href="/a09c2993.a323ae59.js" as="script">

21
22<script async src="https://www.googletagmanager.com/gtag/js?id=

22UA-120900003-1

22"></script>

23<script>

24window.dataLayer = window.dataLayer || [];
25function gtag() { dataLayer.push(arguments); }
26gtag('js', new Date());
27
28gtag('config', '

28UA-120900003-1

28');

29</script>

29</head>
30<body>

31<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:"dark")}()</script>

31<div id="__docusaurus">
32<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 xmlns="http://www.w3.org/2000/svg" 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 class="navbar__logo" src="/Admiralty Ver2 - Horizontal (RGB EPS).svg" alt="Admiralty Logo"><strong class="navbar__title"></strong></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/">Docs</a><a class="navbar__item navbar__link" href="/blog/">Blog</a><a class="navbar__item navbar__link" href="/contact">Contact</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/admiraltyio/admiralty" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><a href="https://join.slack.com/t/admiraltyio/shared_invite/zt-ob2z3hgi-tr8KOJSu6JcaLZHiDVAncQ" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Slack</a><a href="https://twitter.com/admiraltyio" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Twitter</a><a href="https://admiralty.us18.list-manage.com/subscribe?u=a2b70e0c93b2a5e68908f5112&amp;id=f59cd03255" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Newsletter</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_2aTZ"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_BsTx">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_BsTx">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span><span class="DocSearch-Button-Key">⌘</span><span class="DocSearch-Button-Key">K</span></button></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 class="navbar__logo" src="/Admiralty Ver2 - Horizontal (RGB EPS).svg" alt="Admiralty Logo"><strong class="navbar__title"></strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link navbar__link--active" href="/docs/">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/blog/">Blog</a></li><li class="menu__list-item"><a class="menu__link" href="/contact">Contact</a></li><li class="menu__list-item"><a href="https://github.com/admiraltyio/admiralty" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li><li class="menu__list-item"><a href="https://join.slack.com/t/admiraltyio/shared_invite/zt-ob2z3hgi-tr8KOJSu6JcaLZHiDVAncQ" target="_blank" rel="noopener noreferrer" class="menu__link">Slack</a></li><li class="menu__list-item"><a href="https://twitter.com/admiraltyio" target="_blank" rel="noopener noreferrer" class="menu__link">Twitter</a></li><li class="menu__list-item"><a href="https://admiralty.us18.list-manage.com/subscribe?u=a2b70e0c93b2a5e68908f5112&amp;id=f59cd03255" target="_blank" rel="noopener noreferrer" class="menu__link">Newsletter</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_2gpo"><div class="docSidebarContainer_3_JD" role="complementary"><div class="sidebar_2urC"><div class="menu menu--responsive menu_5FrY"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_Dm3K" xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 32 32" 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"><a aria-current="page" class="menu__link menu__link--active active" href="/docs/">Introduction</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/quick_start">Quick Start</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Concepts</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/concepts/topologies">Multi-Cluster Topologies</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/concepts/authentication">Cross-Cluster Authentication</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/concepts/scheduling">Multi-Cluster Scheduling</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Operator Guide</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/operator_guide/installation">Installation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/operator_guide/authentication">Configuring Authentication</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/operator_guide/scheduling">Configuring Scheduling</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/operator_guide/safely_drain_cluster">Safely Drain a Cluster</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">User Guide</a><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">Integrations</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/user_guide/integrations/argo_cd">Argo CD</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/user_guide/integrations/argo_workflows">Argo Workflows</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/user_guide/integrations/k8gb">k8gb</a></li></ul></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Tutorials</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/tutorials/fargate">Multi-Region AWS Fargate on EKS</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">API Reference</a><ul class="menu__list"><li class="menu__list-item"><a href="https://github.com/admiraltyio/admiralty/tree/master/charts/multicluster-scheduler" target="_blank" rel="noreferrer noopener" class="menu__link" tabindex="-1">

32Helm Chart</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/api_reference/cli">CLI</a></li></ul></li><li class="menu__list-item"><a href="https://github.com/admiraltyio/admiralty/blob/master/CHANGELOG.md" target="_blank" rel="noreferrer noopener" class="menu__link">Release Notes</a></li><li class="menu__list-item"><a href="https://github.com/admiraltyio/admiralty/tree/master/LICENSE" target="_blank" rel="noreferrer noopener" class="menu__link">License</a></li></ul></div></div></div><main class="docMainContainer_3EyW"><div class="container padding-vert--lg docItemWrapper_1EkI"><div class="row"><div class="col docItemCol_2ASc"><div class="docItemContainer_3QWW"><article><header><h1 class="docTitle_1Lrw">Introduction</h1></header><div class="markdown"><p>Admiralty is a system of Kubernetes controllers that intelligently schedules workloads across clusters. It is simple to use and simple to integrate with other tools. It enables many multi-cluster, multi-region, multi-cloud, and hybrid (simply put, global computing) use cases:</p><ul style="columns:2"><li>high availability,</li><li>active-active disaster recovery,</li><li>dynamic content delivery networks (dCDNs),</li><li>distributed workflows,</li><li>edge computing, Internet of Things (IoT), 5G,</li><li>central access control and auditing,</li><li>blue/green cluster upgrades,</li><li>cluster abstraction (clusters as cattle),</li><li>resource federation (including global research platforms),</li><li>cloud bursting,</li><li>cloud arbitrage...</li></ul><p>In a nutshell, here&#x27;s how Admiralty works:</p><ol><li>Install Admiralty in each cluster that you want to federate. Configure clusters as sources and/or targets to build a centralized or decentralized topology.</li><li>Annotate any pod or pod template (e.g., of a Deployment, Job, or <a href="https://argoproj.github.io/projects/argo" target="_blank" rel="noopener noreferrer">Argo</a> Workflow, among others) in any source cluster with <code>multicluster.admiralty.io/elect=&quot;&quot;</code>.</li><li>Admiralty mutates the elected pods into <em>proxy pods</em> scheduled on <a href="https://virtual-kubelet.io/" target="_blank" rel="noopener noreferrer">virtual-kubelet</a>

32 nodes representing target clusters, and creates <em>delegate pods</em> in the remote clusters (actually running the containers).</li><li>Pod dependencies (config maps and secrets) and dependents (services and ingresses) &quot;follow&quot; delegate pods, i.e., they are copied as needed to target clusters.</li><li>A feedback loop updates the statuses and annotations of the proxy pods to reflect the statuses and annotations of the delegate pods.</li><li><code>kubectl logs</code> and <code>kubectl exec</code> work as expected.</li><li>Integrate with Admiralty Cloud/Enterprise, <a href="https://cilium.io/blog/2019/03/12/clustermesh/" target="_blank" rel="noopener noreferrer">Cilium</a> and other third-party solutions to enable north-south and east-west networking across clusters.</li></ol><div class="admonition admonition-note alert alert--secondary"><div class="admonition-heading"><h5><span class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" width="14" height="16" viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>Open Source and Admiralty Cloud/Enterprise</h5></div><div class="admonition-content"><p>This documentation covers both the Admiralty open source cluster agent and Admiralty Cloud/Enterprise. Features only available with Admiralty Cloud/Enterprise are clearly marked; in that case, as much as possible, open source and commercial third-party alternatives are discussed.</p></div></div></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/admiraltyio/admiralty/edit/master/docs/introduction.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><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"></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/quick_start"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Quick Start »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_3SO_"></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="text--center"><div class="margin-bottom--sm"><img class="footer__logo" alt="Admiralty Logo" src="/Admiralty Ver3 - Logomark Only (RGB EPS).svg"></div><div>Copyright 2024 The Admiralty Authors.</div></div></div></footer></div>

33<script src="/styles.200ddb04.js"></script>

33

34<script src="/runtime~main.184596f8.js"></script>

34

35<script src="/main.42bccccb.js"></script>

35

36<script src="/1.422d1894.js"></script>

36

37<script src="/2.ac375a69.js"></script>

37

38<script src="/3.e37cd500.js"></script>

38

39<script src="/1be78505.d98eeb35.js"></script>

39

40<script src="/50.6040da8c.js"></script>

40

41<script src="/935f2afb.747ab213.js"></script>

41

42<script src="/17896441.fcbfa7e8.js"></script>

42

43<script src="/a09c2993.a323ae59.js"></script>

43
44</body>
45</html>