index.html 53 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059
  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.5.3, mkdocs-material-9.5.7">
  10. <title>Components - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.f2e4d321.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. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#components" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <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>
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. Components
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  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.5.1 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 md-tabs__item--active">
  116. <a href="./" class="md-tabs__link">
  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.5.1 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--section 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__container">
  169. <a href="../.." class="md-nav__link ">
  170. <span class="md-ellipsis">
  171. Introduction
  172. </span>
  173. </a>
  174. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
  175. <span class="md-nav__icon md-icon"></span>
  176. </label>
  177. </div>
  178. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  179. <label class="md-nav__title" for="__nav_1">
  180. <span class="md-nav__icon md-icon"></span>
  181. Introduction
  182. </label>
  183. <ul class="md-nav__list" data-md-scrollfix>
  184. <li class="md-nav__item">
  185. <a href="../../introduction/overview/" class="md-nav__link">
  186. <span class="md-ellipsis">
  187. Overview
  188. </span>
  189. </a>
  190. </li>
  191. <li class="md-nav__item">
  192. <a href="../../introduction/getting-started/" class="md-nav__link">
  193. <span class="md-ellipsis">
  194. Getting started
  195. </span>
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/faq/" class="md-nav__link">
  200. <span class="md-ellipsis">
  201. FAQ
  202. </span>
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../../introduction/stability-support/" class="md-nav__link">
  207. <span class="md-ellipsis">
  208. Stability and Support
  209. </span>
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  214. <span class="md-ellipsis">
  215. Deprecation Policy
  216. </span>
  217. </a>
  218. </li>
  219. </ul>
  220. </nav>
  221. </li>
  222. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  223. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  224. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  225. <span class="md-ellipsis">
  226. API
  227. </span>
  228. <span class="md-nav__icon md-icon"></span>
  229. </label>
  230. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  231. <label class="md-nav__title" for="__nav_2">
  232. <span class="md-nav__icon md-icon"></span>
  233. API
  234. </label>
  235. <ul class="md-nav__list" data-md-scrollfix>
  236. <li class="md-nav__item md-nav__item--active">
  237. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  238. <label class="md-nav__link md-nav__link--active" for="__toc">
  239. <span class="md-ellipsis">
  240. Components
  241. </span>
  242. <span class="md-nav__icon md-icon"></span>
  243. </label>
  244. <a href="./" class="md-nav__link md-nav__link--active">
  245. <span class="md-ellipsis">
  246. Components
  247. </span>
  248. </a>
  249. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  250. <label class="md-nav__title" for="__toc">
  251. <span class="md-nav__icon md-icon"></span>
  252. Table of contents
  253. </label>
  254. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  255. <li class="md-nav__item">
  256. <a href="#overview" class="md-nav__link">
  257. <span class="md-ellipsis">
  258. Overview
  259. </span>
  260. </a>
  261. <nav class="md-nav" aria-label="Overview">
  262. <ul class="md-nav__list">
  263. <li class="md-nav__item">
  264. <a href="#tls-bootstrap" class="md-nav__link">
  265. <span class="md-ellipsis">
  266. TLS Bootstrap
  267. </span>
  268. </a>
  269. </li>
  270. </ul>
  271. </nav>
  272. </li>
  273. </ul>
  274. </nav>
  275. </li>
  276. <li class="md-nav__item md-nav__item--nested">
  277. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  278. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  279. <span class="md-ellipsis">
  280. Core Resources
  281. </span>
  282. <span class="md-nav__icon md-icon"></span>
  283. </label>
  284. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  285. <label class="md-nav__title" for="__nav_2_2">
  286. <span class="md-nav__icon md-icon"></span>
  287. Core Resources
  288. </label>
  289. <ul class="md-nav__list" data-md-scrollfix>
  290. <li class="md-nav__item">
  291. <a href="../externalsecret/" class="md-nav__link">
  292. <span class="md-ellipsis">
  293. ExternalSecret
  294. </span>
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../secretstore/" class="md-nav__link">
  299. <span class="md-ellipsis">
  300. SecretStore
  301. </span>
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="../clustersecretstore/" class="md-nav__link">
  306. <span class="md-ellipsis">
  307. ClusterSecretStore
  308. </span>
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../clusterexternalsecret/" class="md-nav__link">
  313. <span class="md-ellipsis">
  314. ClusterExternalSecret
  315. </span>
  316. </a>
  317. </li>
  318. <li class="md-nav__item">
  319. <a href="../pushsecret/" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. PushSecret
  322. </span>
  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 md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  330. <div class="md-nav__link md-nav__container">
  331. <a href="../generator/" class="md-nav__link ">
  332. <span class="md-ellipsis">
  333. Generators
  334. </span>
  335. </a>
  336. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  337. <span class="md-nav__icon md-icon"></span>
  338. </label>
  339. </div>
  340. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  341. <label class="md-nav__title" for="__nav_2_3">
  342. <span class="md-nav__icon md-icon"></span>
  343. Generators
  344. </label>
  345. <ul class="md-nav__list" data-md-scrollfix>
  346. <li class="md-nav__item">
  347. <a href="../generator/acr/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. Azure Container Registry
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../generator/ecr/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. AWS Elastic Container Registry
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../generator/gcr/" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. Google Container Registry
  364. </span>
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../generator/vault/" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. Vault Dynamic Secret
  371. </span>
  372. </a>
  373. </li>
  374. <li class="md-nav__item">
  375. <a href="../generator/password/" class="md-nav__link">
  376. <span class="md-ellipsis">
  377. Password
  378. </span>
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="../generator/fake/" class="md-nav__link">
  383. <span class="md-ellipsis">
  384. Fake
  385. </span>
  386. </a>
  387. </li>
  388. </ul>
  389. </nav>
  390. </li>
  391. <li class="md-nav__item md-nav__item--nested">
  392. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  393. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  394. <span class="md-ellipsis">
  395. Reference Docs
  396. </span>
  397. <span class="md-nav__icon md-icon"></span>
  398. </label>
  399. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  400. <label class="md-nav__title" for="__nav_2_4">
  401. <span class="md-nav__icon md-icon"></span>
  402. Reference Docs
  403. </label>
  404. <ul class="md-nav__list" data-md-scrollfix>
  405. <li class="md-nav__item">
  406. <a href="../spec/" class="md-nav__link">
  407. <span class="md-ellipsis">
  408. API specification
  409. </span>
  410. </a>
  411. </li>
  412. <li class="md-nav__item">
  413. <a href="../controller-options/" class="md-nav__link">
  414. <span class="md-ellipsis">
  415. Controller Options
  416. </span>
  417. </a>
  418. </li>
  419. <li class="md-nav__item">
  420. <a href="../metrics/" class="md-nav__link">
  421. <span class="md-ellipsis">
  422. Metrics
  423. </span>
  424. </a>
  425. </li>
  426. </ul>
  427. </nav>
  428. </li>
  429. </ul>
  430. </nav>
  431. </li>
  432. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  433. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  434. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  435. <span class="md-ellipsis">
  436. Guides
  437. </span>
  438. <span class="md-nav__icon md-icon"></span>
  439. </label>
  440. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  441. <label class="md-nav__title" for="__nav_3">
  442. <span class="md-nav__icon md-icon"></span>
  443. Guides
  444. </label>
  445. <ul class="md-nav__list" data-md-scrollfix>
  446. <li class="md-nav__item">
  447. <a href="../../guides/introduction/" class="md-nav__link">
  448. <span class="md-ellipsis">
  449. Introduction
  450. </span>
  451. </a>
  452. </li>
  453. <li class="md-nav__item md-nav__item--nested">
  454. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  455. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  456. <span class="md-ellipsis">
  457. External Secrets
  458. </span>
  459. <span class="md-nav__icon md-icon"></span>
  460. </label>
  461. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  462. <label class="md-nav__title" for="__nav_3_2">
  463. <span class="md-nav__icon md-icon"></span>
  464. External Secrets
  465. </label>
  466. <ul class="md-nav__list" data-md-scrollfix>
  467. <li class="md-nav__item">
  468. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  469. <span class="md-ellipsis">
  470. Extract structured data
  471. </span>
  472. </a>
  473. </li>
  474. <li class="md-nav__item">
  475. <a href="../../guides/getallsecrets/" class="md-nav__link">
  476. <span class="md-ellipsis">
  477. Find Secrets by Name or Metadata
  478. </span>
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. Rewriting Keys
  485. </span>
  486. </a>
  487. </li>
  488. <li class="md-nav__item md-nav__item--nested">
  489. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  490. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  491. <span class="md-ellipsis">
  492. Advanced Templating
  493. </span>
  494. <span class="md-nav__icon md-icon"></span>
  495. </label>
  496. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  497. <label class="md-nav__title" for="__nav_3_2_4">
  498. <span class="md-nav__icon md-icon"></span>
  499. Advanced Templating
  500. </label>
  501. <ul class="md-nav__list" data-md-scrollfix>
  502. <li class="md-nav__item">
  503. <a href="../../guides/templating/" class="md-nav__link">
  504. <span class="md-ellipsis">
  505. v2
  506. </span>
  507. </a>
  508. </li>
  509. <li class="md-nav__item">
  510. <a href="../../guides/templating-v1/" class="md-nav__link">
  511. <span class="md-ellipsis">
  512. v1
  513. </span>
  514. </a>
  515. </li>
  516. </ul>
  517. </nav>
  518. </li>
  519. <li class="md-nav__item">
  520. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  521. <span class="md-ellipsis">
  522. Kubernetes Secret Types
  523. </span>
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  528. <span class="md-ellipsis">
  529. Lifecycle: ownership & deletion
  530. </span>
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  535. <span class="md-ellipsis">
  536. Decoding Strategies
  537. </span>
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../../guides/controller-class/" class="md-nav__link">
  542. <span class="md-ellipsis">
  543. Controller Classes
  544. </span>
  545. </a>
  546. </li>
  547. </ul>
  548. </nav>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../guides/generator/" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. Generators
  554. </span>
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="../../guides/pushsecrets/" class="md-nav__link">
  559. <span class="md-ellipsis">
  560. Push Secrets
  561. </span>
  562. </a>
  563. </li>
  564. <li class="md-nav__item md-nav__item--nested">
  565. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  566. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  567. <span class="md-ellipsis">
  568. Operations
  569. </span>
  570. <span class="md-nav__icon md-icon"></span>
  571. </label>
  572. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  573. <label class="md-nav__title" for="__nav_3_5">
  574. <span class="md-nav__icon md-icon"></span>
  575. Operations
  576. </label>
  577. <ul class="md-nav__list" data-md-scrollfix>
  578. <li class="md-nav__item">
  579. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. Multi Tenancy
  582. </span>
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../guides/security-best-practices/" class="md-nav__link">
  587. <span class="md-ellipsis">
  588. Security Best Practices
  589. </span>
  590. </a>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../guides/threat-model/" class="md-nav__link">
  594. <span class="md-ellipsis">
  595. Threat Model
  596. </span>
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="../../guides/v1beta1/" class="md-nav__link">
  601. <span class="md-ellipsis">
  602. Upgrading to v1beta1
  603. </span>
  604. </a>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="../../guides/using-latest-image/" class="md-nav__link">
  608. <span class="md-ellipsis">
  609. Using Latest Image
  610. </span>
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  615. <span class="md-ellipsis">
  616. Disable Cluster Features
  617. </span>
  618. </a>
  619. </li>
  620. </ul>
  621. </nav>
  622. </li>
  623. </ul>
  624. </nav>
  625. </li>
  626. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  627. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  628. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  629. <span class="md-ellipsis">
  630. Provider
  631. </span>
  632. <span class="md-nav__icon md-icon"></span>
  633. </label>
  634. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  635. <label class="md-nav__title" for="__nav_4">
  636. <span class="md-nav__icon md-icon"></span>
  637. Provider
  638. </label>
  639. <ul class="md-nav__list" data-md-scrollfix>
  640. <li class="md-nav__item">
  641. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. AWS Secrets Manager
  644. </span>
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  649. <span class="md-ellipsis">
  650. AWS Parameter Store
  651. </span>
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. Azure Key Vault
  658. </span>
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../../provider/chef/" class="md-nav__link">
  663. <span class="md-ellipsis">
  664. Chef
  665. </span>
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../provider/conjur/" class="md-nav__link">
  670. <span class="md-ellipsis">
  671. CyberArk Conjur
  672. </span>
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. Google Cloud Secret Manager
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. HashiCorp Vault
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../provider/kubernetes/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Kubernetes
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. IBM Secrets Manager
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../provider/akeyless/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. Akeyless
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Yandex Certificate Manager
  714. </span>
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  719. <span class="md-ellipsis">
  720. Yandex Lockbox
  721. </span>
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../provider/alibaba/" class="md-nav__link">
  726. <span class="md-ellipsis">
  727. Alibaba Cloud
  728. </span>
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. GitLab Variables
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../provider/oracle-vault/" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. Oracle Vault
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/1password-automation/" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. 1Password Secrets Automation
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../provider/webhook/" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. Webhook
  756. </span>
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="../../provider/fake/" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. Fake
  763. </span>
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. senhasegura DevOps Secrets Management (DSM)
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../provider/doppler/" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Doppler
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../provider/keeper-security/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Keeper Security
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../provider/cloak/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. Cloak End 2 End Encrypted Secrets
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../provider/scaleway/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. Scaleway
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../../provider/delinea/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. Delinea
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../../provider/pulumi/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. Pulumi ESC
  812. </span>
  813. </a>
  814. </li>
  815. </ul>
  816. </nav>
  817. </li>
  818. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  819. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  820. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
  821. <span class="md-ellipsis">
  822. Examples
  823. </span>
  824. <span class="md-nav__icon md-icon"></span>
  825. </label>
  826. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  827. <label class="md-nav__title" for="__nav_5">
  828. <span class="md-nav__icon md-icon"></span>
  829. Examples
  830. </label>
  831. <ul class="md-nav__list" data-md-scrollfix>
  832. <li class="md-nav__item">
  833. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  834. <span class="md-ellipsis">
  835. FluxCD
  836. </span>
  837. </a>
  838. </li>
  839. <li class="md-nav__item">
  840. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  841. <span class="md-ellipsis">
  842. Anchore Engine
  843. </span>
  844. </a>
  845. </li>
  846. <li class="md-nav__item">
  847. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  848. <span class="md-ellipsis">
  849. Jenkins
  850. </span>
  851. </a>
  852. </li>
  853. <li class="md-nav__item">
  854. <a href="../../examples/bitwarden/" class="md-nav__link">
  855. <span class="md-ellipsis">
  856. BitWarden
  857. </span>
  858. </a>
  859. </li>
  860. </ul>
  861. </nav>
  862. </li>
  863. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  864. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  865. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  866. <span class="md-ellipsis">
  867. Community
  868. </span>
  869. <span class="md-nav__icon md-icon"></span>
  870. </label>
  871. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  872. <label class="md-nav__title" for="__nav_6">
  873. <span class="md-nav__icon md-icon"></span>
  874. Community
  875. </label>
  876. <ul class="md-nav__list" data-md-scrollfix>
  877. <li class="md-nav__item md-nav__item--nested">
  878. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  879. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  880. <span class="md-ellipsis">
  881. Contributing
  882. </span>
  883. <span class="md-nav__icon md-icon"></span>
  884. </label>
  885. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  886. <label class="md-nav__title" for="__nav_6_1">
  887. <span class="md-nav__icon md-icon"></span>
  888. Contributing
  889. </label>
  890. <ul class="md-nav__list" data-md-scrollfix>
  891. <li class="md-nav__item">
  892. <a href="../../contributing/devguide/" class="md-nav__link">
  893. <span class="md-ellipsis">
  894. Developer guide
  895. </span>
  896. </a>
  897. </li>
  898. <li class="md-nav__item">
  899. <a href="../../contributing/process/" class="md-nav__link">
  900. <span class="md-ellipsis">
  901. Contributing Process
  902. </span>
  903. </a>
  904. </li>
  905. <li class="md-nav__item">
  906. <a href="../../contributing/release/" class="md-nav__link">
  907. <span class="md-ellipsis">
  908. Release Process
  909. </span>
  910. </a>
  911. </li>
  912. <li class="md-nav__item">
  913. <a href="../../contributing/coc/" class="md-nav__link">
  914. <span class="md-ellipsis">
  915. Code of Conduct
  916. </span>
  917. </a>
  918. </li>
  919. <li class="md-nav__item">
  920. <a href="../../contributing/roadmap/" class="md-nav__link">
  921. <span class="md-ellipsis">
  922. Roadmap
  923. </span>
  924. </a>
  925. </li>
  926. </ul>
  927. </nav>
  928. </li>
  929. <li class="md-nav__item md-nav__item--nested">
  930. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  931. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  932. <span class="md-ellipsis">
  933. External Resources
  934. </span>
  935. <span class="md-nav__icon md-icon"></span>
  936. </label>
  937. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  938. <label class="md-nav__title" for="__nav_6_2">
  939. <span class="md-nav__icon md-icon"></span>
  940. External Resources
  941. </label>
  942. <ul class="md-nav__list" data-md-scrollfix>
  943. <li class="md-nav__item">
  944. <a href="../../eso-talks/" class="md-nav__link">
  945. <span class="md-ellipsis">
  946. Talks
  947. </span>
  948. </a>
  949. </li>
  950. <li class="md-nav__item">
  951. <a href="../../eso-demos/" class="md-nav__link">
  952. <span class="md-ellipsis">
  953. Demos
  954. </span>
  955. </a>
  956. </li>
  957. <li class="md-nav__item">
  958. <a href="../../eso-blogs/" class="md-nav__link">
  959. <span class="md-ellipsis">
  960. Blogs
  961. </span>
  962. </a>
  963. </li>
  964. </ul>
  965. </nav>
  966. </li>
  967. </ul>
  968. </nav>
  969. </li>
  970. </ul>
  971. </nav>
  972. </div>
  973. </div>
  974. </div>
  975. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  976. <div class="md-sidebar__scrollwrap">
  977. <div class="md-sidebar__inner">
  978. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  979. <label class="md-nav__title" for="__toc">
  980. <span class="md-nav__icon md-icon"></span>
  981. Table of contents
  982. </label>
  983. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  984. <li class="md-nav__item">
  985. <a href="#overview" class="md-nav__link">
  986. <span class="md-ellipsis">
  987. Overview
  988. </span>
  989. </a>
  990. <nav class="md-nav" aria-label="Overview">
  991. <ul class="md-nav__list">
  992. <li class="md-nav__item">
  993. <a href="#tls-bootstrap" class="md-nav__link">
  994. <span class="md-ellipsis">
  995. TLS Bootstrap
  996. </span>
  997. </a>
  998. </li>
  999. </ul>
  1000. </nav>
  1001. </li>
  1002. </ul>
  1003. </nav>
  1004. </div>
  1005. </div>
  1006. </div>
  1007. <div class="md-content" data-md-component="content">
  1008. <article class="md-content__inner md-typeset">
  1009. <h1 id="components">Components</h1>
  1010. <h2 id="overview">Overview</h2>
  1011. <p>Exernal Secrets comes with three components: <code>Core Controller</code>, <code>Webhook</code> and <code>Cert Controller</code>.</p>
  1012. <p>This is due to the need to implement conversion webhooks in order to convert custom resources between api versions and
  1013. to provide a ValidatingWebhook for the <code>ExternalSecret</code> and <code>SecretStore</code> resources.</p>
  1014. <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>
  1015. <p><br/>
  1016. <img alt="Component Overview" src="../../pictures/diagrams-component-overview.png" /></p>
  1017. <h3 id="tls-bootstrap">TLS Bootstrap</h3>
  1018. <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>
  1019. <p><img alt="" src="../../pictures/eso-threat-model-TLS%20Bootstrap.drawio.png" style="width:70%;" /></p>
  1020. </article>
  1021. </div>
  1022. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1023. </div>
  1024. </main>
  1025. <footer class="md-footer">
  1026. <div class="md-footer-meta md-typeset">
  1027. <div class="md-footer-meta__inner md-grid">
  1028. <div class="md-copyright">
  1029. <div class="md-copyright__highlight">
  1030. &copy; 2023 The external-secrets Authors.<br/>
  1031. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1032. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1033. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1034. </div>
  1035. Made with
  1036. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1037. Material for MkDocs
  1038. </a>
  1039. </div>
  1040. </div>
  1041. </div>
  1042. </footer>
  1043. </div>
  1044. <div class="md-dialog" data-md-component="dialog">
  1045. <div class="md-dialog__inner md-typeset"></div>
  1046. </div>
  1047. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.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>
  1048. <script src="../../assets/javascripts/bundle.caa56a14.min.js"></script>
  1049. </body>
  1050. </html>