index.html 34 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.9">
  8. <title>Multi Tenancy - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.2b4465f4.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#shared-clustersecretstore" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Multi Tenancy
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. </ul>
  166. </nav>
  167. </li>
  168. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  169. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  170. <label class="md-nav__link" for="__nav_4">
  171. Guides
  172. <span class="md-nav__icon md-icon"></span>
  173. </label>
  174. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  175. <label class="md-nav__title" for="__nav_4">
  176. <span class="md-nav__icon md-icon"></span>
  177. Guides
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../guides-introduction/" class="md-nav__link">
  182. Introduction
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-templating/" class="md-nav__link">
  192. Advanced Templating
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../guides-controller-class/" class="md-nav__link">
  197. Controller Classes
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  202. All keys, One secret
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  207. Common K8S Secret Types
  208. </a>
  209. </li>
  210. <li class="md-nav__item md-nav__item--active">
  211. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  212. <label class="md-nav__link md-nav__link--active" for="__toc">
  213. Multi Tenancy
  214. <span class="md-nav__icon md-icon"></span>
  215. </label>
  216. <a href="./" class="md-nav__link md-nav__link--active">
  217. Multi Tenancy
  218. </a>
  219. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  220. <label class="md-nav__title" for="__toc">
  221. <span class="md-nav__icon md-icon"></span>
  222. Table of contents
  223. </label>
  224. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  225. <li class="md-nav__item">
  226. <a href="#shared-clustersecretstore" class="md-nav__link">
  227. Shared ClusterSecretStore
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="#managed-secretstore-per-namespace" class="md-nav__link">
  232. Managed SecretStore per Namespace
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="#eso-as-a-service" class="md-nav__link">
  237. ESO as a Service
  238. </a>
  239. </li>
  240. </ul>
  241. </nav>
  242. </li>
  243. <li class="md-nav__item">
  244. <a href="../guides-metrics/" class="md-nav__link">
  245. Metrics
  246. </a>
  247. </li>
  248. <li class="md-nav__item">
  249. <a href="../guides-using-latest-image/" class="md-nav__link">
  250. Using Latest Image
  251. </a>
  252. </li>
  253. </ul>
  254. </nav>
  255. </li>
  256. <li class="md-nav__item md-nav__item--nested">
  257. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  258. <label class="md-nav__link" for="__nav_5">
  259. Provider
  260. <span class="md-nav__icon md-icon"></span>
  261. </label>
  262. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  263. <label class="md-nav__title" for="__nav_5">
  264. <span class="md-nav__icon md-icon"></span>
  265. Provider
  266. </label>
  267. <ul class="md-nav__list" data-md-scrollfix>
  268. <li class="md-nav__item md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  270. <label class="md-nav__link" for="__nav_5_1">
  271. AWS
  272. <span class="md-nav__icon md-icon"></span>
  273. </label>
  274. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  275. <label class="md-nav__title" for="__nav_5_1">
  276. <span class="md-nav__icon md-icon"></span>
  277. AWS
  278. </label>
  279. <ul class="md-nav__list" data-md-scrollfix>
  280. <li class="md-nav__item">
  281. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  282. Secrets Manager
  283. </a>
  284. </li>
  285. <li class="md-nav__item">
  286. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  287. Parameter Store
  288. </a>
  289. </li>
  290. </ul>
  291. </nav>
  292. </li>
  293. <li class="md-nav__item md-nav__item--nested">
  294. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  295. <label class="md-nav__link" for="__nav_5_2">
  296. Azure
  297. <span class="md-nav__icon md-icon"></span>
  298. </label>
  299. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  300. <label class="md-nav__title" for="__nav_5_2">
  301. <span class="md-nav__icon md-icon"></span>
  302. Azure
  303. </label>
  304. <ul class="md-nav__list" data-md-scrollfix>
  305. <li class="md-nav__item">
  306. <a href="../provider-azure-key-vault/" class="md-nav__link">
  307. Key Vault
  308. </a>
  309. </li>
  310. </ul>
  311. </nav>
  312. </li>
  313. <li class="md-nav__item md-nav__item--nested">
  314. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  315. <label class="md-nav__link" for="__nav_5_3">
  316. Google
  317. <span class="md-nav__icon md-icon"></span>
  318. </label>
  319. <nav class="md-nav" aria-label="Google" data-md-level="2">
  320. <label class="md-nav__title" for="__nav_5_3">
  321. <span class="md-nav__icon md-icon"></span>
  322. Google
  323. </label>
  324. <ul class="md-nav__list" data-md-scrollfix>
  325. <li class="md-nav__item">
  326. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  327. Secret Manager
  328. </a>
  329. </li>
  330. </ul>
  331. </nav>
  332. </li>
  333. <li class="md-nav__item md-nav__item--nested">
  334. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  335. <label class="md-nav__link" for="__nav_5_4">
  336. IBM
  337. <span class="md-nav__icon md-icon"></span>
  338. </label>
  339. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  340. <label class="md-nav__title" for="__nav_5_4">
  341. <span class="md-nav__icon md-icon"></span>
  342. IBM
  343. </label>
  344. <ul class="md-nav__list" data-md-scrollfix>
  345. <li class="md-nav__item">
  346. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  347. Secrets Manager
  348. </a>
  349. </li>
  350. </ul>
  351. </nav>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../provider-akeyless/" class="md-nav__link">
  355. Akeyless
  356. </a>
  357. </li>
  358. <li class="md-nav__item">
  359. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  360. HashiCorp Vault
  361. </a>
  362. </li>
  363. <li class="md-nav__item md-nav__item--nested">
  364. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  365. <label class="md-nav__link" for="__nav_5_7">
  366. Yandex
  367. <span class="md-nav__icon md-icon"></span>
  368. </label>
  369. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  370. <label class="md-nav__title" for="__nav_5_7">
  371. <span class="md-nav__icon md-icon"></span>
  372. Yandex
  373. </label>
  374. <ul class="md-nav__list" data-md-scrollfix>
  375. <li class="md-nav__item">
  376. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  377. Lockbox
  378. </a>
  379. </li>
  380. </ul>
  381. </nav>
  382. </li>
  383. <li class="md-nav__item md-nav__item--nested">
  384. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  385. <label class="md-nav__link" for="__nav_5_8">
  386. Gitlab
  387. <span class="md-nav__icon md-icon"></span>
  388. </label>
  389. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  390. <label class="md-nav__title" for="__nav_5_8">
  391. <span class="md-nav__icon md-icon"></span>
  392. Gitlab
  393. </label>
  394. <ul class="md-nav__list" data-md-scrollfix>
  395. <li class="md-nav__item">
  396. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  397. Gitlab Project Variables
  398. </a>
  399. </li>
  400. </ul>
  401. </nav>
  402. </li>
  403. <li class="md-nav__item md-nav__item--nested">
  404. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  405. <label class="md-nav__link" for="__nav_5_9">
  406. Oracle
  407. <span class="md-nav__icon md-icon"></span>
  408. </label>
  409. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  410. <label class="md-nav__title" for="__nav_5_9">
  411. <span class="md-nav__icon md-icon"></span>
  412. Oracle
  413. </label>
  414. <ul class="md-nav__list" data-md-scrollfix>
  415. <li class="md-nav__item">
  416. <a href="../provider-oracle-vault/" class="md-nav__link">
  417. Oracle Vault
  418. </a>
  419. </li>
  420. </ul>
  421. </nav>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../provider-webhook/" class="md-nav__link">
  425. Webhook
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="../provider-fake/" class="md-nav__link">
  430. Fake
  431. </a>
  432. </li>
  433. </ul>
  434. </nav>
  435. </li>
  436. <li class="md-nav__item md-nav__item--nested">
  437. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  438. <label class="md-nav__link" for="__nav_6">
  439. Examples
  440. <span class="md-nav__icon md-icon"></span>
  441. </label>
  442. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  443. <label class="md-nav__title" for="__nav_6">
  444. <span class="md-nav__icon md-icon"></span>
  445. Examples
  446. </label>
  447. <ul class="md-nav__list" data-md-scrollfix>
  448. <li class="md-nav__item">
  449. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  450. FluxCD
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  455. Anchore Engine
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  460. Jenkins
  461. </a>
  462. </li>
  463. </ul>
  464. </nav>
  465. </li>
  466. <li class="md-nav__item md-nav__item--nested">
  467. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  468. <label class="md-nav__link" for="__nav_7">
  469. References
  470. <span class="md-nav__icon md-icon"></span>
  471. </label>
  472. <nav class="md-nav" aria-label="References" data-md-level="1">
  473. <label class="md-nav__title" for="__nav_7">
  474. <span class="md-nav__icon md-icon"></span>
  475. References
  476. </label>
  477. <ul class="md-nav__list" data-md-scrollfix>
  478. <li class="md-nav__item">
  479. <a href="../spec/" class="md-nav__link">
  480. API specification
  481. </a>
  482. </li>
  483. </ul>
  484. </nav>
  485. </li>
  486. <li class="md-nav__item md-nav__item--nested">
  487. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  488. <label class="md-nav__link" for="__nav_8">
  489. Contributing
  490. <span class="md-nav__icon md-icon"></span>
  491. </label>
  492. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  493. <label class="md-nav__title" for="__nav_8">
  494. <span class="md-nav__icon md-icon"></span>
  495. Contributing
  496. </label>
  497. <ul class="md-nav__list" data-md-scrollfix>
  498. <li class="md-nav__item">
  499. <a href="../contributing-devguide/" class="md-nav__link">
  500. Developer guide
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../contributing-process/" class="md-nav__link">
  505. Contributing Process
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../contributing-coc/" class="md-nav__link">
  510. Code of Conduct
  511. </a>
  512. </li>
  513. </ul>
  514. </nav>
  515. </li>
  516. <li class="md-nav__item">
  517. <a href="../deprecation-policy/" class="md-nav__link">
  518. Deprecation Policy
  519. </a>
  520. </li>
  521. </ul>
  522. </nav>
  523. </div>
  524. </div>
  525. </div>
  526. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  527. <div class="md-sidebar__scrollwrap">
  528. <div class="md-sidebar__inner">
  529. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  530. <label class="md-nav__title" for="__toc">
  531. <span class="md-nav__icon md-icon"></span>
  532. Table of contents
  533. </label>
  534. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  535. <li class="md-nav__item">
  536. <a href="#shared-clustersecretstore" class="md-nav__link">
  537. Shared ClusterSecretStore
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="#managed-secretstore-per-namespace" class="md-nav__link">
  542. Managed SecretStore per Namespace
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="#eso-as-a-service" class="md-nav__link">
  547. ESO as a Service
  548. </a>
  549. </li>
  550. </ul>
  551. </nav>
  552. </div>
  553. </div>
  554. </div>
  555. <div class="md-content" data-md-component="content">
  556. <article class="md-content__inner md-typeset">
  557. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/guides-multi-tenancy.md" title="Edit this page" class="md-content__button md-icon">
  558. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  559. </a>
  560. <h1>Multi Tenancy</h1>
  561. <p>External Secrets Operator provides different modes of operation to fulfill
  562. ogranizational needs. This guide outlines the flexibility of ESO and should give
  563. you a first impression of how you can employ this operator in your organization.</p>
  564. <p>For a multi-tenant deployment you should first examine your organizational
  565. structure:</p>
  566. <ol>
  567. <li>what roles (i.e. <em>Application Developers</em>, <em>Cluster Admins</em>, ...) do you have
  568. in your organization,</li>
  569. <li>what responsibilities do they have and</li>
  570. <li>how does that map to Kubernetes RBAC roles.</li>
  571. </ol>
  572. <p>Further, you should examine how your external API provider manages access
  573. control for your secrets. Can you limit access by secret names (e.g.
  574. <code>db/dev/*</code>)? Or only on a bucket level? Please keep in mind that not all
  575. external APIs provide fine-grained access management for secrets.</p>
  576. <p><strong>Note:</strong> The following examples should <strong>not</strong> be considered as best practice
  577. but rather as a example to show how to combine different mechanics and
  578. techniques for tenant isolation.</p>
  579. <h3 id="shared-clustersecretstore">Shared ClusterSecretStore</h3>
  580. <p><img alt="Shared CSS" src="../pictures/diagrams-multi-tenancy-shared.png" /></p>
  581. <p>A Cluster Administrator deploys a <code>ClusterSecretStore</code> (CSS) and manages access
  582. to the external API. The CSS is shared by all tenants within the cluster.
  583. Application Developers do reference it in a <code>ExternalSecret</code> but can not create
  584. a ClusterSecretStores or SecretStores on their own. Now all application
  585. developers have access to all the secrets. You probably want to limit access to
  586. certain keys or prefixes that should be used. ESO does not provide a mechanic
  587. to limit access to certain keys per namespace. More advanced validation should be
  588. done with an Admission Webhook, e.g. with <a href="https://kyverno.io/">Kyverno</a> or
  589. <a href="https://www.openpolicyagent.org/">Open Policy Agent</a>).</p>
  590. <p>This setup suites well if you have one central bucket that contains all of your
  591. secrets and your Cluster Administrators should manage access to it. This setup
  592. is very simple but does not scale very well.</p>
  593. <h3 id="managed-secretstore-per-namespace">Managed SecretStore per Namespace</h3>
  594. <p><img alt="Shared CSS" src="../pictures/diagrams-multi-tenancy-managed-store.png" /></p>
  595. <p>Cluster Administrators manage one or multipe <code>SecretStores</code> per Namespace. Each
  596. SecretStore uses it's own <em>role</em> that limits access to a small set of keys. The
  597. peculiarity of this is approach is, that <strong>access is actually managed by the
  598. external API</strong> which provides the roles. The Cluster Administrator does just the
  599. wiring. This approach may be desirable if you have an external entity - let's
  600. call it <strong>Secret Administrator</strong> - that manages access and lifecycle of the
  601. secrets.</p>
  602. <h3 id="eso-as-a-service">ESO as a Service</h3>
  603. <p><img alt="Shared CSS" src="../pictures/diagrams-multi-tenancy-self-service.png" /></p>
  604. <p>Every namespace is self-contained. Application developers manage <code>SecretStore</code>,
  605. <code>ExternalSecret</code> and secret infrastructure on their own. Cluster Administrators
  606. <em>just</em> provide the External Secrets Operator as a service.</p>
  607. <p>This makes sense if application developers should be completely autonomous while
  608. a central team provides common services.</p>
  609. </article>
  610. </div>
  611. </div>
  612. </main>
  613. <footer class="md-footer">
  614. <nav class="md-footer__inner md-grid" aria-label="Footer">
  615. <a href="../guides-common-k8s-secret-types/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Common K8S Secret Types" rel="prev">
  616. <div class="md-footer__button md-icon">
  617. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  618. </div>
  619. <div class="md-footer__title">
  620. <div class="md-ellipsis">
  621. <span class="md-footer__direction">
  622. Previous
  623. </span>
  624. Common K8S Secret Types
  625. </div>
  626. </div>
  627. </a>
  628. <a href="../guides-metrics/" class="md-footer__link md-footer__link--next" aria-label="Next: Metrics" rel="next">
  629. <div class="md-footer__title">
  630. <div class="md-ellipsis">
  631. <span class="md-footer__direction">
  632. Next
  633. </span>
  634. Metrics
  635. </div>
  636. </div>
  637. <div class="md-footer__button md-icon">
  638. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  639. </div>
  640. </a>
  641. </nav>
  642. <div class="md-footer-meta md-typeset">
  643. <div class="md-footer-meta__inner md-grid">
  644. <div class="md-copyright">
  645. Made with
  646. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  647. Material for MkDocs
  648. </a>
  649. </div>
  650. </div>
  651. </div>
  652. </footer>
  653. </div>
  654. <div class="md-dialog" data-md-component="dialog">
  655. <div class="md-dialog__inner md-typeset"></div>
  656. </div>
  657. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.22074ed6.min.js", "version": {"provider": "mike"}}</script>
  658. <script src="../assets/javascripts/bundle.960e086b.min.js"></script>
  659. </body>
  660. </html>