index.html 58 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697
  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. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. </ul>
  166. </nav>
  167. </li>
  168. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  169. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  170. <label class="md-nav__link" for="__nav_4">
  171. Guides
  172. <span class="md-nav__icon md-icon"></span>
  173. </label>
  174. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  175. <label class="md-nav__title" for="__nav_4">
  176. <span class="md-nav__icon md-icon"></span>
  177. Guides
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../guides-introduction/" class="md-nav__link">
  182. Introduction
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  191. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" checked>
  192. <label class="md-nav__link" for="__nav_4_3">
  193. Advanced Templating
  194. <span class="md-nav__icon md-icon"></span>
  195. </label>
  196. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  197. <label class="md-nav__title" for="__nav_4_3">
  198. <span class="md-nav__icon md-icon"></span>
  199. Advanced Templating
  200. </label>
  201. <ul class="md-nav__list" data-md-scrollfix>
  202. <li class="md-nav__item md-nav__item--active">
  203. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  204. <label class="md-nav__link md-nav__link--active" for="__toc">
  205. v2
  206. <span class="md-nav__icon md-icon"></span>
  207. </label>
  208. <a href="./" class="md-nav__link md-nav__link--active">
  209. v2
  210. </a>
  211. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  212. <label class="md-nav__title" for="__toc">
  213. <span class="md-nav__icon md-icon"></span>
  214. Table of contents
  215. </label>
  216. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  217. <li class="md-nav__item">
  218. <a href="#examples" class="md-nav__link">
  219. Examples
  220. </a>
  221. <nav class="md-nav" aria-label="Examples">
  222. <ul class="md-nav__list">
  223. <li class="md-nav__item">
  224. <a href="#templatefrom" class="md-nav__link">
  225. TemplateFrom
  226. </a>
  227. </li>
  228. <li class="md-nav__item">
  229. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  230. Extract Keys and Certificates from PKCS#12 Archive
  231. </a>
  232. </li>
  233. <li class="md-nav__item">
  234. <a href="#extract-from-jwk" class="md-nav__link">
  235. Extract from JWK
  236. </a>
  237. </li>
  238. <li class="md-nav__item">
  239. <a href="#filter-pem-blocks" class="md-nav__link">
  240. Filter PEM blocks
  241. </a>
  242. </li>
  243. </ul>
  244. </nav>
  245. </li>
  246. <li class="md-nav__item">
  247. <a href="#helper-functions" class="md-nav__link">
  248. Helper functions
  249. </a>
  250. </li>
  251. <li class="md-nav__item">
  252. <a href="#migrating-from-v1" class="md-nav__link">
  253. Migrating from v1
  254. </a>
  255. <nav class="md-nav" aria-label="Migrating from v1">
  256. <ul class="md-nav__list">
  257. <li class="md-nav__item">
  258. <a href="#functions-removedreplaced" class="md-nav__link">
  259. Functions removed/replaced
  260. </a>
  261. </li>
  262. </ul>
  263. </nav>
  264. </li>
  265. </ul>
  266. </nav>
  267. </li>
  268. <li class="md-nav__item">
  269. <a href="../guides-templating-v1/" class="md-nav__link">
  270. v1
  271. </a>
  272. </li>
  273. </ul>
  274. </nav>
  275. </li>
  276. <li class="md-nav__item">
  277. <a href="../guides-controller-class/" class="md-nav__link">
  278. Controller Classes
  279. </a>
  280. </li>
  281. <li class="md-nav__item">
  282. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  283. All keys, One secret
  284. </a>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  288. Common K8S Secret Types
  289. </a>
  290. </li>
  291. <li class="md-nav__item">
  292. <a href="../guides-multi-tenancy/" class="md-nav__link">
  293. Multi Tenancy
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../guides-metrics/" class="md-nav__link">
  298. Metrics
  299. </a>
  300. </li>
  301. <li class="md-nav__item">
  302. <a href="../guides-using-latest-image/" class="md-nav__link">
  303. Using Latest Image
  304. </a>
  305. </li>
  306. </ul>
  307. </nav>
  308. </li>
  309. <li class="md-nav__item md-nav__item--nested">
  310. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  311. <label class="md-nav__link" for="__nav_5">
  312. Provider
  313. <span class="md-nav__icon md-icon"></span>
  314. </label>
  315. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  316. <label class="md-nav__title" for="__nav_5">
  317. <span class="md-nav__icon md-icon"></span>
  318. Provider
  319. </label>
  320. <ul class="md-nav__list" data-md-scrollfix>
  321. <li class="md-nav__item md-nav__item--nested">
  322. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  323. <label class="md-nav__link" for="__nav_5_1">
  324. AWS
  325. <span class="md-nav__icon md-icon"></span>
  326. </label>
  327. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  328. <label class="md-nav__title" for="__nav_5_1">
  329. <span class="md-nav__icon md-icon"></span>
  330. AWS
  331. </label>
  332. <ul class="md-nav__list" data-md-scrollfix>
  333. <li class="md-nav__item">
  334. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  335. Secrets Manager
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  340. Parameter Store
  341. </a>
  342. </li>
  343. </ul>
  344. </nav>
  345. </li>
  346. <li class="md-nav__item md-nav__item--nested">
  347. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  348. <label class="md-nav__link" for="__nav_5_2">
  349. Azure
  350. <span class="md-nav__icon md-icon"></span>
  351. </label>
  352. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  353. <label class="md-nav__title" for="__nav_5_2">
  354. <span class="md-nav__icon md-icon"></span>
  355. Azure
  356. </label>
  357. <ul class="md-nav__list" data-md-scrollfix>
  358. <li class="md-nav__item">
  359. <a href="../provider-azure-key-vault/" class="md-nav__link">
  360. Key Vault
  361. </a>
  362. </li>
  363. </ul>
  364. </nav>
  365. </li>
  366. <li class="md-nav__item md-nav__item--nested">
  367. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  368. <label class="md-nav__link" for="__nav_5_3">
  369. Google
  370. <span class="md-nav__icon md-icon"></span>
  371. </label>
  372. <nav class="md-nav" aria-label="Google" data-md-level="2">
  373. <label class="md-nav__title" for="__nav_5_3">
  374. <span class="md-nav__icon md-icon"></span>
  375. Google
  376. </label>
  377. <ul class="md-nav__list" data-md-scrollfix>
  378. <li class="md-nav__item">
  379. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  380. Secret Manager
  381. </a>
  382. </li>
  383. </ul>
  384. </nav>
  385. </li>
  386. <li class="md-nav__item md-nav__item--nested">
  387. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  388. <label class="md-nav__link" for="__nav_5_4">
  389. IBM
  390. <span class="md-nav__icon md-icon"></span>
  391. </label>
  392. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  393. <label class="md-nav__title" for="__nav_5_4">
  394. <span class="md-nav__icon md-icon"></span>
  395. IBM
  396. </label>
  397. <ul class="md-nav__list" data-md-scrollfix>
  398. <li class="md-nav__item">
  399. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  400. Secrets Manager
  401. </a>
  402. </li>
  403. </ul>
  404. </nav>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="../provider-akeyless/" class="md-nav__link">
  408. Akeyless
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  413. HashiCorp Vault
  414. </a>
  415. </li>
  416. <li class="md-nav__item md-nav__item--nested">
  417. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  418. <label class="md-nav__link" for="__nav_5_7">
  419. Yandex
  420. <span class="md-nav__icon md-icon"></span>
  421. </label>
  422. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  423. <label class="md-nav__title" for="__nav_5_7">
  424. <span class="md-nav__icon md-icon"></span>
  425. Yandex
  426. </label>
  427. <ul class="md-nav__list" data-md-scrollfix>
  428. <li class="md-nav__item">
  429. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  430. Lockbox
  431. </a>
  432. </li>
  433. </ul>
  434. </nav>
  435. </li>
  436. <li class="md-nav__item md-nav__item--nested">
  437. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  438. <label class="md-nav__link" for="__nav_5_8">
  439. Gitlab
  440. <span class="md-nav__icon md-icon"></span>
  441. </label>
  442. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  443. <label class="md-nav__title" for="__nav_5_8">
  444. <span class="md-nav__icon md-icon"></span>
  445. Gitlab
  446. </label>
  447. <ul class="md-nav__list" data-md-scrollfix>
  448. <li class="md-nav__item">
  449. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  450. Gitlab Project Variables
  451. </a>
  452. </li>
  453. </ul>
  454. </nav>
  455. </li>
  456. <li class="md-nav__item md-nav__item--nested">
  457. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  458. <label class="md-nav__link" for="__nav_5_9">
  459. Oracle
  460. <span class="md-nav__icon md-icon"></span>
  461. </label>
  462. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  463. <label class="md-nav__title" for="__nav_5_9">
  464. <span class="md-nav__icon md-icon"></span>
  465. Oracle
  466. </label>
  467. <ul class="md-nav__list" data-md-scrollfix>
  468. <li class="md-nav__item">
  469. <a href="../provider-oracle-vault/" class="md-nav__link">
  470. Oracle Vault
  471. </a>
  472. </li>
  473. </ul>
  474. </nav>
  475. </li>
  476. <li class="md-nav__item">
  477. <a href="../provider-webhook/" class="md-nav__link">
  478. Webhook
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../provider-fake/" class="md-nav__link">
  483. Fake
  484. </a>
  485. </li>
  486. </ul>
  487. </nav>
  488. </li>
  489. <li class="md-nav__item md-nav__item--nested">
  490. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  491. <label class="md-nav__link" for="__nav_6">
  492. Examples
  493. <span class="md-nav__icon md-icon"></span>
  494. </label>
  495. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  496. <label class="md-nav__title" for="__nav_6">
  497. <span class="md-nav__icon md-icon"></span>
  498. Examples
  499. </label>
  500. <ul class="md-nav__list" data-md-scrollfix>
  501. <li class="md-nav__item">
  502. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  503. FluxCD
  504. </a>
  505. </li>
  506. <li class="md-nav__item">
  507. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  508. Anchore Engine
  509. </a>
  510. </li>
  511. <li class="md-nav__item">
  512. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  513. Jenkins
  514. </a>
  515. </li>
  516. </ul>
  517. </nav>
  518. </li>
  519. <li class="md-nav__item md-nav__item--nested">
  520. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  521. <label class="md-nav__link" for="__nav_7">
  522. References
  523. <span class="md-nav__icon md-icon"></span>
  524. </label>
  525. <nav class="md-nav" aria-label="References" data-md-level="1">
  526. <label class="md-nav__title" for="__nav_7">
  527. <span class="md-nav__icon md-icon"></span>
  528. References
  529. </label>
  530. <ul class="md-nav__list" data-md-scrollfix>
  531. <li class="md-nav__item">
  532. <a href="../spec/" class="md-nav__link">
  533. API specification
  534. </a>
  535. </li>
  536. </ul>
  537. </nav>
  538. </li>
  539. <li class="md-nav__item md-nav__item--nested">
  540. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  541. <label class="md-nav__link" for="__nav_8">
  542. Contributing
  543. <span class="md-nav__icon md-icon"></span>
  544. </label>
  545. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  546. <label class="md-nav__title" for="__nav_8">
  547. <span class="md-nav__icon md-icon"></span>
  548. Contributing
  549. </label>
  550. <ul class="md-nav__list" data-md-scrollfix>
  551. <li class="md-nav__item">
  552. <a href="../contributing-devguide/" class="md-nav__link">
  553. Developer guide
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../contributing-process/" class="md-nav__link">
  558. Contributing Process
  559. </a>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../contributing-coc/" class="md-nav__link">
  563. Code of Conduct
  564. </a>
  565. </li>
  566. </ul>
  567. </nav>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="../deprecation-policy/" class="md-nav__link">
  571. Deprecation Policy
  572. </a>
  573. </li>
  574. </ul>
  575. </nav>
  576. </div>
  577. </div>
  578. </div>
  579. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  580. <div class="md-sidebar__scrollwrap">
  581. <div class="md-sidebar__inner">
  582. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  583. <label class="md-nav__title" for="__toc">
  584. <span class="md-nav__icon md-icon"></span>
  585. Table of contents
  586. </label>
  587. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  588. <li class="md-nav__item">
  589. <a href="#examples" class="md-nav__link">
  590. Examples
  591. </a>
  592. <nav class="md-nav" aria-label="Examples">
  593. <ul class="md-nav__list">
  594. <li class="md-nav__item">
  595. <a href="#templatefrom" class="md-nav__link">
  596. TemplateFrom
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  601. Extract Keys and Certificates from PKCS#12 Archive
  602. </a>
  603. </li>
  604. <li class="md-nav__item">
  605. <a href="#extract-from-jwk" class="md-nav__link">
  606. Extract from JWK
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="#filter-pem-blocks" class="md-nav__link">
  611. Filter PEM blocks
  612. </a>
  613. </li>
  614. </ul>
  615. </nav>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="#helper-functions" class="md-nav__link">
  619. Helper functions
  620. </a>
  621. </li>
  622. <li class="md-nav__item">
  623. <a href="#migrating-from-v1" class="md-nav__link">
  624. Migrating from v1
  625. </a>
  626. <nav class="md-nav" aria-label="Migrating from v1">
  627. <ul class="md-nav__list">
  628. <li class="md-nav__item">
  629. <a href="#functions-removedreplaced" class="md-nav__link">
  630. Functions removed/replaced
  631. </a>
  632. </li>
  633. </ul>
  634. </nav>
  635. </li>
  636. </ul>
  637. </nav>
  638. </div>
  639. </div>
  640. </div>
  641. <div class="md-content" data-md-component="content">
  642. <article class="md-content__inner md-typeset">
  643. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/guides-templating.md" title="Edit this page" class="md-content__button md-icon">
  644. <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>
  645. </a>
  646. <h1 id="advanced-templating-v2">Advanced Templating v2</h1>
  647. <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>
  648. <h2 id="examples">Examples</h2>
  649. <p>You can use templates to inject your secrets into a configuration file that you mount into your pod:</p>
  650. <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>
  651. <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>
  652. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  653. <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>
  654. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  655. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  656. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  657. <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>
  658. <span class="w"> </span><span class="c1"># this is how the Kind=Secret will look like</span><span class="w"></span>
  659. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  660. <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>
  661. <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>
  662. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  663. <span class="w"> </span><span class="c1"># multiline string</span><span class="w"></span>
  664. <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>
  665. <span class="w"> </span><span class="no">datasources:</span><span class="w"></span>
  666. <span class="w"> </span><span class="no">- name: Graphite</span><span class="w"></span>
  667. <span class="w"> </span><span class="no">type: graphite</span><span class="w"></span>
  668. <span class="w"> </span><span class="no">access: proxy</span><span class="w"></span>
  669. <span class="w"> </span><span class="no">url: http://localhost:8080</span><span class="w"></span>
  670. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span><span class="w"></span>
  671. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span><span class="w"></span>
  672. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  673. <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>
  674. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  675. <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>
  676. <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>
  677. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  678. <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>
  679. </code></pre></div>
  680. <h3 id="templatefrom">TemplateFrom</h3>
  681. <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>
  682. <div class="highlight"><pre><span></span><code><span class="c1"># define your template in a config map</span><span class="w"></span>
  683. <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>
  684. <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>
  685. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  686. <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>
  687. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  688. <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>
  689. <span class="w"> </span><span class="no">datasources:</span><span class="w"></span>
  690. <span class="w"> </span><span class="no">- name: Graphite</span><span class="w"></span>
  691. <span class="w"> </span><span class="no">type: graphite</span><span class="w"></span>
  692. <span class="w"> </span><span class="no">access: proxy</span><span class="w"></span>
  693. <span class="w"> </span><span class="no">url: http://localhost:8080</span><span class="w"></span>
  694. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span><span class="w"></span>
  695. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span><span class="w"></span>
  696. <span class="nn">---</span><span class="w"></span>
  697. <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>
  698. <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>
  699. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  700. <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>
  701. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  702. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  703. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  704. <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>
  705. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  706. <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>
  707. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span><span class="w"></span>
  708. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span><span class="w"></span>
  709. <span class="w"> </span><span class="c1"># name of the configmap to pull in</span><span class="w"></span>
  710. <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>
  711. <span class="w"> </span><span class="c1"># here you define the keys that should be used as template</span><span class="w"></span>
  712. <span class="w"> </span><span class="nt">items</span><span class="p">:</span><span class="w"></span>
  713. <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>
  714. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  715. <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>
  716. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  717. <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>
  718. <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>
  719. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  720. <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>
  721. </code></pre></div>
  722. <h3 id="extract-keys-and-certificates-from-pkcs12-archive">Extract Keys and Certificates from PKCS#12 Archive</h3>
  723. <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>
  724. <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>
  725. <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>
  726. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  727. <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>
  728. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  729. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  730. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  731. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  732. <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>
  733. <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>
  734. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  735. <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>
  736. <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>
  737. <span class="w"> </span><span class="c1"># if needed unlock the pkcs12 with the password</span><span class="w"></span>
  738. <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>
  739. </code></pre></div>
  740. <h3 id="extract-from-jwk">Extract from JWK</h3>
  741. <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>
  742. <p>A JWK looks similar to this:</p>
  743. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  744. <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>
  745. <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>
  746. <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>
  747. <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>
  748. <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>
  749. <span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">...</span><span class="w"></span>
  750. <span class="p">}</span><span class="w"></span>
  751. </code></pre></div>
  752. <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>
  753. <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>
  754. <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>
  755. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  756. <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>
  757. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  758. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  759. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  760. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  761. <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>
  762. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  763. <span class="w"> </span><span class="c1"># .myjwk is a json-encoded JWK string.</span><span class="w"></span>
  764. <span class="w"> </span><span class="c1">#</span><span class="w"></span>
  765. <span class="w"> </span><span class="c1"># this template will produce for jwk_pub a PEM encoded public key:</span><span class="w"></span>
  766. <span class="w"> </span><span class="c1"># -----BEGIN PUBLIC KEY-----</span><span class="w"></span>
  767. <span class="w"> </span><span class="c1"># MIIBI...</span><span class="w"></span>
  768. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  769. <span class="w"> </span><span class="c1"># ...AQAB</span><span class="w"></span>
  770. <span class="w"> </span><span class="c1"># -----END PUBLIC KEY-----</span><span class="w"></span>
  771. <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>
  772. <span class="w"> </span><span class="c1"># private key is a pem-encoded PKCS#8 private key</span><span class="w"></span>
  773. <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>
  774. </code></pre></div>
  775. <h3 id="filter-pem-blocks">Filter PEM blocks</h3>
  776. <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>
  777. <div class="highlight"><pre><span></span><code>-----BEGIN PRIVATE KEY-----
  778. MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCvxGZOW4IXvGlh
  779. . . .
  780. m8JCpbJXDfSSVxKHgK1Siw4K6pnTsIA2e/Z+Ha2fvtocERjq7VQMAJFaIZSTKo9Q
  781. JwwY+vj0yxWjyzHUzZB33tg=
  782. -----END PRIVATE KEY-----
  783. -----BEGIN CERTIFICATE-----
  784. MIIDMDCCAhigAwIBAgIQabPaXuZCQaCg+eQAVptGGDANBgkqhkiG9w0BAQsFADAV
  785. . . .
  786. NtFUGA95RGN9s+pl6XY0YARPHf5O76ErC1OZtDTR5RdyQfcM+94gYZsexsXl0aQO
  787. 9YD3Wg==
  788. -----END CERTIFICATE-----
  789. </code></pre></div>
  790. <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>
  791. <h2 id="helper-functions">Helper functions</h2>
  792. <div class="admonition info inline end">
  793. <p class="admonition-title">Info</p>
  794. <p>Note: we removed <code>env</code> and <code>expandenv</code> from sprig functions for security reasons.</p>
  795. </div>
  796. <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>
  797. <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>
  798. <p><br/></p>
  799. <table>
  800. <thead>
  801. <tr>
  802. <th>Function</th>
  803. <th>Description</th>
  804. </tr>
  805. </thead>
  806. <tbody>
  807. <tr>
  808. <td>pkcs12key</td>
  809. <td>Extracts all private keys from a PKCS#12 archive and encodes them in <strong>PKCS#8 PEM</strong> format.</td>
  810. </tr>
  811. <tr>
  812. <td>pkcs12keyPass</td>
  813. <td>Same as <code>pkcs12key</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  814. </tr>
  815. <tr>
  816. <td>pkcs12cert</td>
  817. <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>
  818. </tr>
  819. <tr>
  820. <td>pkcs12certPass</td>
  821. <td>Same as <code>pkcs12cert</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  822. </tr>
  823. <tr>
  824. <td>filterPEM</td>
  825. <td>Filters PEM blocks with a specific type from a list of PEM blocks.</td>
  826. </tr>
  827. </tbody>
  828. </table>
  829. <p>| jwkPublicKeyPem | 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. |
  830. | jwkPrivateKeyPem | 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. |</p>
  831. <h2 id="migrating-from-v1">Migrating from v1</h2>
  832. <p>You have to opt-in to use the new engine version by specifying <code>template.engineVersion=v2</code>:</p>
  833. <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>
  834. <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>
  835. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  836. <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>
  837. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  838. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  839. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  840. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  841. <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>
  842. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  843. </code></pre></div>
  844. <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>
  845. <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>
  846. <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>
  847. <span class="c1"># ...</span><span class="w"></span>
  848. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  849. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  850. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  851. <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>
  852. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  853. <span class="w"> </span><span class="c1"># this used to be {{ .foobar | toString }}</span><span class="w"></span>
  854. <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>
  855. </code></pre></div>
  856. <h5 id="functions-removedreplaced">Functions removed/replaced</h5>
  857. <ul>
  858. <li><code>base64encode</code> was renamed to <code>b64enc</code>.</li>
  859. <li><code>base64decode</code> was renamed to <code>b64dec</code>. Any errors that occurr during decoding are silenced.</li>
  860. <li><code>fromJSON</code> was renamed to <code>fromJson</code>. Any errors that occurr during unmarshalling are silenced.</li>
  861. <li><code>toJSON</code> was renamed to <code>toJson</code>. Any errors that occurr during marshalling are silenced.</li>
  862. <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>
  863. <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>
  864. <li><code>toString</code> implementation was replaced by the <code>sprig</code> implementation and should be api-compatible.</li>
  865. <li><code>toBytes</code> was removed.</li>
  866. <li><code>pemPrivateKey</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  867. <li><code>pemCertificate</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  868. </ul>
  869. </article>
  870. </div>
  871. </div>
  872. </main>
  873. <footer class="md-footer">
  874. <nav class="md-footer__inner md-grid" aria-label="Footer">
  875. <a href="../guides-getting-started/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Getting started" rel="prev">
  876. <div class="md-footer__button md-icon">
  877. <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>
  878. </div>
  879. <div class="md-footer__title">
  880. <div class="md-ellipsis">
  881. <span class="md-footer__direction">
  882. Previous
  883. </span>
  884. Getting started
  885. </div>
  886. </div>
  887. </a>
  888. <a href="../guides-templating-v1/" class="md-footer__link md-footer__link--next" aria-label="Next: v1" rel="next">
  889. <div class="md-footer__title">
  890. <div class="md-ellipsis">
  891. <span class="md-footer__direction">
  892. Next
  893. </span>
  894. v1
  895. </div>
  896. </div>
  897. <div class="md-footer__button md-icon">
  898. <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>
  899. </div>
  900. </a>
  901. </nav>
  902. <div class="md-footer-meta md-typeset">
  903. <div class="md-footer-meta__inner md-grid">
  904. <div class="md-copyright">
  905. Made with
  906. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  907. Material for MkDocs
  908. </a>
  909. </div>
  910. </div>
  911. </div>
  912. </footer>
  913. </div>
  914. <div class="md-dialog" data-md-component="dialog">
  915. <div class="md-dialog__inner md-typeset"></div>
  916. </div>
  917. <script id="__config" type="application/json">{"base": "..", "features": [], "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>
  918. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  919. </body>
  920. </html>