index.html 58 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284
  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="../spec/">
  7. <link rel="next" href="../metrics/">
  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>Controller Options - 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="#controller-options" 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. Controller Options
  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="../components/" 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">
  237. <a href="../components/" class="md-nav__link">
  238. <span class="md-ellipsis">
  239. Components
  240. </span>
  241. </a>
  242. </li>
  243. <li class="md-nav__item md-nav__item--nested">
  244. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  245. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  246. <span class="md-ellipsis">
  247. Core Resources
  248. </span>
  249. <span class="md-nav__icon md-icon"></span>
  250. </label>
  251. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  252. <label class="md-nav__title" for="__nav_2_2">
  253. <span class="md-nav__icon md-icon"></span>
  254. Core Resources
  255. </label>
  256. <ul class="md-nav__list" data-md-scrollfix>
  257. <li class="md-nav__item">
  258. <a href="../externalsecret/" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. ExternalSecret
  261. </span>
  262. </a>
  263. </li>
  264. <li class="md-nav__item">
  265. <a href="../secretstore/" class="md-nav__link">
  266. <span class="md-ellipsis">
  267. SecretStore
  268. </span>
  269. </a>
  270. </li>
  271. <li class="md-nav__item">
  272. <a href="../clustersecretstore/" class="md-nav__link">
  273. <span class="md-ellipsis">
  274. ClusterSecretStore
  275. </span>
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="../clusterexternalsecret/" class="md-nav__link">
  280. <span class="md-ellipsis">
  281. ClusterExternalSecret
  282. </span>
  283. </a>
  284. </li>
  285. <li class="md-nav__item">
  286. <a href="../pushsecret/" class="md-nav__link">
  287. <span class="md-ellipsis">
  288. PushSecret
  289. </span>
  290. </a>
  291. </li>
  292. </ul>
  293. </nav>
  294. </li>
  295. <li class="md-nav__item md-nav__item--nested">
  296. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  297. <div class="md-nav__link md-nav__container">
  298. <a href="../generator/" class="md-nav__link ">
  299. <span class="md-ellipsis">
  300. Generators
  301. </span>
  302. </a>
  303. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  304. <span class="md-nav__icon md-icon"></span>
  305. </label>
  306. </div>
  307. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  308. <label class="md-nav__title" for="__nav_2_3">
  309. <span class="md-nav__icon md-icon"></span>
  310. Generators
  311. </label>
  312. <ul class="md-nav__list" data-md-scrollfix>
  313. <li class="md-nav__item">
  314. <a href="../generator/acr/" class="md-nav__link">
  315. <span class="md-ellipsis">
  316. Azure Container Registry
  317. </span>
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../generator/ecr/" class="md-nav__link">
  322. <span class="md-ellipsis">
  323. AWS Elastic Container Registry
  324. </span>
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../generator/gcr/" class="md-nav__link">
  329. <span class="md-ellipsis">
  330. Google Container Registry
  331. </span>
  332. </a>
  333. </li>
  334. <li class="md-nav__item">
  335. <a href="../generator/vault/" class="md-nav__link">
  336. <span class="md-ellipsis">
  337. Vault Dynamic Secret
  338. </span>
  339. </a>
  340. </li>
  341. <li class="md-nav__item">
  342. <a href="../generator/password/" class="md-nav__link">
  343. <span class="md-ellipsis">
  344. Password
  345. </span>
  346. </a>
  347. </li>
  348. <li class="md-nav__item">
  349. <a href="../generator/fake/" class="md-nav__link">
  350. <span class="md-ellipsis">
  351. Fake
  352. </span>
  353. </a>
  354. </li>
  355. </ul>
  356. </nav>
  357. </li>
  358. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  359. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
  360. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  361. <span class="md-ellipsis">
  362. Reference Docs
  363. </span>
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="true">
  367. <label class="md-nav__title" for="__nav_2_4">
  368. <span class="md-nav__icon md-icon"></span>
  369. Reference Docs
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../spec/" class="md-nav__link">
  374. <span class="md-ellipsis">
  375. API specification
  376. </span>
  377. </a>
  378. </li>
  379. <li class="md-nav__item md-nav__item--active">
  380. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  381. <label class="md-nav__link md-nav__link--active" for="__toc">
  382. <span class="md-ellipsis">
  383. Controller Options
  384. </span>
  385. <span class="md-nav__icon md-icon"></span>
  386. </label>
  387. <a href="./" class="md-nav__link md-nav__link--active">
  388. <span class="md-ellipsis">
  389. Controller Options
  390. </span>
  391. </a>
  392. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  393. <label class="md-nav__title" for="__toc">
  394. <span class="md-nav__icon md-icon"></span>
  395. Table of contents
  396. </label>
  397. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  398. <li class="md-nav__item">
  399. <a href="#core-controller-flags" class="md-nav__link">
  400. <span class="md-ellipsis">
  401. Core Controller Flags
  402. </span>
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="#cert-controller-flags" class="md-nav__link">
  407. <span class="md-ellipsis">
  408. Cert Controller Flags
  409. </span>
  410. </a>
  411. </li>
  412. <li class="md-nav__item">
  413. <a href="#webhook-flags" class="md-nav__link">
  414. <span class="md-ellipsis">
  415. Webhook Flags
  416. </span>
  417. </a>
  418. </li>
  419. </ul>
  420. </nav>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../metrics/" class="md-nav__link">
  424. <span class="md-ellipsis">
  425. Metrics
  426. </span>
  427. </a>
  428. </li>
  429. </ul>
  430. </nav>
  431. </li>
  432. </ul>
  433. </nav>
  434. </li>
  435. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  436. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  437. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  438. <span class="md-ellipsis">
  439. Guides
  440. </span>
  441. <span class="md-nav__icon md-icon"></span>
  442. </label>
  443. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  444. <label class="md-nav__title" for="__nav_3">
  445. <span class="md-nav__icon md-icon"></span>
  446. Guides
  447. </label>
  448. <ul class="md-nav__list" data-md-scrollfix>
  449. <li class="md-nav__item">
  450. <a href="../../guides/introduction/" class="md-nav__link">
  451. <span class="md-ellipsis">
  452. Introduction
  453. </span>
  454. </a>
  455. </li>
  456. <li class="md-nav__item md-nav__item--nested">
  457. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  458. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  459. <span class="md-ellipsis">
  460. External Secrets
  461. </span>
  462. <span class="md-nav__icon md-icon"></span>
  463. </label>
  464. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  465. <label class="md-nav__title" for="__nav_3_2">
  466. <span class="md-nav__icon md-icon"></span>
  467. External Secrets
  468. </label>
  469. <ul class="md-nav__list" data-md-scrollfix>
  470. <li class="md-nav__item">
  471. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  472. <span class="md-ellipsis">
  473. Extract structured data
  474. </span>
  475. </a>
  476. </li>
  477. <li class="md-nav__item">
  478. <a href="../../guides/getallsecrets/" class="md-nav__link">
  479. <span class="md-ellipsis">
  480. Find Secrets by Name or Metadata
  481. </span>
  482. </a>
  483. </li>
  484. <li class="md-nav__item">
  485. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  486. <span class="md-ellipsis">
  487. Rewriting Keys
  488. </span>
  489. </a>
  490. </li>
  491. <li class="md-nav__item md-nav__item--nested">
  492. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  493. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  494. <span class="md-ellipsis">
  495. Advanced Templating
  496. </span>
  497. <span class="md-nav__icon md-icon"></span>
  498. </label>
  499. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  500. <label class="md-nav__title" for="__nav_3_2_4">
  501. <span class="md-nav__icon md-icon"></span>
  502. Advanced Templating
  503. </label>
  504. <ul class="md-nav__list" data-md-scrollfix>
  505. <li class="md-nav__item">
  506. <a href="../../guides/templating/" class="md-nav__link">
  507. <span class="md-ellipsis">
  508. v2
  509. </span>
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../../guides/templating-v1/" class="md-nav__link">
  514. <span class="md-ellipsis">
  515. v1
  516. </span>
  517. </a>
  518. </li>
  519. </ul>
  520. </nav>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. Kubernetes Secret Types
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. Lifecycle: ownership & deletion
  533. </span>
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  538. <span class="md-ellipsis">
  539. Decoding Strategies
  540. </span>
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../guides/controller-class/" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. Controller Classes
  547. </span>
  548. </a>
  549. </li>
  550. </ul>
  551. </nav>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../guides/generator/" class="md-nav__link">
  555. <span class="md-ellipsis">
  556. Generators
  557. </span>
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../guides/pushsecrets/" class="md-nav__link">
  562. <span class="md-ellipsis">
  563. Push Secrets
  564. </span>
  565. </a>
  566. </li>
  567. <li class="md-nav__item md-nav__item--nested">
  568. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  569. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  570. <span class="md-ellipsis">
  571. Operations
  572. </span>
  573. <span class="md-nav__icon md-icon"></span>
  574. </label>
  575. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  576. <label class="md-nav__title" for="__nav_3_5">
  577. <span class="md-nav__icon md-icon"></span>
  578. Operations
  579. </label>
  580. <ul class="md-nav__list" data-md-scrollfix>
  581. <li class="md-nav__item">
  582. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  583. <span class="md-ellipsis">
  584. Multi Tenancy
  585. </span>
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../guides/security-best-practices/" class="md-nav__link">
  590. <span class="md-ellipsis">
  591. Security Best Practices
  592. </span>
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../guides/threat-model/" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. Threat Model
  599. </span>
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../../guides/v1beta1/" class="md-nav__link">
  604. <span class="md-ellipsis">
  605. Upgrading to v1beta1
  606. </span>
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="../../guides/using-latest-image/" class="md-nav__link">
  611. <span class="md-ellipsis">
  612. Using Latest Image
  613. </span>
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  618. <span class="md-ellipsis">
  619. Disable Cluster Features
  620. </span>
  621. </a>
  622. </li>
  623. </ul>
  624. </nav>
  625. </li>
  626. </ul>
  627. </nav>
  628. </li>
  629. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  630. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  631. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  632. <span class="md-ellipsis">
  633. Provider
  634. </span>
  635. <span class="md-nav__icon md-icon"></span>
  636. </label>
  637. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  638. <label class="md-nav__title" for="__nav_4">
  639. <span class="md-nav__icon md-icon"></span>
  640. Provider
  641. </label>
  642. <ul class="md-nav__list" data-md-scrollfix>
  643. <li class="md-nav__item">
  644. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  645. <span class="md-ellipsis">
  646. AWS Secrets Manager
  647. </span>
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  652. <span class="md-ellipsis">
  653. AWS Parameter Store
  654. </span>
  655. </a>
  656. </li>
  657. <li class="md-nav__item">
  658. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  659. <span class="md-ellipsis">
  660. Azure Key Vault
  661. </span>
  662. </a>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="../../provider/conjur/" class="md-nav__link">
  666. <span class="md-ellipsis">
  667. CyberArk Conjur
  668. </span>
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  673. <span class="md-ellipsis">
  674. Google Cloud Secret Manager
  675. </span>
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  680. <span class="md-ellipsis">
  681. HashiCorp Vault
  682. </span>
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../../provider/kubernetes/" class="md-nav__link">
  687. <span class="md-ellipsis">
  688. Kubernetes
  689. </span>
  690. </a>
  691. </li>
  692. <li class="md-nav__item">
  693. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  694. <span class="md-ellipsis">
  695. IBM Secrets Manager
  696. </span>
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../../provider/akeyless/" class="md-nav__link">
  701. <span class="md-ellipsis">
  702. Akeyless
  703. </span>
  704. </a>
  705. </li>
  706. <li class="md-nav__item">
  707. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  708. <span class="md-ellipsis">
  709. Yandex Certificate Manager
  710. </span>
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  715. <span class="md-ellipsis">
  716. Yandex Lockbox
  717. </span>
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="../../provider/alibaba/" class="md-nav__link">
  722. <span class="md-ellipsis">
  723. Alibaba Cloud
  724. </span>
  725. </a>
  726. </li>
  727. <li class="md-nav__item">
  728. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  729. <span class="md-ellipsis">
  730. GitLab Variables
  731. </span>
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="../../provider/oracle-vault/" class="md-nav__link">
  736. <span class="md-ellipsis">
  737. Oracle Vault
  738. </span>
  739. </a>
  740. </li>
  741. <li class="md-nav__item">
  742. <a href="../../provider/1password-automation/" class="md-nav__link">
  743. <span class="md-ellipsis">
  744. 1Password Secrets Automation
  745. </span>
  746. </a>
  747. </li>
  748. <li class="md-nav__item">
  749. <a href="../../provider/webhook/" class="md-nav__link">
  750. <span class="md-ellipsis">
  751. Webhook
  752. </span>
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="../../provider/fake/" class="md-nav__link">
  757. <span class="md-ellipsis">
  758. Fake
  759. </span>
  760. </a>
  761. </li>
  762. <li class="md-nav__item">
  763. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  764. <span class="md-ellipsis">
  765. senhasegura DevOps Secrets Management (DSM)
  766. </span>
  767. </a>
  768. </li>
  769. <li class="md-nav__item">
  770. <a href="../../provider/doppler/" class="md-nav__link">
  771. <span class="md-ellipsis">
  772. Doppler
  773. </span>
  774. </a>
  775. </li>
  776. <li class="md-nav__item">
  777. <a href="../../provider/keeper-security/" class="md-nav__link">
  778. <span class="md-ellipsis">
  779. Keeper Security
  780. </span>
  781. </a>
  782. </li>
  783. <li class="md-nav__item">
  784. <a href="../../provider/cloak/" class="md-nav__link">
  785. <span class="md-ellipsis">
  786. Cloak End 2 End Encrypted Secrets
  787. </span>
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="../../provider/scaleway/" class="md-nav__link">
  792. <span class="md-ellipsis">
  793. Scaleway
  794. </span>
  795. </a>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="../../provider/delinea/" class="md-nav__link">
  799. <span class="md-ellipsis">
  800. Delinea
  801. </span>
  802. </a>
  803. </li>
  804. </ul>
  805. </nav>
  806. </li>
  807. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  808. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  809. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
  810. <span class="md-ellipsis">
  811. Examples
  812. </span>
  813. <span class="md-nav__icon md-icon"></span>
  814. </label>
  815. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  816. <label class="md-nav__title" for="__nav_5">
  817. <span class="md-nav__icon md-icon"></span>
  818. Examples
  819. </label>
  820. <ul class="md-nav__list" data-md-scrollfix>
  821. <li class="md-nav__item">
  822. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  823. <span class="md-ellipsis">
  824. FluxCD
  825. </span>
  826. </a>
  827. </li>
  828. <li class="md-nav__item">
  829. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  830. <span class="md-ellipsis">
  831. Anchore Engine
  832. </span>
  833. </a>
  834. </li>
  835. <li class="md-nav__item">
  836. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  837. <span class="md-ellipsis">
  838. Jenkins
  839. </span>
  840. </a>
  841. </li>
  842. <li class="md-nav__item">
  843. <a href="../../examples/bitwarden/" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. BitWarden
  846. </span>
  847. </a>
  848. </li>
  849. </ul>
  850. </nav>
  851. </li>
  852. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  853. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  854. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  855. <span class="md-ellipsis">
  856. Community
  857. </span>
  858. <span class="md-nav__icon md-icon"></span>
  859. </label>
  860. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  861. <label class="md-nav__title" for="__nav_6">
  862. <span class="md-nav__icon md-icon"></span>
  863. Community
  864. </label>
  865. <ul class="md-nav__list" data-md-scrollfix>
  866. <li class="md-nav__item md-nav__item--nested">
  867. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  868. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  869. <span class="md-ellipsis">
  870. Contributing
  871. </span>
  872. <span class="md-nav__icon md-icon"></span>
  873. </label>
  874. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  875. <label class="md-nav__title" for="__nav_6_1">
  876. <span class="md-nav__icon md-icon"></span>
  877. Contributing
  878. </label>
  879. <ul class="md-nav__list" data-md-scrollfix>
  880. <li class="md-nav__item">
  881. <a href="../../contributing/devguide/" class="md-nav__link">
  882. <span class="md-ellipsis">
  883. Developer guide
  884. </span>
  885. </a>
  886. </li>
  887. <li class="md-nav__item">
  888. <a href="../../contributing/process/" class="md-nav__link">
  889. <span class="md-ellipsis">
  890. Contributing Process
  891. </span>
  892. </a>
  893. </li>
  894. <li class="md-nav__item">
  895. <a href="../../contributing/release/" class="md-nav__link">
  896. <span class="md-ellipsis">
  897. Release Process
  898. </span>
  899. </a>
  900. </li>
  901. <li class="md-nav__item">
  902. <a href="../../contributing/coc/" class="md-nav__link">
  903. <span class="md-ellipsis">
  904. Code of Conduct
  905. </span>
  906. </a>
  907. </li>
  908. <li class="md-nav__item">
  909. <a href="../../contributing/roadmap/" class="md-nav__link">
  910. <span class="md-ellipsis">
  911. Roadmap
  912. </span>
  913. </a>
  914. </li>
  915. </ul>
  916. </nav>
  917. </li>
  918. <li class="md-nav__item md-nav__item--nested">
  919. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  920. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  921. <span class="md-ellipsis">
  922. External Resources
  923. </span>
  924. <span class="md-nav__icon md-icon"></span>
  925. </label>
  926. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  927. <label class="md-nav__title" for="__nav_6_2">
  928. <span class="md-nav__icon md-icon"></span>
  929. External Resources
  930. </label>
  931. <ul class="md-nav__list" data-md-scrollfix>
  932. <li class="md-nav__item">
  933. <a href="../../eso-talks/" class="md-nav__link">
  934. <span class="md-ellipsis">
  935. Talks
  936. </span>
  937. </a>
  938. </li>
  939. <li class="md-nav__item">
  940. <a href="../../eso-demos/" class="md-nav__link">
  941. <span class="md-ellipsis">
  942. Demos
  943. </span>
  944. </a>
  945. </li>
  946. <li class="md-nav__item">
  947. <a href="../../eso-blogs/" class="md-nav__link">
  948. <span class="md-ellipsis">
  949. Blogs
  950. </span>
  951. </a>
  952. </li>
  953. </ul>
  954. </nav>
  955. </li>
  956. </ul>
  957. </nav>
  958. </li>
  959. </ul>
  960. </nav>
  961. </div>
  962. </div>
  963. </div>
  964. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  965. <div class="md-sidebar__scrollwrap">
  966. <div class="md-sidebar__inner">
  967. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  968. <label class="md-nav__title" for="__toc">
  969. <span class="md-nav__icon md-icon"></span>
  970. Table of contents
  971. </label>
  972. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  973. <li class="md-nav__item">
  974. <a href="#core-controller-flags" class="md-nav__link">
  975. <span class="md-ellipsis">
  976. Core Controller Flags
  977. </span>
  978. </a>
  979. </li>
  980. <li class="md-nav__item">
  981. <a href="#cert-controller-flags" class="md-nav__link">
  982. <span class="md-ellipsis">
  983. Cert Controller Flags
  984. </span>
  985. </a>
  986. </li>
  987. <li class="md-nav__item">
  988. <a href="#webhook-flags" class="md-nav__link">
  989. <span class="md-ellipsis">
  990. Webhook Flags
  991. </span>
  992. </a>
  993. </li>
  994. </ul>
  995. </nav>
  996. </div>
  997. </div>
  998. </div>
  999. <div class="md-content" data-md-component="content">
  1000. <article class="md-content__inner md-typeset">
  1001. <h1 id="controller-options">Controller Options</h1>
  1002. <p>The external-secrets binary includes three components: <code>core controller</code>, <code>certcontroller</code> and <code>webook</code>.</p>
  1003. <h2 id="core-controller-flags">Core Controller Flags</h2>
  1004. <p>The core controller is invoked without a subcommand and can be configured with the following flags:</p>
  1005. <table>
  1006. <thead>
  1007. <tr>
  1008. <th>Name</th>
  1009. <th>Type</th>
  1010. <th>Default</th>
  1011. <th>Description</th>
  1012. </tr>
  1013. </thead>
  1014. <tbody>
  1015. <tr>
  1016. <td><code>--client-burst</code></td>
  1017. <td>int</td>
  1018. <td>uses rest client default (10)</td>
  1019. <td>Maximum Burst allowed to be passed to rest.Client</td>
  1020. </tr>
  1021. <tr>
  1022. <td><code>--client-qps</code></td>
  1023. <td>float32</td>
  1024. <td>uses rest client default (5)</td>
  1025. <td>QPS configuration to be passed to rest.Client</td>
  1026. </tr>
  1027. <tr>
  1028. <td><code>--concurrent</code></td>
  1029. <td>int</td>
  1030. <td>1</td>
  1031. <td>The number of concurrent reconciles.</td>
  1032. </tr>
  1033. <tr>
  1034. <td><code>--controller-class</code></td>
  1035. <td>string</td>
  1036. <td>default</td>
  1037. <td>The controller is instantiated with a specific controller name and filters ES based on this property</td>
  1038. </tr>
  1039. <tr>
  1040. <td><code>--enable-cluster-external-secret-reconciler</code></td>
  1041. <td>boolean</td>
  1042. <td>true</td>
  1043. <td>Enables the cluster external secret reconciler.</td>
  1044. </tr>
  1045. <tr>
  1046. <td><code>--enable-cluster-store-reconciler</code></td>
  1047. <td>boolean</td>
  1048. <td>true</td>
  1049. <td>Enables the cluster store reconciler.</td>
  1050. </tr>
  1051. <tr>
  1052. <td><code>--enable-push-secret-reconciler</code></td>
  1053. <td>boolean</td>
  1054. <td>true</td>
  1055. <td>Enables the push secret reconciler.</td>
  1056. </tr>
  1057. <tr>
  1058. <td><code>--enable-secrets-caching</code></td>
  1059. <td>boolean</td>
  1060. <td>false</td>
  1061. <td>Enables the secrets caching for external-secrets pod.</td>
  1062. </tr>
  1063. <tr>
  1064. <td><code>--enable-configmaps-caching</code></td>
  1065. <td>boolean</td>
  1066. <td>false</td>
  1067. <td>Enables the ConfigMap caching for external-secrets pod.</td>
  1068. </tr>
  1069. <tr>
  1070. <td><code>--enable-flood-gate</code></td>
  1071. <td>boolean</td>
  1072. <td>true</td>
  1073. <td>Enable flood gate. External secret will be reconciled only if the ClusterStore or Store have an healthy or unknown state.</td>
  1074. </tr>
  1075. <tr>
  1076. <td><code>--enable-extended-metric-labels</code></td>
  1077. <td>boolean</td>
  1078. <td>true</td>
  1079. <td>Enable recommended kubernetes annotations as labels in metrics.</td>
  1080. </tr>
  1081. <tr>
  1082. <td><code>--enable-leader-election</code></td>
  1083. <td>boolean</td>
  1084. <td>false</td>
  1085. <td>Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager.</td>
  1086. </tr>
  1087. <tr>
  1088. <td><code>--experimental-enable-aws-session-cache</code></td>
  1089. <td>boolean</td>
  1090. <td>false</td>
  1091. <td>Enable experimental AWS session cache. External secret will reuse the AWS session without creating a new one on each request.</td>
  1092. </tr>
  1093. <tr>
  1094. <td><code>--help</code></td>
  1095. <td></td>
  1096. <td></td>
  1097. <td>help for external-secrets</td>
  1098. </tr>
  1099. <tr>
  1100. <td><code>--loglevel</code></td>
  1101. <td>string</td>
  1102. <td>info</td>
  1103. <td>loglevel to use, one of: debug, info, warn, error, dpanic, panic, fatal</td>
  1104. </tr>
  1105. <tr>
  1106. <td><code>--metrics-addr</code></td>
  1107. <td>string</td>
  1108. <td>:8080</td>
  1109. <td>The address the metric endpoint binds to.</td>
  1110. </tr>
  1111. <tr>
  1112. <td><code>--namespace</code></td>
  1113. <td>string</td>
  1114. <td>-</td>
  1115. <td>watch external secrets scoped in the provided namespace only. ClusterSecretStore can be used but only work if it doesn't reference resources from other namespaces</td>
  1116. </tr>
  1117. <tr>
  1118. <td><code>--store-requeue-interval</code></td>
  1119. <td>duration</td>
  1120. <td>5m0s</td>
  1121. <td>Default Time duration between reconciling (Cluster)SecretStores</td>
  1122. </tr>
  1123. </tbody>
  1124. </table>
  1125. <h2 id="cert-controller-flags">Cert Controller Flags</h2>
  1126. <table>
  1127. <thead>
  1128. <tr>
  1129. <th>Name</th>
  1130. <th>Type</th>
  1131. <th>Default</th>
  1132. <th>Descripton</th>
  1133. </tr>
  1134. </thead>
  1135. <tbody>
  1136. <tr>
  1137. <td><code>--crd-requeue-interval</code></td>
  1138. <td>duration</td>
  1139. <td>5m0s</td>
  1140. <td>Time duration between reconciling CRDs for new certs</td>
  1141. </tr>
  1142. <tr>
  1143. <td><code>--enable-leader-election</code></td>
  1144. <td>boolean</td>
  1145. <td>false</td>
  1146. <td>Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager.</td>
  1147. </tr>
  1148. <tr>
  1149. <td><code>--healthz-addr</code></td>
  1150. <td>string</td>
  1151. <td>:8081</td>
  1152. <td>The address the health endpoint binds to.</td>
  1153. </tr>
  1154. <tr>
  1155. <td><code>--help</code></td>
  1156. <td></td>
  1157. <td></td>
  1158. <td>help for certcontroller</td>
  1159. </tr>
  1160. <tr>
  1161. <td><code>--loglevel</code></td>
  1162. <td>string</td>
  1163. <td>info</td>
  1164. <td>loglevel to use, one of: debug, info, warn, error, dpanic, panic, fatal</td>
  1165. </tr>
  1166. <tr>
  1167. <td><code>--metrics-addr</code></td>
  1168. <td>string</td>
  1169. <td>:8080</td>
  1170. <td>The address the metric endpoint binds to.</td>
  1171. </tr>
  1172. <tr>
  1173. <td><code>--secret-name</code></td>
  1174. <td>string</td>
  1175. <td>external-secrets-webhook</td>
  1176. <td>Secret to store certs for webhook</td>
  1177. </tr>
  1178. <tr>
  1179. <td><code>--secret-namespace</code></td>
  1180. <td>string</td>
  1181. <td>default</td>
  1182. <td>namespace of the secret to store certs</td>
  1183. </tr>
  1184. <tr>
  1185. <td><code>--service-name</code></td>
  1186. <td>string</td>
  1187. <td>external-secrets-webhook</td>
  1188. <td>Webhook service name</td>
  1189. </tr>
  1190. <tr>
  1191. <td><code>--service-namespace</code></td>
  1192. <td>string</td>
  1193. <td>default</td>
  1194. <td>Webhook service namespace</td>
  1195. </tr>
  1196. </tbody>
  1197. </table>
  1198. <h2 id="webhook-flags">Webhook Flags</h2>
  1199. <table>
  1200. <thead>
  1201. <tr>
  1202. <th>Name</th>
  1203. <th>Type</th>
  1204. <th>Default</th>
  1205. <th>Description</th>
  1206. </tr>
  1207. </thead>
  1208. <tbody>
  1209. <tr>
  1210. <td><code>--cert-dir</code></td>
  1211. <td>string</td>
  1212. <td>/tmp/k8s-webhook-server/serving-certs</td>
  1213. <td>path to check for certs</td>
  1214. </tr>
  1215. <tr>
  1216. <td><code>--check-interval</code></td>
  1217. <td>duration</td>
  1218. <td>5m0s</td>
  1219. <td>certificate check interval</td>
  1220. </tr>
  1221. <tr>
  1222. <td><code>--dns-name</code></td>
  1223. <td>string</td>
  1224. <td>localhost</td>
  1225. <td>DNS name to validate certificates with</td>
  1226. </tr>
  1227. <tr>
  1228. <td><code>--healthz-addr</code></td>
  1229. <td>string</td>
  1230. <td>:8081</td>
  1231. <td>The address the health endpoint binds to.</td>
  1232. </tr>
  1233. <tr>
  1234. <td><code>--help</code></td>
  1235. <td></td>
  1236. <td></td>
  1237. <td>help for webhook</td>
  1238. </tr>
  1239. <tr>
  1240. <td><code>--loglevel</code></td>
  1241. <td>string</td>
  1242. <td>info</td>
  1243. <td>loglevel to use, one of: debug, info, warn, error, dpanic, panic, fatal</td>
  1244. </tr>
  1245. <tr>
  1246. <td><code>--lookahead-interval</code></td>
  1247. <td>duration</td>
  1248. <td>2160h0m0s (90d)</td>
  1249. <td>certificate check interval</td>
  1250. </tr>
  1251. <tr>
  1252. <td><code>--metrics-addr</code></td>
  1253. <td>string</td>
  1254. <td>:8080</td>
  1255. <td>The address the metric endpoint binds to.</td>
  1256. </tr>
  1257. <tr>
  1258. <td><code>--port</code></td>
  1259. <td>number</td>
  1260. <td>10250</td>
  1261. <td>Port number that the webhook server will serve.</td>
  1262. </tr>
  1263. <tr>
  1264. <td><code>--tls-ciphers</code></td>
  1265. <td>string</td>
  1266. <td></td>
  1267. <td>comma separated list of tls ciphers allowed. This does not apply to TLS 1.3 as the ciphers are selected automatically. The order of this list does not give preference to the ciphers, the ordering is done automatically. Full lists of available ciphers can be found at https://pkg.go.dev/crypto/tls#pkg-constants. E.g. 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256'</td>
  1268. </tr>
  1269. <tr>
  1270. <td><code>--tls-min-version</code></td>
  1271. <td>string</td>
  1272. <td>1.2</td>
  1273. <td>minimum version of TLS supported.</td>
  1274. </tr>
  1275. </tbody>
  1276. </table>
  1277. </article>
  1278. </div>
  1279. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1280. </div>
  1281. </main>
  1282. <footer class="md-footer">
  1283. <div class="md-footer-meta md-typeset">
  1284. <div class="md-footer-meta__inner md-grid">
  1285. <div class="md-copyright">
  1286. <div class="md-copyright__highlight">
  1287. &copy; 2023 The external-secrets Authors.<br/>
  1288. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1289. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1290. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1291. </div>
  1292. Made with
  1293. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1294. Material for MkDocs
  1295. </a>
  1296. </div>
  1297. </div>
  1298. </div>
  1299. </footer>
  1300. </div>
  1301. <div class="md-dialog" data-md-component="dialog">
  1302. <div class="md-dialog__inner md-typeset"></div>
  1303. </div>
  1304. <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>
  1305. <script src="../../assets/javascripts/bundle.caa56a14.min.js"></script>
  1306. </body>
  1307. </html>