index.html 59 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264
  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>Rewriting Keys - 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="#rewriting-keys-in-datafrom" 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. Rewriting Keys
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../introduction/" class="md-tabs__link md-tabs__link--active">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/vault/" class="md-nav__link">
  294. Vault Dynamic Secret
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/password/" class="md-nav__link">
  299. Password
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../../api/generator/fake/" class="md-nav__link">
  304. Fake
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  312. <label class="md-nav__link" for="__nav_2_4">
  313. Reference Docs
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_2_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. Reference Docs
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../../api/spec/" class="md-nav__link">
  324. API specification
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/controller-options/" class="md-nav__link">
  329. Controller Options
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/metrics/" class="md-nav__link">
  334. Metrics
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
  345. <label class="md-nav__link" for="__nav_3">
  346. Guides
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  350. <label class="md-nav__title" for="__nav_3">
  351. <span class="md-nav__icon md-icon"></span>
  352. Guides
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../introduction/" class="md-nav__link">
  357. Introduction
  358. </a>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  362. <label class="md-nav__link" for="__nav_3_2">
  363. Advanced Templating
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_3_2">
  368. <span class="md-nav__icon md-icon"></span>
  369. Advanced Templating
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../templating/" class="md-nav__link">
  374. v2
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../templating-v1/" class="md-nav__link">
  379. v1
  380. </a>
  381. </li>
  382. </ul>
  383. </nav>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../generator/" class="md-nav__link">
  387. Generators
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../all-keys-one-secret/" class="md-nav__link">
  392. All keys, One secret
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../common-k8s-secret-types/" class="md-nav__link">
  397. Common K8S Secret Types
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../controller-class/" class="md-nav__link">
  402. Controller Classes
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../ownership-deletion-policy/" class="md-nav__link">
  407. Lifecycle: ownership & deletion
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../decoding-strategy/" class="md-nav__link">
  412. Decoding Strategies
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../getallsecrets/" class="md-nav__link">
  417. Getting Multiple Secrets
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../multi-tenancy/" class="md-nav__link">
  422. Multi Tenancy
  423. </a>
  424. </li>
  425. <li class="md-nav__item md-nav__item--active">
  426. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  427. <label class="md-nav__link md-nav__link--active" for="__toc">
  428. Rewriting Keys
  429. <span class="md-nav__icon md-icon"></span>
  430. </label>
  431. <a href="./" class="md-nav__link md-nav__link--active">
  432. Rewriting Keys
  433. </a>
  434. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  435. <label class="md-nav__title" for="__toc">
  436. <span class="md-nav__icon md-icon"></span>
  437. Table of contents
  438. </label>
  439. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  440. <li class="md-nav__item">
  441. <a href="#methods" class="md-nav__link">
  442. Methods
  443. </a>
  444. <nav class="md-nav" aria-label="Methods">
  445. <ul class="md-nav__list">
  446. <li class="md-nav__item">
  447. <a href="#regexp" class="md-nav__link">
  448. Regexp
  449. </a>
  450. </li>
  451. </ul>
  452. </nav>
  453. </li>
  454. <li class="md-nav__item">
  455. <a href="#examples" class="md-nav__link">
  456. Examples
  457. </a>
  458. <nav class="md-nav" aria-label="Examples">
  459. <ul class="md-nav__list">
  460. <li class="md-nav__item">
  461. <a href="#removing-a-common-path-from-find-operations" class="md-nav__link">
  462. Removing a common path from find operations
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="#avoiding-key-collisions" class="md-nav__link">
  467. Avoiding key collisions
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="#remove-invalid-characters" class="md-nav__link">
  472. Remove invalid characters
  473. </a>
  474. </li>
  475. </ul>
  476. </nav>
  477. </li>
  478. <li class="md-nav__item">
  479. <a href="#limitations" class="md-nav__link">
  480. Limitations
  481. </a>
  482. </li>
  483. </ul>
  484. </nav>
  485. </li>
  486. <li class="md-nav__item">
  487. <a href="../v1beta1/" class="md-nav__link">
  488. Upgrading to v1beta1
  489. </a>
  490. </li>
  491. <li class="md-nav__item">
  492. <a href="../using-latest-image/" class="md-nav__link">
  493. Using Latest Image
  494. </a>
  495. </li>
  496. <li class="md-nav__item">
  497. <a href="../disable-cluster-features/" class="md-nav__link">
  498. Disable Cluster Features
  499. </a>
  500. </li>
  501. </ul>
  502. </nav>
  503. </li>
  504. <li class="md-nav__item md-nav__item--nested">
  505. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  506. <label class="md-nav__link" for="__nav_4">
  507. Provider
  508. <span class="md-nav__icon md-icon"></span>
  509. </label>
  510. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  511. <label class="md-nav__title" for="__nav_4">
  512. <span class="md-nav__icon md-icon"></span>
  513. Provider
  514. </label>
  515. <ul class="md-nav__list" data-md-scrollfix>
  516. <li class="md-nav__item">
  517. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  518. AWS Secrets Manager
  519. </a>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  523. AWS Parameter Store
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  528. Azure Key Vault
  529. </a>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  533. Google Secret Manager
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  538. IBM Secrets Manager
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="../../provider/akeyless/" class="md-nav__link">
  543. Akeyless
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  548. HashiCorp Vault
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  553. Yandex Certificate Manager
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  558. Yandex Lockbox
  559. </a>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  563. Gitlab Variables
  564. </a>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="../../provider/oracle-vault/" class="md-nav__link">
  568. Oracle Vault
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../../provider/1password-automation/" class="md-nav__link">
  573. 1Password Secrets Automation
  574. </a>
  575. </li>
  576. <li class="md-nav__item">
  577. <a href="../../provider/webhook/" class="md-nav__link">
  578. Webhook
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../../provider/fake/" class="md-nav__link">
  583. Fake
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../../provider/kubernetes/" class="md-nav__link">
  588. Kubernetes
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  593. senhasegura DevOps Secrets Management (DSM)
  594. </a>
  595. </li>
  596. <li class="md-nav__item">
  597. <a href="../../provider/doppler/" class="md-nav__link">
  598. Doppler
  599. </a>
  600. </li>
  601. <li class="md-nav__item">
  602. <a href="../../provider/keeper-security/" class="md-nav__link">
  603. Keeper Security
  604. </a>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="../../provider/scaleway/" class="md-nav__link">
  608. Scaleway
  609. </a>
  610. </li>
  611. </ul>
  612. </nav>
  613. </li>
  614. <li class="md-nav__item md-nav__item--nested">
  615. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  616. <label class="md-nav__link" for="__nav_5">
  617. Examples
  618. <span class="md-nav__icon md-icon"></span>
  619. </label>
  620. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  621. <label class="md-nav__title" for="__nav_5">
  622. <span class="md-nav__icon md-icon"></span>
  623. Examples
  624. </label>
  625. <ul class="md-nav__list" data-md-scrollfix>
  626. <li class="md-nav__item">
  627. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  628. FluxCD
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  633. Anchore Engine
  634. </a>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  638. Jenkins
  639. </a>
  640. </li>
  641. </ul>
  642. </nav>
  643. </li>
  644. <li class="md-nav__item md-nav__item--nested">
  645. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  646. <label class="md-nav__link" for="__nav_6">
  647. Community
  648. <span class="md-nav__icon md-icon"></span>
  649. </label>
  650. <nav class="md-nav" aria-label="Community" data-md-level="1">
  651. <label class="md-nav__title" for="__nav_6">
  652. <span class="md-nav__icon md-icon"></span>
  653. Community
  654. </label>
  655. <ul class="md-nav__list" data-md-scrollfix>
  656. <li class="md-nav__item md-nav__item--nested">
  657. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  658. <label class="md-nav__link" for="__nav_6_1">
  659. Contributing
  660. <span class="md-nav__icon md-icon"></span>
  661. </label>
  662. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  663. <label class="md-nav__title" for="__nav_6_1">
  664. <span class="md-nav__icon md-icon"></span>
  665. Contributing
  666. </label>
  667. <ul class="md-nav__list" data-md-scrollfix>
  668. <li class="md-nav__item">
  669. <a href="../../contributing/devguide/" class="md-nav__link">
  670. Developer guide
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="../../contributing/process/" class="md-nav__link">
  675. Contributing Process
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../../contributing/release/" class="md-nav__link">
  680. Release Process
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="../../contributing/coc/" class="md-nav__link">
  685. Code of Conduct
  686. </a>
  687. </li>
  688. <li class="md-nav__item">
  689. <a href="../../contributing/roadmap/" class="md-nav__link">
  690. Roadmap
  691. </a>
  692. </li>
  693. </ul>
  694. </nav>
  695. </li>
  696. <li class="md-nav__item md-nav__item--nested">
  697. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  698. <label class="md-nav__link" for="__nav_6_2">
  699. External Resources
  700. <span class="md-nav__icon md-icon"></span>
  701. </label>
  702. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  703. <label class="md-nav__title" for="__nav_6_2">
  704. <span class="md-nav__icon md-icon"></span>
  705. External Resources
  706. </label>
  707. <ul class="md-nav__list" data-md-scrollfix>
  708. <li class="md-nav__item">
  709. <a href="../../eso-talks/" class="md-nav__link">
  710. Talks
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="../../eso-demos/" class="md-nav__link">
  715. Demos
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../eso-blogs/" class="md-nav__link">
  720. Blogs
  721. </a>
  722. </li>
  723. </ul>
  724. </nav>
  725. </li>
  726. </ul>
  727. </nav>
  728. </li>
  729. </ul>
  730. </nav>
  731. </div>
  732. </div>
  733. </div>
  734. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  735. <div class="md-sidebar__scrollwrap">
  736. <div class="md-sidebar__inner">
  737. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  738. <label class="md-nav__title" for="__toc">
  739. <span class="md-nav__icon md-icon"></span>
  740. Table of contents
  741. </label>
  742. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  743. <li class="md-nav__item">
  744. <a href="#methods" class="md-nav__link">
  745. Methods
  746. </a>
  747. <nav class="md-nav" aria-label="Methods">
  748. <ul class="md-nav__list">
  749. <li class="md-nav__item">
  750. <a href="#regexp" class="md-nav__link">
  751. Regexp
  752. </a>
  753. </li>
  754. </ul>
  755. </nav>
  756. </li>
  757. <li class="md-nav__item">
  758. <a href="#examples" class="md-nav__link">
  759. Examples
  760. </a>
  761. <nav class="md-nav" aria-label="Examples">
  762. <ul class="md-nav__list">
  763. <li class="md-nav__item">
  764. <a href="#removing-a-common-path-from-find-operations" class="md-nav__link">
  765. Removing a common path from find operations
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="#avoiding-key-collisions" class="md-nav__link">
  770. Avoiding key collisions
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="#remove-invalid-characters" class="md-nav__link">
  775. Remove invalid characters
  776. </a>
  777. </li>
  778. </ul>
  779. </nav>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="#limitations" class="md-nav__link">
  783. Limitations
  784. </a>
  785. </li>
  786. </ul>
  787. </nav>
  788. </div>
  789. </div>
  790. </div>
  791. <div class="md-content" data-md-component="content">
  792. <article class="md-content__inner md-typeset">
  793. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/guides/datafrom-rewrite.md" title="Edit this page" class="md-content__button md-icon">
  794. <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>
  795. </a>
  796. <h1 id="rewriting-keys-in-datafrom">Rewriting Keys in DataFrom</h1>
  797. <p>When calling out an ExternalSecret with <code>dataFrom.extract</code> or <code>dataFrom.find</code>, it is possible that you end up with a kubernetes secret that has conflicts in the key names, or that you simply want to remove a common path from the secret keys.</p>
  798. <p>In order to do so, it is possible to define a set of rewrite operations using <code>dataFrom.rewrite</code>. These operations can be stacked, hence allowing complex manipulations of the secret keys.</p>
  799. <p>Rewrite operations are all applied before <code>ConversionStrategy</code> is applied.</p>
  800. <h2 id="methods">Methods</h2>
  801. <h3 id="regexp">Regexp</h3>
  802. <p>This method implements rewriting through the use of regular expressions. It needs a <code>source</code> and a <code>target</code> field. The source field is where the definition of the matching regular expression goes, where the <code>target</code> field is where the replacing expression goes.</p>
  803. <p>Some considerations about the implementation of Regexp Rewrite:</p>
  804. <ol>
  805. <li>The input of a subsequent rewrite operation are the outputs of the previous rewrite.</li>
  806. <li>If a given set of keys do not match any Rewrite operation, there will be no error. Rather, the original keys will be used.</li>
  807. <li>If a <code>source</code> is not a compilable <code>regexp</code> expression, an error will be produced and the external secret goes into a error state.</li>
  808. </ol>
  809. <h2 id="examples">Examples</h2>
  810. <h3 id="removing-a-common-path-from-find-operations">Removing a common path from find operations</h3>
  811. <p>The following ExternalSecret:
  812. <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>
  813. <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>
  814. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  815. <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">example</span><span class="w"></span>
  816. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  817. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  818. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  819. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  820. <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">backend</span><span class="w"></span>
  821. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  822. <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>
  823. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  824. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
  825. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path/to/my</span><span class="w"></span>
  826. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span>
  827. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secrets</span><span class="w"></span>
  828. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  829. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"></span>
  830. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;path/to/my/secrets/(.*)&quot;</span><span class="w"></span>
  831. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$1&quot;</span><span class="w"></span>
  832. </code></pre></div>
  833. Will get all the secrets matching <code>path/to/my/secrets/*</code> and then rewrite them by removing the common path away.</p>
  834. <p>In this example, if we had the following secrets available in the provider:
  835. <div class="highlight"><pre><span></span><code>path/to/my/secrets/username
  836. path/to/my/secrets/password
  837. </code></pre></div>
  838. the output kubernetes secret would be:
  839. <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">v1</span><span class="w"></span>
  840. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  841. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span><span class="w"></span>
  842. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  843. <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span><span class="w"></span>
  844. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span><span class="w"></span>
  845. </code></pre></div></p>
  846. <h3 id="avoiding-key-collisions">Avoiding key collisions</h3>
  847. <p>The following ExternalSecret:
  848. <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>
  849. <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>
  850. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  851. <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">example</span><span class="w"></span>
  852. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  853. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  854. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  855. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  856. <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">backend</span><span class="w"></span>
  857. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  858. <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>
  859. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  860. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"></span>
  861. <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">my-secrets-dev</span><span class="w"></span>
  862. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  863. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"></span>
  864. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;(.*)&quot;</span><span class="w"></span>
  865. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;dev-$1&quot;</span><span class="w"> </span>
  866. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"></span>
  867. <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">my-secrets-prod</span><span class="w"></span>
  868. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  869. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"></span>
  870. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;(.*)&quot;</span><span class="w"></span>
  871. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;prod-$1&quot;</span><span class="w"></span>
  872. </code></pre></div>
  873. Will allow two secrets with the same JSON keys to be imported into a Kubernetes Secret without any conflict.
  874. In this example, if we had the following secrets available in the provider:
  875. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  876. <span class="w"> </span><span class="nt">&quot;my-secrets-dev&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
  877. <span class="w"> </span><span class="nt">&quot;password&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;bar&quot;</span><span class="p">,</span><span class="w"></span>
  878. <span class="w"> </span><span class="p">},</span><span class="w"></span>
  879. <span class="w"> </span><span class="nt">&quot;my-secrets-prod&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
  880. <span class="w"> </span><span class="nt">&quot;password&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;safebar&quot;</span><span class="p">,</span><span class="w"></span>
  881. <span class="w"> </span><span class="p">}</span><span class="w"></span>
  882. <span class="p">}</span><span class="w"></span>
  883. </code></pre></div>
  884. the output kubernetes secret would be:
  885. <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">v1</span><span class="w"></span>
  886. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  887. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span><span class="w"></span>
  888. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  889. <span class="w"> </span><span class="nt">dev_password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">YmFy</span><span class="w"> </span><span class="c1">#bar</span><span class="w"></span>
  890. <span class="w"> </span><span class="nt">prod_password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">c2FmZWJhcg==</span><span class="w"> </span><span class="c1">#safebar</span><span class="w"></span>
  891. </code></pre></div></p>
  892. <h3 id="remove-invalid-characters">Remove invalid characters</h3>
  893. <p>The following ExternalSecret:
  894. <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>
  895. <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>
  896. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  897. <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">example</span><span class="w"></span>
  898. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  899. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  900. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  901. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></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">backend</span><span class="w"></span>
  903. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  904. <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>
  905. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  906. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"></span>
  907. <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">development</span><span class="w"></span>
  908. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  909. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"></span>
  910. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;[^a-zA-Z0-9</span><span class="nv"> </span><span class="s">-]&quot;</span><span class="w"></span>
  911. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;_&quot;</span><span class="w"></span>
  912. </code></pre></div>
  913. Will remove invalid characters from the secret key.
  914. In this example, if we had the following secrets available in the provider:
  915. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  916. <span class="w"> </span><span class="nt">&quot;development&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
  917. <span class="w"> </span><span class="nt">&quot;foo/bar&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;1111&quot;</span><span class="p">,</span><span class="w"></span>
  918. <span class="w"> </span><span class="nt">&quot;foo$baz&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2222&quot;</span><span class="w"></span>
  919. <span class="w"> </span><span class="p">}</span><span class="w"></span>
  920. <span class="p">}</span><span class="w"></span>
  921. </code></pre></div>
  922. the output kubernetes secret would be:
  923. <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">v1</span><span class="w"></span>
  924. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  925. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span><span class="w"></span>
  926. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  927. <span class="w"> </span><span class="nt">foo_bar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MTExMQ==</span><span class="w"> </span><span class="c1">#1111</span><span class="w"></span>
  928. <span class="w"> </span><span class="nt">foo_baz</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MjIyMg==</span><span class="w"> </span><span class="c1">#2222</span><span class="w"></span>
  929. </code></pre></div></p>
  930. <h2 id="limitations">Limitations</h2>
  931. <p>Regexp Rewrite is based on golang <code>regexp</code>, which in turns implements <code>RE2</code> regexp language. There a a series of known limitations to this implementation, such as:</p>
  932. <ul>
  933. <li>Lack of ability to do lookaheads or lookbehinds;</li>
  934. <li>Lack of negation expressions;</li>
  935. <li>Lack of support for conditional branches;</li>
  936. <li>Lack of support for possessive repetitions.</li>
  937. </ul>
  938. <p>A list of compatibility and known limitations considering other commonly used regexp frameworks (such as PCRE and PERL) are listed <a href="https://github.com/google/re2/wiki/Syntax">here</a>.</p>
  939. </article>
  940. </div>
  941. </div>
  942. </main>
  943. <footer class="md-footer">
  944. <nav class="md-footer__inner md-grid" aria-label="Footer">
  945. <a href="../multi-tenancy/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Multi Tenancy" rel="prev">
  946. <div class="md-footer__button md-icon">
  947. <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>
  948. </div>
  949. <div class="md-footer__title">
  950. <div class="md-ellipsis">
  951. <span class="md-footer__direction">
  952. Previous
  953. </span>
  954. Multi Tenancy
  955. </div>
  956. </div>
  957. </a>
  958. <a href="../v1beta1/" class="md-footer__link md-footer__link--next" aria-label="Next: Upgrading to v1beta1" rel="next">
  959. <div class="md-footer__title">
  960. <div class="md-ellipsis">
  961. <span class="md-footer__direction">
  962. Next
  963. </span>
  964. Upgrading to v1beta1
  965. </div>
  966. </div>
  967. <div class="md-footer__button md-icon">
  968. <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>
  969. </div>
  970. </a>
  971. </nav>
  972. <div class="md-footer-meta md-typeset">
  973. <div class="md-footer-meta__inner md-grid">
  974. <div class="md-copyright">
  975. <div class="md-copyright__highlight">
  976. &copy; 2023 The external-secrets Authors.<br/>
  977. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  978. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  979. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  980. </div>
  981. Made with
  982. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  983. Material for MkDocs
  984. </a>
  985. </div>
  986. </div>
  987. </div>
  988. </footer>
  989. </div>
  990. <div class="md-dialog" data-md-component="dialog">
  991. <div class="md-dialog__inner md-typeset"></div>
  992. </div>
  993. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  994. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  995. </body>
  996. </html>