index.html 81 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660
  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.4.3, mkdocs-material-9.1.9">
  10. <title>v2 - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.85bb2934.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. <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#advanced-templating-v2" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <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>
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. v2
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <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.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 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">
  121. <a href="../introduction/" class="md-tabs__link md-tabs__link--active">
  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.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 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__link--index ">
  169. <a href="../..">Introduction</a>
  170. <label for="__nav_1">
  171. <span class="md-nav__icon md-icon"></span>
  172. </label>
  173. </div>
  174. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  175. <label class="md-nav__title" for="__nav_1">
  176. <span class="md-nav__icon md-icon"></span>
  177. Introduction
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../../introduction/overview/" class="md-nav__link">
  182. Overview
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../../introduction/getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../introduction/faq/" class="md-nav__link">
  192. FAQ
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/stability-support/" class="md-nav__link">
  197. Stability and Support
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  202. Deprecation Policy
  203. </a>
  204. </li>
  205. </ul>
  206. </nav>
  207. </li>
  208. <li class="md-nav__item md-nav__item--nested">
  209. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  210. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  211. API
  212. <span class="md-nav__icon md-icon"></span>
  213. </label>
  214. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  215. <label class="md-nav__title" for="__nav_2">
  216. <span class="md-nav__icon md-icon"></span>
  217. API
  218. </label>
  219. <ul class="md-nav__list" data-md-scrollfix>
  220. <li class="md-nav__item">
  221. <a href="../../api/components/" class="md-nav__link">
  222. Components
  223. </a>
  224. </li>
  225. <li class="md-nav__item md-nav__item--nested">
  226. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  227. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  228. Core Resources
  229. <span class="md-nav__icon md-icon"></span>
  230. </label>
  231. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  232. <label class="md-nav__title" for="__nav_2_2">
  233. <span class="md-nav__icon md-icon"></span>
  234. Core Resources
  235. </label>
  236. <ul class="md-nav__list" data-md-scrollfix>
  237. <li class="md-nav__item">
  238. <a href="../../api/externalsecret/" class="md-nav__link">
  239. ExternalSecret
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../../api/secretstore/" class="md-nav__link">
  244. SecretStore
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../../api/clustersecretstore/" class="md-nav__link">
  249. ClusterSecretStore
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  254. ClusterExternalSecret
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="../../api/pushsecret/" class="md-nav__link">
  259. PushSecret
  260. </a>
  261. </li>
  262. </ul>
  263. </nav>
  264. </li>
  265. <li class="md-nav__item md-nav__item--nested">
  266. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  267. <div class="md-nav__link md-nav__link--index ">
  268. <a href="../../api/generator/">Generators</a>
  269. <label for="__nav_2_3">
  270. <span class="md-nav__icon md-icon"></span>
  271. </label>
  272. </div>
  273. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  274. <label class="md-nav__title" for="__nav_2_3">
  275. <span class="md-nav__icon md-icon"></span>
  276. Generators
  277. </label>
  278. <ul class="md-nav__list" data-md-scrollfix>
  279. <li class="md-nav__item">
  280. <a href="../../api/generator/acr/" class="md-nav__link">
  281. Azure Container Registry
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="../../api/generator/ecr/" class="md-nav__link">
  286. AWS Elastic Container Registry
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/generator/gcr/" class="md-nav__link">
  291. Google Container Registry
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="../../api/generator/vault/" class="md-nav__link">
  296. Vault Dynamic Secret
  297. </a>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="../../api/generator/password/" class="md-nav__link">
  301. Password
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="../../api/generator/fake/" class="md-nav__link">
  306. Fake
  307. </a>
  308. </li>
  309. </ul>
  310. </nav>
  311. </li>
  312. <li class="md-nav__item md-nav__item--nested">
  313. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  314. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  315. Reference Docs
  316. <span class="md-nav__icon md-icon"></span>
  317. </label>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_4">
  320. <span class="md-nav__icon md-icon"></span>
  321. Reference Docs
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../../api/spec/" class="md-nav__link">
  326. API specification
  327. </a>
  328. </li>
  329. <li class="md-nav__item">
  330. <a href="../../api/controller-options/" class="md-nav__link">
  331. Controller Options
  332. </a>
  333. </li>
  334. <li class="md-nav__item">
  335. <a href="../../api/metrics/" class="md-nav__link">
  336. Metrics
  337. </a>
  338. </li>
  339. </ul>
  340. </nav>
  341. </li>
  342. </ul>
  343. </nav>
  344. </li>
  345. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  346. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  347. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  348. Guides
  349. <span class="md-nav__icon md-icon"></span>
  350. </label>
  351. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
  352. <label class="md-nav__title" for="__nav_3">
  353. <span class="md-nav__icon md-icon"></span>
  354. Guides
  355. </label>
  356. <ul class="md-nav__list" data-md-scrollfix>
  357. <li class="md-nav__item">
  358. <a href="../introduction/" class="md-nav__link">
  359. Introduction
  360. </a>
  361. </li>
  362. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  363. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" checked>
  364. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  365. External Secrets
  366. <span class="md-nav__icon md-icon"></span>
  367. </label>
  368. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true">
  369. <label class="md-nav__title" for="__nav_3_2">
  370. <span class="md-nav__icon md-icon"></span>
  371. External Secrets
  372. </label>
  373. <ul class="md-nav__list" data-md-scrollfix>
  374. <li class="md-nav__item">
  375. <a href="../all-keys-one-secret/" class="md-nav__link">
  376. Extract structured data
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="../getallsecrets/" class="md-nav__link">
  381. Find Secrets by Name or Metadata
  382. </a>
  383. </li>
  384. <li class="md-nav__item">
  385. <a href="../datafrom-rewrite/" class="md-nav__link">
  386. Rewriting Keys
  387. </a>
  388. </li>
  389. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  390. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_4" checked>
  391. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  392. Advanced Templating
  393. <span class="md-nav__icon md-icon"></span>
  394. </label>
  395. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="true">
  396. <label class="md-nav__title" for="__nav_3_2_4">
  397. <span class="md-nav__icon md-icon"></span>
  398. Advanced Templating
  399. </label>
  400. <ul class="md-nav__list" data-md-scrollfix>
  401. <li class="md-nav__item md-nav__item--active">
  402. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  403. <label class="md-nav__link md-nav__link--active" for="__toc">
  404. v2
  405. <span class="md-nav__icon md-icon"></span>
  406. </label>
  407. <a href="./" class="md-nav__link md-nav__link--active">
  408. v2
  409. </a>
  410. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  411. <label class="md-nav__title" for="__toc">
  412. <span class="md-nav__icon md-icon"></span>
  413. Table of contents
  414. </label>
  415. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  416. <li class="md-nav__item">
  417. <a href="#examples" class="md-nav__link">
  418. Examples
  419. </a>
  420. <nav class="md-nav" aria-label="Examples">
  421. <ul class="md-nav__list">
  422. <li class="md-nav__item">
  423. <a href="#mergepolicy" class="md-nav__link">
  424. MergePolicy
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="#templatefrom" class="md-nav__link">
  429. TemplateFrom
  430. </a>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  434. Extract Keys and Certificates from PKCS#12 Archive
  435. </a>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="#extract-from-jwk" class="md-nav__link">
  439. Extract from JWK
  440. </a>
  441. </li>
  442. <li class="md-nav__item">
  443. <a href="#filter-pem-blocks" class="md-nav__link">
  444. Filter PEM blocks
  445. </a>
  446. </li>
  447. </ul>
  448. </nav>
  449. </li>
  450. <li class="md-nav__item">
  451. <a href="#helper-functions" class="md-nav__link">
  452. Helper functions
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="#migrating-from-v1" class="md-nav__link">
  457. Migrating from v1
  458. </a>
  459. <nav class="md-nav" aria-label="Migrating from v1">
  460. <ul class="md-nav__list">
  461. <li class="md-nav__item">
  462. <a href="#functions-removedreplaced" class="md-nav__link">
  463. Functions removed/replaced
  464. </a>
  465. </li>
  466. </ul>
  467. </nav>
  468. </li>
  469. </ul>
  470. </nav>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="../templating-v1/" class="md-nav__link">
  474. v1
  475. </a>
  476. </li>
  477. </ul>
  478. </nav>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../common-k8s-secret-types/" class="md-nav__link">
  482. Kubernetes Secret Types
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../ownership-deletion-policy/" class="md-nav__link">
  487. Lifecycle: ownership & deletion
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../decoding-strategy/" class="md-nav__link">
  492. Decoding Strategies
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../controller-class/" class="md-nav__link">
  497. Controller Classes
  498. </a>
  499. </li>
  500. </ul>
  501. </nav>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../generator/" class="md-nav__link">
  505. Generators
  506. </a>
  507. </li>
  508. <li class="md-nav__item md-nav__item--nested">
  509. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
  510. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  511. Operations
  512. <span class="md-nav__icon md-icon"></span>
  513. </label>
  514. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
  515. <label class="md-nav__title" for="__nav_3_4">
  516. <span class="md-nav__icon md-icon"></span>
  517. Operations
  518. </label>
  519. <ul class="md-nav__list" data-md-scrollfix>
  520. <li class="md-nav__item">
  521. <a href="../multi-tenancy/" class="md-nav__link">
  522. Multi Tenancy
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../security-best-practices/" class="md-nav__link">
  527. Security Best Practices
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../threat-model/" class="md-nav__link">
  532. Threat Model
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../v1beta1/" class="md-nav__link">
  537. Upgrading to v1beta1
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../using-latest-image/" class="md-nav__link">
  542. Using Latest Image
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../disable-cluster-features/" class="md-nav__link">
  547. Disable Cluster Features
  548. </a>
  549. </li>
  550. </ul>
  551. </nav>
  552. </li>
  553. </ul>
  554. </nav>
  555. </li>
  556. <li class="md-nav__item md-nav__item--nested">
  557. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  558. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  559. Provider
  560. <span class="md-nav__icon md-icon"></span>
  561. </label>
  562. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  563. <label class="md-nav__title" for="__nav_4">
  564. <span class="md-nav__icon md-icon"></span>
  565. Provider
  566. </label>
  567. <ul class="md-nav__list" data-md-scrollfix>
  568. <li class="md-nav__item">
  569. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  570. AWS Secrets Manager
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  575. AWS Parameter Store
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  580. Azure Key Vault
  581. </a>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="../../provider/conjur/" class="md-nav__link">
  585. CyberArk Conjur
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  590. Google Cloud Secret Manager
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  595. HashiCorp Vault
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../../provider/kubernetes/" class="md-nav__link">
  600. Kubernetes
  601. </a>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  605. IBM Secrets Manager
  606. </a>
  607. </li>
  608. <li class="md-nav__item">
  609. <a href="../../provider/akeyless/" class="md-nav__link">
  610. Akeyless
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  615. Yandex Certificate Manager
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  620. Yandex Lockbox
  621. </a>
  622. </li>
  623. <li class="md-nav__item">
  624. <a href="../../provider/alibaba/" class="md-nav__link">
  625. Alibaba Cloud
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  630. GitLab Variables
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../provider/oracle-vault/" class="md-nav__link">
  635. Oracle Vault
  636. </a>
  637. </li>
  638. <li class="md-nav__item">
  639. <a href="../../provider/1password-automation/" class="md-nav__link">
  640. 1Password Secrets Automation
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="../../provider/webhook/" class="md-nav__link">
  645. Webhook
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="../../provider/fake/" class="md-nav__link">
  650. Fake
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  655. senhasegura DevOps Secrets Management (DSM)
  656. </a>
  657. </li>
  658. <li class="md-nav__item">
  659. <a href="../../provider/doppler/" class="md-nav__link">
  660. Doppler
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../../provider/keeper-security/" class="md-nav__link">
  665. Keeper Security
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../provider/scaleway/" class="md-nav__link">
  670. Scaleway
  671. </a>
  672. </li>
  673. </ul>
  674. </nav>
  675. </li>
  676. <li class="md-nav__item md-nav__item--nested">
  677. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  678. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  679. Examples
  680. <span class="md-nav__icon md-icon"></span>
  681. </label>
  682. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  683. <label class="md-nav__title" for="__nav_5">
  684. <span class="md-nav__icon md-icon"></span>
  685. Examples
  686. </label>
  687. <ul class="md-nav__list" data-md-scrollfix>
  688. <li class="md-nav__item">
  689. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  690. FluxCD
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  695. Anchore Engine
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  700. Jenkins
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../examples/bitwarden/" class="md-nav__link">
  705. BitWarden
  706. </a>
  707. </li>
  708. </ul>
  709. </nav>
  710. </li>
  711. <li class="md-nav__item md-nav__item--nested">
  712. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  713. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  714. Community
  715. <span class="md-nav__icon md-icon"></span>
  716. </label>
  717. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  718. <label class="md-nav__title" for="__nav_6">
  719. <span class="md-nav__icon md-icon"></span>
  720. Community
  721. </label>
  722. <ul class="md-nav__list" data-md-scrollfix>
  723. <li class="md-nav__item md-nav__item--nested">
  724. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  725. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  726. Contributing
  727. <span class="md-nav__icon md-icon"></span>
  728. </label>
  729. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  730. <label class="md-nav__title" for="__nav_6_1">
  731. <span class="md-nav__icon md-icon"></span>
  732. Contributing
  733. </label>
  734. <ul class="md-nav__list" data-md-scrollfix>
  735. <li class="md-nav__item">
  736. <a href="../../contributing/devguide/" class="md-nav__link">
  737. Developer guide
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="../../contributing/process/" class="md-nav__link">
  742. Contributing Process
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../contributing/release/" class="md-nav__link">
  747. Release Process
  748. </a>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="../../contributing/coc/" class="md-nav__link">
  752. Code of Conduct
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="../../contributing/roadmap/" class="md-nav__link">
  757. Roadmap
  758. </a>
  759. </li>
  760. </ul>
  761. </nav>
  762. </li>
  763. <li class="md-nav__item md-nav__item--nested">
  764. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  765. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  766. External Resources
  767. <span class="md-nav__icon md-icon"></span>
  768. </label>
  769. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  770. <label class="md-nav__title" for="__nav_6_2">
  771. <span class="md-nav__icon md-icon"></span>
  772. External Resources
  773. </label>
  774. <ul class="md-nav__list" data-md-scrollfix>
  775. <li class="md-nav__item">
  776. <a href="../../eso-talks/" class="md-nav__link">
  777. Talks
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../eso-demos/" class="md-nav__link">
  782. Demos
  783. </a>
  784. </li>
  785. <li class="md-nav__item">
  786. <a href="../../eso-blogs/" class="md-nav__link">
  787. Blogs
  788. </a>
  789. </li>
  790. </ul>
  791. </nav>
  792. </li>
  793. </ul>
  794. </nav>
  795. </li>
  796. </ul>
  797. </nav>
  798. </div>
  799. </div>
  800. </div>
  801. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  802. <div class="md-sidebar__scrollwrap">
  803. <div class="md-sidebar__inner">
  804. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  805. <label class="md-nav__title" for="__toc">
  806. <span class="md-nav__icon md-icon"></span>
  807. Table of contents
  808. </label>
  809. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  810. <li class="md-nav__item">
  811. <a href="#examples" class="md-nav__link">
  812. Examples
  813. </a>
  814. <nav class="md-nav" aria-label="Examples">
  815. <ul class="md-nav__list">
  816. <li class="md-nav__item">
  817. <a href="#mergepolicy" class="md-nav__link">
  818. MergePolicy
  819. </a>
  820. </li>
  821. <li class="md-nav__item">
  822. <a href="#templatefrom" class="md-nav__link">
  823. TemplateFrom
  824. </a>
  825. </li>
  826. <li class="md-nav__item">
  827. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  828. Extract Keys and Certificates from PKCS#12 Archive
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="#extract-from-jwk" class="md-nav__link">
  833. Extract from JWK
  834. </a>
  835. </li>
  836. <li class="md-nav__item">
  837. <a href="#filter-pem-blocks" class="md-nav__link">
  838. Filter PEM blocks
  839. </a>
  840. </li>
  841. </ul>
  842. </nav>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="#helper-functions" class="md-nav__link">
  846. Helper functions
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="#migrating-from-v1" class="md-nav__link">
  851. Migrating from v1
  852. </a>
  853. <nav class="md-nav" aria-label="Migrating from v1">
  854. <ul class="md-nav__list">
  855. <li class="md-nav__item">
  856. <a href="#functions-removedreplaced" class="md-nav__link">
  857. Functions removed/replaced
  858. </a>
  859. </li>
  860. </ul>
  861. </nav>
  862. </li>
  863. </ul>
  864. </nav>
  865. </div>
  866. </div>
  867. </div>
  868. <div class="md-content" data-md-component="content">
  869. <article class="md-content__inner md-typeset">
  870. <h1 id="advanced-templating-v2">Advanced Templating v2</h1>
  871. <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>
  872. <h2 id="examples">Examples</h2>
  873. <p>You can use templates to inject your secrets into a configuration file that you mount into your pod:</p>
  874. <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>
  875. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  876. <span class="nt">metadata</span><span class="p">:</span>
  877. <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>
  878. <span class="nt">spec</span><span class="p">:</span>
  879. <span class="w"> </span><span class="c1"># ...</span>
  880. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  881. <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>
  882. <span class="w"> </span><span class="c1"># this is how the Kind=Secret will look like</span>
  883. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  884. <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>
  885. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  886. <span class="w"> </span><span class="c1"># multiline string</span>
  887. <span class="w"> </span><span class="nt">config</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  888. <span class="w"> </span><span class="no">datasources:</span>
  889. <span class="w"> </span><span class="no">- name: Graphite</span>
  890. <span class="w"> </span><span class="no">type: graphite</span>
  891. <span class="w"> </span><span class="no">access: proxy</span>
  892. <span class="w"> </span><span class="no">url: http://localhost:8080</span>
  893. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span>
  894. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span>
  895. <span class="w"> </span><span class="c1"># using replace function to rewrite secret</span>
  896. <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>
  897. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  898. <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>
  899. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  900. <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>
  901. <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>
  902. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  903. <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>
  904. <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>
  905. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  906. <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>
  907. </code></pre></div>
  908. <p>Another example with two keys in the same secret:</p>
  909. <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>
  910. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  911. <span class="nt">metadata</span><span class="p">:</span>
  912. <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>
  913. <span class="nt">spec</span><span class="p">:</span>
  914. <span class="w"> </span><span class="c1"># ...</span>
  915. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  916. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  917. <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>
  918. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  919. <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>
  920. <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>
  921. <span class="w"> </span><span class="c1"># password: &#39;{{ printf &quot;{{ .mysecret }}&quot; }}&#39; # If you are using templated tools like helm</span>
  922. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  923. <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>
  924. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  925. <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>
  926. </code></pre></div>
  927. <h3 id="mergepolicy">MergePolicy</h3>
  928. <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>
  929. <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>
  930. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  931. <span class="nt">metadata</span><span class="p">:</span>
  932. <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>
  933. <span class="nt">spec</span><span class="p">:</span>
  934. <span class="w"> </span><span class="c1"># ...</span>
  935. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  936. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  937. <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>
  938. <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>
  939. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  940. <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>
  941. <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>
  942. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  943. <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>
  944. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  945. <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>
  946. <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>
  947. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  948. <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>
  949. </code></pre></div>
  950. <h3 id="templatefrom">TemplateFrom</h3>
  951. <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>
  952. <div class="highlight"><pre><span></span><code><span class="c1"># define your template in a config map</span>
  953. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  954. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ConfigMap</span>
  955. <span class="nt">metadata</span><span class="p">:</span>
  956. <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>
  957. <span class="nt">data</span><span class="p">:</span>
  958. <span class="w"> </span><span class="nt">config.yaml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  959. <span class="w"> </span><span class="no">datasources:</span>
  960. <span class="w"> </span><span class="no">- name: Graphite</span>
  961. <span class="w"> </span><span class="no">type: graphite</span>
  962. <span class="w"> </span><span class="no">access: proxy</span>
  963. <span class="w"> </span><span class="no">url: &quot;{{ .uri }}&quot;</span>
  964. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span>
  965. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span>
  966. <span class="w"> </span><span class="nt">templated</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  967. <span class="w"> </span><span class="no"># key and value templated</span>
  968. <span class="w"> </span><span class="no">my-application-{{ .user}}: {{ .password | b64enc }}</span>
  969. <span class="w"> </span><span class="no"># conditional keys</span>
  970. <span class="w"> </span><span class="no">{{- if hasPrefix &quot;oci://&quot; .uri }}</span>
  971. <span class="w"> </span><span class="no">enableOCI: true</span>
  972. <span class="w"> </span><span class="no">{{- else }}</span>
  973. <span class="w"> </span><span class="no">enableOCI: false</span>
  974. <span class="w"> </span><span class="no">{{- end }}</span>
  975. <span class="w"> </span><span class="no"># Fixed values</span>
  976. <span class="w"> </span><span class="no">application-type: grafana</span>
  977. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  978. <span class="w"> </span><span class="no">#dynamic timestamp generation</span>
  979. <span class="w"> </span><span class="no">last-synced-for-user/{{ .user }}: {{ now }}</span>
  980. <span class="nn">---</span>
  981. <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>
  982. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  983. <span class="nt">metadata</span><span class="p">:</span>
  984. <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>
  985. <span class="nt">spec</span><span class="p">:</span>
  986. <span class="w"> </span><span class="c1"># ...</span>
  987. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  988. <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>
  989. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  990. <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>
  991. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  992. <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>
  993. <span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  994. <span class="w"> </span><span class="c1"># name of the configmap to pull in</span>
  995. <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>
  996. <span class="w"> </span><span class="c1"># here you define the keys that should be used as template</span>
  997. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  998. <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>
  999. <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>
  1000. <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">generated</span>
  1001. <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>
  1002. <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>
  1003. <span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1004. <span class="w"> </span><span class="c1"># name of the configmap to pull in</span>
  1005. <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>
  1006. <span class="w"> </span><span class="c1"># here you define the keys that should be used as template</span>
  1007. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1008. <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>
  1009. <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>
  1010. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1011. <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>
  1012. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1013. <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>
  1014. <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>
  1015. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1016. <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>
  1017. <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>
  1018. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1019. <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>
  1020. </code></pre></div>
  1021. <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>
  1022. <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>
  1023. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1024. <span class="nt">metadata</span><span class="p">:</span>
  1025. <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>
  1026. <span class="nt">spec</span><span class="p">:</span>
  1027. <span class="w"> </span><span class="c1"># ...</span>
  1028. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1029. <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>
  1030. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1031. <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>
  1032. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1033. <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>
  1034. <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>
  1035. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1036. <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>
  1037. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1038. <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>
  1039. <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>
  1040. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1041. <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>
  1042. </code></pre></div>
  1043. <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>
  1044. <h3 id="extract-keys-and-certificates-from-pkcs12-archive">Extract Keys and Certificates from PKCS#12 Archive</h3>
  1045. <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>
  1046. <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>
  1047. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1048. <span class="nt">metadata</span><span class="p">:</span>
  1049. <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>
  1050. <span class="nt">spec</span><span class="p">:</span>
  1051. <span class="w"> </span><span class="c1"># ...</span>
  1052. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1053. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1054. <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>
  1055. <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>
  1056. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1057. <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>
  1058. <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>
  1059. <span class="w"> </span><span class="c1"># if needed unlock the pkcs12 with the password</span>
  1060. <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>
  1061. </code></pre></div>
  1062. <h3 id="extract-from-jwk">Extract from JWK</h3>
  1063. <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>
  1064. <p>A JWK looks similar to this:</p>
  1065. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1066. <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>
  1067. <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>
  1068. <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>
  1069. <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>
  1070. <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>
  1071. <span class="w"> </span><span class="c1">// ...</span>
  1072. <span class="p">}</span>
  1073. </code></pre></div>
  1074. <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>
  1075. <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>
  1076. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1077. <span class="nt">metadata</span><span class="p">:</span>
  1078. <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>
  1079. <span class="nt">spec</span><span class="p">:</span>
  1080. <span class="w"> </span><span class="c1"># ...</span>
  1081. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1082. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1083. <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>
  1084. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1085. <span class="w"> </span><span class="c1"># .myjwk is a json-encoded JWK string.</span>
  1086. <span class="w"> </span><span class="c1">#</span>
  1087. <span class="w"> </span><span class="c1"># this template will produce for jwk_pub a PEM encoded public key:</span>
  1088. <span class="w"> </span><span class="c1"># -----BEGIN PUBLIC KEY-----</span>
  1089. <span class="w"> </span><span class="c1"># MIIBI...</span>
  1090. <span class="w"> </span><span class="c1"># ...</span>
  1091. <span class="w"> </span><span class="c1"># ...AQAB</span>
  1092. <span class="w"> </span><span class="c1"># -----END PUBLIC KEY-----</span>
  1093. <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>
  1094. <span class="w"> </span><span class="c1"># private key is a pem-encoded PKCS#8 private key</span>
  1095. <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>
  1096. </code></pre></div>
  1097. <h3 id="filter-pem-blocks">Filter PEM blocks</h3>
  1098. <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>
  1099. <div class="highlight"><pre><span></span><code>-----BEGIN PRIVATE KEY-----
  1100. MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCvxGZOW4IXvGlh
  1101. . . .
  1102. m8JCpbJXDfSSVxKHgK1Siw4K6pnTsIA2e/Z+Ha2fvtocERjq7VQMAJFaIZSTKo9Q
  1103. JwwY+vj0yxWjyzHUzZB33tg=
  1104. -----END PRIVATE KEY-----
  1105. -----BEGIN CERTIFICATE-----
  1106. MIIDMDCCAhigAwIBAgIQabPaXuZCQaCg+eQAVptGGDANBgkqhkiG9w0BAQsFADAV
  1107. . . .
  1108. NtFUGA95RGN9s+pl6XY0YARPHf5O76ErC1OZtDTR5RdyQfcM+94gYZsexsXl0aQO
  1109. 9YD3Wg==
  1110. -----END CERTIFICATE-----
  1111. </code></pre></div>
  1112. <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 then all of them are returned in the order they are specified.</p>
  1113. <h2 id="helper-functions">Helper functions</h2>
  1114. <div class="admonition info inline end">
  1115. <p class="admonition-title">Info</p>
  1116. <p>Note: we removed <code>env</code> and <code>expandenv</code> from sprig functions for security reasons.</p>
  1117. </div>
  1118. <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>
  1119. <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>
  1120. <p><br/></p>
  1121. <table>
  1122. <thead>
  1123. <tr>
  1124. <th>Function</th>
  1125. <th>Description</th>
  1126. </tr>
  1127. </thead>
  1128. <tbody>
  1129. <tr>
  1130. <td>pkcs12key</td>
  1131. <td>Extracts all private keys from a PKCS#12 archive and encodes them in <strong>PKCS#8 PEM</strong> format.</td>
  1132. </tr>
  1133. <tr>
  1134. <td>pkcs12keyPass</td>
  1135. <td>Same as <code>pkcs12key</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  1136. </tr>
  1137. <tr>
  1138. <td>pkcs12cert</td>
  1139. <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>
  1140. </tr>
  1141. <tr>
  1142. <td>pkcs12certPass</td>
  1143. <td>Same as <code>pkcs12cert</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  1144. </tr>
  1145. <tr>
  1146. <td>filterPEM</td>
  1147. <td>Filters PEM blocks with a specific type from a list of PEM blocks.</td>
  1148. </tr>
  1149. <tr>
  1150. <td>jwkPublicKeyPem</td>
  1151. <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>
  1152. </tr>
  1153. <tr>
  1154. <td>jwkPrivateKeyPem</td>
  1155. <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>
  1156. </tr>
  1157. <tr>
  1158. <td>toYaml</td>
  1159. <td>Takes an interface, marshals it to yaml. It returns a string, even on marshal error (empty string).</td>
  1160. </tr>
  1161. <tr>
  1162. <td>fromYaml</td>
  1163. <td>Function converts a YAML document into a map[string]interface{}.</td>
  1164. </tr>
  1165. </tbody>
  1166. </table>
  1167. <h2 id="migrating-from-v1">Migrating from v1</h2>
  1168. <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>
  1169. <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>
  1170. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1171. <span class="nt">metadata</span><span class="p">:</span>
  1172. <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>
  1173. <span class="nt">spec</span><span class="p">:</span>
  1174. <span class="w"> </span><span class="c1"># ...</span>
  1175. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1176. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1177. <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>
  1178. <span class="w"> </span><span class="c1"># ...</span>
  1179. </code></pre></div>
  1180. <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>
  1181. <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>
  1182. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1183. <span class="c1"># ...</span>
  1184. <span class="nt">spec</span><span class="p">:</span>
  1185. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1186. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1187. <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>
  1188. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1189. <span class="w"> </span><span class="c1"># this used to be {{ .foobar | toString }}</span>
  1190. <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>
  1191. </code></pre></div>
  1192. <h5 id="functions-removedreplaced">Functions removed/replaced</h5>
  1193. <ul>
  1194. <li><code>base64encode</code> was renamed to <code>b64enc</code>.</li>
  1195. <li><code>base64decode</code> was renamed to <code>b64dec</code>. Any errors that occur during decoding are silenced.</li>
  1196. <li><code>fromJSON</code> was renamed to <code>fromJson</code>. Any errors that occur during unmarshalling are silenced.</li>
  1197. <li><code>toJSON</code> was renamed to <code>toJson</code>. Any errors that occur during marshalling are silenced.</li>
  1198. <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>
  1199. <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>
  1200. <li><code>toString</code> implementation was replaced by the <code>sprig</code> implementation and should be api-compatible.</li>
  1201. <li><code>toBytes</code> was removed.</li>
  1202. <li><code>pemPrivateKey</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  1203. <li><code>pemCertificate</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  1204. </ul>
  1205. </article>
  1206. </div>
  1207. </div>
  1208. </main>
  1209. <footer class="md-footer">
  1210. <div class="md-footer-meta md-typeset">
  1211. <div class="md-footer-meta__inner md-grid">
  1212. <div class="md-copyright">
  1213. <div class="md-copyright__highlight">
  1214. &copy; 2023 The external-secrets Authors.<br/>
  1215. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1216. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1217. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1218. </div>
  1219. Made with
  1220. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1221. Material for MkDocs
  1222. </a>
  1223. </div>
  1224. </div>
  1225. </div>
  1226. </footer>
  1227. </div>
  1228. <div class="md-dialog" data-md-component="dialog">
  1229. <div class="md-dialog__inner md-typeset"></div>
  1230. </div>
  1231. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.208ed371.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>
  1232. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  1233. </body>
  1234. </html>