index.html 63 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518
  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.1, mkdocs-material-9.5.42">
  10. <title>FAQ - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <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">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <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>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. FAQ
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <form class="md-header__option" data-md-component="palette">
  65. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  68. </label>
  69. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  72. </label>
  73. </form>
  74. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var 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(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  75. <label class="md-header__button md-icon" for="__search">
  76. <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.52 6.52 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 5"/></svg>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <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>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <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.52 6.52 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 5"/></svg>
  85. <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 11z"/></svg>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <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 12z"/></svg>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item md-tabs__item--active">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item">
  127. <a href="../../api/components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item">
  132. <a href="../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item">
  137. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../getting-started/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Getting started
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item md-nav__item--active">
  210. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  211. <label class="md-nav__link md-nav__link--active" for="__toc">
  212. <span class="md-ellipsis">
  213. FAQ
  214. </span>
  215. <span class="md-nav__icon md-icon"></span>
  216. </label>
  217. <a href="./" class="md-nav__link md-nav__link--active">
  218. <span class="md-ellipsis">
  219. FAQ
  220. </span>
  221. </a>
  222. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  223. <label class="md-nav__title" for="__toc">
  224. <span class="md-nav__icon md-icon"></span>
  225. Table of contents
  226. </label>
  227. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  228. <li class="md-nav__item">
  229. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  230. <span class="md-ellipsis">
  231. Can I manually trigger a secret refresh?
  232. </span>
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  237. <span class="md-ellipsis">
  238. How do I know when my secret was last synced?
  239. </span>
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="#how-do-i-know-when-the-status-of-my-secret-changed-the-last-time" class="md-nav__link">
  244. <span class="md-ellipsis">
  245. How do I know when the status of my secret changed the last time?
  246. </span>
  247. </a>
  248. </li>
  249. <li class="md-nav__item">
  250. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  251. <span class="md-ellipsis">
  252. Differences to csi-secret-store
  253. </span>
  254. </a>
  255. </li>
  256. <li class="md-nav__item">
  257. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  258. <span class="md-ellipsis">
  259. How do I debug an external-secret that doesn't sync?
  260. </span>
  261. </a>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  265. <span class="md-ellipsis">
  266. Upgrading from KES to ESO
  267. </span>
  268. </a>
  269. </li>
  270. </ul>
  271. </nav>
  272. </li>
  273. <li class="md-nav__item">
  274. <a href="../stability-support/" class="md-nav__link">
  275. <span class="md-ellipsis">
  276. Stability and Support
  277. </span>
  278. </a>
  279. </li>
  280. <li class="md-nav__item">
  281. <a href="../deprecation-policy/" class="md-nav__link">
  282. <span class="md-ellipsis">
  283. Deprecation Policy
  284. </span>
  285. </a>
  286. </li>
  287. </ul>
  288. </nav>
  289. </li>
  290. <li class="md-nav__item md-nav__item--nested">
  291. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  292. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  293. <span class="md-ellipsis">
  294. API
  295. </span>
  296. <span class="md-nav__icon md-icon"></span>
  297. </label>
  298. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  299. <label class="md-nav__title" for="__nav_2">
  300. <span class="md-nav__icon md-icon"></span>
  301. API
  302. </label>
  303. <ul class="md-nav__list" data-md-scrollfix>
  304. <li class="md-nav__item">
  305. <a href="../../api/components/" class="md-nav__link">
  306. <span class="md-ellipsis">
  307. Components
  308. </span>
  309. </a>
  310. </li>
  311. <li class="md-nav__item md-nav__item--nested">
  312. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  313. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  314. <span class="md-ellipsis">
  315. Core Resources
  316. </span>
  317. <span class="md-nav__icon md-icon"></span>
  318. </label>
  319. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  320. <label class="md-nav__title" for="__nav_2_2">
  321. <span class="md-nav__icon md-icon"></span>
  322. Core Resources
  323. </label>
  324. <ul class="md-nav__list" data-md-scrollfix>
  325. <li class="md-nav__item">
  326. <a href="../../api/externalsecret/" class="md-nav__link">
  327. <span class="md-ellipsis">
  328. ExternalSecret
  329. </span>
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/secretstore/" class="md-nav__link">
  334. <span class="md-ellipsis">
  335. SecretStore
  336. </span>
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="../../api/clustersecretstore/" class="md-nav__link">
  341. <span class="md-ellipsis">
  342. ClusterSecretStore
  343. </span>
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. ClusterExternalSecret
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../../api/pushsecret/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. PushSecret
  357. </span>
  358. </a>
  359. </li>
  360. </ul>
  361. </nav>
  362. </li>
  363. <li class="md-nav__item md-nav__item--nested">
  364. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  365. <div class="md-nav__link md-nav__container">
  366. <a href="../../api/generator/" class="md-nav__link ">
  367. <span class="md-ellipsis">
  368. Generators
  369. </span>
  370. </a>
  371. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  372. <span class="md-nav__icon md-icon"></span>
  373. </label>
  374. </div>
  375. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  376. <label class="md-nav__title" for="__nav_2_3">
  377. <span class="md-nav__icon md-icon"></span>
  378. Generators
  379. </label>
  380. <ul class="md-nav__list" data-md-scrollfix>
  381. <li class="md-nav__item">
  382. <a href="../../api/generator/acr/" class="md-nav__link">
  383. <span class="md-ellipsis">
  384. Azure Container Registry
  385. </span>
  386. </a>
  387. </li>
  388. <li class="md-nav__item">
  389. <a href="../../api/generator/ecr/" class="md-nav__link">
  390. <span class="md-ellipsis">
  391. AWS Elastic Container Registry
  392. </span>
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../api/generator/gcr/" class="md-nav__link">
  397. <span class="md-ellipsis">
  398. Google Container Registry
  399. </span>
  400. </a>
  401. </li>
  402. <li class="md-nav__item">
  403. <a href="../../api/generator/vault/" class="md-nav__link">
  404. <span class="md-ellipsis">
  405. Vault Dynamic Secret
  406. </span>
  407. </a>
  408. </li>
  409. <li class="md-nav__item">
  410. <a href="../../api/generator/password/" class="md-nav__link">
  411. <span class="md-ellipsis">
  412. Password
  413. </span>
  414. </a>
  415. </li>
  416. <li class="md-nav__item">
  417. <a href="../../api/generator/fake/" class="md-nav__link">
  418. <span class="md-ellipsis">
  419. Fake
  420. </span>
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../../api/generator/webhook/" class="md-nav__link">
  425. <span class="md-ellipsis">
  426. Webhook
  427. </span>
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../api/generator/github/" class="md-nav__link">
  432. <span class="md-ellipsis">
  433. Github
  434. </span>
  435. </a>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="../../api/generator/uuid/" class="md-nav__link">
  439. <span class="md-ellipsis">
  440. UUID
  441. </span>
  442. </a>
  443. </li>
  444. </ul>
  445. </nav>
  446. </li>
  447. <li class="md-nav__item md-nav__item--nested">
  448. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  449. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  450. <span class="md-ellipsis">
  451. Reference Docs
  452. </span>
  453. <span class="md-nav__icon md-icon"></span>
  454. </label>
  455. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  456. <label class="md-nav__title" for="__nav_2_4">
  457. <span class="md-nav__icon md-icon"></span>
  458. Reference Docs
  459. </label>
  460. <ul class="md-nav__list" data-md-scrollfix>
  461. <li class="md-nav__item">
  462. <a href="../../api/spec/" class="md-nav__link">
  463. <span class="md-ellipsis">
  464. API specification
  465. </span>
  466. </a>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="../../api/controller-options/" class="md-nav__link">
  470. <span class="md-ellipsis">
  471. Controller Options
  472. </span>
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../../api/metrics/" class="md-nav__link">
  477. <span class="md-ellipsis">
  478. Metrics
  479. </span>
  480. </a>
  481. </li>
  482. </ul>
  483. </nav>
  484. </li>
  485. </ul>
  486. </nav>
  487. </li>
  488. <li class="md-nav__item md-nav__item--nested">
  489. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  490. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  491. <span class="md-ellipsis">
  492. Guides
  493. </span>
  494. <span class="md-nav__icon md-icon"></span>
  495. </label>
  496. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  497. <label class="md-nav__title" for="__nav_3">
  498. <span class="md-nav__icon md-icon"></span>
  499. Guides
  500. </label>
  501. <ul class="md-nav__list" data-md-scrollfix>
  502. <li class="md-nav__item">
  503. <a href="../../guides/introduction/" class="md-nav__link">
  504. <span class="md-ellipsis">
  505. Introduction
  506. </span>
  507. </a>
  508. </li>
  509. <li class="md-nav__item md-nav__item--nested">
  510. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  511. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  512. <span class="md-ellipsis">
  513. External Secrets
  514. </span>
  515. <span class="md-nav__icon md-icon"></span>
  516. </label>
  517. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  518. <label class="md-nav__title" for="__nav_3_2">
  519. <span class="md-nav__icon md-icon"></span>
  520. External Secrets
  521. </label>
  522. <ul class="md-nav__list" data-md-scrollfix>
  523. <li class="md-nav__item">
  524. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  525. <span class="md-ellipsis">
  526. Extract structured data
  527. </span>
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../guides/getallsecrets/" class="md-nav__link">
  532. <span class="md-ellipsis">
  533. Find Secrets by Name or Metadata
  534. </span>
  535. </a>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  539. <span class="md-ellipsis">
  540. Rewriting Keys
  541. </span>
  542. </a>
  543. </li>
  544. <li class="md-nav__item md-nav__item--nested">
  545. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  546. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  547. <span class="md-ellipsis">
  548. Advanced Templating
  549. </span>
  550. <span class="md-nav__icon md-icon"></span>
  551. </label>
  552. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  553. <label class="md-nav__title" for="__nav_3_2_4">
  554. <span class="md-nav__icon md-icon"></span>
  555. Advanced Templating
  556. </label>
  557. <ul class="md-nav__list" data-md-scrollfix>
  558. <li class="md-nav__item">
  559. <a href="../../guides/templating/" class="md-nav__link">
  560. <span class="md-ellipsis">
  561. v2
  562. </span>
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="../../guides/templating-v1/" class="md-nav__link">
  567. <span class="md-ellipsis">
  568. v1
  569. </span>
  570. </a>
  571. </li>
  572. </ul>
  573. </nav>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  577. <span class="md-ellipsis">
  578. Kubernetes Secret Types
  579. </span>
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  584. <span class="md-ellipsis">
  585. Lifecycle: ownership & deletion
  586. </span>
  587. </a>
  588. </li>
  589. <li class="md-nav__item">
  590. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  591. <span class="md-ellipsis">
  592. Decoding Strategies
  593. </span>
  594. </a>
  595. </li>
  596. <li class="md-nav__item">
  597. <a href="../../guides/controller-class/" class="md-nav__link">
  598. <span class="md-ellipsis">
  599. Controller Classes
  600. </span>
  601. </a>
  602. </li>
  603. </ul>
  604. </nav>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="../../guides/generator/" class="md-nav__link">
  608. <span class="md-ellipsis">
  609. Generators
  610. </span>
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../../guides/pushsecrets/" class="md-nav__link">
  615. <span class="md-ellipsis">
  616. Push Secrets
  617. </span>
  618. </a>
  619. </li>
  620. <li class="md-nav__item md-nav__item--nested">
  621. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  622. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  623. <span class="md-ellipsis">
  624. Operations
  625. </span>
  626. <span class="md-nav__icon md-icon"></span>
  627. </label>
  628. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  629. <label class="md-nav__title" for="__nav_3_5">
  630. <span class="md-nav__icon md-icon"></span>
  631. Operations
  632. </label>
  633. <ul class="md-nav__list" data-md-scrollfix>
  634. <li class="md-nav__item">
  635. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  636. <span class="md-ellipsis">
  637. Multi Tenancy
  638. </span>
  639. </a>
  640. </li>
  641. <li class="md-nav__item">
  642. <a href="../../guides/security-best-practices/" class="md-nav__link">
  643. <span class="md-ellipsis">
  644. Security Best Practices
  645. </span>
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="../../guides/threat-model/" class="md-nav__link">
  650. <span class="md-ellipsis">
  651. Threat Model
  652. </span>
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="../../guides/v1beta1/" class="md-nav__link">
  657. <span class="md-ellipsis">
  658. Upgrading to v1beta1
  659. </span>
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../../guides/using-latest-image/" class="md-nav__link">
  664. <span class="md-ellipsis">
  665. Using Latest Image
  666. </span>
  667. </a>
  668. </li>
  669. <li class="md-nav__item">
  670. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  671. <span class="md-ellipsis">
  672. Disable Cluster Features
  673. </span>
  674. </a>
  675. </li>
  676. </ul>
  677. </nav>
  678. </li>
  679. </ul>
  680. </nav>
  681. </li>
  682. <li class="md-nav__item md-nav__item--nested">
  683. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  684. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  685. <span class="md-ellipsis">
  686. Provider
  687. </span>
  688. <span class="md-nav__icon md-icon"></span>
  689. </label>
  690. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  691. <label class="md-nav__title" for="__nav_4">
  692. <span class="md-nav__icon md-icon"></span>
  693. Provider
  694. </label>
  695. <ul class="md-nav__list" data-md-scrollfix>
  696. <li class="md-nav__item">
  697. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. AWS Secrets Manager
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. AWS Parameter Store
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Azure Key Vault
  714. </span>
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../provider/beyondtrust/" class="md-nav__link">
  719. <span class="md-ellipsis">
  720. BeyondTrust
  721. </span>
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  726. <span class="md-ellipsis">
  727. Bitwarden Secrets Manager
  728. </span>
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../provider/chef/" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. Chef
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../provider/conjur/" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. CyberArk Conjur
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/device42/" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. Device42
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. Google Cloud Secret Manager
  756. </span>
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. HashiCorp Vault
  763. </span>
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../provider/kubernetes/" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. Kubernetes
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. IBM Secrets Manager
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../provider/akeyless/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Akeyless
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. Yandex Certificate Manager
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. Yandex Lockbox
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../../provider/alibaba/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. Alibaba Cloud
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. GitLab Variables
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="../../provider/oracle-vault/" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Oracle Vault
  819. </span>
  820. </a>
  821. </li>
  822. <li class="md-nav__item">
  823. <a href="../../provider/1password-automation/" class="md-nav__link">
  824. <span class="md-ellipsis">
  825. 1Password Secrets Automation
  826. </span>
  827. </a>
  828. </li>
  829. <li class="md-nav__item">
  830. <a href="../../provider/webhook/" class="md-nav__link">
  831. <span class="md-ellipsis">
  832. Webhook
  833. </span>
  834. </a>
  835. </li>
  836. <li class="md-nav__item">
  837. <a href="../../provider/fake/" class="md-nav__link">
  838. <span class="md-ellipsis">
  839. Fake
  840. </span>
  841. </a>
  842. </li>
  843. <li class="md-nav__item">
  844. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  845. <span class="md-ellipsis">
  846. senhasegura DevOps Secrets Management (DSM)
  847. </span>
  848. </a>
  849. </li>
  850. <li class="md-nav__item">
  851. <a href="../../provider/doppler/" class="md-nav__link">
  852. <span class="md-ellipsis">
  853. Doppler
  854. </span>
  855. </a>
  856. </li>
  857. <li class="md-nav__item">
  858. <a href="../../provider/keeper-security/" class="md-nav__link">
  859. <span class="md-ellipsis">
  860. Keeper Security
  861. </span>
  862. </a>
  863. </li>
  864. <li class="md-nav__item">
  865. <a href="../../provider/cloak/" class="md-nav__link">
  866. <span class="md-ellipsis">
  867. Cloak End 2 End Encrypted Secrets
  868. </span>
  869. </a>
  870. </li>
  871. <li class="md-nav__item">
  872. <a href="../../provider/scaleway/" class="md-nav__link">
  873. <span class="md-ellipsis">
  874. Scaleway
  875. </span>
  876. </a>
  877. </li>
  878. <li class="md-nav__item">
  879. <a href="../../provider/delinea/" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Delinea
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="../../provider/secretserver/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Secret Server
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../provider/passbolt/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. Passbolt
  896. </span>
  897. </a>
  898. </li>
  899. <li class="md-nav__item">
  900. <a href="../../provider/pulumi/" class="md-nav__link">
  901. <span class="md-ellipsis">
  902. Pulumi ESC
  903. </span>
  904. </a>
  905. </li>
  906. <li class="md-nav__item">
  907. <a href="../../provider/onboardbase/" class="md-nav__link">
  908. <span class="md-ellipsis">
  909. Onboardbase
  910. </span>
  911. </a>
  912. </li>
  913. <li class="md-nav__item">
  914. <a href="../../provider-passworddepot/" class="md-nav__link">
  915. <span class="md-ellipsis">
  916. Password Depot
  917. </span>
  918. </a>
  919. </li>
  920. <li class="md-nav__item">
  921. <a href="../../provider/fortanix/" class="md-nav__link">
  922. <span class="md-ellipsis">
  923. Fortanix
  924. </span>
  925. </a>
  926. </li>
  927. <li class="md-nav__item">
  928. <a href="../../provider/infisical/" class="md-nav__link">
  929. <span class="md-ellipsis">
  930. Infisical
  931. </span>
  932. </a>
  933. </li>
  934. <li class="md-nav__item">
  935. <a href="../../provider/previder/" class="md-nav__link">
  936. <span class="md-ellipsis">
  937. Previder
  938. </span>
  939. </a>
  940. </li>
  941. </ul>
  942. </nav>
  943. </li>
  944. <li class="md-nav__item md-nav__item--nested">
  945. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  946. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  947. <span class="md-ellipsis">
  948. Examples
  949. </span>
  950. <span class="md-nav__icon md-icon"></span>
  951. </label>
  952. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  953. <label class="md-nav__title" for="__nav_5">
  954. <span class="md-nav__icon md-icon"></span>
  955. Examples
  956. </label>
  957. <ul class="md-nav__list" data-md-scrollfix>
  958. <li class="md-nav__item">
  959. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. FluxCD
  962. </span>
  963. </a>
  964. </li>
  965. <li class="md-nav__item">
  966. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  967. <span class="md-ellipsis">
  968. Anchore Engine
  969. </span>
  970. </a>
  971. </li>
  972. <li class="md-nav__item">
  973. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  974. <span class="md-ellipsis">
  975. Jenkins
  976. </span>
  977. </a>
  978. </li>
  979. <li class="md-nav__item">
  980. <a href="../../examples/bitwarden/" class="md-nav__link">
  981. <span class="md-ellipsis">
  982. BitWarden
  983. </span>
  984. </a>
  985. </li>
  986. </ul>
  987. </nav>
  988. </li>
  989. <li class="md-nav__item md-nav__item--nested">
  990. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  991. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  992. <span class="md-ellipsis">
  993. Community
  994. </span>
  995. <span class="md-nav__icon md-icon"></span>
  996. </label>
  997. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  998. <label class="md-nav__title" for="__nav_6">
  999. <span class="md-nav__icon md-icon"></span>
  1000. Community
  1001. </label>
  1002. <ul class="md-nav__list" data-md-scrollfix>
  1003. <li class="md-nav__item md-nav__item--nested">
  1004. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1005. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1006. <span class="md-ellipsis">
  1007. Contributing
  1008. </span>
  1009. <span class="md-nav__icon md-icon"></span>
  1010. </label>
  1011. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1012. <label class="md-nav__title" for="__nav_6_1">
  1013. <span class="md-nav__icon md-icon"></span>
  1014. Contributing
  1015. </label>
  1016. <ul class="md-nav__list" data-md-scrollfix>
  1017. <li class="md-nav__item">
  1018. <a href="../../contributing/devguide/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Developer guide
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../../contributing/process/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Contributing Process
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../../contributing/release/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Release Process
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="../../contributing/coc/" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Code of Conduct
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="../../contributing/roadmap/" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Roadmap
  1049. </span>
  1050. </a>
  1051. </li>
  1052. </ul>
  1053. </nav>
  1054. </li>
  1055. <li class="md-nav__item md-nav__item--nested">
  1056. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1057. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1058. <span class="md-ellipsis">
  1059. External Resources
  1060. </span>
  1061. <span class="md-nav__icon md-icon"></span>
  1062. </label>
  1063. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1064. <label class="md-nav__title" for="__nav_6_2">
  1065. <span class="md-nav__icon md-icon"></span>
  1066. External Resources
  1067. </label>
  1068. <ul class="md-nav__list" data-md-scrollfix>
  1069. <li class="md-nav__item">
  1070. <a href="../../eso-talks/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Talks
  1073. </span>
  1074. </a>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="../../eso-demos/" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. Demos
  1080. </span>
  1081. </a>
  1082. </li>
  1083. <li class="md-nav__item">
  1084. <a href="../../eso-blogs/" class="md-nav__link">
  1085. <span class="md-ellipsis">
  1086. Blogs
  1087. </span>
  1088. </a>
  1089. </li>
  1090. <li class="md-nav__item">
  1091. <a href="../../eso-tools/" class="md-nav__link">
  1092. <span class="md-ellipsis">
  1093. Tools
  1094. </span>
  1095. </a>
  1096. </li>
  1097. </ul>
  1098. </nav>
  1099. </li>
  1100. </ul>
  1101. </nav>
  1102. </li>
  1103. </ul>
  1104. </nav>
  1105. </div>
  1106. </div>
  1107. </div>
  1108. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1109. <div class="md-sidebar__scrollwrap">
  1110. <div class="md-sidebar__inner">
  1111. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1112. <label class="md-nav__title" for="__toc">
  1113. <span class="md-nav__icon md-icon"></span>
  1114. Table of contents
  1115. </label>
  1116. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1117. <li class="md-nav__item">
  1118. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  1119. <span class="md-ellipsis">
  1120. Can I manually trigger a secret refresh?
  1121. </span>
  1122. </a>
  1123. </li>
  1124. <li class="md-nav__item">
  1125. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  1126. <span class="md-ellipsis">
  1127. How do I know when my secret was last synced?
  1128. </span>
  1129. </a>
  1130. </li>
  1131. <li class="md-nav__item">
  1132. <a href="#how-do-i-know-when-the-status-of-my-secret-changed-the-last-time" class="md-nav__link">
  1133. <span class="md-ellipsis">
  1134. How do I know when the status of my secret changed the last time?
  1135. </span>
  1136. </a>
  1137. </li>
  1138. <li class="md-nav__item">
  1139. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  1140. <span class="md-ellipsis">
  1141. Differences to csi-secret-store
  1142. </span>
  1143. </a>
  1144. </li>
  1145. <li class="md-nav__item">
  1146. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  1147. <span class="md-ellipsis">
  1148. How do I debug an external-secret that doesn't sync?
  1149. </span>
  1150. </a>
  1151. </li>
  1152. <li class="md-nav__item">
  1153. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  1154. <span class="md-ellipsis">
  1155. Upgrading from KES to ESO
  1156. </span>
  1157. </a>
  1158. </li>
  1159. </ul>
  1160. </nav>
  1161. </div>
  1162. </div>
  1163. </div>
  1164. <div class="md-content" data-md-component="content">
  1165. <article class="md-content__inner md-typeset">
  1166. <h1>FAQ</h1>
  1167. <h2 id="can-i-manually-trigger-a-secret-refresh">Can I manually trigger a secret refresh?</h2>
  1168. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client.
  1169. You just need to change an annotation, label or the spec of the resource:</p>
  1170. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  1171. </code></pre></div>
  1172. <h2 id="how-do-i-know-when-my-secret-was-last-synced">How do I know when my secret was last synced?</h2>
  1173. <p>The last synchronization timestamp of an ExternalSecret can be retrieved from the field <code>refreshTime</code>. </p>
  1174. <div class="highlight"><pre><span></span><code>kubectl get es my-external-secret -o yaml | grep refreshTime
  1175. refreshTime: &quot;2022-05-21T23:02:47Z&quot;
  1176. </code></pre></div>
  1177. <p>The interval can be changed by the <code>spec.refreshInterval</code> in the ExternalSecret.</p>
  1178. <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>
  1179. <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>
  1180. <div class="highlight"><pre><span></span><code>kubectl get es my-external-secret -o yaml | grep condition -A 5
  1181. conditions:
  1182. - lastTransitionTime: &quot;2022-05-21T21:02:47Z&quot;
  1183. message: Secret was synced
  1184. reason: SecretSynced
  1185. status: &quot;True&quot;
  1186. type: Ready
  1187. </code></pre></div>
  1188. <h2 id="differences-to-csi-secret-store">Differences to csi-secret-store</h2>
  1189. <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>
  1190. <h2 id="how-do-i-debug-an-external-secret-that-doesnt-sync">How do I debug an external-secret that doesn't sync?</h2>
  1191. <p>First, check the status of the ExternalSecret resource using <code>kubectl describe</code>. That displays the status conditions as well as recent events.
  1192. 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>
  1193. <div class="highlight"><pre><span></span><code>kubectl describe es my-external-secret
  1194. [...]
  1195. Status:
  1196. Conditions:
  1197. Last Transition Time: 2022-05-21T21:02:47Z
  1198. Message: Secret was synced
  1199. Reason: SecretSynced
  1200. Status: True
  1201. Type: Ready
  1202. Refresh Time: 2022-05-21T21:06:47Z
  1203. Synced Resource Version: 1-5c833527afd7ba3f426cb0082ee7e083
  1204. Events:
  1205. Type Reason Age From Message
  1206. ---- ------ ---- ---- -------
  1207. Warning UpdateFailed 4m12s external-secrets secrets &quot;yyyyyyy&quot; already exists
  1208. Normal Updated 12s (x4 over 3m12s) external-secrets Updated Secret
  1209. </code></pre></div>
  1210. <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>
  1211. <p>In an ideally, the store should be validated and Ready.</p>
  1212. <div class="highlight"><pre><span></span><code>kubectl describe css kubernetes
  1213. [...]
  1214. Status:
  1215. Conditions:
  1216. Last Transition Time: 2022-05-21T21:02:47Z
  1217. Message: store validated
  1218. Reason: Valid
  1219. Status: True
  1220. Type: Ready
  1221. Events:
  1222. Type Reason Age From Message
  1223. ---- ------ ---- ---- -------
  1224. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  1225. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  1226. </code></pre></div>
  1227. <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>
  1228. <h2 id="upgrading-from-kes-to-eso">Upgrading from KES to ESO</h2>
  1229. <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>
  1230. <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.
  1231. 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>
  1232. </article>
  1233. </div>
  1234. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1235. </div>
  1236. </main>
  1237. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1238. <footer class="md-footer">
  1239. <div class="md-footer-meta md-typeset">
  1240. <div class="md-footer-meta__inner md-grid">
  1241. <div class="md-copyright">
  1242. <div class="md-copyright__highlight">
  1243. &copy; 2024 The external-secrets Authors.<br/>
  1244. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1245. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1246. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1247. </div>
  1248. Made with
  1249. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1250. Material for MkDocs
  1251. </a>
  1252. </div>
  1253. </div>
  1254. </div>
  1255. </footer>
  1256. </div>
  1257. <div class="md-dialog" data-md-component="dialog">
  1258. <div class="md-dialog__inner md-typeset"></div>
  1259. </div>
  1260. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.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>
  1261. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  1262. </body>
  1263. </html>