index.html 81 KB

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