index.html 109 KB

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