index.html 79 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387
  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="icon" href="../../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>v2 - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("../..",location),__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>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#advanced-templating-v2" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <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>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. v2
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <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>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <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>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <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>
  72. <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>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <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>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../introduction/" class="md-tabs__link md-tabs__link--active">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <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>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/password/" class="md-nav__link">
  294. Password
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/fake/" class="md-nav__link">
  299. Fake
  300. </a>
  301. </li>
  302. </ul>
  303. </nav>
  304. </li>
  305. <li class="md-nav__item md-nav__item--nested">
  306. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  307. <label class="md-nav__link" for="__nav_2_4">
  308. Reference Docs
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_2_4">
  313. <span class="md-nav__icon md-icon"></span>
  314. Reference Docs
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../../api/spec/" class="md-nav__link">
  319. API specification
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../../api/controller-options/" class="md-nav__link">
  324. Controller Options
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/metrics/" class="md-nav__link">
  329. Metrics
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. </ul>
  336. </nav>
  337. </li>
  338. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  339. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
  340. <label class="md-nav__link" for="__nav_3">
  341. Guides
  342. <span class="md-nav__icon md-icon"></span>
  343. </label>
  344. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  345. <label class="md-nav__title" for="__nav_3">
  346. <span class="md-nav__icon md-icon"></span>
  347. Guides
  348. </label>
  349. <ul class="md-nav__list" data-md-scrollfix>
  350. <li class="md-nav__item">
  351. <a href="../introduction/" class="md-nav__link">
  352. Introduction
  353. </a>
  354. </li>
  355. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  356. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" type="checkbox" id="__nav_3_2" checked>
  357. <label class="md-nav__link" for="__nav_3_2">
  358. Advanced Templating
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_3_2">
  363. <span class="md-nav__icon md-icon"></span>
  364. Advanced Templating
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item md-nav__item--active">
  368. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  369. <label class="md-nav__link md-nav__link--active" for="__toc">
  370. v2
  371. <span class="md-nav__icon md-icon"></span>
  372. </label>
  373. <a href="./" class="md-nav__link md-nav__link--active">
  374. v2
  375. </a>
  376. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  377. <label class="md-nav__title" for="__toc">
  378. <span class="md-nav__icon md-icon"></span>
  379. Table of contents
  380. </label>
  381. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  382. <li class="md-nav__item">
  383. <a href="#examples" class="md-nav__link">
  384. Examples
  385. </a>
  386. <nav class="md-nav" aria-label="Examples">
  387. <ul class="md-nav__list">
  388. <li class="md-nav__item">
  389. <a href="#templatefrom" class="md-nav__link">
  390. TemplateFrom
  391. </a>
  392. </li>
  393. <li class="md-nav__item">
  394. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  395. Extract Keys and Certificates from PKCS#12 Archive
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="#extract-from-jwk" class="md-nav__link">
  400. Extract from JWK
  401. </a>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="#filter-pem-blocks" class="md-nav__link">
  405. Filter PEM blocks
  406. </a>
  407. </li>
  408. </ul>
  409. </nav>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="#helper-functions" class="md-nav__link">
  413. Helper functions
  414. </a>
  415. </li>
  416. <li class="md-nav__item">
  417. <a href="#migrating-from-v1" class="md-nav__link">
  418. Migrating from v1
  419. </a>
  420. <nav class="md-nav" aria-label="Migrating from v1">
  421. <ul class="md-nav__list">
  422. <li class="md-nav__item">
  423. <a href="#functions-removedreplaced" class="md-nav__link">
  424. Functions removed/replaced
  425. </a>
  426. </li>
  427. </ul>
  428. </nav>
  429. </li>
  430. </ul>
  431. </nav>
  432. </li>
  433. <li class="md-nav__item">
  434. <a href="../templating-v1/" class="md-nav__link">
  435. v1
  436. </a>
  437. </li>
  438. </ul>
  439. </nav>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../generator/" class="md-nav__link">
  443. Generators
  444. </a>
  445. </li>
  446. <li class="md-nav__item">
  447. <a href="../all-keys-one-secret/" class="md-nav__link">
  448. All keys, One secret
  449. </a>
  450. </li>
  451. <li class="md-nav__item">
  452. <a href="../common-k8s-secret-types/" class="md-nav__link">
  453. Common K8S Secret Types
  454. </a>
  455. </li>
  456. <li class="md-nav__item">
  457. <a href="../controller-class/" class="md-nav__link">
  458. Controller Classes
  459. </a>
  460. </li>
  461. <li class="md-nav__item">
  462. <a href="../ownership-deletion-policy/" class="md-nav__link">
  463. Lifecycle: ownership & deletion
  464. </a>
  465. </li>
  466. <li class="md-nav__item">
  467. <a href="../decoding-strategy/" class="md-nav__link">
  468. Decoding Strategies
  469. </a>
  470. </li>
  471. <li class="md-nav__item">
  472. <a href="../getallsecrets/" class="md-nav__link">
  473. Getting Multiple Secrets
  474. </a>
  475. </li>
  476. <li class="md-nav__item">
  477. <a href="../multi-tenancy/" class="md-nav__link">
  478. Multi Tenancy
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../datafrom-rewrite/" class="md-nav__link">
  483. Rewriting Keys
  484. </a>
  485. </li>
  486. <li class="md-nav__item">
  487. <a href="../v1beta1/" class="md-nav__link">
  488. Upgrading to v1beta1
  489. </a>
  490. </li>
  491. <li class="md-nav__item">
  492. <a href="../using-latest-image/" class="md-nav__link">
  493. Using Latest Image
  494. </a>
  495. </li>
  496. </ul>
  497. </nav>
  498. </li>
  499. <li class="md-nav__item md-nav__item--nested">
  500. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  501. <label class="md-nav__link" for="__nav_4">
  502. Provider
  503. <span class="md-nav__icon md-icon"></span>
  504. </label>
  505. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  506. <label class="md-nav__title" for="__nav_4">
  507. <span class="md-nav__icon md-icon"></span>
  508. Provider
  509. </label>
  510. <ul class="md-nav__list" data-md-scrollfix>
  511. <li class="md-nav__item">
  512. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  513. AWS Secrets Manager
  514. </a>
  515. </li>
  516. <li class="md-nav__item">
  517. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  518. AWS Parameter Store
  519. </a>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  523. Azure Key Vault
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  528. Google Secret Manager
  529. </a>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  533. IBM Secrets Manager
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../../provider/akeyless/" class="md-nav__link">
  538. Akeyless
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  543. HashiCorp Vault
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  548. Yandex Certificate Manager
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  553. Yandex Lockbox
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  558. Gitlab Variables
  559. </a>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../../provider/oracle-vault/" class="md-nav__link">
  563. Oracle Vault
  564. </a>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="../../provider/1password-automation/" class="md-nav__link">
  568. 1Password Secrets Automation
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../../provider/webhook/" class="md-nav__link">
  573. Webhook
  574. </a>
  575. </li>
  576. <li class="md-nav__item">
  577. <a href="../../provider/fake/" class="md-nav__link">
  578. Fake
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../../provider/kubernetes/" class="md-nav__link">
  583. Kubernetes
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  588. senhasegura DevOps Secrets Management (DSM)
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../../provider/doppler/" class="md-nav__link">
  593. Doppler
  594. </a>
  595. </li>
  596. </ul>
  597. </nav>
  598. </li>
  599. <li class="md-nav__item md-nav__item--nested">
  600. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  601. <label class="md-nav__link" for="__nav_5">
  602. Examples
  603. <span class="md-nav__icon md-icon"></span>
  604. </label>
  605. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  606. <label class="md-nav__title" for="__nav_5">
  607. <span class="md-nav__icon md-icon"></span>
  608. Examples
  609. </label>
  610. <ul class="md-nav__list" data-md-scrollfix>
  611. <li class="md-nav__item">
  612. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  613. FluxCD
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  618. Anchore Engine
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  623. Jenkins
  624. </a>
  625. </li>
  626. </ul>
  627. </nav>
  628. </li>
  629. <li class="md-nav__item md-nav__item--nested">
  630. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  631. <label class="md-nav__link" for="__nav_6">
  632. Community
  633. <span class="md-nav__icon md-icon"></span>
  634. </label>
  635. <nav class="md-nav" aria-label="Community" data-md-level="1">
  636. <label class="md-nav__title" for="__nav_6">
  637. <span class="md-nav__icon md-icon"></span>
  638. Community
  639. </label>
  640. <ul class="md-nav__list" data-md-scrollfix>
  641. <li class="md-nav__item md-nav__item--nested">
  642. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  643. <label class="md-nav__link" for="__nav_6_1">
  644. Contributing
  645. <span class="md-nav__icon md-icon"></span>
  646. </label>
  647. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  648. <label class="md-nav__title" for="__nav_6_1">
  649. <span class="md-nav__icon md-icon"></span>
  650. Contributing
  651. </label>
  652. <ul class="md-nav__list" data-md-scrollfix>
  653. <li class="md-nav__item">
  654. <a href="../../contributing/devguide/" class="md-nav__link">
  655. Developer guide
  656. </a>
  657. </li>
  658. <li class="md-nav__item">
  659. <a href="../../contributing/process/" class="md-nav__link">
  660. Contributing Process
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../../contributing/release/" class="md-nav__link">
  665. Release Process
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../contributing/coc/" class="md-nav__link">
  670. Code of Conduct
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="../../contributing/roadmap/" class="md-nav__link">
  675. Roadmap
  676. </a>
  677. </li>
  678. </ul>
  679. </nav>
  680. </li>
  681. <li class="md-nav__item md-nav__item--nested">
  682. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  683. <label class="md-nav__link" for="__nav_6_2">
  684. External Resources
  685. <span class="md-nav__icon md-icon"></span>
  686. </label>
  687. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  688. <label class="md-nav__title" for="__nav_6_2">
  689. <span class="md-nav__icon md-icon"></span>
  690. External Resources
  691. </label>
  692. <ul class="md-nav__list" data-md-scrollfix>
  693. <li class="md-nav__item">
  694. <a href="../../eso-talks/" class="md-nav__link">
  695. Talks
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../../eso-demos/" class="md-nav__link">
  700. Demos
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../eso-blogs/" class="md-nav__link">
  705. Blogs
  706. </a>
  707. </li>
  708. </ul>
  709. </nav>
  710. </li>
  711. </ul>
  712. </nav>
  713. </li>
  714. </ul>
  715. </nav>
  716. </div>
  717. </div>
  718. </div>
  719. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  720. <div class="md-sidebar__scrollwrap">
  721. <div class="md-sidebar__inner">
  722. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  723. <label class="md-nav__title" for="__toc">
  724. <span class="md-nav__icon md-icon"></span>
  725. Table of contents
  726. </label>
  727. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  728. <li class="md-nav__item">
  729. <a href="#examples" class="md-nav__link">
  730. Examples
  731. </a>
  732. <nav class="md-nav" aria-label="Examples">
  733. <ul class="md-nav__list">
  734. <li class="md-nav__item">
  735. <a href="#templatefrom" class="md-nav__link">
  736. TemplateFrom
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  741. Extract Keys and Certificates from PKCS#12 Archive
  742. </a>
  743. </li>
  744. <li class="md-nav__item">
  745. <a href="#extract-from-jwk" class="md-nav__link">
  746. Extract from JWK
  747. </a>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="#filter-pem-blocks" class="md-nav__link">
  751. Filter PEM blocks
  752. </a>
  753. </li>
  754. </ul>
  755. </nav>
  756. </li>
  757. <li class="md-nav__item">
  758. <a href="#helper-functions" class="md-nav__link">
  759. Helper functions
  760. </a>
  761. </li>
  762. <li class="md-nav__item">
  763. <a href="#migrating-from-v1" class="md-nav__link">
  764. Migrating from v1
  765. </a>
  766. <nav class="md-nav" aria-label="Migrating from v1">
  767. <ul class="md-nav__list">
  768. <li class="md-nav__item">
  769. <a href="#functions-removedreplaced" class="md-nav__link">
  770. Functions removed/replaced
  771. </a>
  772. </li>
  773. </ul>
  774. </nav>
  775. </li>
  776. </ul>
  777. </nav>
  778. </div>
  779. </div>
  780. </div>
  781. <div class="md-content" data-md-component="content">
  782. <article class="md-content__inner md-typeset">
  783. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/guides/templating.md" title="Edit this page" class="md-content__button md-icon">
  784. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  785. </a>
  786. <h1 id="advanced-templating-v2">Advanced Templating v2</h1>
  787. <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>
  788. <h2 id="examples">Examples</h2>
  789. <p>You can use templates to inject your secrets into a configuration file that you mount into your pod:</p>
  790. <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><span class="w"></span>
  791. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  792. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  793. <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><span class="w"></span>
  794. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  795. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  796. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  797. <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><span class="w"></span>
  798. <span class="w"> </span><span class="c1"># this is how the Kind=Secret will look like</span><span class="w"></span>
  799. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  800. <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><span class="w"></span>
  801. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  802. <span class="w"> </span><span class="c1"># multiline string</span><span class="w"></span>
  803. <span class="w"> </span><span class="nt">config</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span><span class="w"></span>
  804. <span class="w"> </span><span class="no">datasources:</span><span class="w"></span>
  805. <span class="w"> </span><span class="no">- name: Graphite</span><span class="w"></span>
  806. <span class="w"> </span><span class="no">type: graphite</span><span class="w"></span>
  807. <span class="w"> </span><span class="no">access: proxy</span><span class="w"></span>
  808. <span class="w"> </span><span class="no">url: http://localhost:8080</span><span class="w"></span>
  809. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span><span class="w"></span>
  810. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span><span class="w"></span>
  811. <span class="w"> </span><span class="c1"># using replace function to rewrite secret</span><span class="w"></span>
  812. <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><span class="w"></span>
  813. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  814. <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><span class="w"></span>
  815. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  816. <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><span class="w"></span>
  817. <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><span class="w"></span>
  818. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  819. <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><span class="w"></span>
  820. <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><span class="w"></span>
  821. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  822. <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><span class="w"></span>
  823. </code></pre></div>
  824. <p>Another example with two keys in the same secret:</p>
  825. <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><span class="w"></span>
  826. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  827. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  828. <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><span class="w"></span>
  829. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  830. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  831. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  832. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  833. <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><span class="w"></span>
  834. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  835. <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><span class="w"></span>
  836. <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><span class="w"></span>
  837. <span class="w"> </span><span class="c1"># password: &#39;{{ printf &quot;{{ .mysecret }}&quot; }}&#39; # If you are using templated tools like helm</span><span class="w"></span>
  838. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  839. <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><span class="w"></span>
  840. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  841. <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><span class="w"></span>
  842. </code></pre></div>
  843. <h3 id="templatefrom">TemplateFrom</h3>
  844. <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>
  845. <div class="highlight"><pre><span></span><code><span class="c1"># define your template in a config map</span><span class="w"></span>
  846. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span><span class="w"></span>
  847. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ConfigMap</span><span class="w"></span>
  848. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  849. <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><span class="w"></span>
  850. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  851. <span class="w"> </span><span class="nt">config.yaml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span><span class="w"></span>
  852. <span class="w"> </span><span class="no">datasources:</span><span class="w"></span>
  853. <span class="w"> </span><span class="no">- name: Graphite</span><span class="w"></span>
  854. <span class="w"> </span><span class="no">type: graphite</span><span class="w"></span>
  855. <span class="w"> </span><span class="no">access: proxy</span><span class="w"></span>
  856. <span class="w"> </span><span class="no">url: &quot;{{ .uri }}&quot;</span><span class="w"></span>
  857. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span><span class="w"></span>
  858. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span><span class="w"></span>
  859. <span class="w"> </span><span class="nt">templated</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span><span class="w"></span>
  860. <span class="w"> </span><span class="no"># key and value templated</span><span class="w"></span>
  861. <span class="w"> </span><span class="no">my-application-{{ .user}}: {{ .password | b64enc }}</span><span class="w"></span>
  862. <span class="w"> </span><span class="no"># conditional keys</span><span class="w"></span>
  863. <span class="w"> </span><span class="no">{{- if hasPrefix &quot;oci://&quot; .uri }}</span><span class="w"></span>
  864. <span class="w"> </span><span class="no">enableOCI: true</span><span class="w"></span>
  865. <span class="w"> </span><span class="no">{{- else }}</span><span class="w"></span>
  866. <span class="w"> </span><span class="no">enableOCI: false</span><span class="w"></span>
  867. <span class="w"> </span><span class="no">{{- end }}</span><span class="w"></span>
  868. <span class="w"> </span><span class="no"># Fixed values</span><span class="w"></span>
  869. <span class="w"> </span><span class="no">application-type: grafana</span><span class="w"></span>
  870. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span><span class="w"></span>
  871. <span class="w"> </span><span class="no">#dynamic timestamp generation</span><span class="w"></span>
  872. <span class="w"> </span><span class="no">last-synced-for-user/{{ .user }}: {{ now }}</span><span class="w"></span>
  873. <span class="nn">---</span><span class="w"></span>
  874. <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><span class="w"></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><span class="w"></span>
  876. <span class="nt">metadata</span><span class="p">:</span><span class="w"></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">my-template-example</span><span class="w"></span>
  878. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  879. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  880. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></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><span class="w"></span>
  882. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  883. <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><span class="w"></span>
  884. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span><span class="w"></span>
  885. <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><span class="w"></span>
  886. <span class="w"> </span><span class="nt">configMap</span><span class="p">:</span><span class="w"></span>
  887. <span class="w"> </span><span class="c1"># name of the configmap to pull in</span><span class="w"></span>
  888. <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><span class="w"></span>
  889. <span class="w"> </span><span class="c1"># here you define the keys that should be used as template</span><span class="w"></span>
  890. <span class="w"> </span><span class="nt">items</span><span class="p">:</span><span class="w"></span>
  891. <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><span class="w"></span>
  892. <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><span class="w"></span>
  893. <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><span class="w"></span>
  894. <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><span class="w"></span>
  895. <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><span class="w"></span>
  896. <span class="w"> </span><span class="nt">configMap</span><span class="p">:</span><span class="w"></span>
  897. <span class="w"> </span><span class="c1"># name of the configmap to pull in</span><span class="w"></span>
  898. <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><span class="w"></span>
  899. <span class="w"> </span><span class="c1"># here you define the keys that should be used as template</span><span class="w"></span>
  900. <span class="w"> </span><span class="nt">items</span><span class="p">:</span><span class="w"></span>
  901. <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><span class="w"></span>
  902. <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><span class="w"></span>
  903. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></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">user</span><span class="w"></span>
  905. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></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">/grafana/user</span><span class="w"></span>
  907. <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><span class="w"></span>
  908. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  909. <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><span class="w"></span>
  910. <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><span class="w"></span>
  911. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  912. <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><span class="w"></span>
  913. </code></pre></div>
  914. <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>
  915. <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><span class="w"></span>
  916. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  917. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  918. <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><span class="w"></span>
  919. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  920. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  921. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  922. <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><span class="w"></span>
  923. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  924. <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><span class="w"></span>
  925. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span><span class="w"></span>
  926. <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><span class="w"></span>
  927. <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><span class="w"></span>
  928. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  929. <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><span class="w"></span>
  930. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  931. <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><span class="w"></span>
  932. <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><span class="w"></span>
  933. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  934. <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><span class="w"></span>
  935. </code></pre></div>
  936. <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>
  937. <h3 id="extract-keys-and-certificates-from-pkcs12-archive">Extract Keys and Certificates from PKCS#12 Archive</h3>
  938. <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>
  939. <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><span class="w"></span>
  940. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  941. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  942. <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><span class="w"></span>
  943. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  944. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  945. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  946. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  947. <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><span class="w"></span>
  948. <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><span class="w"></span>
  949. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  950. <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><span class="w"></span>
  951. <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><span class="w"></span>
  952. <span class="w"> </span><span class="c1"># if needed unlock the pkcs12 with the password</span><span class="w"></span>
  953. <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><span class="w"></span>
  954. </code></pre></div>
  955. <h3 id="extract-from-jwk">Extract from JWK</h3>
  956. <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>
  957. <p>A JWK looks similar to this:</p>
  958. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  959. <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><span class="w"></span>
  960. <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><span class="w"></span>
  961. <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><span class="w"></span>
  962. <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><span class="w"></span>
  963. <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><span class="w"></span>
  964. <span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">...</span><span class="w"></span>
  965. <span class="p">}</span><span class="w"></span>
  966. </code></pre></div>
  967. <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>
  968. <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><span class="w"></span>
  969. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  970. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  971. <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><span class="w"></span>
  972. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  973. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  974. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  975. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  976. <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><span class="w"></span>
  977. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  978. <span class="w"> </span><span class="c1"># .myjwk is a json-encoded JWK string.</span><span class="w"></span>
  979. <span class="w"> </span><span class="c1">#</span><span class="w"></span>
  980. <span class="w"> </span><span class="c1"># this template will produce for jwk_pub a PEM encoded public key:</span><span class="w"></span>
  981. <span class="w"> </span><span class="c1"># -----BEGIN PUBLIC KEY-----</span><span class="w"></span>
  982. <span class="w"> </span><span class="c1"># MIIBI...</span><span class="w"></span>
  983. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  984. <span class="w"> </span><span class="c1"># ...AQAB</span><span class="w"></span>
  985. <span class="w"> </span><span class="c1"># -----END PUBLIC KEY-----</span><span class="w"></span>
  986. <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><span class="w"></span>
  987. <span class="w"> </span><span class="c1"># private key is a pem-encoded PKCS#8 private key</span><span class="w"></span>
  988. <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><span class="w"></span>
  989. </code></pre></div>
  990. <h3 id="filter-pem-blocks">Filter PEM blocks</h3>
  991. <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>
  992. <div class="highlight"><pre><span></span><code>-----BEGIN PRIVATE KEY-----
  993. MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCvxGZOW4IXvGlh
  994. . . .
  995. m8JCpbJXDfSSVxKHgK1Siw4K6pnTsIA2e/Z+Ha2fvtocERjq7VQMAJFaIZSTKo9Q
  996. JwwY+vj0yxWjyzHUzZB33tg=
  997. -----END PRIVATE KEY-----
  998. -----BEGIN CERTIFICATE-----
  999. MIIDMDCCAhigAwIBAgIQabPaXuZCQaCg+eQAVptGGDANBgkqhkiG9w0BAQsFADAV
  1000. . . .
  1001. NtFUGA95RGN9s+pl6XY0YARPHf5O76ErC1OZtDTR5RdyQfcM+94gYZsexsXl0aQO
  1002. 9YD3Wg==
  1003. -----END CERTIFICATE-----
  1004. </code></pre></div>
  1005. <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>
  1006. <h2 id="helper-functions">Helper functions</h2>
  1007. <div class="admonition info inline end">
  1008. <p class="admonition-title">Info</p>
  1009. <p>Note: we removed <code>env</code> and <code>expandenv</code> from sprig functions for security reasons.</p>
  1010. </div>
  1011. <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>
  1012. <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>
  1013. <p><br/></p>
  1014. <table>
  1015. <thead>
  1016. <tr>
  1017. <th>Function</th>
  1018. <th>Description</th>
  1019. </tr>
  1020. </thead>
  1021. <tbody>
  1022. <tr>
  1023. <td>pkcs12key</td>
  1024. <td>Extracts all private keys from a PKCS#12 archive and encodes them in <strong>PKCS#8 PEM</strong> format.</td>
  1025. </tr>
  1026. <tr>
  1027. <td>pkcs12keyPass</td>
  1028. <td>Same as <code>pkcs12key</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  1029. </tr>
  1030. <tr>
  1031. <td>pkcs12cert</td>
  1032. <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>
  1033. </tr>
  1034. <tr>
  1035. <td>pkcs12certPass</td>
  1036. <td>Same as <code>pkcs12cert</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  1037. </tr>
  1038. <tr>
  1039. <td>filterPEM</td>
  1040. <td>Filters PEM blocks with a specific type from a list of PEM blocks.</td>
  1041. </tr>
  1042. <tr>
  1043. <td>jwkPublicKeyPem</td>
  1044. <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>
  1045. </tr>
  1046. <tr>
  1047. <td>jwkPrivateKeyPem</td>
  1048. <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>
  1049. </tr>
  1050. <tr>
  1051. <td>toYaml</td>
  1052. <td>Takes an interface, marshals it to yaml. It returns a string, even on marshal error (empty string).</td>
  1053. </tr>
  1054. <tr>
  1055. <td>fromYaml</td>
  1056. <td>Function converts a YAML document into a map[string]interface{}.</td>
  1057. </tr>
  1058. </tbody>
  1059. </table>
  1060. <h2 id="migrating-from-v1">Migrating from v1</h2>
  1061. <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>
  1062. <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><span class="w"></span>
  1063. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  1064. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1065. <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><span class="w"></span>
  1066. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1067. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  1068. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  1069. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  1070. <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><span class="w"></span>
  1071. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  1072. </code></pre></div>
  1073. <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>
  1074. <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><span class="w"></span>
  1075. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  1076. <span class="c1"># ...</span><span class="w"></span>
  1077. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1078. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  1079. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  1080. <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><span class="w"></span>
  1081. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  1082. <span class="w"> </span><span class="c1"># this used to be {{ .foobar | toString }}</span><span class="w"></span>
  1083. <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><span class="w"></span>
  1084. </code></pre></div>
  1085. <h5 id="functions-removedreplaced">Functions removed/replaced</h5>
  1086. <ul>
  1087. <li><code>base64encode</code> was renamed to <code>b64enc</code>.</li>
  1088. <li><code>base64decode</code> was renamed to <code>b64dec</code>. Any errors that occurr during decoding are silenced.</li>
  1089. <li><code>fromJSON</code> was renamed to <code>fromJson</code>. Any errors that occurr during unmarshalling are silenced.</li>
  1090. <li><code>toJSON</code> was renamed to <code>toJson</code>. Any errors that occurr during marshalling are silenced.</li>
  1091. <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>
  1092. <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>
  1093. <li><code>toString</code> implementation was replaced by the <code>sprig</code> implementation and should be api-compatible.</li>
  1094. <li><code>toBytes</code> was removed.</li>
  1095. <li><code>pemPrivateKey</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  1096. <li><code>pemCertificate</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  1097. </ul>
  1098. </article>
  1099. </div>
  1100. </div>
  1101. </main>
  1102. <footer class="md-footer">
  1103. <nav class="md-footer__inner md-grid" aria-label="Footer">
  1104. <a href="../introduction/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Introduction" rel="prev">
  1105. <div class="md-footer__button md-icon">
  1106. <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>
  1107. </div>
  1108. <div class="md-footer__title">
  1109. <div class="md-ellipsis">
  1110. <span class="md-footer__direction">
  1111. Previous
  1112. </span>
  1113. Introduction
  1114. </div>
  1115. </div>
  1116. </a>
  1117. <a href="../templating-v1/" class="md-footer__link md-footer__link--next" aria-label="Next: v1" rel="next">
  1118. <div class="md-footer__title">
  1119. <div class="md-ellipsis">
  1120. <span class="md-footer__direction">
  1121. Next
  1122. </span>
  1123. v1
  1124. </div>
  1125. </div>
  1126. <div class="md-footer__button md-icon">
  1127. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  1128. </div>
  1129. </a>
  1130. </nav>
  1131. <div class="md-footer-meta md-typeset">
  1132. <div class="md-footer-meta__inner md-grid">
  1133. <div class="md-copyright">
  1134. <div class="md-copyright__highlight">
  1135. &copy; 2022 The external-secrets Authors.<br/>
  1136. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  1137. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1138. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1139. </div>
  1140. Made with
  1141. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1142. Material for MkDocs
  1143. </a>
  1144. </div>
  1145. </div>
  1146. </div>
  1147. </footer>
  1148. </div>
  1149. <div class="md-dialog" data-md-component="dialog">
  1150. <div class="md-dialog__inner md-typeset"></div>
  1151. </div>
  1152. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  1153. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1154. </body>
  1155. </html>