index.html 73 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482
  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="../components/">
  7. <link rel="next" href="../secretstore/">
  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>ExternalSecret - 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="#template" 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. ExternalSecret
  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">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item md-tabs__item--active">
  116. <a href="../components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <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--nested">
  172. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  173. <div class="md-nav__link md-nav__container">
  174. <a href="../.." class="md-nav__link ">
  175. <span class="md-ellipsis">
  176. Introduction
  177. </span>
  178. </a>
  179. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  180. <span class="md-nav__icon md-icon"></span>
  181. </label>
  182. </div>
  183. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  184. <label class="md-nav__title" for="__nav_1">
  185. <span class="md-nav__icon md-icon"></span>
  186. Introduction
  187. </label>
  188. <ul class="md-nav__list" data-md-scrollfix>
  189. <li class="md-nav__item">
  190. <a href="../../introduction/overview/" class="md-nav__link">
  191. <span class="md-ellipsis">
  192. Overview
  193. </span>
  194. </a>
  195. </li>
  196. <li class="md-nav__item">
  197. <a href="../../introduction/getting-started/" class="md-nav__link">
  198. <span class="md-ellipsis">
  199. Getting started
  200. </span>
  201. </a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="../../introduction/faq/" class="md-nav__link">
  205. <span class="md-ellipsis">
  206. FAQ
  207. </span>
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../../introduction/stability-support/" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. Stability and Support
  214. </span>
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Deprecation Policy
  221. </span>
  222. </a>
  223. </li>
  224. </ul>
  225. </nav>
  226. </li>
  227. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  229. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  230. <span class="md-ellipsis">
  231. API
  232. </span>
  233. <span class="md-nav__icon md-icon"></span>
  234. </label>
  235. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  236. <label class="md-nav__title" for="__nav_2">
  237. <span class="md-nav__icon md-icon"></span>
  238. API
  239. </label>
  240. <ul class="md-nav__list" data-md-scrollfix>
  241. <li class="md-nav__item">
  242. <a href="../components/" class="md-nav__link">
  243. <span class="md-ellipsis">
  244. Components
  245. </span>
  246. </a>
  247. </li>
  248. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  249. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2" checked>
  250. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  251. <span class="md-ellipsis">
  252. Core Resources
  253. </span>
  254. <span class="md-nav__icon md-icon"></span>
  255. </label>
  256. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="true">
  257. <label class="md-nav__title" for="__nav_2_2">
  258. <span class="md-nav__icon md-icon"></span>
  259. Core Resources
  260. </label>
  261. <ul class="md-nav__list" data-md-scrollfix>
  262. <li class="md-nav__item md-nav__item--active">
  263. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  264. <label class="md-nav__link md-nav__link--active" for="__toc">
  265. <span class="md-ellipsis">
  266. ExternalSecret
  267. </span>
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. <a href="./" class="md-nav__link md-nav__link--active">
  271. <span class="md-ellipsis">
  272. ExternalSecret
  273. </span>
  274. </a>
  275. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  276. <label class="md-nav__title" for="__toc">
  277. <span class="md-nav__icon md-icon"></span>
  278. Table of contents
  279. </label>
  280. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  281. <li class="md-nav__item">
  282. <a href="#template" class="md-nav__link">
  283. <span class="md-ellipsis">
  284. Template
  285. </span>
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="#update-behavior" class="md-nav__link">
  290. <span class="md-ellipsis">
  291. Update Behavior
  292. </span>
  293. </a>
  294. </li>
  295. <li class="md-nav__item">
  296. <a href="#features" class="md-nav__link">
  297. <span class="md-ellipsis">
  298. Features
  299. </span>
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="#example" class="md-nav__link">
  304. <span class="md-ellipsis">
  305. Example
  306. </span>
  307. </a>
  308. </li>
  309. </ul>
  310. </nav>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="../secretstore/" class="md-nav__link">
  314. <span class="md-ellipsis">
  315. SecretStore
  316. </span>
  317. </a>
  318. </li>
  319. <li class="md-nav__item">
  320. <a href="../clustersecretstore/" class="md-nav__link">
  321. <span class="md-ellipsis">
  322. ClusterSecretStore
  323. </span>
  324. </a>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="../clusterexternalsecret/" class="md-nav__link">
  328. <span class="md-ellipsis">
  329. ClusterExternalSecret
  330. </span>
  331. </a>
  332. </li>
  333. <li class="md-nav__item">
  334. <a href="../pushsecret/" class="md-nav__link">
  335. <span class="md-ellipsis">
  336. PushSecret
  337. </span>
  338. </a>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  345. <div class="md-nav__link md-nav__container">
  346. <a href="../generator/" class="md-nav__link ">
  347. <span class="md-ellipsis">
  348. Generators
  349. </span>
  350. </a>
  351. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  352. <span class="md-nav__icon md-icon"></span>
  353. </label>
  354. </div>
  355. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  356. <label class="md-nav__title" for="__nav_2_3">
  357. <span class="md-nav__icon md-icon"></span>
  358. Generators
  359. </label>
  360. <ul class="md-nav__list" data-md-scrollfix>
  361. <li class="md-nav__item">
  362. <a href="../generator/acr/" class="md-nav__link">
  363. <span class="md-ellipsis">
  364. Azure Container Registry
  365. </span>
  366. </a>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="../generator/ecr/" class="md-nav__link">
  370. <span class="md-ellipsis">
  371. AWS Elastic Container Registry
  372. </span>
  373. </a>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="../generator/gcr/" class="md-nav__link">
  377. <span class="md-ellipsis">
  378. Google Container Registry
  379. </span>
  380. </a>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="../generator/vault/" class="md-nav__link">
  384. <span class="md-ellipsis">
  385. Vault Dynamic Secret
  386. </span>
  387. </a>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="../generator/password/" class="md-nav__link">
  391. <span class="md-ellipsis">
  392. Password
  393. </span>
  394. </a>
  395. </li>
  396. <li class="md-nav__item">
  397. <a href="../generator/fake/" class="md-nav__link">
  398. <span class="md-ellipsis">
  399. Fake
  400. </span>
  401. </a>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="../generator/webhook/" class="md-nav__link">
  405. <span class="md-ellipsis">
  406. Webhook
  407. </span>
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../generator/github/" class="md-nav__link">
  412. <span class="md-ellipsis">
  413. Github
  414. </span>
  415. </a>
  416. </li>
  417. </ul>
  418. </nav>
  419. </li>
  420. <li class="md-nav__item md-nav__item--nested">
  421. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  422. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  423. <span class="md-ellipsis">
  424. Reference Docs
  425. </span>
  426. <span class="md-nav__icon md-icon"></span>
  427. </label>
  428. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  429. <label class="md-nav__title" for="__nav_2_4">
  430. <span class="md-nav__icon md-icon"></span>
  431. Reference Docs
  432. </label>
  433. <ul class="md-nav__list" data-md-scrollfix>
  434. <li class="md-nav__item">
  435. <a href="../spec/" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. API specification
  438. </span>
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../controller-options/" class="md-nav__link">
  443. <span class="md-ellipsis">
  444. Controller Options
  445. </span>
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../metrics/" class="md-nav__link">
  450. <span class="md-ellipsis">
  451. Metrics
  452. </span>
  453. </a>
  454. </li>
  455. </ul>
  456. </nav>
  457. </li>
  458. </ul>
  459. </nav>
  460. </li>
  461. <li class="md-nav__item md-nav__item--nested">
  462. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  463. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  464. <span class="md-ellipsis">
  465. Guides
  466. </span>
  467. <span class="md-nav__icon md-icon"></span>
  468. </label>
  469. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  470. <label class="md-nav__title" for="__nav_3">
  471. <span class="md-nav__icon md-icon"></span>
  472. Guides
  473. </label>
  474. <ul class="md-nav__list" data-md-scrollfix>
  475. <li class="md-nav__item">
  476. <a href="../../guides/introduction/" class="md-nav__link">
  477. <span class="md-ellipsis">
  478. Introduction
  479. </span>
  480. </a>
  481. </li>
  482. <li class="md-nav__item md-nav__item--nested">
  483. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  484. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  485. <span class="md-ellipsis">
  486. External Secrets
  487. </span>
  488. <span class="md-nav__icon md-icon"></span>
  489. </label>
  490. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  491. <label class="md-nav__title" for="__nav_3_2">
  492. <span class="md-nav__icon md-icon"></span>
  493. External Secrets
  494. </label>
  495. <ul class="md-nav__list" data-md-scrollfix>
  496. <li class="md-nav__item">
  497. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  498. <span class="md-ellipsis">
  499. Extract structured data
  500. </span>
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../guides/getallsecrets/" class="md-nav__link">
  505. <span class="md-ellipsis">
  506. Find Secrets by Name or Metadata
  507. </span>
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  512. <span class="md-ellipsis">
  513. Rewriting Keys
  514. </span>
  515. </a>
  516. </li>
  517. <li class="md-nav__item md-nav__item--nested">
  518. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  519. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  520. <span class="md-ellipsis">
  521. Advanced Templating
  522. </span>
  523. <span class="md-nav__icon md-icon"></span>
  524. </label>
  525. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  526. <label class="md-nav__title" for="__nav_3_2_4">
  527. <span class="md-nav__icon md-icon"></span>
  528. Advanced Templating
  529. </label>
  530. <ul class="md-nav__list" data-md-scrollfix>
  531. <li class="md-nav__item">
  532. <a href="../../guides/templating/" class="md-nav__link">
  533. <span class="md-ellipsis">
  534. v2
  535. </span>
  536. </a>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="../../guides/templating-v1/" class="md-nav__link">
  540. <span class="md-ellipsis">
  541. v1
  542. </span>
  543. </a>
  544. </li>
  545. </ul>
  546. </nav>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  550. <span class="md-ellipsis">
  551. Kubernetes Secret Types
  552. </span>
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  557. <span class="md-ellipsis">
  558. Lifecycle: ownership & deletion
  559. </span>
  560. </a>
  561. </li>
  562. <li class="md-nav__item">
  563. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  564. <span class="md-ellipsis">
  565. Decoding Strategies
  566. </span>
  567. </a>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="../../guides/controller-class/" class="md-nav__link">
  571. <span class="md-ellipsis">
  572. Controller Classes
  573. </span>
  574. </a>
  575. </li>
  576. </ul>
  577. </nav>
  578. </li>
  579. <li class="md-nav__item">
  580. <a href="../../guides/generator/" class="md-nav__link">
  581. <span class="md-ellipsis">
  582. Generators
  583. </span>
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../../guides/pushsecrets/" class="md-nav__link">
  588. <span class="md-ellipsis">
  589. Push Secrets
  590. </span>
  591. </a>
  592. </li>
  593. <li class="md-nav__item md-nav__item--nested">
  594. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  595. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  596. <span class="md-ellipsis">
  597. Operations
  598. </span>
  599. <span class="md-nav__icon md-icon"></span>
  600. </label>
  601. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  602. <label class="md-nav__title" for="__nav_3_5">
  603. <span class="md-nav__icon md-icon"></span>
  604. Operations
  605. </label>
  606. <ul class="md-nav__list" data-md-scrollfix>
  607. <li class="md-nav__item">
  608. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  609. <span class="md-ellipsis">
  610. Multi Tenancy
  611. </span>
  612. </a>
  613. </li>
  614. <li class="md-nav__item">
  615. <a href="../../guides/security-best-practices/" class="md-nav__link">
  616. <span class="md-ellipsis">
  617. Security Best Practices
  618. </span>
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../../guides/threat-model/" class="md-nav__link">
  623. <span class="md-ellipsis">
  624. Threat Model
  625. </span>
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../../guides/v1beta1/" class="md-nav__link">
  630. <span class="md-ellipsis">
  631. Upgrading to v1beta1
  632. </span>
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../guides/using-latest-image/" class="md-nav__link">
  637. <span class="md-ellipsis">
  638. Using Latest Image
  639. </span>
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  644. <span class="md-ellipsis">
  645. Disable Cluster Features
  646. </span>
  647. </a>
  648. </li>
  649. </ul>
  650. </nav>
  651. </li>
  652. </ul>
  653. </nav>
  654. </li>
  655. <li class="md-nav__item md-nav__item--nested">
  656. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  657. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  658. <span class="md-ellipsis">
  659. Provider
  660. </span>
  661. <span class="md-nav__icon md-icon"></span>
  662. </label>
  663. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  664. <label class="md-nav__title" for="__nav_4">
  665. <span class="md-nav__icon md-icon"></span>
  666. Provider
  667. </label>
  668. <ul class="md-nav__list" data-md-scrollfix>
  669. <li class="md-nav__item">
  670. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  671. <span class="md-ellipsis">
  672. AWS Secrets Manager
  673. </span>
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  678. <span class="md-ellipsis">
  679. AWS Parameter Store
  680. </span>
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  685. <span class="md-ellipsis">
  686. Azure Key Vault
  687. </span>
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../../provider/chef/" class="md-nav__link">
  692. <span class="md-ellipsis">
  693. Chef
  694. </span>
  695. </a>
  696. </li>
  697. <li class="md-nav__item">
  698. <a href="../../provider/conjur/" class="md-nav__link">
  699. <span class="md-ellipsis">
  700. CyberArk Conjur
  701. </span>
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  706. <span class="md-ellipsis">
  707. Google Cloud Secret Manager
  708. </span>
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. HashiCorp Vault
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../provider/kubernetes/" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. Kubernetes
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. IBM Secrets Manager
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="../../provider/akeyless/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. Akeyless
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. Yandex Certificate Manager
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. Yandex Lockbox
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="../../provider/alibaba/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Alibaba Cloud
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. GitLab Variables
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="../../provider/oracle-vault/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Oracle Vault
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../../provider/1password-automation/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. 1Password Secrets Automation
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../../provider/webhook/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. Webhook
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="../../provider/fake/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. Fake
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. senhasegura DevOps Secrets Management (DSM)
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="../../provider/doppler/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. Doppler
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="../../provider/keeper-security/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. Keeper Security
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="../../provider/cloak/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. Cloak End 2 End Encrypted Secrets
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="../../provider/scaleway/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Scaleway
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="../../provider/delinea/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. Delinea
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="../../provider/passbolt/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. Passbolt
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="../../provider/pulumi/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Pulumi ESC
  848. </span>
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="../../provider/onboardbase/" class="md-nav__link">
  853. <span class="md-ellipsis">
  854. Onboardbase
  855. </span>
  856. </a>
  857. </li>
  858. <li class="md-nav__item">
  859. <a href="../../provider-passworddepot/" class="md-nav__link">
  860. <span class="md-ellipsis">
  861. Password Depot
  862. </span>
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="../../provider/fortanix/" class="md-nav__link">
  867. <span class="md-ellipsis">
  868. Fortanix
  869. </span>
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="../../provider/infisical/" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. Infisical
  876. </span>
  877. </a>
  878. </li>
  879. </ul>
  880. </nav>
  881. </li>
  882. <li class="md-nav__item md-nav__item--nested">
  883. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  884. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  885. <span class="md-ellipsis">
  886. Examples
  887. </span>
  888. <span class="md-nav__icon md-icon"></span>
  889. </label>
  890. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  891. <label class="md-nav__title" for="__nav_5">
  892. <span class="md-nav__icon md-icon"></span>
  893. Examples
  894. </label>
  895. <ul class="md-nav__list" data-md-scrollfix>
  896. <li class="md-nav__item">
  897. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  898. <span class="md-ellipsis">
  899. FluxCD
  900. </span>
  901. </a>
  902. </li>
  903. <li class="md-nav__item">
  904. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  905. <span class="md-ellipsis">
  906. Anchore Engine
  907. </span>
  908. </a>
  909. </li>
  910. <li class="md-nav__item">
  911. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  912. <span class="md-ellipsis">
  913. Jenkins
  914. </span>
  915. </a>
  916. </li>
  917. <li class="md-nav__item">
  918. <a href="../../examples/bitwarden/" class="md-nav__link">
  919. <span class="md-ellipsis">
  920. BitWarden
  921. </span>
  922. </a>
  923. </li>
  924. </ul>
  925. </nav>
  926. </li>
  927. <li class="md-nav__item md-nav__item--nested">
  928. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  929. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  930. <span class="md-ellipsis">
  931. Community
  932. </span>
  933. <span class="md-nav__icon md-icon"></span>
  934. </label>
  935. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  936. <label class="md-nav__title" for="__nav_6">
  937. <span class="md-nav__icon md-icon"></span>
  938. Community
  939. </label>
  940. <ul class="md-nav__list" data-md-scrollfix>
  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_1" >
  943. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  944. <span class="md-ellipsis">
  945. Contributing
  946. </span>
  947. <span class="md-nav__icon md-icon"></span>
  948. </label>
  949. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  950. <label class="md-nav__title" for="__nav_6_1">
  951. <span class="md-nav__icon md-icon"></span>
  952. Contributing
  953. </label>
  954. <ul class="md-nav__list" data-md-scrollfix>
  955. <li class="md-nav__item">
  956. <a href="../../contributing/devguide/" class="md-nav__link">
  957. <span class="md-ellipsis">
  958. Developer guide
  959. </span>
  960. </a>
  961. </li>
  962. <li class="md-nav__item">
  963. <a href="../../contributing/process/" class="md-nav__link">
  964. <span class="md-ellipsis">
  965. Contributing Process
  966. </span>
  967. </a>
  968. </li>
  969. <li class="md-nav__item">
  970. <a href="../../contributing/release/" class="md-nav__link">
  971. <span class="md-ellipsis">
  972. Release Process
  973. </span>
  974. </a>
  975. </li>
  976. <li class="md-nav__item">
  977. <a href="../../contributing/coc/" class="md-nav__link">
  978. <span class="md-ellipsis">
  979. Code of Conduct
  980. </span>
  981. </a>
  982. </li>
  983. <li class="md-nav__item">
  984. <a href="../../contributing/roadmap/" class="md-nav__link">
  985. <span class="md-ellipsis">
  986. Roadmap
  987. </span>
  988. </a>
  989. </li>
  990. </ul>
  991. </nav>
  992. </li>
  993. <li class="md-nav__item md-nav__item--nested">
  994. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  995. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  996. <span class="md-ellipsis">
  997. External Resources
  998. </span>
  999. <span class="md-nav__icon md-icon"></span>
  1000. </label>
  1001. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1002. <label class="md-nav__title" for="__nav_6_2">
  1003. <span class="md-nav__icon md-icon"></span>
  1004. External Resources
  1005. </label>
  1006. <ul class="md-nav__list" data-md-scrollfix>
  1007. <li class="md-nav__item">
  1008. <a href="../../eso-talks/" class="md-nav__link">
  1009. <span class="md-ellipsis">
  1010. Talks
  1011. </span>
  1012. </a>
  1013. </li>
  1014. <li class="md-nav__item">
  1015. <a href="../../eso-demos/" class="md-nav__link">
  1016. <span class="md-ellipsis">
  1017. Demos
  1018. </span>
  1019. </a>
  1020. </li>
  1021. <li class="md-nav__item">
  1022. <a href="../../eso-blogs/" class="md-nav__link">
  1023. <span class="md-ellipsis">
  1024. Blogs
  1025. </span>
  1026. </a>
  1027. </li>
  1028. </ul>
  1029. </nav>
  1030. </li>
  1031. </ul>
  1032. </nav>
  1033. </li>
  1034. <li class="md-nav__item md-nav__item--nested">
  1035. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1036. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1037. <span class="md-ellipsis">
  1038. References
  1039. </span>
  1040. <span class="md-nav__icon md-icon"></span>
  1041. </label>
  1042. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1043. <label class="md-nav__title" for="__nav_7">
  1044. <span class="md-nav__icon md-icon"></span>
  1045. References
  1046. </label>
  1047. <ul class="md-nav__list" data-md-scrollfix>
  1048. <li class="md-nav__item">
  1049. <a href="../../spec/" class="md-nav__link">
  1050. <span class="md-ellipsis">
  1051. API specification
  1052. </span>
  1053. </a>
  1054. </li>
  1055. </ul>
  1056. </nav>
  1057. </li>
  1058. </ul>
  1059. </nav>
  1060. </div>
  1061. </div>
  1062. </div>
  1063. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1064. <div class="md-sidebar__scrollwrap">
  1065. <div class="md-sidebar__inner">
  1066. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1067. <label class="md-nav__title" for="__toc">
  1068. <span class="md-nav__icon md-icon"></span>
  1069. Table of contents
  1070. </label>
  1071. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1072. <li class="md-nav__item">
  1073. <a href="#template" class="md-nav__link">
  1074. <span class="md-ellipsis">
  1075. Template
  1076. </span>
  1077. </a>
  1078. </li>
  1079. <li class="md-nav__item">
  1080. <a href="#update-behavior" class="md-nav__link">
  1081. <span class="md-ellipsis">
  1082. Update Behavior
  1083. </span>
  1084. </a>
  1085. </li>
  1086. <li class="md-nav__item">
  1087. <a href="#features" class="md-nav__link">
  1088. <span class="md-ellipsis">
  1089. Features
  1090. </span>
  1091. </a>
  1092. </li>
  1093. <li class="md-nav__item">
  1094. <a href="#example" class="md-nav__link">
  1095. <span class="md-ellipsis">
  1096. Example
  1097. </span>
  1098. </a>
  1099. </li>
  1100. </ul>
  1101. </nav>
  1102. </div>
  1103. </div>
  1104. </div>
  1105. <div class="md-content" data-md-component="content">
  1106. <article class="md-content__inner md-typeset">
  1107. <h1>ExternalSecret</h1>
  1108. <p>The <code>ExternalSecret</code> describes what data should be fetched, how the data should
  1109. be transformed and saved as a <code>Kind=Secret</code>:</p>
  1110. <ul>
  1111. <li>tells the operator what secrets should be synced by using <code>spec.data</code> to
  1112. explicitly sync individual keys or use <code>spec.dataFrom</code> to get <strong>all values</strong>
  1113. from the external API.</li>
  1114. <li>you can specify how the secret should look like by specifying a
  1115. <code>spec.target.template</code></li>
  1116. </ul>
  1117. <h2 id="template">Template</h2>
  1118. <p>When the controller reconciles the <code>ExternalSecret</code> it will use the <code>spec.template</code> as a blueprint to construct a new <code>Kind=Secret</code>. You can use golang templates to define the blueprint and use template functions to transform secret values. You can also pull in <code>ConfigMaps</code> that contain golang-template data using <code>templateFrom</code>. See <a href="../../guides/templating/">advanced templating</a> for details.</p>
  1119. <h2 id="update-behavior">Update Behavior</h2>
  1120. <p>The <code>Kind=Secret</code> is updated when:</p>
  1121. <ul>
  1122. <li>the <code>spec.refreshInterval</code> has passed and is not <code>0</code></li>
  1123. <li>the <code>ExternalSecret</code>'s <code>labels</code> or <code>annotations</code> are changed</li>
  1124. <li>the <code>ExternalSecret</code>'s <code>spec</code> has been changed</li>
  1125. </ul>
  1126. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client:</p>
  1127. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  1128. </code></pre></div>
  1129. <h2 id="features">Features</h2>
  1130. <p>Individual features are described in the <a href="../../guides/introduction/">Guides section</a>:</p>
  1131. <ul>
  1132. <li><a href="../../guides/getallsecrets/">Find many secrets / Extract from structured data</a></li>
  1133. <li><a href="../../guides/templating/">Templating</a></li>
  1134. <li><a href="../../guides/generator/">Using Generators</a></li>
  1135. <li><a href="../../guides/ownership-deletion-policy/">Secret Ownership and Deletion</a></li>
  1136. <li><a href="../../guides/datafrom-rewrite/">Key Rewriting</a></li>
  1137. <li><a href="../../guides/decoding-strategy/">Decoding Strategy</a></li>
  1138. </ul>
  1139. <h2 id="example">Example</h2>
  1140. <p>Take a look at an annotated example to understand the design behind the
  1141. <code>ExternalSecret</code>.</p>
  1142. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1143. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1144. <span class="nt">metadata</span><span class="p">:</span>
  1145. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;hello-world&quot;</span>
  1146. <span class="w"> </span><span class="c1"># labels and annotations are copied over to the</span>
  1147. <span class="w"> </span><span class="c1"># secret that will be created</span>
  1148. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1149. <span class="w"> </span><span class="nt">acme.org/owned-by</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;q-team&quot;</span>
  1150. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1151. <span class="w"> </span><span class="nt">acme.org/sha</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1234</span>
  1152. <span class="nt">spec</span><span class="p">:</span>
  1153. <span class="w"> </span><span class="c1"># Optional, SecretStoreRef defines the default SecretStore to use when fetching the secret data.</span>
  1154. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1155. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aws-store</span>
  1156. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"> </span><span class="c1"># or ClusterSecretStore</span>
  1157. <span class="w"> </span><span class="c1"># RefreshInterval is the amount of time before the values reading again from the SecretStore provider</span>
  1158. <span class="w"> </span><span class="c1"># Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot; (from time.ParseDuration)</span>
  1159. <span class="w"> </span><span class="c1"># May be set to zero to fetch and create it once</span>
  1160. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1h&quot;</span>
  1161. <span class="w"> </span><span class="c1"># the target describes the secret that shall be created</span>
  1162. <span class="w"> </span><span class="c1"># there can only be one target per ExternalSecret</span>
  1163. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1164. <span class="w"> </span><span class="c1"># The secret name of the resource</span>
  1165. <span class="w"> </span><span class="c1"># Defaults to .metadata.name of the ExternalSecret</span>
  1166. <span class="w"> </span><span class="c1"># It is immutable</span>
  1167. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">application-config</span>
  1168. <span class="w"> </span><span class="c1"># Enum with values: &#39;Owner&#39;, &#39;Merge&#39;, or &#39;None&#39;</span>
  1169. <span class="w"> </span><span class="c1"># Default value of &#39;Owner&#39;</span>
  1170. <span class="w"> </span><span class="c1"># Owner creates the secret and sets .metadata.ownerReferences of the resource</span>
  1171. <span class="w"> </span><span class="c1"># Merge does not create the secret, but merges in the data fields to the secret</span>
  1172. <span class="w"> </span><span class="c1"># None does not create a secret (future use with injector)</span>
  1173. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;Merge&#39;</span>
  1174. <span class="w"> </span><span class="c1"># DeletionPolicy defines how/when to delete the Secret in Kubernetes</span>
  1175. <span class="w"> </span><span class="c1"># if the provider secret gets deleted.</span>
  1176. <span class="w"> </span><span class="c1"># Valid values are Delete, Merge, Retain</span>
  1177. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Retain&quot;</span>
  1178. <span class="w"> </span><span class="c1"># Specify a blueprint for the resulting Kind=Secret</span>
  1179. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1180. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubernetes.io/dockerconfigjson</span><span class="w"> </span><span class="c1"># or TLS...</span>
  1181. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1182. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
  1183. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
  1184. <span class="w"> </span><span class="c1"># Use inline templates to construct your desired config file that contains your secret</span>
  1185. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1186. <span class="w"> </span><span class="nt">config.yml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1187. <span class="w"> </span><span class="no">database:</span>
  1188. <span class="w"> </span><span class="no">connection: postgres://{{ .username }}:{{ .password }}@{{ .database_host }}:5432/payments</span>
  1189. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span>
  1190. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span>
  1191. <span class="w"> </span><span class="c1"># It does not update the configmap, it creates a secret with: data[&quot;alertmanager.yml&quot;] = ...result...</span>
  1192. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1193. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1194. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">application-config-tmpl</span>
  1195. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1196. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">config.yml</span>
  1197. <span class="w"> </span><span class="c1"># Data defines the connection between the Kubernetes Secret keys and the Provider data</span>
  1198. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1199. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span>
  1200. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1201. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">database-credentials</span>
  1202. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1203. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span>
  1204. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">None</span><span class="w"> </span><span class="c1"># can be None, Base64, Base64URL or Auto</span>
  1205. <span class="w"> </span><span class="c1"># define the source of the secret. Can be a SecretStore or a Generator kind</span>
  1206. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1207. <span class="w"> </span><span class="c1"># point to a SecretStore that should be used to fetch a secret.</span>
  1208. <span class="w"> </span><span class="c1"># must be defined if no spec.secretStoreRef is defined.</span>
  1209. <span class="w"> </span><span class="nt">storeRef</span><span class="p">:</span>
  1210. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aws-secretstore</span>
  1211. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1212. <span class="w"> </span><span class="c1"># Used to fetch all properties from the Provider key</span>
  1213. <span class="w"> </span><span class="c1"># If multiple dataFrom are specified, secrets are merged in the specified order</span>
  1214. <span class="w"> </span><span class="c1"># Can be defined using sourceRef.generatorRef or extract / find</span>
  1215. <span class="w"> </span><span class="c1"># Both use cases are exemplified below</span>
  1216. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1217. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1218. <span class="w"> </span><span class="nt">generatorRef</span><span class="p">:</span>
  1219. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">generators.external-secrets.io/v1alpha1</span>
  1220. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ECRAuthorizationToken</span>
  1221. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-ecr&quot;</span>
  1222. <span class="w"> </span><span class="c1">#Or</span>
  1223. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1224. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1225. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">database-credentials</span>
  1226. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1227. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">data</span>
  1228. <span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Default</span>
  1229. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Auto</span>
  1230. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1231. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1232. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;exp-(.*?)-ression&quot;</span>
  1233. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;rewriting-${1}-with-groups&quot;</span>
  1234. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span>
  1235. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path-to-filter</span>
  1236. <span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">&quot;exp-(.*?)-ression&quot;</span>
  1237. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;rewriting-${1}-with-groups&quot;</span>
  1238. <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
  1239. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;.*foobar.*&quot;</span>
  1240. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
  1241. <span class="w"> </span><span class="nt">foo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bar</span>
  1242. <span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Unicode</span>
  1243. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Base64</span>
  1244. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1245. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1246. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
  1247. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
  1248. <span class="nt">status</span><span class="p">:</span>
  1249. <span class="w"> </span><span class="c1"># refreshTime is the time and date the external secret was fetched and</span>
  1250. <span class="w"> </span><span class="c1"># the target secret updated</span>
  1251. <span class="w"> </span><span class="nt">refreshTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span>
  1252. <span class="w"> </span><span class="c1"># Standard condition schema</span>
  1253. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  1254. <span class="w"> </span><span class="c1"># ExternalSecret ready condition indicates the secret is ready for use.</span>
  1255. <span class="w"> </span><span class="c1"># This is defined as:</span>
  1256. <span class="w"> </span><span class="c1"># - The target secret exists</span>
  1257. <span class="w"> </span><span class="c1"># - The target secret has been refreshed within the last refreshInterval</span>
  1258. <span class="w"> </span><span class="c1"># - The target secret content is up-to-date based on any target templates</span>
  1259. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Ready</span>
  1260. <span class="w"> </span><span class="nt">status</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;True&quot;</span><span class="w"> </span><span class="c1"># False if last refresh was not successful</span>
  1261. <span class="w"> </span><span class="nt">reason</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecretSynced&quot;</span>
  1262. <span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Secret</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">synced&quot;</span>
  1263. <span class="w"> </span><span class="nt">lastTransitionTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span>
  1264. </code></pre></div>
  1265. </article>
  1266. </div>
  1267. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1268. </div>
  1269. </main>
  1270. <footer class="md-footer">
  1271. <div class="md-footer-meta md-typeset">
  1272. <div class="md-footer-meta__inner md-grid">
  1273. <div class="md-copyright">
  1274. <div class="md-copyright__highlight">
  1275. &copy; 2024 The external-secrets Authors.<br/>
  1276. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1277. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1278. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1279. </div>
  1280. Made with
  1281. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1282. Material for MkDocs
  1283. </a>
  1284. </div>
  1285. </div>
  1286. </div>
  1287. </footer>
  1288. </div>
  1289. <div class="md-dialog" data-md-component="dialog">
  1290. <div class="md-dialog__inner md-typeset"></div>
  1291. </div>
  1292. <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>
  1293. <script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
  1294. </body>
  1295. </html>