index.html 61 KB

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