index.html 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169
  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. </li>
  240. </ul>
  241. </nav>
  242. </li>
  243. <li class="md-nav__item md-nav__item--nested">
  244. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  245. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  246. Core Resources
  247. <span class="md-nav__icon md-icon"></span>
  248. </label>
  249. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  250. <label class="md-nav__title" for="__nav_2_2">
  251. <span class="md-nav__icon md-icon"></span>
  252. Core Resources
  253. </label>
  254. <ul class="md-nav__list" data-md-scrollfix>
  255. <li class="md-nav__item">
  256. <a href="../externalsecret/" class="md-nav__link">
  257. ExternalSecret
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../secretstore/" class="md-nav__link">
  262. SecretStore
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="../clustersecretstore/" class="md-nav__link">
  267. ClusterSecretStore
  268. </a>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="../clusterexternalsecret/" class="md-nav__link">
  272. ClusterExternalSecret
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../pushsecret/" class="md-nav__link">
  277. PushSecret
  278. </a>
  279. </li>
  280. </ul>
  281. </nav>
  282. </li>
  283. <li class="md-nav__item md-nav__item--nested">
  284. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  285. <div class="md-nav__link md-nav__link--index ">
  286. <a href="../generator/">Generators</a>
  287. <label for="__nav_2_3">
  288. <span class="md-nav__icon md-icon"></span>
  289. </label>
  290. </div>
  291. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  292. <label class="md-nav__title" for="__nav_2_3">
  293. <span class="md-nav__icon md-icon"></span>
  294. Generators
  295. </label>
  296. <ul class="md-nav__list" data-md-scrollfix>
  297. <li class="md-nav__item">
  298. <a href="../generator/acr/" class="md-nav__link">
  299. Azure Container Registry
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../generator/ecr/" class="md-nav__link">
  304. AWS Elastic Container Registry
  305. </a>
  306. </li>
  307. <li class="md-nav__item">
  308. <a href="../generator/gcr/" class="md-nav__link">
  309. Google Container Registry
  310. </a>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="../generator/vault/" class="md-nav__link">
  314. Vault Dynamic Secret
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../generator/password/" class="md-nav__link">
  319. Password
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../generator/fake/" class="md-nav__link">
  324. Fake
  325. </a>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. <li class="md-nav__item md-nav__item--nested">
  331. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  332. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  333. Reference Docs
  334. <span class="md-nav__icon md-icon"></span>
  335. </label>
  336. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  337. <label class="md-nav__title" for="__nav_2_4">
  338. <span class="md-nav__icon md-icon"></span>
  339. Reference Docs
  340. </label>
  341. <ul class="md-nav__list" data-md-scrollfix>
  342. <li class="md-nav__item">
  343. <a href="../spec/" class="md-nav__link">
  344. API specification
  345. </a>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="../controller-options/" class="md-nav__link">
  349. Controller Options
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../metrics/" class="md-nav__link">
  354. Metrics
  355. </a>
  356. </li>
  357. </ul>
  358. </nav>
  359. </li>
  360. </ul>
  361. </nav>
  362. </li>
  363. <li class="md-nav__item md-nav__item--nested">
  364. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  365. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  366. Guides
  367. <span class="md-nav__icon md-icon"></span>
  368. </label>
  369. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  370. <label class="md-nav__title" for="__nav_3">
  371. <span class="md-nav__icon md-icon"></span>
  372. Guides
  373. </label>
  374. <ul class="md-nav__list" data-md-scrollfix>
  375. <li class="md-nav__item">
  376. <a href="../../guides/introduction/" class="md-nav__link">
  377. Introduction
  378. </a>
  379. </li>
  380. <li class="md-nav__item md-nav__item--nested">
  381. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  382. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  383. External Secrets
  384. <span class="md-nav__icon md-icon"></span>
  385. </label>
  386. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  387. <label class="md-nav__title" for="__nav_3_2">
  388. <span class="md-nav__icon md-icon"></span>
  389. External Secrets
  390. </label>
  391. <ul class="md-nav__list" data-md-scrollfix>
  392. <li class="md-nav__item">
  393. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  394. Extract structured data
  395. </a>
  396. </li>
  397. <li class="md-nav__item">
  398. <a href="../../guides/getallsecrets/" class="md-nav__link">
  399. Find Secrets by Name or Metadata
  400. </a>
  401. </li>
  402. <li class="md-nav__item">
  403. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  404. Rewriting Keys
  405. </a>
  406. </li>
  407. <li class="md-nav__item md-nav__item--nested">
  408. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  409. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  410. Advanced Templating
  411. <span class="md-nav__icon md-icon"></span>
  412. </label>
  413. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  414. <label class="md-nav__title" for="__nav_3_2_4">
  415. <span class="md-nav__icon md-icon"></span>
  416. Advanced Templating
  417. </label>
  418. <ul class="md-nav__list" data-md-scrollfix>
  419. <li class="md-nav__item">
  420. <a href="../../guides/templating/" class="md-nav__link">
  421. v2
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="../../guides/templating-v1/" class="md-nav__link">
  426. v1
  427. </a>
  428. </li>
  429. </ul>
  430. </nav>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  434. Kubernetes Secret Types
  435. </a>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  439. Lifecycle: ownership & deletion
  440. </a>
  441. </li>
  442. <li class="md-nav__item">
  443. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  444. Decoding Strategies
  445. </a>
  446. </li>
  447. <li class="md-nav__item">
  448. <a href="../../guides/controller-class/" class="md-nav__link">
  449. Controller Classes
  450. </a>
  451. </li>
  452. </ul>
  453. </nav>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../../guides/generator/" class="md-nav__link">
  457. Generators
  458. </a>
  459. </li>
  460. <li class="md-nav__item md-nav__item--nested">
  461. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
  462. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  463. Operations
  464. <span class="md-nav__icon md-icon"></span>
  465. </label>
  466. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
  467. <label class="md-nav__title" for="__nav_3_4">
  468. <span class="md-nav__icon md-icon"></span>
  469. Operations
  470. </label>
  471. <ul class="md-nav__list" data-md-scrollfix>
  472. <li class="md-nav__item">
  473. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  474. Multi Tenancy
  475. </a>
  476. </li>
  477. <li class="md-nav__item">
  478. <a href="../../guides/security-best-practices/" class="md-nav__link">
  479. Security Best Practices
  480. </a>
  481. </li>
  482. <li class="md-nav__item">
  483. <a href="../../guides/v1beta1/" class="md-nav__link">
  484. Upgrading to v1beta1
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../../guides/using-latest-image/" class="md-nav__link">
  489. Using Latest Image
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  494. Disable Cluster Features
  495. </a>
  496. </li>
  497. </ul>
  498. </nav>
  499. </li>
  500. </ul>
  501. </nav>
  502. </li>
  503. <li class="md-nav__item md-nav__item--nested">
  504. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  505. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  506. Provider
  507. <span class="md-nav__icon md-icon"></span>
  508. </label>
  509. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  510. <label class="md-nav__title" for="__nav_4">
  511. <span class="md-nav__icon md-icon"></span>
  512. Provider
  513. </label>
  514. <ul class="md-nav__list" data-md-scrollfix>
  515. <li class="md-nav__item">
  516. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  517. AWS Secrets Manager
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  522. AWS Parameter Store
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  527. Azure Key Vault
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  532. Google Cloud Secret Manager
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  537. HashiCorp Vault
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../../provider/kubernetes/" class="md-nav__link">
  542. Kubernetes
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  547. IBM Secrets Manager
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../provider/akeyless/" class="md-nav__link">
  552. Akeyless
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  557. Yandex Certificate Manager
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  562. Yandex Lockbox
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="../../provider/alibaba/" class="md-nav__link">
  567. Alibaba Cloud
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  572. GitLab Variables
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../provider/oracle-vault/" class="md-nav__link">
  577. Oracle Vault
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../provider/1password-automation/" class="md-nav__link">
  582. 1Password Secrets Automation
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../provider/webhook/" class="md-nav__link">
  587. Webhook
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="../../provider/fake/" class="md-nav__link">
  592. Fake
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  597. senhasegura DevOps Secrets Management (DSM)
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../../provider/doppler/" class="md-nav__link">
  602. Doppler
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../provider/keeper-security/" class="md-nav__link">
  607. Keeper Security
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../../provider/scaleway/" class="md-nav__link">
  612. Scaleway
  613. </a>
  614. </li>
  615. </ul>
  616. </nav>
  617. </li>
  618. <li class="md-nav__item md-nav__item--nested">
  619. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  620. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  621. Examples
  622. <span class="md-nav__icon md-icon"></span>
  623. </label>
  624. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  625. <label class="md-nav__title" for="__nav_5">
  626. <span class="md-nav__icon md-icon"></span>
  627. Examples
  628. </label>
  629. <ul class="md-nav__list" data-md-scrollfix>
  630. <li class="md-nav__item">
  631. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  632. FluxCD
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  637. Anchore Engine
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  642. Jenkins
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="../../examples/bitwarden/" class="md-nav__link">
  647. BitWarden
  648. </a>
  649. </li>
  650. </ul>
  651. </nav>
  652. </li>
  653. <li class="md-nav__item md-nav__item--nested">
  654. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  655. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  656. Community
  657. <span class="md-nav__icon md-icon"></span>
  658. </label>
  659. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  660. <label class="md-nav__title" for="__nav_6">
  661. <span class="md-nav__icon md-icon"></span>
  662. Community
  663. </label>
  664. <ul class="md-nav__list" data-md-scrollfix>
  665. <li class="md-nav__item md-nav__item--nested">
  666. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  667. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  668. Contributing
  669. <span class="md-nav__icon md-icon"></span>
  670. </label>
  671. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  672. <label class="md-nav__title" for="__nav_6_1">
  673. <span class="md-nav__icon md-icon"></span>
  674. Contributing
  675. </label>
  676. <ul class="md-nav__list" data-md-scrollfix>
  677. <li class="md-nav__item">
  678. <a href="../../contributing/devguide/" class="md-nav__link">
  679. Developer guide
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../contributing/process/" class="md-nav__link">
  684. Contributing Process
  685. </a>
  686. </li>
  687. <li class="md-nav__item">
  688. <a href="../../contributing/release/" class="md-nav__link">
  689. Release Process
  690. </a>
  691. </li>
  692. <li class="md-nav__item">
  693. <a href="../../contributing/coc/" class="md-nav__link">
  694. Code of Conduct
  695. </a>
  696. </li>
  697. <li class="md-nav__item">
  698. <a href="../../contributing/roadmap/" class="md-nav__link">
  699. Roadmap
  700. </a>
  701. </li>
  702. </ul>
  703. </nav>
  704. </li>
  705. <li class="md-nav__item md-nav__item--nested">
  706. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  707. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  708. External Resources
  709. <span class="md-nav__icon md-icon"></span>
  710. </label>
  711. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  712. <label class="md-nav__title" for="__nav_6_2">
  713. <span class="md-nav__icon md-icon"></span>
  714. External Resources
  715. </label>
  716. <ul class="md-nav__list" data-md-scrollfix>
  717. <li class="md-nav__item">
  718. <a href="../../eso-talks/" class="md-nav__link">
  719. Talks
  720. </a>
  721. </li>
  722. <li class="md-nav__item">
  723. <a href="../../eso-demos/" class="md-nav__link">
  724. Demos
  725. </a>
  726. </li>
  727. <li class="md-nav__item">
  728. <a href="../../eso-blogs/" class="md-nav__link">
  729. Blogs
  730. </a>
  731. </li>
  732. </ul>
  733. </nav>
  734. </li>
  735. </ul>
  736. </nav>
  737. </li>
  738. </ul>
  739. </nav>
  740. </div>
  741. </div>
  742. </div>
  743. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  744. <div class="md-sidebar__scrollwrap">
  745. <div class="md-sidebar__inner">
  746. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  747. <label class="md-nav__title" for="__toc">
  748. <span class="md-nav__icon md-icon"></span>
  749. Table of contents
  750. </label>
  751. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  752. <li class="md-nav__item">
  753. <a href="#overview" class="md-nav__link">
  754. Overview
  755. </a>
  756. </li>
  757. </ul>
  758. </nav>
  759. </div>
  760. </div>
  761. </div>
  762. <div class="md-content" data-md-component="content">
  763. <article class="md-content__inner md-typeset">
  764. <h1 id="components">Components</h1>
  765. <h2 id="overview">Overview</h2>
  766. <p>Exernal Secrets comes with three components: <code>Core Controller</code>, <code>Webhook</code> and <code>Cert Controller</code>.</p>
  767. <p>This is due to the need to implement conversion webhooks in order to convert custom resources between api versions and
  768. to provide a ValidatingWebhook for the <code>ExternalSecret</code> and <code>SecretStore</code> resources.</p>
  769. <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>
  770. <p><br/>
  771. <img alt="Component Overview" src="../../pictures/diagrams-component-overview.png" /></p>
  772. </article>
  773. </div>
  774. </div>
  775. </main>
  776. <footer class="md-footer">
  777. <div class="md-footer-meta md-typeset">
  778. <div class="md-footer-meta__inner md-grid">
  779. <div class="md-copyright">
  780. <div class="md-copyright__highlight">
  781. &copy; 2023 The external-secrets Authors.<br/>
  782. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  783. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  784. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  785. </div>
  786. Made with
  787. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  788. Material for MkDocs
  789. </a>
  790. </div>
  791. </div>
  792. </div>
  793. </footer>
  794. </div>
  795. <div class="md-dialog" data-md-component="dialog">
  796. <div class="md-dialog__inner md-typeset"></div>
  797. </div>
  798. <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>
  799. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  800. </body>
  801. </html>