index.html 107 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977
  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="../datafrom-rewrite/">
  7. <link rel="next" href="../templating-v1/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.33">
  10. <title>v2 - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.3cba04c6.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#advanced-templating-v2" 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. v2
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  64. <label class="md-header__button md-icon" for="__search">
  65. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  74. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item md-tabs__item--active">
  121. <a href="../introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. </ul>
  146. </div>
  147. </nav>
  148. <main class="md-main" data-md-component="main">
  149. <div class="md-main__inner md-grid">
  150. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  151. <div class="md-sidebar__scrollwrap">
  152. <div class="md-sidebar__inner">
  153. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  154. <label class="md-nav__title" for="__drawer">
  155. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  156. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  157. </a>
  158. External Secrets Operator
  159. </label>
  160. <div class="md-nav__source">
  161. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  162. <div class="md-source__icon md-icon">
  163. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  164. </div>
  165. <div class="md-source__repository">
  166. External Secrets Operator
  167. </div>
  168. </a>
  169. </div>
  170. <ul class="md-nav__list" data-md-scrollfix>
  171. <li class="md-nav__item md-nav__item--nested">
  172. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  173. <div class="md-nav__link md-nav__container">
  174. <a href="../.." class="md-nav__link ">
  175. <span class="md-ellipsis">
  176. Introduction
  177. </span>
  178. </a>
  179. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  180. <span class="md-nav__icon md-icon"></span>
  181. </label>
  182. </div>
  183. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  184. <label class="md-nav__title" for="__nav_1">
  185. <span class="md-nav__icon md-icon"></span>
  186. Introduction
  187. </label>
  188. <ul class="md-nav__list" data-md-scrollfix>
  189. <li class="md-nav__item">
  190. <a href="../../introduction/overview/" class="md-nav__link">
  191. <span class="md-ellipsis">
  192. Overview
  193. </span>
  194. </a>
  195. </li>
  196. <li class="md-nav__item">
  197. <a href="../../introduction/getting-started/" class="md-nav__link">
  198. <span class="md-ellipsis">
  199. Getting started
  200. </span>
  201. </a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="../../introduction/faq/" class="md-nav__link">
  205. <span class="md-ellipsis">
  206. FAQ
  207. </span>
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../../introduction/stability-support/" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. Stability and Support
  214. </span>
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Deprecation Policy
  221. </span>
  222. </a>
  223. </li>
  224. </ul>
  225. </nav>
  226. </li>
  227. <li class="md-nav__item md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  229. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  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="false">
  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="../../api/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--nested">
  249. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  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="false">
  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">
  263. <a href="../../api/externalsecret/" class="md-nav__link">
  264. <span class="md-ellipsis">
  265. ExternalSecret
  266. </span>
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="../../api/secretstore/" class="md-nav__link">
  271. <span class="md-ellipsis">
  272. SecretStore
  273. </span>
  274. </a>
  275. </li>
  276. <li class="md-nav__item">
  277. <a href="../../api/clustersecretstore/" class="md-nav__link">
  278. <span class="md-ellipsis">
  279. ClusterSecretStore
  280. </span>
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  285. <span class="md-ellipsis">
  286. ClusterExternalSecret
  287. </span>
  288. </a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="../../api/pushsecret/" class="md-nav__link">
  292. <span class="md-ellipsis">
  293. PushSecret
  294. </span>
  295. </a>
  296. </li>
  297. </ul>
  298. </nav>
  299. </li>
  300. <li class="md-nav__item md-nav__item--nested">
  301. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  302. <div class="md-nav__link md-nav__container">
  303. <a href="../../api/generator/" class="md-nav__link ">
  304. <span class="md-ellipsis">
  305. Generators
  306. </span>
  307. </a>
  308. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. </div>
  312. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  313. <label class="md-nav__title" for="__nav_2_3">
  314. <span class="md-nav__icon md-icon"></span>
  315. Generators
  316. </label>
  317. <ul class="md-nav__list" data-md-scrollfix>
  318. <li class="md-nav__item">
  319. <a href="../../api/generator/acr/" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. Azure Container Registry
  322. </span>
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../../api/generator/ecr/" class="md-nav__link">
  327. <span class="md-ellipsis">
  328. AWS Elastic Container Registry
  329. </span>
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/generator/gcr/" class="md-nav__link">
  334. <span class="md-ellipsis">
  335. Google Container Registry
  336. </span>
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="../../api/generator/vault/" class="md-nav__link">
  341. <span class="md-ellipsis">
  342. Vault Dynamic Secret
  343. </span>
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="../../api/generator/password/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. Password
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../../api/generator/fake/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. Fake
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../../api/generator/webhook/" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. Webhook
  364. </span>
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../../api/generator/github/" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. Github
  371. </span>
  372. </a>
  373. </li>
  374. </ul>
  375. </nav>
  376. </li>
  377. <li class="md-nav__item md-nav__item--nested">
  378. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  379. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  380. <span class="md-ellipsis">
  381. Reference Docs
  382. </span>
  383. <span class="md-nav__icon md-icon"></span>
  384. </label>
  385. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  386. <label class="md-nav__title" for="__nav_2_4">
  387. <span class="md-nav__icon md-icon"></span>
  388. Reference Docs
  389. </label>
  390. <ul class="md-nav__list" data-md-scrollfix>
  391. <li class="md-nav__item">
  392. <a href="../../api/spec/" class="md-nav__link">
  393. <span class="md-ellipsis">
  394. API specification
  395. </span>
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="../../api/controller-options/" class="md-nav__link">
  400. <span class="md-ellipsis">
  401. Controller Options
  402. </span>
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../api/metrics/" class="md-nav__link">
  407. <span class="md-ellipsis">
  408. Metrics
  409. </span>
  410. </a>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. </ul>
  416. </nav>
  417. </li>
  418. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  419. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  420. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  421. <span class="md-ellipsis">
  422. Guides
  423. </span>
  424. <span class="md-nav__icon md-icon"></span>
  425. </label>
  426. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
  427. <label class="md-nav__title" for="__nav_3">
  428. <span class="md-nav__icon md-icon"></span>
  429. Guides
  430. </label>
  431. <ul class="md-nav__list" data-md-scrollfix>
  432. <li class="md-nav__item">
  433. <a href="../introduction/" class="md-nav__link">
  434. <span class="md-ellipsis">
  435. Introduction
  436. </span>
  437. </a>
  438. </li>
  439. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  440. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" checked>
  441. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  442. <span class="md-ellipsis">
  443. External Secrets
  444. </span>
  445. <span class="md-nav__icon md-icon"></span>
  446. </label>
  447. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true">
  448. <label class="md-nav__title" for="__nav_3_2">
  449. <span class="md-nav__icon md-icon"></span>
  450. External Secrets
  451. </label>
  452. <ul class="md-nav__list" data-md-scrollfix>
  453. <li class="md-nav__item">
  454. <a href="../all-keys-one-secret/" class="md-nav__link">
  455. <span class="md-ellipsis">
  456. Extract structured data
  457. </span>
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../getallsecrets/" class="md-nav__link">
  462. <span class="md-ellipsis">
  463. Find Secrets by Name or Metadata
  464. </span>
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../datafrom-rewrite/" class="md-nav__link">
  469. <span class="md-ellipsis">
  470. Rewriting Keys
  471. </span>
  472. </a>
  473. </li>
  474. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  475. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_4" checked>
  476. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  477. <span class="md-ellipsis">
  478. Advanced Templating
  479. </span>
  480. <span class="md-nav__icon md-icon"></span>
  481. </label>
  482. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="true">
  483. <label class="md-nav__title" for="__nav_3_2_4">
  484. <span class="md-nav__icon md-icon"></span>
  485. Advanced Templating
  486. </label>
  487. <ul class="md-nav__list" data-md-scrollfix>
  488. <li class="md-nav__item md-nav__item--active">
  489. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  490. <label class="md-nav__link md-nav__link--active" for="__toc">
  491. <span class="md-ellipsis">
  492. v2
  493. </span>
  494. <span class="md-nav__icon md-icon"></span>
  495. </label>
  496. <a href="./" class="md-nav__link md-nav__link--active">
  497. <span class="md-ellipsis">
  498. v2
  499. </span>
  500. </a>
  501. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  502. <label class="md-nav__title" for="__toc">
  503. <span class="md-nav__icon md-icon"></span>
  504. Table of contents
  505. </label>
  506. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  507. <li class="md-nav__item">
  508. <a href="#helm" class="md-nav__link">
  509. <span class="md-ellipsis">
  510. Helm
  511. </span>
  512. </a>
  513. </li>
  514. <li class="md-nav__item">
  515. <a href="#examples" class="md-nav__link">
  516. <span class="md-ellipsis">
  517. Examples
  518. </span>
  519. </a>
  520. <nav class="md-nav" aria-label="Examples">
  521. <ul class="md-nav__list">
  522. <li class="md-nav__item">
  523. <a href="#mergepolicy" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. MergePolicy
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="#templatefrom" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. TemplateFrom
  533. </span>
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  538. <span class="md-ellipsis">
  539. Extract Keys and Certificates from PKCS#12 Archive
  540. </span>
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="#extract-from-jwk" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. Extract from JWK
  547. </span>
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="#filter-pem-blocks" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. Filter PEM blocks
  554. </span>
  555. </a>
  556. </li>
  557. </ul>
  558. </nav>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="#templating-with-pushsecret" class="md-nav__link">
  562. <span class="md-ellipsis">
  563. Templating with PushSecret
  564. </span>
  565. </a>
  566. </li>
  567. <li class="md-nav__item">
  568. <a href="#helper-functions" class="md-nav__link">
  569. <span class="md-ellipsis">
  570. Helper functions
  571. </span>
  572. </a>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="#migrating-from-v1" class="md-nav__link">
  576. <span class="md-ellipsis">
  577. Migrating from v1
  578. </span>
  579. </a>
  580. <nav class="md-nav" aria-label="Migrating from v1">
  581. <ul class="md-nav__list">
  582. <li class="md-nav__item">
  583. <a href="#functions-removedreplaced" class="md-nav__link">
  584. <span class="md-ellipsis">
  585. Functions removed/replaced
  586. </span>
  587. </a>
  588. </li>
  589. </ul>
  590. </nav>
  591. </li>
  592. </ul>
  593. </nav>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../templating-v1/" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. v1
  599. </span>
  600. </a>
  601. </li>
  602. </ul>
  603. </nav>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../common-k8s-secret-types/" class="md-nav__link">
  607. <span class="md-ellipsis">
  608. Kubernetes Secret Types
  609. </span>
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../ownership-deletion-policy/" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. Lifecycle: ownership & deletion
  616. </span>
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../decoding-strategy/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Decoding Strategies
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../controller-class/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Controller Classes
  630. </span>
  631. </a>
  632. </li>
  633. </ul>
  634. </nav>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="../generator/" class="md-nav__link">
  638. <span class="md-ellipsis">
  639. Generators
  640. </span>
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="../pushsecrets/" class="md-nav__link">
  645. <span class="md-ellipsis">
  646. Push Secrets
  647. </span>
  648. </a>
  649. </li>
  650. <li class="md-nav__item md-nav__item--nested">
  651. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  652. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  653. <span class="md-ellipsis">
  654. Operations
  655. </span>
  656. <span class="md-nav__icon md-icon"></span>
  657. </label>
  658. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  659. <label class="md-nav__title" for="__nav_3_5">
  660. <span class="md-nav__icon md-icon"></span>
  661. Operations
  662. </label>
  663. <ul class="md-nav__list" data-md-scrollfix>
  664. <li class="md-nav__item">
  665. <a href="../multi-tenancy/" class="md-nav__link">
  666. <span class="md-ellipsis">
  667. Multi Tenancy
  668. </span>
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../security-best-practices/" class="md-nav__link">
  673. <span class="md-ellipsis">
  674. Security Best Practices
  675. </span>
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../threat-model/" class="md-nav__link">
  680. <span class="md-ellipsis">
  681. Threat Model
  682. </span>
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../v1beta1/" class="md-nav__link">
  687. <span class="md-ellipsis">
  688. Upgrading to v1beta1
  689. </span>
  690. </a>
  691. </li>
  692. <li class="md-nav__item">
  693. <a href="../using-latest-image/" class="md-nav__link">
  694. <span class="md-ellipsis">
  695. Using Latest Image
  696. </span>
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../disable-cluster-features/" class="md-nav__link">
  701. <span class="md-ellipsis">
  702. Disable Cluster Features
  703. </span>
  704. </a>
  705. </li>
  706. </ul>
  707. </nav>
  708. </li>
  709. </ul>
  710. </nav>
  711. </li>
  712. <li class="md-nav__item md-nav__item--nested">
  713. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  714. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  715. <span class="md-ellipsis">
  716. Provider
  717. </span>
  718. <span class="md-nav__icon md-icon"></span>
  719. </label>
  720. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  721. <label class="md-nav__title" for="__nav_4">
  722. <span class="md-nav__icon md-icon"></span>
  723. Provider
  724. </label>
  725. <ul class="md-nav__list" data-md-scrollfix>
  726. <li class="md-nav__item">
  727. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  728. <span class="md-ellipsis">
  729. AWS Secrets Manager
  730. </span>
  731. </a>
  732. </li>
  733. <li class="md-nav__item">
  734. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  735. <span class="md-ellipsis">
  736. AWS Parameter Store
  737. </span>
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  742. <span class="md-ellipsis">
  743. Azure Key Vault
  744. </span>
  745. </a>
  746. </li>
  747. <li class="md-nav__item">
  748. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  749. <span class="md-ellipsis">
  750. Bitwarden Secrets Manager
  751. </span>
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="../../provider/chef/" class="md-nav__link">
  756. <span class="md-ellipsis">
  757. Chef
  758. </span>
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../../provider/conjur/" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. CyberArk Conjur
  765. </span>
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../../provider/device42/" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Device42
  772. </span>
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  777. <span class="md-ellipsis">
  778. Google Cloud Secret Manager
  779. </span>
  780. </a>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. HashiCorp Vault
  786. </span>
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="../../provider/kubernetes/" class="md-nav__link">
  791. <span class="md-ellipsis">
  792. Kubernetes
  793. </span>
  794. </a>
  795. </li>
  796. <li class="md-nav__item">
  797. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  798. <span class="md-ellipsis">
  799. IBM Secrets Manager
  800. </span>
  801. </a>
  802. </li>
  803. <li class="md-nav__item">
  804. <a href="../../provider/akeyless/" class="md-nav__link">
  805. <span class="md-ellipsis">
  806. Akeyless
  807. </span>
  808. </a>
  809. </li>
  810. <li class="md-nav__item">
  811. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  812. <span class="md-ellipsis">
  813. Yandex Certificate Manager
  814. </span>
  815. </a>
  816. </li>
  817. <li class="md-nav__item">
  818. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  819. <span class="md-ellipsis">
  820. Yandex Lockbox
  821. </span>
  822. </a>
  823. </li>
  824. <li class="md-nav__item">
  825. <a href="../../provider/alibaba/" class="md-nav__link">
  826. <span class="md-ellipsis">
  827. Alibaba Cloud
  828. </span>
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  833. <span class="md-ellipsis">
  834. GitLab Variables
  835. </span>
  836. </a>
  837. </li>
  838. <li class="md-nav__item">
  839. <a href="../../provider/oracle-vault/" class="md-nav__link">
  840. <span class="md-ellipsis">
  841. Oracle Vault
  842. </span>
  843. </a>
  844. </li>
  845. <li class="md-nav__item">
  846. <a href="../../provider/1password-automation/" class="md-nav__link">
  847. <span class="md-ellipsis">
  848. 1Password Secrets Automation
  849. </span>
  850. </a>
  851. </li>
  852. <li class="md-nav__item">
  853. <a href="../../provider/webhook/" class="md-nav__link">
  854. <span class="md-ellipsis">
  855. Webhook
  856. </span>
  857. </a>
  858. </li>
  859. <li class="md-nav__item">
  860. <a href="../../provider/fake/" class="md-nav__link">
  861. <span class="md-ellipsis">
  862. Fake
  863. </span>
  864. </a>
  865. </li>
  866. <li class="md-nav__item">
  867. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  868. <span class="md-ellipsis">
  869. senhasegura DevOps Secrets Management (DSM)
  870. </span>
  871. </a>
  872. </li>
  873. <li class="md-nav__item">
  874. <a href="../../provider/doppler/" class="md-nav__link">
  875. <span class="md-ellipsis">
  876. Doppler
  877. </span>
  878. </a>
  879. </li>
  880. <li class="md-nav__item">
  881. <a href="../../provider/keeper-security/" class="md-nav__link">
  882. <span class="md-ellipsis">
  883. Keeper Security
  884. </span>
  885. </a>
  886. </li>
  887. <li class="md-nav__item">
  888. <a href="../../provider/cloak/" class="md-nav__link">
  889. <span class="md-ellipsis">
  890. Cloak End 2 End Encrypted Secrets
  891. </span>
  892. </a>
  893. </li>
  894. <li class="md-nav__item">
  895. <a href="../../provider/scaleway/" class="md-nav__link">
  896. <span class="md-ellipsis">
  897. Scaleway
  898. </span>
  899. </a>
  900. </li>
  901. <li class="md-nav__item">
  902. <a href="../../provider/delinea/" class="md-nav__link">
  903. <span class="md-ellipsis">
  904. Delinea
  905. </span>
  906. </a>
  907. </li>
  908. <li class="md-nav__item">
  909. <a href="../../provider/delinea/" class="md-nav__link">
  910. <span class="md-ellipsis">
  911. Delinea
  912. </span>
  913. </a>
  914. </li>
  915. <li class="md-nav__item">
  916. <a href="../../provider/passbolt/" class="md-nav__link">
  917. <span class="md-ellipsis">
  918. Passbolt
  919. </span>
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="../../provider/pulumi/" class="md-nav__link">
  924. <span class="md-ellipsis">
  925. Pulumi ESC
  926. </span>
  927. </a>
  928. </li>
  929. <li class="md-nav__item">
  930. <a href="../../provider/onboardbase/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. Onboardbase
  933. </span>
  934. </a>
  935. </li>
  936. <li class="md-nav__item">
  937. <a href="../../provider-passworddepot/" class="md-nav__link">
  938. <span class="md-ellipsis">
  939. Password Depot
  940. </span>
  941. </a>
  942. </li>
  943. <li class="md-nav__item">
  944. <a href="../../provider/fortanix/" class="md-nav__link">
  945. <span class="md-ellipsis">
  946. Fortanix
  947. </span>
  948. </a>
  949. </li>
  950. <li class="md-nav__item">
  951. <a href="../../provider/infisical/" class="md-nav__link">
  952. <span class="md-ellipsis">
  953. Infisical
  954. </span>
  955. </a>
  956. </li>
  957. </ul>
  958. </nav>
  959. </li>
  960. <li class="md-nav__item md-nav__item--nested">
  961. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  962. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  963. <span class="md-ellipsis">
  964. Examples
  965. </span>
  966. <span class="md-nav__icon md-icon"></span>
  967. </label>
  968. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  969. <label class="md-nav__title" for="__nav_5">
  970. <span class="md-nav__icon md-icon"></span>
  971. Examples
  972. </label>
  973. <ul class="md-nav__list" data-md-scrollfix>
  974. <li class="md-nav__item">
  975. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  976. <span class="md-ellipsis">
  977. FluxCD
  978. </span>
  979. </a>
  980. </li>
  981. <li class="md-nav__item">
  982. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  983. <span class="md-ellipsis">
  984. Anchore Engine
  985. </span>
  986. </a>
  987. </li>
  988. <li class="md-nav__item">
  989. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  990. <span class="md-ellipsis">
  991. Jenkins
  992. </span>
  993. </a>
  994. </li>
  995. <li class="md-nav__item">
  996. <a href="../../examples/bitwarden/" class="md-nav__link">
  997. <span class="md-ellipsis">
  998. BitWarden
  999. </span>
  1000. </a>
  1001. </li>
  1002. </ul>
  1003. </nav>
  1004. </li>
  1005. <li class="md-nav__item md-nav__item--nested">
  1006. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1007. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1008. <span class="md-ellipsis">
  1009. Community
  1010. </span>
  1011. <span class="md-nav__icon md-icon"></span>
  1012. </label>
  1013. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1014. <label class="md-nav__title" for="__nav_6">
  1015. <span class="md-nav__icon md-icon"></span>
  1016. Community
  1017. </label>
  1018. <ul class="md-nav__list" data-md-scrollfix>
  1019. <li class="md-nav__item md-nav__item--nested">
  1020. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1021. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1022. <span class="md-ellipsis">
  1023. Contributing
  1024. </span>
  1025. <span class="md-nav__icon md-icon"></span>
  1026. </label>
  1027. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1028. <label class="md-nav__title" for="__nav_6_1">
  1029. <span class="md-nav__icon md-icon"></span>
  1030. Contributing
  1031. </label>
  1032. <ul class="md-nav__list" data-md-scrollfix>
  1033. <li class="md-nav__item">
  1034. <a href="../../contributing/devguide/" class="md-nav__link">
  1035. <span class="md-ellipsis">
  1036. Developer guide
  1037. </span>
  1038. </a>
  1039. </li>
  1040. <li class="md-nav__item">
  1041. <a href="../../contributing/process/" class="md-nav__link">
  1042. <span class="md-ellipsis">
  1043. Contributing Process
  1044. </span>
  1045. </a>
  1046. </li>
  1047. <li class="md-nav__item">
  1048. <a href="../../contributing/release/" class="md-nav__link">
  1049. <span class="md-ellipsis">
  1050. Release Process
  1051. </span>
  1052. </a>
  1053. </li>
  1054. <li class="md-nav__item">
  1055. <a href="../../contributing/coc/" class="md-nav__link">
  1056. <span class="md-ellipsis">
  1057. Code of Conduct
  1058. </span>
  1059. </a>
  1060. </li>
  1061. <li class="md-nav__item">
  1062. <a href="../../contributing/roadmap/" class="md-nav__link">
  1063. <span class="md-ellipsis">
  1064. Roadmap
  1065. </span>
  1066. </a>
  1067. </li>
  1068. </ul>
  1069. </nav>
  1070. </li>
  1071. <li class="md-nav__item md-nav__item--nested">
  1072. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1073. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1074. <span class="md-ellipsis">
  1075. External Resources
  1076. </span>
  1077. <span class="md-nav__icon md-icon"></span>
  1078. </label>
  1079. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1080. <label class="md-nav__title" for="__nav_6_2">
  1081. <span class="md-nav__icon md-icon"></span>
  1082. External Resources
  1083. </label>
  1084. <ul class="md-nav__list" data-md-scrollfix>
  1085. <li class="md-nav__item">
  1086. <a href="../../eso-talks/" class="md-nav__link">
  1087. <span class="md-ellipsis">
  1088. Talks
  1089. </span>
  1090. </a>
  1091. </li>
  1092. <li class="md-nav__item">
  1093. <a href="../../eso-demos/" class="md-nav__link">
  1094. <span class="md-ellipsis">
  1095. Demos
  1096. </span>
  1097. </a>
  1098. </li>
  1099. <li class="md-nav__item">
  1100. <a href="../../eso-blogs/" class="md-nav__link">
  1101. <span class="md-ellipsis">
  1102. Blogs
  1103. </span>
  1104. </a>
  1105. </li>
  1106. </ul>
  1107. </nav>
  1108. </li>
  1109. </ul>
  1110. </nav>
  1111. </li>
  1112. <li class="md-nav__item md-nav__item--nested">
  1113. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1114. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1115. <span class="md-ellipsis">
  1116. References
  1117. </span>
  1118. <span class="md-nav__icon md-icon"></span>
  1119. </label>
  1120. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1121. <label class="md-nav__title" for="__nav_7">
  1122. <span class="md-nav__icon md-icon"></span>
  1123. References
  1124. </label>
  1125. <ul class="md-nav__list" data-md-scrollfix>
  1126. <li class="md-nav__item">
  1127. <a href="../../spec/" class="md-nav__link">
  1128. <span class="md-ellipsis">
  1129. API specification
  1130. </span>
  1131. </a>
  1132. </li>
  1133. </ul>
  1134. </nav>
  1135. </li>
  1136. </ul>
  1137. </nav>
  1138. </div>
  1139. </div>
  1140. </div>
  1141. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1142. <div class="md-sidebar__scrollwrap">
  1143. <div class="md-sidebar__inner">
  1144. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1145. <label class="md-nav__title" for="__toc">
  1146. <span class="md-nav__icon md-icon"></span>
  1147. Table of contents
  1148. </label>
  1149. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1150. <li class="md-nav__item">
  1151. <a href="#helm" class="md-nav__link">
  1152. <span class="md-ellipsis">
  1153. Helm
  1154. </span>
  1155. </a>
  1156. </li>
  1157. <li class="md-nav__item">
  1158. <a href="#examples" class="md-nav__link">
  1159. <span class="md-ellipsis">
  1160. Examples
  1161. </span>
  1162. </a>
  1163. <nav class="md-nav" aria-label="Examples">
  1164. <ul class="md-nav__list">
  1165. <li class="md-nav__item">
  1166. <a href="#mergepolicy" class="md-nav__link">
  1167. <span class="md-ellipsis">
  1168. MergePolicy
  1169. </span>
  1170. </a>
  1171. </li>
  1172. <li class="md-nav__item">
  1173. <a href="#templatefrom" class="md-nav__link">
  1174. <span class="md-ellipsis">
  1175. TemplateFrom
  1176. </span>
  1177. </a>
  1178. </li>
  1179. <li class="md-nav__item">
  1180. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  1181. <span class="md-ellipsis">
  1182. Extract Keys and Certificates from PKCS#12 Archive
  1183. </span>
  1184. </a>
  1185. </li>
  1186. <li class="md-nav__item">
  1187. <a href="#extract-from-jwk" class="md-nav__link">
  1188. <span class="md-ellipsis">
  1189. Extract from JWK
  1190. </span>
  1191. </a>
  1192. </li>
  1193. <li class="md-nav__item">
  1194. <a href="#filter-pem-blocks" class="md-nav__link">
  1195. <span class="md-ellipsis">
  1196. Filter PEM blocks
  1197. </span>
  1198. </a>
  1199. </li>
  1200. </ul>
  1201. </nav>
  1202. </li>
  1203. <li class="md-nav__item">
  1204. <a href="#templating-with-pushsecret" class="md-nav__link">
  1205. <span class="md-ellipsis">
  1206. Templating with PushSecret
  1207. </span>
  1208. </a>
  1209. </li>
  1210. <li class="md-nav__item">
  1211. <a href="#helper-functions" class="md-nav__link">
  1212. <span class="md-ellipsis">
  1213. Helper functions
  1214. </span>
  1215. </a>
  1216. </li>
  1217. <li class="md-nav__item">
  1218. <a href="#migrating-from-v1" class="md-nav__link">
  1219. <span class="md-ellipsis">
  1220. Migrating from v1
  1221. </span>
  1222. </a>
  1223. <nav class="md-nav" aria-label="Migrating from v1">
  1224. <ul class="md-nav__list">
  1225. <li class="md-nav__item">
  1226. <a href="#functions-removedreplaced" class="md-nav__link">
  1227. <span class="md-ellipsis">
  1228. Functions removed/replaced
  1229. </span>
  1230. </a>
  1231. </li>
  1232. </ul>
  1233. </nav>
  1234. </li>
  1235. </ul>
  1236. </nav>
  1237. </div>
  1238. </div>
  1239. </div>
  1240. <div class="md-content" data-md-component="content">
  1241. <article class="md-content__inner md-typeset">
  1242. <h1 id="advanced-templating-v2">Advanced Templating v2</h1>
  1243. <p>With External Secrets Operator you can transform the data from the external secret provider before it is stored as <code>Kind=Secret</code>. You can do this with the <code>Spec.Target.Template</code>.</p>
  1244. <p>Each data value is interpreted as a <a href="https://golang.org/pkg/text/template/">Go template</a>. Please note that referencing a non-existing key in the template will raise an error, instead of being suppressed.</p>
  1245. <div class="admonition note">
  1246. <p class="admonition-title">Note</p>
  1247. <p>Consider using camelcase when defining <strong>.'spec.data.secretkey'</strong>, example: serviceAccountToken</p>
  1248. <p>If your secret keys contain <strong><code>-</code> (dashes)</strong>, you will need to reference them using <strong><code>index</code></strong> </br>
  1249. Example: <strong><code>\{\{ index .data "service-account-token" \}\}</code></strong></p>
  1250. </div>
  1251. <h2 id="helm">Helm</h2>
  1252. <p>When installing ExternalSecrets via <code>helm</code>, the template must be escaped so that <code>helm</code> will not try to render it. The most straightforward way to accomplish this would be to use backticks (<a href="https://pkg.go.dev/text/template#hdr-Examples">raw string constants</a>):</p>
  1253. <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>
  1254. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1255. <span class="nt">metadata</span><span class="p">:</span>
  1256. <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">template</span>
  1257. <span class="nt">spec</span><span class="p">:</span>
  1258. <span class="w"> </span><span class="c1"># ...</span>
  1259. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1260. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1261. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1262. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1263. <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">admin</span>
  1264. <span class="w"> </span><span class="c1"># password: &quot;{{ .mysecret }}&quot; # If you are using plain manifests or gitops tools</span>
  1265. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">`{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">}}`</span><span class="nv"> </span><span class="s">}}&quot;</span><span class="w"> </span><span class="c1"># If you are using helm</span>
  1266. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1267. <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">mysecret</span>
  1268. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1269. <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">/credentials</span>
  1270. </code></pre></div>
  1271. <h2 id="examples">Examples</h2>
  1272. <p>You can use templates to inject your secrets into a configuration file that you mount into your pod:</p>
  1273. <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>
  1274. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1275. <span class="nt">metadata</span><span class="p">:</span>
  1276. <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">template</span>
  1277. <span class="nt">spec</span><span class="p">:</span>
  1278. <span class="w"> </span><span class="c1"># ...</span>
  1279. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1280. <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">secret-to-be-created</span>
  1281. <span class="w"> </span><span class="c1"># this is how the Kind=Secret will look like</span>
  1282. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1283. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1284. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1285. <span class="w"> </span><span class="c1"># multiline string</span>
  1286. <span class="w"> </span><span class="nt">config</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1287. <span class="w"> </span><span class="no">datasources:</span>
  1288. <span class="w"> </span><span class="no">- name: Graphite</span>
  1289. <span class="w"> </span><span class="no">type: graphite</span>
  1290. <span class="w"> </span><span class="no">access: proxy</span>
  1291. <span class="w"> </span><span class="no">url: http://localhost:8080</span>
  1292. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span>
  1293. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span>
  1294. <span class="w"> </span><span class="c1"># using replace function to rewrite secret</span>
  1295. <span class="w"> </span><span class="nt">connection</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;{{</span><span class="nv"> </span><span class="s">.dburl</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">replace</span><span class="nv"> </span><span class="s">&quot;postgres://&quot;</span><span class="nv"> </span><span class="s">&quot;postgresql://&quot;</span><span class="nv"> </span><span class="s">}}&#39;</span>
  1296. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1297. <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">user</span>
  1298. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1299. <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">/grafana/user</span>
  1300. <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">password</span>
  1301. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1302. <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">/grafana/password</span>
  1303. <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">dburl</span>
  1304. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1305. <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/url</span>
  1306. </code></pre></div>
  1307. <p>Another example with two keys in the same secret:</p>
  1308. <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>
  1309. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1310. <span class="nt">metadata</span><span class="p">:</span>
  1311. <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">template</span>
  1312. <span class="nt">spec</span><span class="p">:</span>
  1313. <span class="w"> </span><span class="c1"># ...</span>
  1314. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1315. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1316. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1317. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1318. <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">admin</span>
  1319. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">}}&quot;</span><span class="w"> </span><span class="c1"># If you are using plain manifests or gitops tools</span>
  1320. <span class="w"> </span><span class="c1"># password: &quot;{{ `{{ .mysecret }}` }}&quot; # If you are using templated tools like helm</span>
  1321. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1322. <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">mysecret</span>
  1323. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1324. <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">/credentials</span>
  1325. </code></pre></div>
  1326. <h3 id="mergepolicy">MergePolicy</h3>
  1327. <p>By default, the templating mechanism will not use any information available from the original <code>data</code> and <code>dataFrom</code> queries to the provider, and only keep the templated information. It is possible to change this behavior through the use of the <code>mergePolicy</code> field. <code>mergePolicy</code> currently accepts two values: <code>Replace</code> (the default) and <code>Merge</code>. When using <code>Merge</code>, <code>data</code> and <code>dataFrom</code> keys will also be embedded into the templated secret, having lower priority than the template outcome. See the example for more information:</p>
  1328. <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>
  1329. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1330. <span class="nt">metadata</span><span class="p">:</span>
  1331. <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">template</span>
  1332. <span class="nt">spec</span><span class="p">:</span>
  1333. <span class="w"> </span><span class="c1"># ...</span>
  1334. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1335. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1336. <span class="w"> </span><span class="nt">mergePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Merge</span>
  1337. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1338. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1339. <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">admin</span>
  1340. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.password</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">b64dec</span><span class="nv"> </span><span class="s">}}&quot;</span><span class="w"> </span><span class="c1"># Overwrites the password from the data call and use this output</span>
  1341. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1342. <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">password</span>
  1343. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1344. <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">/credentials/password</span>
  1345. <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><span class="w"> </span><span class="c1"># Preserves the username in the templated Secret</span>
  1346. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1347. <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">/credentials/username</span>
  1348. </code></pre></div>
  1349. <h3 id="templatefrom">TemplateFrom</h3>
  1350. <p>You do not have to define your templates inline in an ExternalSecret but you can pull <code>ConfigMaps</code> or other Secrets that contain a template. Consider the following example:</p>
  1351. <div class="highlight"><pre><span></span><code><span class="c1"># define your template in a config map</span>
  1352. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1353. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ConfigMap</span>
  1354. <span class="nt">metadata</span><span class="p">:</span>
  1355. <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">grafana-config-tpl</span>
  1356. <span class="nt">data</span><span class="p">:</span>
  1357. <span class="w"> </span><span class="nt">config.yaml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1358. <span class="w"> </span><span class="no">datasources:</span>
  1359. <span class="w"> </span><span class="no">- name: Graphite</span>
  1360. <span class="w"> </span><span class="no">type: graphite</span>
  1361. <span class="w"> </span><span class="no">access: proxy</span>
  1362. <span class="w"> </span><span class="no">url: &quot;{{ .uri }}&quot;</span>
  1363. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span>
  1364. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span>
  1365. <span class="w"> </span><span class="nt">templated</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1366. <span class="w"> </span><span class="no"># key and value templated</span>
  1367. <span class="w"> </span><span class="no">my-application-{{ .user}}: {{ .password | b64enc }}</span>
  1368. <span class="w"> </span><span class="no"># conditional keys</span>
  1369. <span class="w"> </span><span class="no">{{- if hasPrefix &quot;oci://&quot; .uri }}</span>
  1370. <span class="w"> </span><span class="no">enableOCI: true</span>
  1371. <span class="w"> </span><span class="no">{{- else }}</span>
  1372. <span class="w"> </span><span class="no">enableOCI: false</span>
  1373. <span class="w"> </span><span class="no">{{- end }}</span>
  1374. <span class="w"> </span><span class="no"># Fixed values</span>
  1375. <span class="w"> </span><span class="no">application-type: grafana</span>
  1376. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1377. <span class="w"> </span><span class="no">#dynamic timestamp generation</span>
  1378. <span class="w"> </span><span class="no">last-synced-for-user/{{ .user }}: {{ now }}</span>
  1379. <span class="nn">---</span>
  1380. <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>
  1381. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1382. <span class="nt">metadata</span><span class="p">:</span>
  1383. <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">my-template-example</span>
  1384. <span class="nt">spec</span><span class="p">:</span>
  1385. <span class="w"> </span><span class="c1"># ...</span>
  1386. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1387. <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">secret-to-be-created</span>
  1388. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1389. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1390. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1391. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Data</span>
  1392. <span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1393. <span class="w"> </span><span class="c1"># name of the configmap to pull in</span>
  1394. <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">grafana-config-tpl</span>
  1395. <span class="w"> </span><span class="c1"># here you define the keys that should be used as template</span>
  1396. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1397. <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.yaml</span>
  1398. <span class="w"> </span><span class="nt">templateAs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Values</span>
  1399. <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">templated</span>
  1400. <span class="w"> </span><span class="nt">templateAs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">KeysAndValues</span>
  1401. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Annotations</span>
  1402. <span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1403. <span class="w"> </span><span class="c1"># name of the configmap to pull in</span>
  1404. <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">grafana-config-tpl</span>
  1405. <span class="w"> </span><span class="c1"># here you define the keys that should be used as template</span>
  1406. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1407. <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">annotations</span>
  1408. <span class="w"> </span><span class="nt">templateAs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">KeysAndValues</span>
  1409. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1410. <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">user</span>
  1411. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1412. <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">/grafana/user</span>
  1413. <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">password</span>
  1414. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1415. <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">/grafana/password</span>
  1416. <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">uri</span>
  1417. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1418. <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">/grafana/uri</span>
  1419. </code></pre></div>
  1420. <p><code>TemplateFrom</code> also gives you the ability to Target your template to the Secret's Annotations, Labels or the Data block. It also allows you to render the templated information as <code>Values</code> or as <code>KeysAndValues</code> through the <code>templateAs</code> configuration:</p>
  1421. <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>
  1422. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1423. <span class="nt">metadata</span><span class="p">:</span>
  1424. <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">my-template-example</span>
  1425. <span class="nt">spec</span><span class="p">:</span>
  1426. <span class="w"> </span><span class="c1"># ...</span>
  1427. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1428. <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">secret-to-be-created</span>
  1429. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1430. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1431. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1432. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Annotations</span>
  1433. <span class="w"> </span><span class="nt">literal</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;last-sync-for-user/{{</span><span class="nv"> </span><span class="s">.user</span><span class="nv"> </span><span class="s">}}:</span><span class="nv"> </span><span class="s">{{</span><span class="nv"> </span><span class="s">.now</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1434. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1435. <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">user</span>
  1436. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1437. <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">/grafana/user</span>
  1438. <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">password</span>
  1439. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1440. <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">/grafana/password</span>
  1441. </code></pre></div>
  1442. <p>Lastly, <code>TemplateFrom</code> also supports adding <code>Literal</code> blocks for quick templating. These <code>Literal</code> blocks differ from <code>Template.Data</code> as they are rendered as a a <code>key:value</code> pair (while the <code>Template.Data</code>, you can only template the value).</p>
  1443. <p>See an example, how to produce a <code>htpasswd</code> file that can be used by an ingress-controller (for example: https://kubernetes.github.io/ingress-nginx/examples/auth/basic/) where the contents of the <code>htpasswd</code> file needs to be presented via the <code>auth</code> key. We use the <code>htpasswd</code> function to create a <code>bcrytped</code> hash of the password.</p>
  1444. <p>Suppose you have multiple key-value pairs within your provider secret like</p>
  1445. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1446. <span class="w"> </span><span class="nt">&quot;user1&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;password1&quot;</span><span class="p">,</span>
  1447. <span class="w"> </span><span class="nt">&quot;user2&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;password2&quot;</span><span class="p">,</span>
  1448. <span class="w"> </span><span class="err">...</span>
  1449. <span class="p">}</span>
  1450. </code></pre></div>
  1451. <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>
  1452. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1453. <span class="nt">metadata</span><span class="p">:</span>
  1454. <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">my-template-example</span>
  1455. <span class="nt">spec</span><span class="p">:</span>
  1456. <span class="w"> </span><span class="c1"># ...</span>
  1457. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1458. <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">secret-to-be-created</span>
  1459. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1460. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1461. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1462. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Data</span>
  1463. <span class="w"> </span><span class="nt">literal</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|-</span>
  1464. <span class="w"> </span><span class="no">{{- $creds := list }}</span>
  1465. <span class="w"> </span><span class="no">{{- range $user, $pw := . }}</span>
  1466. <span class="w"> </span><span class="no">{{- $creds = append $creds (printf &quot;%s&quot; (htpasswd $user $pw)) }}</span>
  1467. <span class="w"> </span><span class="no">{{- end }}</span>
  1468. <span class="w"> </span><span class="no">auth: {{ $creds | join &quot;\n&quot; | quote }}</span>
  1469. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1470. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1471. <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">/ingress-controller/valid-users</span>
  1472. </code></pre></div>
  1473. <h3 id="extract-keys-and-certificates-from-pkcs12-archive">Extract Keys and Certificates from PKCS#12 Archive</h3>
  1474. <p>You can use pre-defined functions to extract data from your secrets. Here: extract keys and certificates from a PKCS#12 archive and store it as PEM.</p>
  1475. <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>
  1476. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1477. <span class="nt">metadata</span><span class="p">:</span>
  1478. <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">template</span>
  1479. <span class="nt">spec</span><span class="p">:</span>
  1480. <span class="w"> </span><span class="c1"># ...</span>
  1481. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1482. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1483. <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/tls</span>
  1484. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1485. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1486. <span class="w"> </span><span class="nt">tls.crt</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">pkcs12cert</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1487. <span class="w"> </span><span class="nt">tls.key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">pkcs12key</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1488. <span class="w"> </span><span class="c1"># if needed unlock the pkcs12 with the password</span>
  1489. <span class="w"> </span><span class="nt">tls.crt</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">pkcs12certPass</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">my-password&quot; }}&quot;</span>
  1490. </code></pre></div>
  1491. <h3 id="extract-from-jwk">Extract from JWK</h3>
  1492. <p>You can extract the public or private key parts of a JWK and use them as <a href="https://pkg.go.dev/crypto/x509#ParsePKCS8PrivateKey">PKCS#8</a> private key or PEM-encoded <a href="https://pkg.go.dev/crypto/x509#MarshalPKIXPublicKey">PKIX</a> public key.</p>
  1493. <p>A JWK looks similar to this:</p>
  1494. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1495. <span class="w"> </span><span class="nt">&quot;kty&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;RSA&quot;</span><span class="p">,</span>
  1496. <span class="w"> </span><span class="nt">&quot;kid&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cc34c0a0-bd5a-4a3c-a50d-a2a7db7643df&quot;</span><span class="p">,</span>
  1497. <span class="w"> </span><span class="nt">&quot;use&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;sig&quot;</span><span class="p">,</span>
  1498. <span class="w"> </span><span class="nt">&quot;n&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;pjdss...&quot;</span><span class="p">,</span>
  1499. <span class="w"> </span><span class="nt">&quot;e&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;AQAB&quot;</span>
  1500. <span class="w"> </span><span class="c1">// ...</span>
  1501. <span class="p">}</span>
  1502. </code></pre></div>
  1503. <p>And what you want may be a PEM-encoded public or private key portion of it. Take a look at this example on how to transform it into the desired format:</p>
  1504. <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>
  1505. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1506. <span class="nt">metadata</span><span class="p">:</span>
  1507. <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">template</span>
  1508. <span class="nt">spec</span><span class="p">:</span>
  1509. <span class="w"> </span><span class="c1"># ...</span>
  1510. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1511. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1512. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1513. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1514. <span class="w"> </span><span class="c1"># .myjwk is a json-encoded JWK string.</span>
  1515. <span class="w"> </span><span class="c1">#</span>
  1516. <span class="w"> </span><span class="c1"># this template will produce for jwk_pub a PEM encoded public key:</span>
  1517. <span class="w"> </span><span class="c1"># -----BEGIN PUBLIC KEY-----</span>
  1518. <span class="w"> </span><span class="c1"># MIIBI...</span>
  1519. <span class="w"> </span><span class="c1"># ...</span>
  1520. <span class="w"> </span><span class="c1"># ...AQAB</span>
  1521. <span class="w"> </span><span class="c1"># -----END PUBLIC KEY-----</span>
  1522. <span class="w"> </span><span class="nt">jwk_pub</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.myjwk</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">jwkPublicKeyPem</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1523. <span class="w"> </span><span class="c1"># private key is a pem-encoded PKCS#8 private key</span>
  1524. <span class="w"> </span><span class="nt">jwk_priv</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.myjwk</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">jwkPrivateKeyPem</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1525. </code></pre></div>
  1526. <h3 id="filter-pem-blocks">Filter PEM blocks</h3>
  1527. <p>Consider you have a secret that contains both a certificate and a private key encoded in PEM format and it is your goal to use only the certificate from that secret.</p>
  1528. <div class="highlight"><pre><span></span><code>-----BEGIN PRIVATE KEY-----
  1529. MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCvxGZOW4IXvGlh
  1530. . . .
  1531. m8JCpbJXDfSSVxKHgK1Siw4K6pnTsIA2e/Z+Ha2fvtocERjq7VQMAJFaIZSTKo9Q
  1532. JwwY+vj0yxWjyzHUzZB33tg=
  1533. -----END PRIVATE KEY-----
  1534. -----BEGIN CERTIFICATE-----
  1535. MIIDMDCCAhigAwIBAgIQabPaXuZCQaCg+eQAVptGGDANBgkqhkiG9w0BAQsFADAV
  1536. . . .
  1537. NtFUGA95RGN9s+pl6XY0YARPHf5O76ErC1OZtDTR5RdyQfcM+94gYZsexsXl0aQO
  1538. 9YD3Wg==
  1539. -----END CERTIFICATE-----
  1540. </code></pre></div>
  1541. <p>You can achieve that by using the <code>filterPEM</code> function to extract a specific type of PEM block from that secret. If multiple blocks of that type (here: <code>CERTIFICATE</code>) exist, all of them are returned in the order specified. To extract a specific type of PEM block, pass the type as a string argument to the filterPEM function. Take a look at this example of how to transform a secret which contains a private key and a certificate into the desired format:</p>
  1542. <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>
  1543. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1544. <span class="nt">metadata</span><span class="p">:</span>
  1545. <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">template</span>
  1546. <span class="nt">spec</span><span class="p">:</span>
  1547. <span class="w"> </span><span class="c1"># ...</span>
  1548. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1549. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1550. <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/tls</span>
  1551. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1552. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1553. <span class="w"> </span><span class="nt">tls.crt</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">filterPEM</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">CERTIFICATE&quot; }}&quot;</span>
  1554. <span class="w"> </span><span class="nt">tls.key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">filterPEM</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">PRIVATE KEY&quot; }}&quot;</span>
  1555. </code></pre></div>
  1556. <h2 id="templating-with-pushsecret">Templating with PushSecret</h2>
  1557. <p><code>PushSecret</code> templating is much like <code>ExternalSecrets</code> templating. In-fact under the hood, it's using the same data structure.
  1558. Which means, anything described in the above should be possible with push secret as well resulting in a templated secret
  1559. created at the provider.</p>
  1560. <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>
  1561. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1562. <span class="nt">metadata</span><span class="p">:</span>
  1563. <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">template</span>
  1564. <span class="nt">spec</span><span class="p">:</span>
  1565. <span class="w"> </span><span class="c1"># ...</span>
  1566. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1567. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1568. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1569. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.token</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">toString</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">upper</span><span class="nv"> </span><span class="s">}}</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">templated&quot;</span>
  1570. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1571. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1572. <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">token</span>
  1573. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1574. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create-secret-name</span>
  1575. <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">token</span>
  1576. </code></pre></div>
  1577. <h2 id="helper-functions">Helper functions</h2>
  1578. <div class="admonition info inline end">
  1579. <p class="admonition-title">Info</p>
  1580. <p>Note: we removed <code>env</code> and <code>expandenv</code> from sprig functions for security reasons.</p>
  1581. </div>
  1582. <p>We provide a couple of convenience functions that help you transform your secrets. This is useful when dealing with PKCS#12 archives or JSON Web Keys (JWK).</p>
  1583. <p>In addition to that you can use over 200+ <a href="http://masterminds.github.io/sprig/">sprig functions</a>. If you feel a function is missing or might be valuable feel free to open an issue and submit a <a href="../../contributing/process/#submitting-a-pull-request">pull request</a>.</p>
  1584. <p><br/></p>
  1585. <table>
  1586. <thead>
  1587. <tr>
  1588. <th>Function</th>
  1589. <th>Description</th>
  1590. </tr>
  1591. </thead>
  1592. <tbody>
  1593. <tr>
  1594. <td>pkcs12key</td>
  1595. <td>Extracts all private keys from a PKCS#12 archive and encodes them in <strong>PKCS#8 PEM</strong> format.</td>
  1596. </tr>
  1597. <tr>
  1598. <td>pkcs12keyPass</td>
  1599. <td>Same as <code>pkcs12key</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  1600. </tr>
  1601. <tr>
  1602. <td>pkcs12cert</td>
  1603. <td>Extracts all certificates from a PKCS#12 archive and orders them if possible. If disjunct or multiple leaf certs are provided they are returned as-is. <br/> Sort order: <code>leaf / intermediate(s) / root</code>.</td>
  1604. </tr>
  1605. <tr>
  1606. <td>pkcs12certPass</td>
  1607. <td>Same as <code>pkcs12cert</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  1608. </tr>
  1609. <tr>
  1610. <td>pemToPkcs12</td>
  1611. <td>Takes a PEM encoded certificate and key and creates a base64 encoded PKCS#12 archive.</td>
  1612. </tr>
  1613. <tr>
  1614. <td>pemToPkcs12Pass</td>
  1615. <td>Same as <code>pemToPkcs12</code>. Uses the provided password to encrypt the PKCS#12 archive.</td>
  1616. </tr>
  1617. <tr>
  1618. <td>fullPemToPkcs12</td>
  1619. <td>Takes a PEM encoded certificates chain and key and creates a base64 encoded PKCS#12 archive.</td>
  1620. </tr>
  1621. <tr>
  1622. <td>fullPemToPkcs12Pass</td>
  1623. <td>Same as <code>fullPemToPkcs12</code>. Uses the provided password to encrypt the PKCS#12 archive.</td>
  1624. </tr>
  1625. <tr>
  1626. <td>filterPEM</td>
  1627. <td>Filters PEM blocks with a specific type from a list of PEM blocks.</td>
  1628. </tr>
  1629. <tr>
  1630. <td>jwkPublicKeyPem</td>
  1631. <td>Takes an json-serialized JWK and returns an PEM block of type <code>PUBLIC KEY</code> that contains the public key. <a href="https://golang.org/pkg/crypto/x509/#MarshalPKIXPublicKey">See here</a> for details.</td>
  1632. </tr>
  1633. <tr>
  1634. <td>jwkPrivateKeyPem</td>
  1635. <td>Takes an json-serialized JWK as <code>string</code> and returns an PEM block of type <code>PRIVATE KEY</code> that contains the private key in PKCS #8 format. <a href="https://golang.org/pkg/crypto/x509/#MarshalPKCS8PrivateKey">See here</a> for details.</td>
  1636. </tr>
  1637. <tr>
  1638. <td>toYaml</td>
  1639. <td>Takes an interface, marshals it to yaml. It returns a string, even on marshal error (empty string).</td>
  1640. </tr>
  1641. <tr>
  1642. <td>fromYaml</td>
  1643. <td>Function converts a YAML document into a map[string]any.</td>
  1644. </tr>
  1645. </tbody>
  1646. </table>
  1647. <h2 id="migrating-from-v1">Migrating from v1</h2>
  1648. <p>If you are still using <code>v1alpha1</code>, You have to opt-in to use the new engine version by specifying <code>template.engineVersion=v2</code>:</p>
  1649. <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/v1alpha1</span>
  1650. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1651. <span class="nt">metadata</span><span class="p">:</span>
  1652. <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">secret</span>
  1653. <span class="nt">spec</span><span class="p">:</span>
  1654. <span class="w"> </span><span class="c1"># ...</span>
  1655. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1656. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1657. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1658. <span class="w"> </span><span class="c1"># ...</span>
  1659. </code></pre></div>
  1660. <p>The biggest change was that basically all function parameter types were changed from accepting/returning <code>[]byte</code> to <code>string</code>. This is relevant for you because now you don't need to specify <code>toString</code> all the time at the end of a template pipeline.</p>
  1661. <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/v1alpha1</span>
  1662. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1663. <span class="c1"># ...</span>
  1664. <span class="nt">spec</span><span class="p">:</span>
  1665. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1666. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1667. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1668. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1669. <span class="w"> </span><span class="c1"># this used to be {{ .foobar | toString }}</span>
  1670. <span class="w"> </span><span class="nt">egg</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;new:</span><span class="nv"> </span><span class="s">{{</span><span class="nv"> </span><span class="s">.foobar</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1671. </code></pre></div>
  1672. <h5 id="functions-removedreplaced">Functions removed/replaced</h5>
  1673. <ul>
  1674. <li><code>base64encode</code> was renamed to <code>b64enc</code>.</li>
  1675. <li><code>base64decode</code> was renamed to <code>b64dec</code>. Any errors that occur during decoding are silenced.</li>
  1676. <li><code>fromJSON</code> was renamed to <code>fromJson</code>. Any errors that occur during unmarshalling are silenced.</li>
  1677. <li><code>toJSON</code> was renamed to <code>toJson</code>. Any errors that occur during marshalling are silenced.</li>
  1678. <li><code>pkcs12key</code> and <code>pkcs12keyPass</code> encode the PKCS#8 key directly into PEM format. There is no need to call <code>pemPrivateKey</code> anymore. Also, these functions do extract all private keys from the PKCS#12 archive not just the first one.</li>
  1679. <li><code>pkcs12cert</code> and <code>pkcs12certPass</code> encode the certs directly into PEM format. There is no need to call <code>pemCertificate</code> anymore. These functions now <strong>extract all certificates</strong> from the PKCS#12 archive not just the first one.</li>
  1680. <li><code>toString</code> implementation was replaced by the <code>sprig</code> implementation and should be api-compatible.</li>
  1681. <li><code>toBytes</code> was removed.</li>
  1682. <li><code>pemPrivateKey</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  1683. <li><code>pemCertificate</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  1684. </ul>
  1685. </article>
  1686. </div>
  1687. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1688. </div>
  1689. </main>
  1690. <footer class="md-footer">
  1691. <div class="md-footer-meta md-typeset">
  1692. <div class="md-footer-meta__inner md-grid">
  1693. <div class="md-copyright">
  1694. <div class="md-copyright__highlight">
  1695. &copy; 2024 The external-secrets Authors.<br/>
  1696. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1697. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1698. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1699. </div>
  1700. Made with
  1701. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1702. Material for MkDocs
  1703. </a>
  1704. </div>
  1705. </div>
  1706. </div>
  1707. </footer>
  1708. </div>
  1709. <div class="md-dialog" data-md-component="dialog">
  1710. <div class="md-dialog__inner md-typeset"></div>
  1711. </div>
  1712. <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>
  1713. <script src="../../assets/javascripts/bundle.af256bd8.min.js"></script>
  1714. </body>
  1715. </html>