index.html 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>Components - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("../..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#components" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Components
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="./" class="md-tabs__link md-tabs__link--active">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <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>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item md-nav__item--active">
  219. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  220. <label class="md-nav__link md-nav__link--active" for="__toc">
  221. Components
  222. <span class="md-nav__icon md-icon"></span>
  223. </label>
  224. <a href="./" class="md-nav__link md-nav__link--active">
  225. Components
  226. </a>
  227. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  228. <label class="md-nav__title" for="__toc">
  229. <span class="md-nav__icon md-icon"></span>
  230. Table of contents
  231. </label>
  232. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  233. <li class="md-nav__item">
  234. <a href="#overview" class="md-nav__link">
  235. Overview
  236. </a>
  237. </li>
  238. </ul>
  239. </nav>
  240. </li>
  241. <li class="md-nav__item md-nav__item--nested">
  242. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  243. <label class="md-nav__link" for="__nav_2_2">
  244. Core Resources
  245. <span class="md-nav__icon md-icon"></span>
  246. </label>
  247. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  248. <label class="md-nav__title" for="__nav_2_2">
  249. <span class="md-nav__icon md-icon"></span>
  250. Core Resources
  251. </label>
  252. <ul class="md-nav__list" data-md-scrollfix>
  253. <li class="md-nav__item">
  254. <a href="../externalsecret/" class="md-nav__link">
  255. ExternalSecret
  256. </a>
  257. </li>
  258. <li class="md-nav__item">
  259. <a href="../secretstore/" class="md-nav__link">
  260. SecretStore
  261. </a>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="../clustersecretstore/" class="md-nav__link">
  265. ClusterSecretStore
  266. </a>
  267. </li>
  268. <li class="md-nav__item">
  269. <a href="../clusterexternalsecret/" class="md-nav__link">
  270. ClusterExternalSecret
  271. </a>
  272. </li>
  273. <li class="md-nav__item">
  274. <a href="../pushsecret/" class="md-nav__link">
  275. PushSecret
  276. </a>
  277. </li>
  278. </ul>
  279. </nav>
  280. </li>
  281. <li class="md-nav__item md-nav__item--nested">
  282. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  283. <div class="md-nav__link md-nav__link--index ">
  284. <a href="../generator/">Generators</a>
  285. <label for="__nav_2_3">
  286. <span class="md-nav__icon md-icon"></span>
  287. </label>
  288. </div>
  289. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  290. <label class="md-nav__title" for="__nav_2_3">
  291. <span class="md-nav__icon md-icon"></span>
  292. Generators
  293. </label>
  294. <ul class="md-nav__list" data-md-scrollfix>
  295. <li class="md-nav__item">
  296. <a href="../generator/acr/" class="md-nav__link">
  297. Azure Container Registry
  298. </a>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="../generator/ecr/" class="md-nav__link">
  302. AWS Elastic Container Registry
  303. </a>
  304. </li>
  305. <li class="md-nav__item">
  306. <a href="../generator/gcr/" class="md-nav__link">
  307. Google Container Registry
  308. </a>
  309. </li>
  310. <li class="md-nav__item">
  311. <a href="../generator/vault/" class="md-nav__link">
  312. Vault Dynamic Secret
  313. </a>
  314. </li>
  315. <li class="md-nav__item">
  316. <a href="../generator/password/" class="md-nav__link">
  317. Password
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../generator/fake/" class="md-nav__link">
  322. Fake
  323. </a>
  324. </li>
  325. </ul>
  326. </nav>
  327. </li>
  328. <li class="md-nav__item md-nav__item--nested">
  329. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  330. <label class="md-nav__link" for="__nav_2_4">
  331. Reference Docs
  332. <span class="md-nav__icon md-icon"></span>
  333. </label>
  334. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  335. <label class="md-nav__title" for="__nav_2_4">
  336. <span class="md-nav__icon md-icon"></span>
  337. Reference Docs
  338. </label>
  339. <ul class="md-nav__list" data-md-scrollfix>
  340. <li class="md-nav__item">
  341. <a href="../spec/" class="md-nav__link">
  342. API specification
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../controller-options/" class="md-nav__link">
  347. Controller Options
  348. </a>
  349. </li>
  350. <li class="md-nav__item">
  351. <a href="../metrics/" class="md-nav__link">
  352. Metrics
  353. </a>
  354. </li>
  355. </ul>
  356. </nav>
  357. </li>
  358. </ul>
  359. </nav>
  360. </li>
  361. <li class="md-nav__item md-nav__item--nested">
  362. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  363. <label class="md-nav__link" for="__nav_3">
  364. Guides
  365. <span class="md-nav__icon md-icon"></span>
  366. </label>
  367. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  368. <label class="md-nav__title" for="__nav_3">
  369. <span class="md-nav__icon md-icon"></span>
  370. Guides
  371. </label>
  372. <ul class="md-nav__list" data-md-scrollfix>
  373. <li class="md-nav__item">
  374. <a href="../../guides/introduction/" class="md-nav__link">
  375. Introduction
  376. </a>
  377. </li>
  378. <li class="md-nav__item md-nav__item--nested">
  379. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  380. <label class="md-nav__link" for="__nav_3_2">
  381. Advanced Templating
  382. <span class="md-nav__icon md-icon"></span>
  383. </label>
  384. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  385. <label class="md-nav__title" for="__nav_3_2">
  386. <span class="md-nav__icon md-icon"></span>
  387. Advanced Templating
  388. </label>
  389. <ul class="md-nav__list" data-md-scrollfix>
  390. <li class="md-nav__item">
  391. <a href="../../guides/templating/" class="md-nav__link">
  392. v2
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/templating-v1/" class="md-nav__link">
  397. v1
  398. </a>
  399. </li>
  400. </ul>
  401. </nav>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="../../guides/generator/" class="md-nav__link">
  405. Generators
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  410. All keys, One secret
  411. </a>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  415. Common K8S Secret Types
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../guides/controller-class/" class="md-nav__link">
  420. Controller Classes
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  425. Lifecycle: ownership & deletion
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  430. Decoding Strategies
  431. </a>
  432. </li>
  433. <li class="md-nav__item">
  434. <a href="../../guides/getallsecrets/" class="md-nav__link">
  435. Getting Multiple Secrets
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  440. Multi Tenancy
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  445. Rewriting Keys
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../../guides/v1beta1/" class="md-nav__link">
  450. Upgrading to v1beta1
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../guides/using-latest-image/" class="md-nav__link">
  455. Using Latest Image
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  460. Disable Cluster Features
  461. </a>
  462. </li>
  463. </ul>
  464. </nav>
  465. </li>
  466. <li class="md-nav__item md-nav__item--nested">
  467. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  468. <label class="md-nav__link" for="__nav_4">
  469. Provider
  470. <span class="md-nav__icon md-icon"></span>
  471. </label>
  472. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  473. <label class="md-nav__title" for="__nav_4">
  474. <span class="md-nav__icon md-icon"></span>
  475. Provider
  476. </label>
  477. <ul class="md-nav__list" data-md-scrollfix>
  478. <li class="md-nav__item">
  479. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  480. AWS Secrets Manager
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  485. AWS Parameter Store
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  490. Azure Key Vault
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  495. Google Secret Manager
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  500. IBM Secrets Manager
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../provider/akeyless/" class="md-nav__link">
  505. Akeyless
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  510. HashiCorp Vault
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  515. Yandex Certificate Manager
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  520. Yandex Lockbox
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  525. Gitlab Variables
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../provider/oracle-vault/" class="md-nav__link">
  530. Oracle Vault
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../../provider/1password-automation/" class="md-nav__link">
  535. 1Password Secrets Automation
  536. </a>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="../../provider/webhook/" class="md-nav__link">
  540. Webhook
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../provider/fake/" class="md-nav__link">
  545. Fake
  546. </a>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../../provider/kubernetes/" class="md-nav__link">
  550. Kubernetes
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  555. senhasegura DevOps Secrets Management (DSM)
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../provider/doppler/" class="md-nav__link">
  560. Doppler
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="../../provider/keeper-security/" class="md-nav__link">
  565. Keeper Security
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="../../provider/scaleway/" class="md-nav__link">
  570. Scaleway
  571. </a>
  572. </li>
  573. </ul>
  574. </nav>
  575. </li>
  576. <li class="md-nav__item md-nav__item--nested">
  577. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  578. <label class="md-nav__link" for="__nav_5">
  579. Examples
  580. <span class="md-nav__icon md-icon"></span>
  581. </label>
  582. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  583. <label class="md-nav__title" for="__nav_5">
  584. <span class="md-nav__icon md-icon"></span>
  585. Examples
  586. </label>
  587. <ul class="md-nav__list" data-md-scrollfix>
  588. <li class="md-nav__item">
  589. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  590. FluxCD
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  595. Anchore Engine
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  600. Jenkins
  601. </a>
  602. </li>
  603. </ul>
  604. </nav>
  605. </li>
  606. <li class="md-nav__item md-nav__item--nested">
  607. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  608. <label class="md-nav__link" for="__nav_6">
  609. Community
  610. <span class="md-nav__icon md-icon"></span>
  611. </label>
  612. <nav class="md-nav" aria-label="Community" data-md-level="1">
  613. <label class="md-nav__title" for="__nav_6">
  614. <span class="md-nav__icon md-icon"></span>
  615. Community
  616. </label>
  617. <ul class="md-nav__list" data-md-scrollfix>
  618. <li class="md-nav__item md-nav__item--nested">
  619. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  620. <label class="md-nav__link" for="__nav_6_1">
  621. Contributing
  622. <span class="md-nav__icon md-icon"></span>
  623. </label>
  624. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  625. <label class="md-nav__title" for="__nav_6_1">
  626. <span class="md-nav__icon md-icon"></span>
  627. Contributing
  628. </label>
  629. <ul class="md-nav__list" data-md-scrollfix>
  630. <li class="md-nav__item">
  631. <a href="../../contributing/devguide/" class="md-nav__link">
  632. Developer guide
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../contributing/process/" class="md-nav__link">
  637. Contributing Process
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../contributing/release/" class="md-nav__link">
  642. Release Process
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="../../contributing/coc/" class="md-nav__link">
  647. Code of Conduct
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="../../contributing/roadmap/" class="md-nav__link">
  652. Roadmap
  653. </a>
  654. </li>
  655. </ul>
  656. </nav>
  657. </li>
  658. <li class="md-nav__item md-nav__item--nested">
  659. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  660. <label class="md-nav__link" for="__nav_6_2">
  661. External Resources
  662. <span class="md-nav__icon md-icon"></span>
  663. </label>
  664. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  665. <label class="md-nav__title" for="__nav_6_2">
  666. <span class="md-nav__icon md-icon"></span>
  667. External Resources
  668. </label>
  669. <ul class="md-nav__list" data-md-scrollfix>
  670. <li class="md-nav__item">
  671. <a href="../../eso-talks/" class="md-nav__link">
  672. Talks
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../eso-demos/" class="md-nav__link">
  677. Demos
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="../../eso-blogs/" class="md-nav__link">
  682. Blogs
  683. </a>
  684. </li>
  685. </ul>
  686. </nav>
  687. </li>
  688. </ul>
  689. </nav>
  690. </li>
  691. </ul>
  692. </nav>
  693. </div>
  694. </div>
  695. </div>
  696. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  697. <div class="md-sidebar__scrollwrap">
  698. <div class="md-sidebar__inner">
  699. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  700. <label class="md-nav__title" for="__toc">
  701. <span class="md-nav__icon md-icon"></span>
  702. Table of contents
  703. </label>
  704. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  705. <li class="md-nav__item">
  706. <a href="#overview" class="md-nav__link">
  707. Overview
  708. </a>
  709. </li>
  710. </ul>
  711. </nav>
  712. </div>
  713. </div>
  714. </div>
  715. <div class="md-content" data-md-component="content">
  716. <article class="md-content__inner md-typeset">
  717. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/api/components.md" title="Edit this page" class="md-content__button md-icon">
  718. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  719. </a>
  720. <h1 id="components">Components</h1>
  721. <h2 id="overview">Overview</h2>
  722. <p>Exernal Secrets comes with three components: <code>Core Controller</code>, <code>Webhook</code> and <code>Cert Controller</code>.</p>
  723. <p>This is due to the need to implement conversion webhooks in order to convert custom resources between api versions and
  724. to provide a ValidatingWebhook for the <code>ExternalSecret</code> and <code>SecretStore</code> resources.</p>
  725. <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>
  726. <p><br/>
  727. <img alt="Component Overview" src="../../pictures/diagrams-component-overview.png" /></p>
  728. </article>
  729. </div>
  730. </div>
  731. </main>
  732. <footer class="md-footer">
  733. <nav class="md-footer__inner md-grid" aria-label="Footer">
  734. <a href="../../introduction/deprecation-policy/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Deprecation Policy" rel="prev">
  735. <div class="md-footer__button md-icon">
  736. <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>
  737. </div>
  738. <div class="md-footer__title">
  739. <div class="md-ellipsis">
  740. <span class="md-footer__direction">
  741. Previous
  742. </span>
  743. Deprecation Policy
  744. </div>
  745. </div>
  746. </a>
  747. <a href="../externalsecret/" class="md-footer__link md-footer__link--next" aria-label="Next: ExternalSecret" rel="next">
  748. <div class="md-footer__title">
  749. <div class="md-ellipsis">
  750. <span class="md-footer__direction">
  751. Next
  752. </span>
  753. ExternalSecret
  754. </div>
  755. </div>
  756. <div class="md-footer__button md-icon">
  757. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  758. </div>
  759. </a>
  760. </nav>
  761. <div class="md-footer-meta md-typeset">
  762. <div class="md-footer-meta__inner md-grid">
  763. <div class="md-copyright">
  764. <div class="md-copyright__highlight">
  765. &copy; 2023 The external-secrets Authors.<br/>
  766. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  767. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  768. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  769. </div>
  770. Made with
  771. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  772. Material for MkDocs
  773. </a>
  774. </div>
  775. </div>
  776. </div>
  777. </footer>
  778. </div>
  779. <div class="md-dialog" data-md-component="dialog">
  780. <div class="md-dialog__inner md-typeset"></div>
  781. </div>
  782. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  783. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  784. </body>
  785. </html>