index.html 61 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410
  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="../getting-started/">
  7. <link rel="next" href="../stability-support/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
  10. <title>FAQ - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.6543a935.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="#can-i-manually-trigger-a-secret-refresh" 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. FAQ
  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.5.2 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 md-tabs__item--active">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/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. <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.5.2 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--active md-nav__item--section md-nav__item--nested">
  172. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  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="">
  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="true">
  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="../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="../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 md-nav__item--active">
  204. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  205. <label class="md-nav__link md-nav__link--active" for="__toc">
  206. <span class="md-ellipsis">
  207. FAQ
  208. </span>
  209. <span class="md-nav__icon md-icon"></span>
  210. </label>
  211. <a href="./" class="md-nav__link md-nav__link--active">
  212. <span class="md-ellipsis">
  213. FAQ
  214. </span>
  215. </a>
  216. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  217. <label class="md-nav__title" for="__toc">
  218. <span class="md-nav__icon md-icon"></span>
  219. Table of contents
  220. </label>
  221. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  222. <li class="md-nav__item">
  223. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  224. <span class="md-ellipsis">
  225. Can I manually trigger a secret refresh?
  226. </span>
  227. </a>
  228. </li>
  229. <li class="md-nav__item">
  230. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  231. <span class="md-ellipsis">
  232. How do I know when my secret was last synced?
  233. </span>
  234. </a>
  235. </li>
  236. <li class="md-nav__item">
  237. <a href="#how-do-i-know-when-the-status-of-my-secret-changed-the-last-time" class="md-nav__link">
  238. <span class="md-ellipsis">
  239. How do I know when the status of my secret changed the last time?
  240. </span>
  241. </a>
  242. </li>
  243. <li class="md-nav__item">
  244. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  245. <span class="md-ellipsis">
  246. Differences to csi-secret-store
  247. </span>
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  252. <span class="md-ellipsis">
  253. How do I debug an external-secret that doesn't sync?
  254. </span>
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. Upgrading from KES to ESO
  261. </span>
  262. </a>
  263. </li>
  264. </ul>
  265. </nav>
  266. </li>
  267. <li class="md-nav__item">
  268. <a href="../stability-support/" class="md-nav__link">
  269. <span class="md-ellipsis">
  270. Stability and Support
  271. </span>
  272. </a>
  273. </li>
  274. <li class="md-nav__item">
  275. <a href="../deprecation-policy/" class="md-nav__link">
  276. <span class="md-ellipsis">
  277. Deprecation Policy
  278. </span>
  279. </a>
  280. </li>
  281. </ul>
  282. </nav>
  283. </li>
  284. <li class="md-nav__item md-nav__item--nested">
  285. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  286. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  287. <span class="md-ellipsis">
  288. API
  289. </span>
  290. <span class="md-nav__icon md-icon"></span>
  291. </label>
  292. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  293. <label class="md-nav__title" for="__nav_2">
  294. <span class="md-nav__icon md-icon"></span>
  295. API
  296. </label>
  297. <ul class="md-nav__list" data-md-scrollfix>
  298. <li class="md-nav__item">
  299. <a href="../../api/components/" class="md-nav__link">
  300. <span class="md-ellipsis">
  301. Components
  302. </span>
  303. </a>
  304. </li>
  305. <li class="md-nav__item md-nav__item--nested">
  306. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  307. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  308. <span class="md-ellipsis">
  309. Core Resources
  310. </span>
  311. <span class="md-nav__icon md-icon"></span>
  312. </label>
  313. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  314. <label class="md-nav__title" for="__nav_2_2">
  315. <span class="md-nav__icon md-icon"></span>
  316. Core Resources
  317. </label>
  318. <ul class="md-nav__list" data-md-scrollfix>
  319. <li class="md-nav__item">
  320. <a href="../../api/externalsecret/" class="md-nav__link">
  321. <span class="md-ellipsis">
  322. ExternalSecret
  323. </span>
  324. </a>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="../../api/secretstore/" class="md-nav__link">
  328. <span class="md-ellipsis">
  329. SecretStore
  330. </span>
  331. </a>
  332. </li>
  333. <li class="md-nav__item">
  334. <a href="../../api/clustersecretstore/" class="md-nav__link">
  335. <span class="md-ellipsis">
  336. ClusterSecretStore
  337. </span>
  338. </a>
  339. </li>
  340. <li class="md-nav__item">
  341. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  342. <span class="md-ellipsis">
  343. ClusterExternalSecret
  344. </span>
  345. </a>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="../../api/pushsecret/" class="md-nav__link">
  349. <span class="md-ellipsis">
  350. PushSecret
  351. </span>
  352. </a>
  353. </li>
  354. </ul>
  355. </nav>
  356. </li>
  357. <li class="md-nav__item md-nav__item--nested">
  358. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  359. <div class="md-nav__link md-nav__container">
  360. <a href="../../api/generator/" class="md-nav__link ">
  361. <span class="md-ellipsis">
  362. Generators
  363. </span>
  364. </a>
  365. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  366. <span class="md-nav__icon md-icon"></span>
  367. </label>
  368. </div>
  369. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  370. <label class="md-nav__title" for="__nav_2_3">
  371. <span class="md-nav__icon md-icon"></span>
  372. Generators
  373. </label>
  374. <ul class="md-nav__list" data-md-scrollfix>
  375. <li class="md-nav__item">
  376. <a href="../../api/generator/acr/" class="md-nav__link">
  377. <span class="md-ellipsis">
  378. Azure Container Registry
  379. </span>
  380. </a>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="../../api/generator/ecr/" class="md-nav__link">
  384. <span class="md-ellipsis">
  385. AWS Elastic Container Registry
  386. </span>
  387. </a>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="../../api/generator/gcr/" class="md-nav__link">
  391. <span class="md-ellipsis">
  392. Google Container Registry
  393. </span>
  394. </a>
  395. </li>
  396. <li class="md-nav__item">
  397. <a href="../../api/generator/vault/" class="md-nav__link">
  398. <span class="md-ellipsis">
  399. Vault Dynamic Secret
  400. </span>
  401. </a>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="../../api/generator/password/" class="md-nav__link">
  405. <span class="md-ellipsis">
  406. Password
  407. </span>
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../api/generator/fake/" class="md-nav__link">
  412. <span class="md-ellipsis">
  413. Fake
  414. </span>
  415. </a>
  416. </li>
  417. <li class="md-nav__item">
  418. <a href="../../api/generator/webhook/" class="md-nav__link">
  419. <span class="md-ellipsis">
  420. Webhook
  421. </span>
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="../../api/generator/github/" class="md-nav__link">
  426. <span class="md-ellipsis">
  427. Github
  428. </span>
  429. </a>
  430. </li>
  431. </ul>
  432. </nav>
  433. </li>
  434. <li class="md-nav__item md-nav__item--nested">
  435. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  436. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  437. <span class="md-ellipsis">
  438. Reference Docs
  439. </span>
  440. <span class="md-nav__icon md-icon"></span>
  441. </label>
  442. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  443. <label class="md-nav__title" for="__nav_2_4">
  444. <span class="md-nav__icon md-icon"></span>
  445. Reference Docs
  446. </label>
  447. <ul class="md-nav__list" data-md-scrollfix>
  448. <li class="md-nav__item">
  449. <a href="../../api/spec/" class="md-nav__link">
  450. <span class="md-ellipsis">
  451. API specification
  452. </span>
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../../api/controller-options/" class="md-nav__link">
  457. <span class="md-ellipsis">
  458. Controller Options
  459. </span>
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../../api/metrics/" class="md-nav__link">
  464. <span class="md-ellipsis">
  465. Metrics
  466. </span>
  467. </a>
  468. </li>
  469. </ul>
  470. </nav>
  471. </li>
  472. </ul>
  473. </nav>
  474. </li>
  475. <li class="md-nav__item md-nav__item--nested">
  476. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  477. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  478. <span class="md-ellipsis">
  479. Guides
  480. </span>
  481. <span class="md-nav__icon md-icon"></span>
  482. </label>
  483. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  484. <label class="md-nav__title" for="__nav_3">
  485. <span class="md-nav__icon md-icon"></span>
  486. Guides
  487. </label>
  488. <ul class="md-nav__list" data-md-scrollfix>
  489. <li class="md-nav__item">
  490. <a href="../../guides/introduction/" class="md-nav__link">
  491. <span class="md-ellipsis">
  492. Introduction
  493. </span>
  494. </a>
  495. </li>
  496. <li class="md-nav__item md-nav__item--nested">
  497. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  498. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  499. <span class="md-ellipsis">
  500. External Secrets
  501. </span>
  502. <span class="md-nav__icon md-icon"></span>
  503. </label>
  504. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  505. <label class="md-nav__title" for="__nav_3_2">
  506. <span class="md-nav__icon md-icon"></span>
  507. External Secrets
  508. </label>
  509. <ul class="md-nav__list" data-md-scrollfix>
  510. <li class="md-nav__item">
  511. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  512. <span class="md-ellipsis">
  513. Extract structured data
  514. </span>
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="../../guides/getallsecrets/" class="md-nav__link">
  519. <span class="md-ellipsis">
  520. Find Secrets by Name or Metadata
  521. </span>
  522. </a>
  523. </li>
  524. <li class="md-nav__item">
  525. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  526. <span class="md-ellipsis">
  527. Rewriting Keys
  528. </span>
  529. </a>
  530. </li>
  531. <li class="md-nav__item md-nav__item--nested">
  532. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  533. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  534. <span class="md-ellipsis">
  535. Advanced Templating
  536. </span>
  537. <span class="md-nav__icon md-icon"></span>
  538. </label>
  539. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  540. <label class="md-nav__title" for="__nav_3_2_4">
  541. <span class="md-nav__icon md-icon"></span>
  542. Advanced Templating
  543. </label>
  544. <ul class="md-nav__list" data-md-scrollfix>
  545. <li class="md-nav__item">
  546. <a href="../../guides/templating/" class="md-nav__link">
  547. <span class="md-ellipsis">
  548. v2
  549. </span>
  550. </a>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="../../guides/templating-v1/" class="md-nav__link">
  554. <span class="md-ellipsis">
  555. v1
  556. </span>
  557. </a>
  558. </li>
  559. </ul>
  560. </nav>
  561. </li>
  562. <li class="md-nav__item">
  563. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  564. <span class="md-ellipsis">
  565. Kubernetes Secret Types
  566. </span>
  567. </a>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  571. <span class="md-ellipsis">
  572. Lifecycle: ownership & deletion
  573. </span>
  574. </a>
  575. </li>
  576. <li class="md-nav__item">
  577. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  578. <span class="md-ellipsis">
  579. Decoding Strategies
  580. </span>
  581. </a>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="../../guides/controller-class/" class="md-nav__link">
  585. <span class="md-ellipsis">
  586. Controller Classes
  587. </span>
  588. </a>
  589. </li>
  590. </ul>
  591. </nav>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../../guides/generator/" class="md-nav__link">
  595. <span class="md-ellipsis">
  596. Generators
  597. </span>
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../../guides/pushsecrets/" class="md-nav__link">
  602. <span class="md-ellipsis">
  603. Push Secrets
  604. </span>
  605. </a>
  606. </li>
  607. <li class="md-nav__item md-nav__item--nested">
  608. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  609. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  610. <span class="md-ellipsis">
  611. Operations
  612. </span>
  613. <span class="md-nav__icon md-icon"></span>
  614. </label>
  615. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  616. <label class="md-nav__title" for="__nav_3_5">
  617. <span class="md-nav__icon md-icon"></span>
  618. Operations
  619. </label>
  620. <ul class="md-nav__list" data-md-scrollfix>
  621. <li class="md-nav__item">
  622. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  623. <span class="md-ellipsis">
  624. Multi Tenancy
  625. </span>
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../../guides/security-best-practices/" class="md-nav__link">
  630. <span class="md-ellipsis">
  631. Security Best Practices
  632. </span>
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../guides/threat-model/" class="md-nav__link">
  637. <span class="md-ellipsis">
  638. Threat Model
  639. </span>
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../../guides/v1beta1/" class="md-nav__link">
  644. <span class="md-ellipsis">
  645. Upgrading to v1beta1
  646. </span>
  647. </a>
  648. </li>
  649. <li class="md-nav__item">
  650. <a href="../../guides/using-latest-image/" class="md-nav__link">
  651. <span class="md-ellipsis">
  652. Using Latest Image
  653. </span>
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  658. <span class="md-ellipsis">
  659. Disable Cluster Features
  660. </span>
  661. </a>
  662. </li>
  663. </ul>
  664. </nav>
  665. </li>
  666. </ul>
  667. </nav>
  668. </li>
  669. <li class="md-nav__item md-nav__item--nested">
  670. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  671. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  672. <span class="md-ellipsis">
  673. Provider
  674. </span>
  675. <span class="md-nav__icon md-icon"></span>
  676. </label>
  677. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  678. <label class="md-nav__title" for="__nav_4">
  679. <span class="md-nav__icon md-icon"></span>
  680. Provider
  681. </label>
  682. <ul class="md-nav__list" data-md-scrollfix>
  683. <li class="md-nav__item">
  684. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  685. <span class="md-ellipsis">
  686. AWS Secrets Manager
  687. </span>
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  692. <span class="md-ellipsis">
  693. AWS Parameter Store
  694. </span>
  695. </a>
  696. </li>
  697. <li class="md-nav__item">
  698. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  699. <span class="md-ellipsis">
  700. Azure Key Vault
  701. </span>
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="../../provider/chef/" class="md-nav__link">
  706. <span class="md-ellipsis">
  707. Chef
  708. </span>
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../../provider/conjur/" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. CyberArk Conjur
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. Google Cloud Secret Manager
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. HashiCorp Vault
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="../../provider/kubernetes/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. Kubernetes
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. IBM Secrets Manager
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../../provider/akeyless/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. Akeyless
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Yandex Certificate Manager
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. Yandex Lockbox
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="../../provider/alibaba/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Alibaba Cloud
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. GitLab Variables
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../../provider/oracle-vault/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. Oracle Vault
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="../../provider/1password-automation/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. 1Password Secrets Automation
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../../provider/webhook/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. Webhook
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="../../provider/fake/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. Fake
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. senhasegura DevOps Secrets Management (DSM)
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="../../provider/doppler/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. Doppler
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="../../provider/keeper-security/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Keeper Security
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="../../provider/cloak/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. Cloak End 2 End Encrypted Secrets
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="../../provider/scaleway/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. Scaleway
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="../../provider/delinea/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Delinea
  848. </span>
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="../../provider/passbolt/" class="md-nav__link">
  853. <span class="md-ellipsis">
  854. Passbolt
  855. </span>
  856. </a>
  857. </li>
  858. <li class="md-nav__item">
  859. <a href="../../provider/pulumi/" class="md-nav__link">
  860. <span class="md-ellipsis">
  861. Pulumi ESC
  862. </span>
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="../../provider/onboardbase/" class="md-nav__link">
  867. <span class="md-ellipsis">
  868. Onboardbase
  869. </span>
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="../../provider-passworddepot/" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. Password Depot
  876. </span>
  877. </a>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="../../provider/fortanix/" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. Fortanix
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="../../provider/infisical/" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. Infisical
  890. </span>
  891. </a>
  892. </li>
  893. </ul>
  894. </nav>
  895. </li>
  896. <li class="md-nav__item md-nav__item--nested">
  897. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  898. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  899. <span class="md-ellipsis">
  900. Examples
  901. </span>
  902. <span class="md-nav__icon md-icon"></span>
  903. </label>
  904. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  905. <label class="md-nav__title" for="__nav_5">
  906. <span class="md-nav__icon md-icon"></span>
  907. Examples
  908. </label>
  909. <ul class="md-nav__list" data-md-scrollfix>
  910. <li class="md-nav__item">
  911. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  912. <span class="md-ellipsis">
  913. FluxCD
  914. </span>
  915. </a>
  916. </li>
  917. <li class="md-nav__item">
  918. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  919. <span class="md-ellipsis">
  920. Anchore Engine
  921. </span>
  922. </a>
  923. </li>
  924. <li class="md-nav__item">
  925. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  926. <span class="md-ellipsis">
  927. Jenkins
  928. </span>
  929. </a>
  930. </li>
  931. <li class="md-nav__item">
  932. <a href="../../examples/bitwarden/" class="md-nav__link">
  933. <span class="md-ellipsis">
  934. BitWarden
  935. </span>
  936. </a>
  937. </li>
  938. </ul>
  939. </nav>
  940. </li>
  941. <li class="md-nav__item md-nav__item--nested">
  942. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  943. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  944. <span class="md-ellipsis">
  945. Community
  946. </span>
  947. <span class="md-nav__icon md-icon"></span>
  948. </label>
  949. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  950. <label class="md-nav__title" for="__nav_6">
  951. <span class="md-nav__icon md-icon"></span>
  952. Community
  953. </label>
  954. <ul class="md-nav__list" data-md-scrollfix>
  955. <li class="md-nav__item md-nav__item--nested">
  956. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  957. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  958. <span class="md-ellipsis">
  959. Contributing
  960. </span>
  961. <span class="md-nav__icon md-icon"></span>
  962. </label>
  963. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  964. <label class="md-nav__title" for="__nav_6_1">
  965. <span class="md-nav__icon md-icon"></span>
  966. Contributing
  967. </label>
  968. <ul class="md-nav__list" data-md-scrollfix>
  969. <li class="md-nav__item">
  970. <a href="../../contributing/devguide/" class="md-nav__link">
  971. <span class="md-ellipsis">
  972. Developer guide
  973. </span>
  974. </a>
  975. </li>
  976. <li class="md-nav__item">
  977. <a href="../../contributing/process/" class="md-nav__link">
  978. <span class="md-ellipsis">
  979. Contributing Process
  980. </span>
  981. </a>
  982. </li>
  983. <li class="md-nav__item">
  984. <a href="../../contributing/release/" class="md-nav__link">
  985. <span class="md-ellipsis">
  986. Release Process
  987. </span>
  988. </a>
  989. </li>
  990. <li class="md-nav__item">
  991. <a href="../../contributing/coc/" class="md-nav__link">
  992. <span class="md-ellipsis">
  993. Code of Conduct
  994. </span>
  995. </a>
  996. </li>
  997. <li class="md-nav__item">
  998. <a href="../../contributing/roadmap/" class="md-nav__link">
  999. <span class="md-ellipsis">
  1000. Roadmap
  1001. </span>
  1002. </a>
  1003. </li>
  1004. </ul>
  1005. </nav>
  1006. </li>
  1007. <li class="md-nav__item md-nav__item--nested">
  1008. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1009. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1010. <span class="md-ellipsis">
  1011. External Resources
  1012. </span>
  1013. <span class="md-nav__icon md-icon"></span>
  1014. </label>
  1015. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1016. <label class="md-nav__title" for="__nav_6_2">
  1017. <span class="md-nav__icon md-icon"></span>
  1018. External Resources
  1019. </label>
  1020. <ul class="md-nav__list" data-md-scrollfix>
  1021. <li class="md-nav__item">
  1022. <a href="../../eso-talks/" class="md-nav__link">
  1023. <span class="md-ellipsis">
  1024. Talks
  1025. </span>
  1026. </a>
  1027. </li>
  1028. <li class="md-nav__item">
  1029. <a href="../../eso-demos/" class="md-nav__link">
  1030. <span class="md-ellipsis">
  1031. Demos
  1032. </span>
  1033. </a>
  1034. </li>
  1035. <li class="md-nav__item">
  1036. <a href="../../eso-blogs/" class="md-nav__link">
  1037. <span class="md-ellipsis">
  1038. Blogs
  1039. </span>
  1040. </a>
  1041. </li>
  1042. </ul>
  1043. </nav>
  1044. </li>
  1045. </ul>
  1046. </nav>
  1047. </li>
  1048. <li class="md-nav__item md-nav__item--nested">
  1049. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1050. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1051. <span class="md-ellipsis">
  1052. References
  1053. </span>
  1054. <span class="md-nav__icon md-icon"></span>
  1055. </label>
  1056. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1057. <label class="md-nav__title" for="__nav_7">
  1058. <span class="md-nav__icon md-icon"></span>
  1059. References
  1060. </label>
  1061. <ul class="md-nav__list" data-md-scrollfix>
  1062. <li class="md-nav__item">
  1063. <a href="../../spec/" class="md-nav__link">
  1064. <span class="md-ellipsis">
  1065. API specification
  1066. </span>
  1067. </a>
  1068. </li>
  1069. </ul>
  1070. </nav>
  1071. </li>
  1072. </ul>
  1073. </nav>
  1074. </div>
  1075. </div>
  1076. </div>
  1077. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1078. <div class="md-sidebar__scrollwrap">
  1079. <div class="md-sidebar__inner">
  1080. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1081. <label class="md-nav__title" for="__toc">
  1082. <span class="md-nav__icon md-icon"></span>
  1083. Table of contents
  1084. </label>
  1085. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1086. <li class="md-nav__item">
  1087. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  1088. <span class="md-ellipsis">
  1089. Can I manually trigger a secret refresh?
  1090. </span>
  1091. </a>
  1092. </li>
  1093. <li class="md-nav__item">
  1094. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  1095. <span class="md-ellipsis">
  1096. How do I know when my secret was last synced?
  1097. </span>
  1098. </a>
  1099. </li>
  1100. <li class="md-nav__item">
  1101. <a href="#how-do-i-know-when-the-status-of-my-secret-changed-the-last-time" class="md-nav__link">
  1102. <span class="md-ellipsis">
  1103. How do I know when the status of my secret changed the last time?
  1104. </span>
  1105. </a>
  1106. </li>
  1107. <li class="md-nav__item">
  1108. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  1109. <span class="md-ellipsis">
  1110. Differences to csi-secret-store
  1111. </span>
  1112. </a>
  1113. </li>
  1114. <li class="md-nav__item">
  1115. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  1116. <span class="md-ellipsis">
  1117. How do I debug an external-secret that doesn't sync?
  1118. </span>
  1119. </a>
  1120. </li>
  1121. <li class="md-nav__item">
  1122. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  1123. <span class="md-ellipsis">
  1124. Upgrading from KES to ESO
  1125. </span>
  1126. </a>
  1127. </li>
  1128. </ul>
  1129. </nav>
  1130. </div>
  1131. </div>
  1132. </div>
  1133. <div class="md-content" data-md-component="content">
  1134. <article class="md-content__inner md-typeset">
  1135. <h1>FAQ</h1>
  1136. <h2 id="can-i-manually-trigger-a-secret-refresh">Can I manually trigger a secret refresh?</h2>
  1137. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client.
  1138. You just need to change an annotation, label or the spec of the resource:</p>
  1139. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  1140. </code></pre></div>
  1141. <h2 id="how-do-i-know-when-my-secret-was-last-synced">How do I know when my secret was last synced?</h2>
  1142. <p>The last synchronization timestamp of an ExternalSecret can be retrieved from the field <code>refreshTime</code>. </p>
  1143. <div class="highlight"><pre><span></span><code>kubectl get es my-external-secret -o yaml | grep refreshTime
  1144. refreshTime: &quot;2022-05-21T23:02:47Z&quot;
  1145. </code></pre></div>
  1146. <p>The interval can be changed by the <code>spec.refreshInterval</code> in the ExternalSecret.</p>
  1147. <h2 id="how-do-i-know-when-the-status-of-my-secret-changed-the-last-time">How do I know when the status of my secret changed the last time?</h2>
  1148. <p>Every ExternalSecret resource contains a status condition that indicates whether a secret was successfully synchronized, along with the timestamp of the last status change of the ExternalSecret (e.g. from SecretSyncedError to SecretSynced). This can be obtained from the field <code>lastTransitionTime</code>:</p>
  1149. <div class="highlight"><pre><span></span><code>kubectl get es my-external-secret -o yaml | grep condition -A 5
  1150. conditions:
  1151. - lastTransitionTime: &quot;2022-05-21T21:02:47Z&quot;
  1152. message: Secret was synced
  1153. reason: SecretSynced
  1154. status: &quot;True&quot;
  1155. type: Ready
  1156. </code></pre></div>
  1157. <h2 id="differences-to-csi-secret-store">Differences to csi-secret-store</h2>
  1158. <p>Please take a look at this <a href="https://github.com/external-secrets/external-secrets/issues/478#issuecomment-964413129">issue comment here</a>.</p>
  1159. <h2 id="how-do-i-debug-an-external-secret-that-doesnt-sync">How do I debug an external-secret that doesn't sync?</h2>
  1160. <p>First, check the status of the ExternalSecret resource using <code>kubectl describe</code>. That displays the status conditions as well as recent events.
  1161. You should expect a status condition with <code>Type=Ready</code>, <code>Status=True</code>. Further you shouldn't see any events with <code>Type=Warning</code>. Read carefully if they exist.</p>
  1162. <div class="highlight"><pre><span></span><code>kubectl describe es my-external-secret
  1163. [...]
  1164. Status:
  1165. Conditions:
  1166. Last Transition Time: 2022-05-21T21:02:47Z
  1167. Message: Secret was synced
  1168. Reason: SecretSynced
  1169. Status: True
  1170. Type: Ready
  1171. Refresh Time: 2022-05-21T21:06:47Z
  1172. Synced Resource Version: 1-5c833527afd7ba3f426cb0082ee7e083
  1173. Events:
  1174. Type Reason Age From Message
  1175. ---- ------ ---- ---- -------
  1176. Warning UpdateFailed 4m12s external-secrets secrets &quot;yyyyyyy&quot; already exists
  1177. Normal Updated 12s (x4 over 3m12s) external-secrets Updated Secret
  1178. </code></pre></div>
  1179. <p>If everything looks good you should check the corresponding secret store resource that is referenced from an ExternalSecret. Again, use <code>kubectl describe</code> to show status conditions and events and look for warning signs as described above.</p>
  1180. <p>In an ideally, the store should be validated and Ready.</p>
  1181. <div class="highlight"><pre><span></span><code>kubectl describe css kubernetes
  1182. [...]
  1183. Status:
  1184. Conditions:
  1185. Last Transition Time: 2022-05-21T21:02:47Z
  1186. Message: store validated
  1187. Reason: Valid
  1188. Status: True
  1189. Type: Ready
  1190. Events:
  1191. Type Reason Age From Message
  1192. ---- ------ ---- ---- -------
  1193. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  1194. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  1195. </code></pre></div>
  1196. <p>If everything looks normal so far, please go ahead and ensure that the created secret has the expected value. Also, take a look at the logs of the controller.</p>
  1197. <h2 id="upgrading-from-kes-to-eso">Upgrading from KES to ESO</h2>
  1198. <p>Migrating from KES to ESO is quite tricky! There is a tool we built to help users out available <a href="https://github.com/external-secrets/kes-to-eso">here</a>, and there is a small migration procedure.</p>
  1199. <p>There are some incompatibilities between KES to ESO, and while the tool tries to cover most of them, some of them will require manual intervention. We recommend to first convert the manifest files, and actually see if the tool provides a warning about any file needed to be changed.
  1200. Beware that the tool points the SecretStores to use KES Service Account, so you'll also need to tweak that if you plan to uninstall KES after the upgrade.</p>
  1201. </article>
  1202. </div>
  1203. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1204. </div>
  1205. </main>
  1206. <footer class="md-footer">
  1207. <div class="md-footer-meta md-typeset">
  1208. <div class="md-footer-meta__inner md-grid">
  1209. <div class="md-copyright">
  1210. <div class="md-copyright__highlight">
  1211. &copy; 2024 The external-secrets Authors.<br/>
  1212. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1213. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1214. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1215. </div>
  1216. Made with
  1217. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1218. Material for MkDocs
  1219. </a>
  1220. </div>
  1221. </div>
  1222. </div>
  1223. </footer>
  1224. </div>
  1225. <div class="md-dialog" data-md-component="dialog">
  1226. <div class="md-dialog__inner md-typeset"></div>
  1227. </div>
  1228. <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>
  1229. <script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
  1230. </body>
  1231. </html>