index.html 49 KB

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