index.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262
  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/cloak/" class="md-nav__link">
  631. Cloak End 2 End Encrypted Secrets
  632. </a>
  633. </li>
  634. <li class="md-nav__item">
  635. <a href="../../provider/scaleway/" class="md-nav__link">
  636. Scaleway
  637. </a>
  638. </li>
  639. <li class="md-nav__item">
  640. <a href="../../provider/delinea/" class="md-nav__link">
  641. Delinea
  642. </a>
  643. </li>
  644. </ul>
  645. </nav>
  646. </li>
  647. <li class="md-nav__item md-nav__item--nested">
  648. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  649. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  650. Examples
  651. <span class="md-nav__icon md-icon"></span>
  652. </label>
  653. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  654. <label class="md-nav__title" for="__nav_5">
  655. <span class="md-nav__icon md-icon"></span>
  656. Examples
  657. </label>
  658. <ul class="md-nav__list" data-md-scrollfix>
  659. <li class="md-nav__item">
  660. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  661. FluxCD
  662. </a>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  666. Anchore Engine
  667. </a>
  668. </li>
  669. <li class="md-nav__item">
  670. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  671. Jenkins
  672. </a>
  673. </li>
  674. <li class="md-nav__item">
  675. <a href="../../examples/bitwarden/" class="md-nav__link">
  676. BitWarden
  677. </a>
  678. </li>
  679. </ul>
  680. </nav>
  681. </li>
  682. <li class="md-nav__item md-nav__item--nested">
  683. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  684. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  685. Community
  686. <span class="md-nav__icon md-icon"></span>
  687. </label>
  688. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  689. <label class="md-nav__title" for="__nav_6">
  690. <span class="md-nav__icon md-icon"></span>
  691. Community
  692. </label>
  693. <ul class="md-nav__list" data-md-scrollfix>
  694. <li class="md-nav__item md-nav__item--nested">
  695. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  696. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  697. Contributing
  698. <span class="md-nav__icon md-icon"></span>
  699. </label>
  700. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  701. <label class="md-nav__title" for="__nav_6_1">
  702. <span class="md-nav__icon md-icon"></span>
  703. Contributing
  704. </label>
  705. <ul class="md-nav__list" data-md-scrollfix>
  706. <li class="md-nav__item">
  707. <a href="../../contributing/devguide/" class="md-nav__link">
  708. Developer guide
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../../contributing/process/" class="md-nav__link">
  713. Contributing Process
  714. </a>
  715. </li>
  716. <li class="md-nav__item">
  717. <a href="../../contributing/release/" class="md-nav__link">
  718. Release Process
  719. </a>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="../../contributing/coc/" class="md-nav__link">
  723. Code of Conduct
  724. </a>
  725. </li>
  726. <li class="md-nav__item">
  727. <a href="../../contributing/roadmap/" class="md-nav__link">
  728. Roadmap
  729. </a>
  730. </li>
  731. </ul>
  732. </nav>
  733. </li>
  734. <li class="md-nav__item md-nav__item--nested">
  735. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  736. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  737. External Resources
  738. <span class="md-nav__icon md-icon"></span>
  739. </label>
  740. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  741. <label class="md-nav__title" for="__nav_6_2">
  742. <span class="md-nav__icon md-icon"></span>
  743. External Resources
  744. </label>
  745. <ul class="md-nav__list" data-md-scrollfix>
  746. <li class="md-nav__item">
  747. <a href="../../eso-talks/" class="md-nav__link">
  748. Talks
  749. </a>
  750. </li>
  751. <li class="md-nav__item">
  752. <a href="../../eso-demos/" class="md-nav__link">
  753. Demos
  754. </a>
  755. </li>
  756. <li class="md-nav__item">
  757. <a href="../../eso-blogs/" class="md-nav__link">
  758. Blogs
  759. </a>
  760. </li>
  761. </ul>
  762. </nav>
  763. </li>
  764. </ul>
  765. </nav>
  766. </li>
  767. </ul>
  768. </nav>
  769. </div>
  770. </div>
  771. </div>
  772. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  773. <div class="md-sidebar__scrollwrap">
  774. <div class="md-sidebar__inner">
  775. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  776. <label class="md-nav__title" for="__toc">
  777. <span class="md-nav__icon md-icon"></span>
  778. Table of contents
  779. </label>
  780. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  781. <li class="md-nav__item">
  782. <a href="#overview" class="md-nav__link">
  783. Overview
  784. </a>
  785. <nav class="md-nav" aria-label="Overview">
  786. <ul class="md-nav__list">
  787. <li class="md-nav__item">
  788. <a href="#tls-bootstrap" class="md-nav__link">
  789. TLS Bootstrap
  790. </a>
  791. </li>
  792. </ul>
  793. </nav>
  794. </li>
  795. </ul>
  796. </nav>
  797. </div>
  798. </div>
  799. </div>
  800. <div class="md-content" data-md-component="content">
  801. <article class="md-content__inner md-typeset">
  802. <h1 id="components">Components</h1>
  803. <h2 id="overview">Overview</h2>
  804. <p>Exernal Secrets comes with three components: <code>Core Controller</code>, <code>Webhook</code> and <code>Cert Controller</code>.</p>
  805. <p>This is due to the need to implement conversion webhooks in order to convert custom resources between api versions and
  806. to provide a ValidatingWebhook for the <code>ExternalSecret</code> and <code>SecretStore</code> resources.</p>
  807. <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>
  808. <p><br/>
  809. <img alt="Component Overview" src="../../pictures/diagrams-component-overview.png" /></p>
  810. <h3 id="tls-bootstrap">TLS Bootstrap</h3>
  811. <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>
  812. <p><img alt="" src="../../pictures/eso-threat-model-TLS%20Bootstrap.drawio.png" style="width:70%;" /></p>
  813. </article>
  814. </div>
  815. </div>
  816. </main>
  817. <footer class="md-footer">
  818. <div class="md-footer-meta md-typeset">
  819. <div class="md-footer-meta__inner md-grid">
  820. <div class="md-copyright">
  821. <div class="md-copyright__highlight">
  822. &copy; 2023 The external-secrets Authors.<br/>
  823. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  824. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  825. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  826. </div>
  827. Made with
  828. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  829. Material for MkDocs
  830. </a>
  831. </div>
  832. </div>
  833. </div>
  834. </footer>
  835. </div>
  836. <div class="md-dialog" data-md-component="dialog">
  837. <div class="md-dialog__inner md-typeset"></div>
  838. </div>
  839. <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>
  840. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  841. </body>
  842. </html>