index.html 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230
  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="prev" href="../../introduction/deprecation-policy/">
  7. <link rel="next" href="../externalsecret/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.9">
  10. <title>Components - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.85bb2934.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__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>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#components" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <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>
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Components
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <label class="md-header__button md-icon" for="__search">
  65. <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>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <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>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <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>
  74. <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>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <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>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="./" class="md-tabs__link md-tabs__link--active">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <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>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--nested">
  167. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  168. <div class="md-nav__link md-nav__link--index ">
  169. <a href="../..">Introduction</a>
  170. <label for="__nav_1">
  171. <span class="md-nav__icon md-icon"></span>
  172. </label>
  173. </div>
  174. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  175. <label class="md-nav__title" for="__nav_1">
  176. <span class="md-nav__icon md-icon"></span>
  177. Introduction
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../../introduction/overview/" class="md-nav__link">
  182. Overview
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../../introduction/getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../introduction/faq/" class="md-nav__link">
  192. FAQ
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/stability-support/" class="md-nav__link">
  197. Stability and Support
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  202. Deprecation Policy
  203. </a>
  204. </li>
  205. </ul>
  206. </nav>
  207. </li>
  208. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  209. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  210. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  211. API
  212. <span class="md-nav__icon md-icon"></span>
  213. </label>
  214. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  215. <label class="md-nav__title" for="__nav_2">
  216. <span class="md-nav__icon md-icon"></span>
  217. API
  218. </label>
  219. <ul class="md-nav__list" data-md-scrollfix>
  220. <li class="md-nav__item md-nav__item--active">
  221. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  222. <label class="md-nav__link md-nav__link--active" for="__toc">
  223. Components
  224. <span class="md-nav__icon md-icon"></span>
  225. </label>
  226. <a href="./" class="md-nav__link md-nav__link--active">
  227. Components
  228. </a>
  229. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  230. <label class="md-nav__title" for="__toc">
  231. <span class="md-nav__icon md-icon"></span>
  232. Table of contents
  233. </label>
  234. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="#overview" class="md-nav__link">
  237. Overview
  238. </a>
  239. <nav class="md-nav" aria-label="Overview">
  240. <ul class="md-nav__list">
  241. <li class="md-nav__item">
  242. <a href="#tls-bootstrap" class="md-nav__link">
  243. TLS Bootstrap
  244. </a>
  245. </li>
  246. </ul>
  247. </nav>
  248. </li>
  249. </ul>
  250. </nav>
  251. </li>
  252. <li class="md-nav__item md-nav__item--nested">
  253. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  254. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  255. Core Resources
  256. <span class="md-nav__icon md-icon"></span>
  257. </label>
  258. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  259. <label class="md-nav__title" for="__nav_2_2">
  260. <span class="md-nav__icon md-icon"></span>
  261. Core Resources
  262. </label>
  263. <ul class="md-nav__list" data-md-scrollfix>
  264. <li class="md-nav__item">
  265. <a href="../externalsecret/" class="md-nav__link">
  266. ExternalSecret
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="../secretstore/" class="md-nav__link">
  271. SecretStore
  272. </a>
  273. </li>
  274. <li class="md-nav__item">
  275. <a href="../clustersecretstore/" class="md-nav__link">
  276. ClusterSecretStore
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../clusterexternalsecret/" class="md-nav__link">
  281. ClusterExternalSecret
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="../pushsecret/" class="md-nav__link">
  286. PushSecret
  287. </a>
  288. </li>
  289. </ul>
  290. </nav>
  291. </li>
  292. <li class="md-nav__item md-nav__item--nested">
  293. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  294. <div class="md-nav__link md-nav__link--index ">
  295. <a href="../generator/">Generators</a>
  296. <label for="__nav_2_3">
  297. <span class="md-nav__icon md-icon"></span>
  298. </label>
  299. </div>
  300. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  301. <label class="md-nav__title" for="__nav_2_3">
  302. <span class="md-nav__icon md-icon"></span>
  303. Generators
  304. </label>
  305. <ul class="md-nav__list" data-md-scrollfix>
  306. <li class="md-nav__item">
  307. <a href="../generator/acr/" class="md-nav__link">
  308. Azure Container Registry
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../generator/ecr/" class="md-nav__link">
  313. AWS Elastic Container Registry
  314. </a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="../generator/gcr/" class="md-nav__link">
  318. Google Container Registry
  319. </a>
  320. </li>
  321. <li class="md-nav__item">
  322. <a href="../generator/vault/" class="md-nav__link">
  323. Vault Dynamic Secret
  324. </a>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="../generator/password/" class="md-nav__link">
  328. Password
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../generator/fake/" class="md-nav__link">
  333. Fake
  334. </a>
  335. </li>
  336. </ul>
  337. </nav>
  338. </li>
  339. <li class="md-nav__item md-nav__item--nested">
  340. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  341. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  342. Reference Docs
  343. <span class="md-nav__icon md-icon"></span>
  344. </label>
  345. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  346. <label class="md-nav__title" for="__nav_2_4">
  347. <span class="md-nav__icon md-icon"></span>
  348. Reference Docs
  349. </label>
  350. <ul class="md-nav__list" data-md-scrollfix>
  351. <li class="md-nav__item">
  352. <a href="../spec/" class="md-nav__link">
  353. API specification
  354. </a>
  355. </li>
  356. <li class="md-nav__item">
  357. <a href="../controller-options/" class="md-nav__link">
  358. Controller Options
  359. </a>
  360. </li>
  361. <li class="md-nav__item">
  362. <a href="../metrics/" class="md-nav__link">
  363. Metrics
  364. </a>
  365. </li>
  366. </ul>
  367. </nav>
  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 md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  374. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  375. Guides
  376. <span class="md-nav__icon md-icon"></span>
  377. </label>
  378. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  379. <label class="md-nav__title" for="__nav_3">
  380. <span class="md-nav__icon md-icon"></span>
  381. Guides
  382. </label>
  383. <ul class="md-nav__list" data-md-scrollfix>
  384. <li class="md-nav__item">
  385. <a href="../../guides/introduction/" class="md-nav__link">
  386. Introduction
  387. </a>
  388. </li>
  389. <li class="md-nav__item md-nav__item--nested">
  390. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  391. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  392. External Secrets
  393. <span class="md-nav__icon md-icon"></span>
  394. </label>
  395. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  396. <label class="md-nav__title" for="__nav_3_2">
  397. <span class="md-nav__icon md-icon"></span>
  398. External Secrets
  399. </label>
  400. <ul class="md-nav__list" data-md-scrollfix>
  401. <li class="md-nav__item">
  402. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  403. Extract structured data
  404. </a>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="../../guides/getallsecrets/" class="md-nav__link">
  408. Find Secrets by Name or Metadata
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  413. Rewriting Keys
  414. </a>
  415. </li>
  416. <li class="md-nav__item md-nav__item--nested">
  417. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  418. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  419. Advanced Templating
  420. <span class="md-nav__icon md-icon"></span>
  421. </label>
  422. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  423. <label class="md-nav__title" for="__nav_3_2_4">
  424. <span class="md-nav__icon md-icon"></span>
  425. Advanced Templating
  426. </label>
  427. <ul class="md-nav__list" data-md-scrollfix>
  428. <li class="md-nav__item">
  429. <a href="../../guides/templating/" class="md-nav__link">
  430. v2
  431. </a>
  432. </li>
  433. <li class="md-nav__item">
  434. <a href="../../guides/templating-v1/" class="md-nav__link">
  435. v1
  436. </a>
  437. </li>
  438. </ul>
  439. </nav>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  443. Kubernetes Secret Types
  444. </a>
  445. </li>
  446. <li class="md-nav__item">
  447. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  448. Lifecycle: ownership & deletion
  449. </a>
  450. </li>
  451. <li class="md-nav__item">
  452. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  453. Decoding Strategies
  454. </a>
  455. </li>
  456. <li class="md-nav__item">
  457. <a href="../../guides/controller-class/" class="md-nav__link">
  458. Controller Classes
  459. </a>
  460. </li>
  461. </ul>
  462. </nav>
  463. </li>
  464. <li class="md-nav__item">
  465. <a href="../../guides/generator/" class="md-nav__link">
  466. Generators
  467. </a>
  468. </li>
  469. <li class="md-nav__item md-nav__item--nested">
  470. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
  471. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  472. Operations
  473. <span class="md-nav__icon md-icon"></span>
  474. </label>
  475. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
  476. <label class="md-nav__title" for="__nav_3_4">
  477. <span class="md-nav__icon md-icon"></span>
  478. Operations
  479. </label>
  480. <ul class="md-nav__list" data-md-scrollfix>
  481. <li class="md-nav__item">
  482. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  483. Multi Tenancy
  484. </a>
  485. </li>
  486. <li class="md-nav__item">
  487. <a href="../../guides/security-best-practices/" class="md-nav__link">
  488. Security Best Practices
  489. </a>
  490. </li>
  491. <li class="md-nav__item">
  492. <a href="../../guides/threat-model/" class="md-nav__link">
  493. Threat Model
  494. </a>
  495. </li>
  496. <li class="md-nav__item">
  497. <a href="../../guides/v1beta1/" class="md-nav__link">
  498. Upgrading to v1beta1
  499. </a>
  500. </li>
  501. <li class="md-nav__item">
  502. <a href="../../guides/using-latest-image/" class="md-nav__link">
  503. Using Latest Image
  504. </a>
  505. </li>
  506. <li class="md-nav__item">
  507. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  508. Disable Cluster Features
  509. </a>
  510. </li>
  511. </ul>
  512. </nav>
  513. </li>
  514. </ul>
  515. </nav>
  516. </li>
  517. <li class="md-nav__item md-nav__item--nested">
  518. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  519. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  520. Provider
  521. <span class="md-nav__icon md-icon"></span>
  522. </label>
  523. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  524. <label class="md-nav__title" for="__nav_4">
  525. <span class="md-nav__icon md-icon"></span>
  526. Provider
  527. </label>
  528. <ul class="md-nav__list" data-md-scrollfix>
  529. <li class="md-nav__item">
  530. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  531. AWS Secrets Manager
  532. </a>
  533. </li>
  534. <li class="md-nav__item">
  535. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  536. AWS Parameter Store
  537. </a>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  541. Azure Key Vault
  542. </a>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="../../provider/conjur/" class="md-nav__link">
  546. CyberArk Conjur
  547. </a>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  551. Google Cloud Secret Manager
  552. </a>
  553. </li>
  554. <li class="md-nav__item">
  555. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  556. HashiCorp Vault
  557. </a>
  558. </li>
  559. <li class="md-nav__item">
  560. <a href="../../provider/kubernetes/" class="md-nav__link">
  561. Kubernetes
  562. </a>
  563. </li>
  564. <li class="md-nav__item">
  565. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  566. IBM Secrets Manager
  567. </a>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="../../provider/akeyless/" class="md-nav__link">
  571. Akeyless
  572. </a>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  576. Yandex Certificate Manager
  577. </a>
  578. </li>
  579. <li class="md-nav__item">
  580. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  581. Yandex Lockbox
  582. </a>
  583. </li>
  584. <li class="md-nav__item">
  585. <a href="../../provider/alibaba/" class="md-nav__link">
  586. Alibaba Cloud
  587. </a>
  588. </li>
  589. <li class="md-nav__item">
  590. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  591. GitLab Variables
  592. </a>
  593. </li>
  594. <li class="md-nav__item">
  595. <a href="../../provider/oracle-vault/" class="md-nav__link">
  596. Oracle Vault
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="../../provider/1password-automation/" class="md-nav__link">
  601. 1Password Secrets Automation
  602. </a>
  603. </li>
  604. <li class="md-nav__item">
  605. <a href="../../provider/webhook/" class="md-nav__link">
  606. Webhook
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="../../provider/fake/" class="md-nav__link">
  611. Fake
  612. </a>
  613. </li>
  614. <li class="md-nav__item">
  615. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  616. senhasegura DevOps Secrets Management (DSM)
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../../provider/doppler/" class="md-nav__link">
  621. Doppler
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="../../provider/keeper-security/" class="md-nav__link">
  626. Keeper Security
  627. </a>
  628. </li>
  629. <li class="md-nav__item">
  630. <a href="../../provider/scaleway/" class="md-nav__link">
  631. Scaleway
  632. </a>
  633. </li>
  634. </ul>
  635. </nav>
  636. </li>
  637. <li class="md-nav__item md-nav__item--nested">
  638. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  639. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  640. Examples
  641. <span class="md-nav__icon md-icon"></span>
  642. </label>
  643. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  644. <label class="md-nav__title" for="__nav_5">
  645. <span class="md-nav__icon md-icon"></span>
  646. Examples
  647. </label>
  648. <ul class="md-nav__list" data-md-scrollfix>
  649. <li class="md-nav__item">
  650. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  651. FluxCD
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  656. Anchore Engine
  657. </a>
  658. </li>
  659. <li class="md-nav__item">
  660. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  661. Jenkins
  662. </a>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="../../examples/bitwarden/" class="md-nav__link">
  666. BitWarden
  667. </a>
  668. </li>
  669. </ul>
  670. </nav>
  671. </li>
  672. <li class="md-nav__item md-nav__item--nested">
  673. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  674. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  675. Community
  676. <span class="md-nav__icon md-icon"></span>
  677. </label>
  678. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  679. <label class="md-nav__title" for="__nav_6">
  680. <span class="md-nav__icon md-icon"></span>
  681. Community
  682. </label>
  683. <ul class="md-nav__list" data-md-scrollfix>
  684. <li class="md-nav__item md-nav__item--nested">
  685. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  686. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  687. Contributing
  688. <span class="md-nav__icon md-icon"></span>
  689. </label>
  690. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  691. <label class="md-nav__title" for="__nav_6_1">
  692. <span class="md-nav__icon md-icon"></span>
  693. Contributing
  694. </label>
  695. <ul class="md-nav__list" data-md-scrollfix>
  696. <li class="md-nav__item">
  697. <a href="../../contributing/devguide/" class="md-nav__link">
  698. Developer guide
  699. </a>
  700. </li>
  701. <li class="md-nav__item">
  702. <a href="../../contributing/process/" class="md-nav__link">
  703. Contributing Process
  704. </a>
  705. </li>
  706. <li class="md-nav__item">
  707. <a href="../../contributing/release/" class="md-nav__link">
  708. Release Process
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../../contributing/coc/" class="md-nav__link">
  713. Code of Conduct
  714. </a>
  715. </li>
  716. <li class="md-nav__item">
  717. <a href="../../contributing/roadmap/" class="md-nav__link">
  718. Roadmap
  719. </a>
  720. </li>
  721. </ul>
  722. </nav>
  723. </li>
  724. <li class="md-nav__item md-nav__item--nested">
  725. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  726. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  727. External Resources
  728. <span class="md-nav__icon md-icon"></span>
  729. </label>
  730. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  731. <label class="md-nav__title" for="__nav_6_2">
  732. <span class="md-nav__icon md-icon"></span>
  733. External Resources
  734. </label>
  735. <ul class="md-nav__list" data-md-scrollfix>
  736. <li class="md-nav__item">
  737. <a href="../../eso-talks/" class="md-nav__link">
  738. Talks
  739. </a>
  740. </li>
  741. <li class="md-nav__item">
  742. <a href="../../eso-demos/" class="md-nav__link">
  743. Demos
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../../eso-blogs/" class="md-nav__link">
  748. Blogs
  749. </a>
  750. </li>
  751. </ul>
  752. </nav>
  753. </li>
  754. </ul>
  755. </nav>
  756. </li>
  757. </ul>
  758. </nav>
  759. </div>
  760. </div>
  761. </div>
  762. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  763. <div class="md-sidebar__scrollwrap">
  764. <div class="md-sidebar__inner">
  765. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  766. <label class="md-nav__title" for="__toc">
  767. <span class="md-nav__icon md-icon"></span>
  768. Table of contents
  769. </label>
  770. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  771. <li class="md-nav__item">
  772. <a href="#overview" class="md-nav__link">
  773. Overview
  774. </a>
  775. <nav class="md-nav" aria-label="Overview">
  776. <ul class="md-nav__list">
  777. <li class="md-nav__item">
  778. <a href="#tls-bootstrap" class="md-nav__link">
  779. TLS Bootstrap
  780. </a>
  781. </li>
  782. </ul>
  783. </nav>
  784. </li>
  785. </ul>
  786. </nav>
  787. </div>
  788. </div>
  789. </div>
  790. <div class="md-content" data-md-component="content">
  791. <article class="md-content__inner md-typeset">
  792. <h1 id="components">Components</h1>
  793. <h2 id="overview">Overview</h2>
  794. <p>Exernal Secrets comes with three components: <code>Core Controller</code>, <code>Webhook</code> and <code>Cert Controller</code>.</p>
  795. <p>This is due to the need to implement conversion webhooks in order to convert custom resources between api versions and
  796. to provide a ValidatingWebhook for the <code>ExternalSecret</code> and <code>SecretStore</code> resources.</p>
  797. <p>These features are optional but highly recommended. You can disable them with helm chart values <code>certController.create=false</code> and <code>webhook.create=false</code>.</p>
  798. <p><br/>
  799. <img alt="Component Overview" src="../../pictures/diagrams-component-overview.png" /></p>
  800. <h3 id="tls-bootstrap">TLS Bootstrap</h3>
  801. <p>Cert-controller is responsible for (1) generating TLS credentials which will be used by the webhook component and (2) injecting the certificate as <code>caBundle</code> into <code>Kind=CustomResourceDefinition</code> for conversion webhooks and <code>Kind=ValidatingWebhookConfiguration</code> for validating admission webhook. The TLS credentials are stored in a <code>Kind=Secret</code> which is consumed by the webhook.</p>
  802. <p><img alt="" src="../../pictures/eso-threat-model-TLS%20Bootstrap.drawio.png" style="width:70%;" /></p>
  803. </article>
  804. </div>
  805. </div>
  806. </main>
  807. <footer class="md-footer">
  808. <div class="md-footer-meta md-typeset">
  809. <div class="md-footer-meta__inner md-grid">
  810. <div class="md-copyright">
  811. <div class="md-copyright__highlight">
  812. &copy; 2023 The external-secrets Authors.<br/>
  813. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  814. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  815. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  816. </div>
  817. Made with
  818. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  819. Material for MkDocs
  820. </a>
  821. </div>
  822. </div>
  823. </div>
  824. </footer>
  825. </div>
  826. <div class="md-dialog" data-md-component="dialog">
  827. <div class="md-dialog__inner md-typeset"></div>
  828. </div>
  829. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  830. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  831. </body>
  832. </html>