index.html 56 KB

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