index.html 103 KB

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