index.html 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903
  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.10">
  8. <title>Overview - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.d6be258b.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="#api-overview" 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. Overview
  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 md-nav__item--active">
  134. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  135. <label class="md-nav__link md-nav__link--active" for="__toc">
  136. Overview
  137. <span class="md-nav__icon md-icon"></span>
  138. </label>
  139. <a href="./" class="md-nav__link md-nav__link--active">
  140. Overview
  141. </a>
  142. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  143. <label class="md-nav__title" for="__toc">
  144. <span class="md-nav__icon md-icon"></span>
  145. Table of contents
  146. </label>
  147. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  148. <li class="md-nav__item">
  149. <a href="#architecture" class="md-nav__link">
  150. Architecture
  151. </a>
  152. </li>
  153. <li class="md-nav__item">
  154. <a href="#resource-model" class="md-nav__link">
  155. Resource model
  156. </a>
  157. <nav class="md-nav" aria-label="Resource model">
  158. <ul class="md-nav__list">
  159. <li class="md-nav__item">
  160. <a href="#secretstore" class="md-nav__link">
  161. SecretStore
  162. </a>
  163. </li>
  164. <li class="md-nav__item">
  165. <a href="#externalsecret" class="md-nav__link">
  166. ExternalSecret
  167. </a>
  168. </li>
  169. <li class="md-nav__item">
  170. <a href="#clustersecretstore" class="md-nav__link">
  171. ClusterSecretStore
  172. </a>
  173. </li>
  174. </ul>
  175. </nav>
  176. </li>
  177. <li class="md-nav__item">
  178. <a href="#behavior" class="md-nav__link">
  179. Behavior
  180. </a>
  181. </li>
  182. <li class="md-nav__item">
  183. <a href="#roles-and-responsibilities" class="md-nav__link">
  184. Roles and responsibilities
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="#access-control" class="md-nav__link">
  189. Access Control
  190. </a>
  191. </li>
  192. <li class="md-nav__item">
  193. <a href="#running-multiple-controller" class="md-nav__link">
  194. Running multiple Controller
  195. </a>
  196. </li>
  197. </ul>
  198. </nav>
  199. </li>
  200. <li class="md-nav__item md-nav__item--nested">
  201. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  202. <label class="md-nav__link" for="__nav_3">
  203. API Types
  204. <span class="md-nav__icon md-icon"></span>
  205. </label>
  206. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  207. <label class="md-nav__title" for="__nav_3">
  208. <span class="md-nav__icon md-icon"></span>
  209. API Types
  210. </label>
  211. <ul class="md-nav__list" data-md-scrollfix>
  212. <li class="md-nav__item">
  213. <a href="../api-externalsecret/" class="md-nav__link">
  214. ExternalSecret
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../api-secretstore/" class="md-nav__link">
  219. SecretStore
  220. </a>
  221. </li>
  222. <li class="md-nav__item">
  223. <a href="../api-clustersecretstore/" class="md-nav__link">
  224. ClusterSecretStore
  225. </a>
  226. </li>
  227. <li class="md-nav__item">
  228. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  229. ClusterExternalSecret
  230. </a>
  231. </li>
  232. </ul>
  233. </nav>
  234. </li>
  235. <li class="md-nav__item md-nav__item--nested">
  236. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  237. <label class="md-nav__link" for="__nav_4">
  238. Guides
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  242. <label class="md-nav__title" for="__nav_4">
  243. <span class="md-nav__icon md-icon"></span>
  244. Guides
  245. </label>
  246. <ul class="md-nav__list" data-md-scrollfix>
  247. <li class="md-nav__item">
  248. <a href="../guides-introduction/" class="md-nav__link">
  249. Introduction
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../guides-getting-started/" class="md-nav__link">
  254. Getting started
  255. </a>
  256. </li>
  257. <li class="md-nav__item md-nav__item--nested">
  258. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  259. <label class="md-nav__link" for="__nav_4_3">
  260. Advanced Templating
  261. <span class="md-nav__icon md-icon"></span>
  262. </label>
  263. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  264. <label class="md-nav__title" for="__nav_4_3">
  265. <span class="md-nav__icon md-icon"></span>
  266. Advanced Templating
  267. </label>
  268. <ul class="md-nav__list" data-md-scrollfix>
  269. <li class="md-nav__item">
  270. <a href="../guides-templating/" class="md-nav__link">
  271. v2
  272. </a>
  273. </li>
  274. <li class="md-nav__item">
  275. <a href="../guides-templating-v1/" class="md-nav__link">
  276. v1
  277. </a>
  278. </li>
  279. </ul>
  280. </nav>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  284. All keys, One secret
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  289. Common K8S Secret Types
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../guides-controller-class/" class="md-nav__link">
  294. Controller Classes
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  299. Lifecycle: ownership & deletion
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../guides-getallsecrets/" class="md-nav__link">
  304. Getting Multiple Secrets
  305. </a>
  306. </li>
  307. <li class="md-nav__item">
  308. <a href="../guides-multi-tenancy/" class="md-nav__link">
  309. Multi Tenancy
  310. </a>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="../guides-metrics/" class="md-nav__link">
  314. Metrics
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../guides-v1beta1/" class="md-nav__link">
  319. Upgrading to v1beta1
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../guides-using-latest-image/" class="md-nav__link">
  324. Using Latest Image
  325. </a>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. <li class="md-nav__item md-nav__item--nested">
  331. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  332. <label class="md-nav__link" for="__nav_5">
  333. Provider
  334. <span class="md-nav__icon md-icon"></span>
  335. </label>
  336. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  337. <label class="md-nav__title" for="__nav_5">
  338. <span class="md-nav__icon md-icon"></span>
  339. Provider
  340. </label>
  341. <ul class="md-nav__list" data-md-scrollfix>
  342. <li class="md-nav__item md-nav__item--nested">
  343. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  344. <label class="md-nav__link" for="__nav_5_1">
  345. AWS
  346. <span class="md-nav__icon md-icon"></span>
  347. </label>
  348. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  349. <label class="md-nav__title" for="__nav_5_1">
  350. <span class="md-nav__icon md-icon"></span>
  351. AWS
  352. </label>
  353. <ul class="md-nav__list" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  356. Secrets Manager
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  361. Parameter Store
  362. </a>
  363. </li>
  364. </ul>
  365. </nav>
  366. </li>
  367. <li class="md-nav__item md-nav__item--nested">
  368. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  369. <label class="md-nav__link" for="__nav_5_2">
  370. Azure
  371. <span class="md-nav__icon md-icon"></span>
  372. </label>
  373. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  374. <label class="md-nav__title" for="__nav_5_2">
  375. <span class="md-nav__icon md-icon"></span>
  376. Azure
  377. </label>
  378. <ul class="md-nav__list" data-md-scrollfix>
  379. <li class="md-nav__item">
  380. <a href="../provider-azure-key-vault/" class="md-nav__link">
  381. Key Vault
  382. </a>
  383. </li>
  384. </ul>
  385. </nav>
  386. </li>
  387. <li class="md-nav__item md-nav__item--nested">
  388. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  389. <label class="md-nav__link" for="__nav_5_3">
  390. Google
  391. <span class="md-nav__icon md-icon"></span>
  392. </label>
  393. <nav class="md-nav" aria-label="Google" data-md-level="2">
  394. <label class="md-nav__title" for="__nav_5_3">
  395. <span class="md-nav__icon md-icon"></span>
  396. Google
  397. </label>
  398. <ul class="md-nav__list" data-md-scrollfix>
  399. <li class="md-nav__item">
  400. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  401. Secret Manager
  402. </a>
  403. </li>
  404. </ul>
  405. </nav>
  406. </li>
  407. <li class="md-nav__item md-nav__item--nested">
  408. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  409. <label class="md-nav__link" for="__nav_5_4">
  410. IBM
  411. <span class="md-nav__icon md-icon"></span>
  412. </label>
  413. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  414. <label class="md-nav__title" for="__nav_5_4">
  415. <span class="md-nav__icon md-icon"></span>
  416. IBM
  417. </label>
  418. <ul class="md-nav__list" data-md-scrollfix>
  419. <li class="md-nav__item">
  420. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  421. Secrets Manager
  422. </a>
  423. </li>
  424. </ul>
  425. </nav>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="../provider-akeyless/" class="md-nav__link">
  429. Akeyless
  430. </a>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  434. HashiCorp Vault
  435. </a>
  436. </li>
  437. <li class="md-nav__item md-nav__item--nested">
  438. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  439. <label class="md-nav__link" for="__nav_5_7">
  440. Yandex
  441. <span class="md-nav__icon md-icon"></span>
  442. </label>
  443. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  444. <label class="md-nav__title" for="__nav_5_7">
  445. <span class="md-nav__icon md-icon"></span>
  446. Yandex
  447. </label>
  448. <ul class="md-nav__list" data-md-scrollfix>
  449. <li class="md-nav__item">
  450. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  451. Certificate Manager
  452. </a>
  453. </li>
  454. <li class="md-nav__item">
  455. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  456. Lockbox
  457. </a>
  458. </li>
  459. </ul>
  460. </nav>
  461. </li>
  462. <li class="md-nav__item md-nav__item--nested">
  463. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  464. <label class="md-nav__link" for="__nav_5_8">
  465. Gitlab
  466. <span class="md-nav__icon md-icon"></span>
  467. </label>
  468. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  469. <label class="md-nav__title" for="__nav_5_8">
  470. <span class="md-nav__icon md-icon"></span>
  471. Gitlab
  472. </label>
  473. <ul class="md-nav__list" data-md-scrollfix>
  474. <li class="md-nav__item">
  475. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  476. Gitlab Project Variables
  477. </a>
  478. </li>
  479. </ul>
  480. </nav>
  481. </li>
  482. <li class="md-nav__item md-nav__item--nested">
  483. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  484. <label class="md-nav__link" for="__nav_5_9">
  485. Oracle
  486. <span class="md-nav__icon md-icon"></span>
  487. </label>
  488. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  489. <label class="md-nav__title" for="__nav_5_9">
  490. <span class="md-nav__icon md-icon"></span>
  491. Oracle
  492. </label>
  493. <ul class="md-nav__list" data-md-scrollfix>
  494. <li class="md-nav__item">
  495. <a href="../provider-oracle-vault/" class="md-nav__link">
  496. Oracle Vault
  497. </a>
  498. </li>
  499. </ul>
  500. </nav>
  501. </li>
  502. <li class="md-nav__item md-nav__item--nested">
  503. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  504. <label class="md-nav__link" for="__nav_5_10">
  505. 1Password
  506. <span class="md-nav__icon md-icon"></span>
  507. </label>
  508. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  509. <label class="md-nav__title" for="__nav_5_10">
  510. <span class="md-nav__icon md-icon"></span>
  511. 1Password
  512. </label>
  513. <ul class="md-nav__list" data-md-scrollfix>
  514. <li class="md-nav__item">
  515. <a href="../provider-1password-automation/" class="md-nav__link">
  516. Secrets Automation
  517. </a>
  518. </li>
  519. </ul>
  520. </nav>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../provider-webhook/" class="md-nav__link">
  524. Webhook
  525. </a>
  526. </li>
  527. <li class="md-nav__item">
  528. <a href="../provider-fake/" class="md-nav__link">
  529. Fake
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../provider-kubernetes/" class="md-nav__link">
  534. Kubernetes
  535. </a>
  536. </li>
  537. <li class="md-nav__item md-nav__item--nested">
  538. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  539. <label class="md-nav__link" for="__nav_5_14">
  540. senhasegura
  541. <span class="md-nav__icon md-icon"></span>
  542. </label>
  543. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  544. <label class="md-nav__title" for="__nav_5_14">
  545. <span class="md-nav__icon md-icon"></span>
  546. senhasegura
  547. </label>
  548. <ul class="md-nav__list" data-md-scrollfix>
  549. <li class="md-nav__item">
  550. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  551. DevOps Secrets Management (DSM)
  552. </a>
  553. </li>
  554. </ul>
  555. </nav>
  556. </li>
  557. </ul>
  558. </nav>
  559. </li>
  560. <li class="md-nav__item md-nav__item--nested">
  561. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  562. <label class="md-nav__link" for="__nav_6">
  563. Examples
  564. <span class="md-nav__icon md-icon"></span>
  565. </label>
  566. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  567. <label class="md-nav__title" for="__nav_6">
  568. <span class="md-nav__icon md-icon"></span>
  569. Examples
  570. </label>
  571. <ul class="md-nav__list" data-md-scrollfix>
  572. <li class="md-nav__item">
  573. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  574. FluxCD
  575. </a>
  576. </li>
  577. <li class="md-nav__item">
  578. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  579. Anchore Engine
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  584. Jenkins
  585. </a>
  586. </li>
  587. </ul>
  588. </nav>
  589. </li>
  590. <li class="md-nav__item md-nav__item--nested">
  591. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  592. <label class="md-nav__link" for="__nav_7">
  593. External Resources
  594. <span class="md-nav__icon md-icon"></span>
  595. </label>
  596. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  597. <label class="md-nav__title" for="__nav_7">
  598. <span class="md-nav__icon md-icon"></span>
  599. External Resources
  600. </label>
  601. <ul class="md-nav__list" data-md-scrollfix>
  602. <li class="md-nav__item">
  603. <a href="../eso-talks/" class="md-nav__link">
  604. Talks
  605. </a>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="../eso-demos/" class="md-nav__link">
  609. Demos
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../eso-blogs/" class="md-nav__link">
  614. Blogs
  615. </a>
  616. </li>
  617. </ul>
  618. </nav>
  619. </li>
  620. <li class="md-nav__item md-nav__item--nested">
  621. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  622. <label class="md-nav__link" for="__nav_8">
  623. References
  624. <span class="md-nav__icon md-icon"></span>
  625. </label>
  626. <nav class="md-nav" aria-label="References" data-md-level="1">
  627. <label class="md-nav__title" for="__nav_8">
  628. <span class="md-nav__icon md-icon"></span>
  629. References
  630. </label>
  631. <ul class="md-nav__list" data-md-scrollfix>
  632. <li class="md-nav__item">
  633. <a href="../spec/" class="md-nav__link">
  634. API specification
  635. </a>
  636. </li>
  637. </ul>
  638. </nav>
  639. </li>
  640. <li class="md-nav__item md-nav__item--nested">
  641. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  642. <label class="md-nav__link" for="__nav_9">
  643. Contributing
  644. <span class="md-nav__icon md-icon"></span>
  645. </label>
  646. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  647. <label class="md-nav__title" for="__nav_9">
  648. <span class="md-nav__icon md-icon"></span>
  649. Contributing
  650. </label>
  651. <ul class="md-nav__list" data-md-scrollfix>
  652. <li class="md-nav__item">
  653. <a href="../contributing-devguide/" class="md-nav__link">
  654. Developer guide
  655. </a>
  656. </li>
  657. <li class="md-nav__item">
  658. <a href="../contributing-process/" class="md-nav__link">
  659. Contributing Process
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../contributing-release/" class="md-nav__link">
  664. Release Process
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="../contributing-coc/" class="md-nav__link">
  669. Code of Conduct
  670. </a>
  671. </li>
  672. </ul>
  673. </nav>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../roadmap/" class="md-nav__link">
  677. Roadmap
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="../faq/" class="md-nav__link">
  682. FAQ
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../stability-support/" class="md-nav__link">
  687. Stability and Support
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../deprecation-policy/" class="md-nav__link">
  692. Deprecation Policy
  693. </a>
  694. </li>
  695. </ul>
  696. </nav>
  697. </div>
  698. </div>
  699. </div>
  700. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  701. <div class="md-sidebar__scrollwrap">
  702. <div class="md-sidebar__inner">
  703. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  704. <label class="md-nav__title" for="__toc">
  705. <span class="md-nav__icon md-icon"></span>
  706. Table of contents
  707. </label>
  708. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  709. <li class="md-nav__item">
  710. <a href="#architecture" class="md-nav__link">
  711. Architecture
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="#resource-model" class="md-nav__link">
  716. Resource model
  717. </a>
  718. <nav class="md-nav" aria-label="Resource model">
  719. <ul class="md-nav__list">
  720. <li class="md-nav__item">
  721. <a href="#secretstore" class="md-nav__link">
  722. SecretStore
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="#externalsecret" class="md-nav__link">
  727. ExternalSecret
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="#clustersecretstore" class="md-nav__link">
  732. ClusterSecretStore
  733. </a>
  734. </li>
  735. </ul>
  736. </nav>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="#behavior" class="md-nav__link">
  740. Behavior
  741. </a>
  742. </li>
  743. <li class="md-nav__item">
  744. <a href="#roles-and-responsibilities" class="md-nav__link">
  745. Roles and responsibilities
  746. </a>
  747. </li>
  748. <li class="md-nav__item">
  749. <a href="#access-control" class="md-nav__link">
  750. Access Control
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="#running-multiple-controller" class="md-nav__link">
  755. Running multiple Controller
  756. </a>
  757. </li>
  758. </ul>
  759. </nav>
  760. </div>
  761. </div>
  762. </div>
  763. <div class="md-content" data-md-component="content">
  764. <article class="md-content__inner md-typeset">
  765. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/api-overview.md" title="Edit this page" class="md-content__button md-icon">
  766. <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>
  767. </a>
  768. <h1 id="api-overview">API Overview</h1>
  769. <h2 id="architecture">Architecture</h2>
  770. <p><img alt="high-level" src="../pictures/diagrams-high-level-simple.png" /></p>
  771. <p>The External Secrets Operator extends Kubernetes with <a href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/">Custom
  772. Resources</a>,
  773. which define where secrets live and how to synchronize them. The controller
  774. fetches secrets from an external API and creates Kubernetes
  775. <a href="https://kubernetes.io/docs/concepts/configuration/secret/">secrets</a>. If the
  776. secret from the external API changes, the controller will reconcile the state in
  777. the cluster and update the secrets accordingly.</p>
  778. <h2 id="resource-model">Resource model</h2>
  779. <p>To understand the mechanics of the operator let's start with the data model. The
  780. SecretStore references an bucket of key/value pairs. But because every external
  781. API is slightly different this bucket may be e.g. an instance of an Azure
  782. KeyVault or a AWS Secrets Manager in a certain AWS Account and region. Please
  783. take a look at the provider documentation to see what the Bucket actually maps
  784. to.</p>
  785. <p><img alt="Resource Mapping" src="../pictures/diagrams-resource-mapping.png" /></p>
  786. <h3 id="secretstore">SecretStore</h3>
  787. <p>The idea behind the <a href="../api-secretstore/">SecretStore</a> resource is to separate concerns of
  788. authentication/access and the actual Secret and configuration needed for
  789. workloads. The ExternalSecret specifies what to fetch, the SecretStore specifies
  790. how to access. This resource is namespaced.</p>
  791. <p><div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span><span class="w"></span>
  792. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  793. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  794. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span><span class="w"></span>
  795. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  796. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  797. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  798. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span><span class="w"></span>
  799. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-east-1</span><span class="w"></span>
  800. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  801. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  802. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  803. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span><span class="w"></span>
  804. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access-key</span><span class="w"></span>
  805. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  806. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span><span class="w"></span>
  807. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span><span class="w"></span>
  808. </code></pre></div>
  809. The <code>SecretStore</code> contains references to secrets which hold credentials to
  810. access the external API.</p>
  811. <h3 id="externalsecret">ExternalSecret</h3>
  812. <p>An <a href="../api-externalsecret/">ExternalSecret</a> declares what data to fetch. It has a reference to a
  813. <code>SecretStore</code> which knows how to access that data. The controller uses that
  814. <code>ExternalSecret</code> as a blueprint to create secrets.</p>
  815. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span><span class="w"></span>
  816. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  817. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  818. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"></span>
  819. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  820. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  821. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  822. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span><span class="w"></span>
  823. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  824. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  825. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-to-be-created</span><span class="w"></span>
  826. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Owner</span><span class="w"></span>
  827. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  828. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-key-to-be-managed</span><span class="w"></span>
  829. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  830. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">provider-key</span><span class="w"></span>
  831. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">provider-key-version</span><span class="w"></span>
  832. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">provider-key-property</span><span class="w"></span>
  833. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  834. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"></span>
  835. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">remote-key-in-the-provider</span><span class="w"></span>
  836. </code></pre></div>
  837. <h3 id="clustersecretstore">ClusterSecretStore</h3>
  838. <p>The <a href="../api-clustersecretstore/">ClusterSecretStore</a> is a global, cluster-wide SecretStore that can be
  839. referenced from all namespaces. You can use it to provide a central gateway to your secret provider.</p>
  840. <h2 id="behavior">Behavior</h2>
  841. <p>The External Secret Operator (ESO for brevity) reconciles <code>ExternalSecrets</code> in
  842. the following manner:</p>
  843. <ol>
  844. <li>ESO uses <code>spec.secretStoreRef</code> to find an appropriate <code>SecretStore</code>. If it
  845. doesn't exist or the <code>spec.controller</code> field doesn't match it won't further
  846. process this ExternalSecret.</li>
  847. <li>ESO instanciates an external API client using the specified credentials from
  848. the <code>SecretStore</code> spec.</li>
  849. <li>ESO fetches the secrets as requested by the <code>ExternalSecret</code>, it will decode
  850. the secrets if required</li>
  851. <li>ESO creates an <code>Kind=Secret</code> based on the template provided by
  852. <code>ExternalSecret.target.template</code>. The <code>Secret.data</code> can be templated using
  853. the secret values from the external API.</li>
  854. <li>ESO ensures that the secret values stay in sync with the external API</li>
  855. </ol>
  856. <h2 id="roles-and-responsibilities">Roles and responsibilities</h2>
  857. <p>The External Secret Operator is designed to target the following persona:</p>
  858. <ul>
  859. <li><strong>Cluster Operator</strong>: The cluster operator is responsible for setting up the
  860. External Secret Operator, managing access policies and creating
  861. ClusterSecretStores.</li>
  862. <li><strong>Application developer</strong>: The Application developer is responsible for
  863. defining ExternalSecrets and the application configuration</li>
  864. </ul>
  865. <p>Each persona will roughly map to a Kubernetes RBAC role. Depending on your
  866. environment these roles can map to a single user. <strong>Note:</strong> There is no Secret
  867. Operator that handles the lifecycle of the secret, this is out of the scope of
  868. ESO.</p>
  869. <h2 id="access-control">Access Control</h2>
  870. <p>The External Secrets Operator runs as a deployment in your cluster with elevated
  871. privileges. It will create/read/update secrets in all namespaces and has access
  872. to secrets stored in some external API. Ensure that the credentials you provide
  873. give ESO the least privilege necessary.</p>
  874. <p>Design your <code>SecretStore</code>/<code>ClusterSecretStore</code> carefully! Be sure to restrict
  875. access of application developers to read only certain
  876. keys in a shared environment.</p>
  877. <p>You should also consider using Kubernetes' admission control system (e.g.
  878. <a href="https://www.openpolicyagent.org/">OPA</a> or <a href="https://kyverno.io/">Kyverno</a>) for
  879. fine-grained access control.</p>
  880. <h2 id="running-multiple-controller">Running multiple Controller</h2>
  881. <p>You can run multiple controllers within the cluster. One controller can be
  882. limited to only process <code>SecretStores</code> with a predefined <code>spec.controller</code>
  883. field.</p>
  884. <div class="admonition note">
  885. <p class="admonition-title">Testers welcome</p>
  886. <p>This is not widely tested. Please help us test the setup and/or document use-cases.</p>
  887. </div>
  888. </article>
  889. </div>
  890. </div>
  891. </main>
  892. <footer class="md-footer">
  893. <nav class="md-footer__inner md-grid" aria-label="Footer">
  894. <a href=".." class="md-footer__link md-footer__link--prev" aria-label="Previous: Introduction" rel="prev">
  895. <div class="md-footer__button md-icon">
  896. <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>
  897. </div>
  898. <div class="md-footer__title">
  899. <div class="md-ellipsis">
  900. <span class="md-footer__direction">
  901. Previous
  902. </span>
  903. Introduction
  904. </div>
  905. </div>
  906. </a>
  907. <a href="../api-externalsecret/" class="md-footer__link md-footer__link--next" aria-label="Next: ExternalSecret" rel="next">
  908. <div class="md-footer__title">
  909. <div class="md-ellipsis">
  910. <span class="md-footer__direction">
  911. Next
  912. </span>
  913. ExternalSecret
  914. </div>
  915. </div>
  916. <div class="md-footer__button md-icon">
  917. <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>
  918. </div>
  919. </a>
  920. </nav>
  921. <div class="md-footer-meta md-typeset">
  922. <div class="md-footer-meta__inner md-grid">
  923. <div class="md-copyright">
  924. Made with
  925. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  926. Material for MkDocs
  927. </a>
  928. </div>
  929. </div>
  930. </div>
  931. </footer>
  932. </div>
  933. <div class="md-dialog" data-md-component="dialog">
  934. <div class="md-dialog__inner md-typeset"></div>
  935. </div>
  936. <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.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  937. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  938. </body>
  939. </html>