index.html 58 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200
  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/password/" class="md-nav__link">
  294. Password
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/fake/" class="md-nav__link">
  299. Fake
  300. </a>
  301. </li>
  302. </ul>
  303. </nav>
  304. </li>
  305. <li class="md-nav__item md-nav__item--nested">
  306. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  307. <label class="md-nav__link" for="__nav_2_4">
  308. Reference Docs
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_2_4">
  313. <span class="md-nav__icon md-icon"></span>
  314. Reference Docs
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../../api/spec/" class="md-nav__link">
  319. API specification
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../../api/controller-options/" class="md-nav__link">
  324. Controller Options
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/metrics/" class="md-nav__link">
  329. Metrics
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. </ul>
  336. </nav>
  337. </li>
  338. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  339. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
  340. <label class="md-nav__link" for="__nav_3">
  341. Guides
  342. <span class="md-nav__icon md-icon"></span>
  343. </label>
  344. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  345. <label class="md-nav__title" for="__nav_3">
  346. <span class="md-nav__icon md-icon"></span>
  347. Guides
  348. </label>
  349. <ul class="md-nav__list" data-md-scrollfix>
  350. <li class="md-nav__item">
  351. <a href="../introduction/" class="md-nav__link">
  352. Introduction
  353. </a>
  354. </li>
  355. <li class="md-nav__item md-nav__item--nested">
  356. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  357. <label class="md-nav__link" for="__nav_3_2">
  358. Advanced Templating
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_3_2">
  363. <span class="md-nav__icon md-icon"></span>
  364. Advanced Templating
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../templating/" class="md-nav__link">
  369. v2
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="../templating-v1/" class="md-nav__link">
  374. v1
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../generator/" class="md-nav__link">
  382. Generators
  383. </a>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../all-keys-one-secret/" class="md-nav__link">
  387. All keys, One secret
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../common-k8s-secret-types/" class="md-nav__link">
  392. Common K8S Secret Types
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../controller-class/" class="md-nav__link">
  397. Controller Classes
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../ownership-deletion-policy/" class="md-nav__link">
  402. Lifecycle: ownership & deletion
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../decoding-strategy/" class="md-nav__link">
  407. Decoding Strategies
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../getallsecrets/" class="md-nav__link">
  412. Getting Multiple Secrets
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../multi-tenancy/" class="md-nav__link">
  417. Multi Tenancy
  418. </a>
  419. </li>
  420. <li class="md-nav__item md-nav__item--active">
  421. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  422. <label class="md-nav__link md-nav__link--active" for="__toc">
  423. Rewriting Keys
  424. <span class="md-nav__icon md-icon"></span>
  425. </label>
  426. <a href="./" class="md-nav__link md-nav__link--active">
  427. Rewriting Keys
  428. </a>
  429. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  430. <label class="md-nav__title" for="__toc">
  431. <span class="md-nav__icon md-icon"></span>
  432. Table of contents
  433. </label>
  434. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  435. <li class="md-nav__item">
  436. <a href="#methods" class="md-nav__link">
  437. Methods
  438. </a>
  439. <nav class="md-nav" aria-label="Methods">
  440. <ul class="md-nav__list">
  441. <li class="md-nav__item">
  442. <a href="#regexp" class="md-nav__link">
  443. Regexp
  444. </a>
  445. </li>
  446. </ul>
  447. </nav>
  448. </li>
  449. <li class="md-nav__item">
  450. <a href="#examples" class="md-nav__link">
  451. Examples
  452. </a>
  453. <nav class="md-nav" aria-label="Examples">
  454. <ul class="md-nav__list">
  455. <li class="md-nav__item">
  456. <a href="#removing-a-common-path-from-find-operations" class="md-nav__link">
  457. Removing a common path from find operations
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="#avoiding-key-collisions" class="md-nav__link">
  462. Avoiding key collisions
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="#remove-invalid-characters" class="md-nav__link">
  467. Remove invalid characters
  468. </a>
  469. </li>
  470. </ul>
  471. </nav>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="#limitations" class="md-nav__link">
  475. Limitations
  476. </a>
  477. </li>
  478. </ul>
  479. </nav>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../v1beta1/" class="md-nav__link">
  483. Upgrading to v1beta1
  484. </a>
  485. </li>
  486. <li class="md-nav__item">
  487. <a href="../using-latest-image/" class="md-nav__link">
  488. Using Latest Image
  489. </a>
  490. </li>
  491. </ul>
  492. </nav>
  493. </li>
  494. <li class="md-nav__item md-nav__item--nested">
  495. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  496. <label class="md-nav__link" for="__nav_4">
  497. Provider
  498. <span class="md-nav__icon md-icon"></span>
  499. </label>
  500. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  501. <label class="md-nav__title" for="__nav_4">
  502. <span class="md-nav__icon md-icon"></span>
  503. Provider
  504. </label>
  505. <ul class="md-nav__list" data-md-scrollfix>
  506. <li class="md-nav__item">
  507. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  508. AWS Secrets Manager
  509. </a>
  510. </li>
  511. <li class="md-nav__item">
  512. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  513. AWS Parameter Store
  514. </a>
  515. </li>
  516. <li class="md-nav__item">
  517. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  518. Azure Key Vault
  519. </a>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  523. Google Secret Manager
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  528. IBM Secrets Manager
  529. </a>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../../provider/akeyless/" class="md-nav__link">
  533. Akeyless
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  538. HashiCorp Vault
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  543. Yandex Certificate Manager
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  548. Yandex Lockbox
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  553. Gitlab Variables
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../../provider/oracle-vault/" class="md-nav__link">
  558. Oracle Vault
  559. </a>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../../provider/1password-automation/" class="md-nav__link">
  563. 1Password Secrets Automation
  564. </a>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="../../provider/webhook/" class="md-nav__link">
  568. Webhook
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../../provider/fake/" class="md-nav__link">
  573. Fake
  574. </a>
  575. </li>
  576. <li class="md-nav__item">
  577. <a href="../../provider/kubernetes/" class="md-nav__link">
  578. Kubernetes
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  583. senhasegura DevOps Secrets Management (DSM)
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../../provider/doppler/" class="md-nav__link">
  588. Doppler
  589. </a>
  590. </li>
  591. </ul>
  592. </nav>
  593. </li>
  594. <li class="md-nav__item md-nav__item--nested">
  595. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  596. <label class="md-nav__link" for="__nav_5">
  597. Examples
  598. <span class="md-nav__icon md-icon"></span>
  599. </label>
  600. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  601. <label class="md-nav__title" for="__nav_5">
  602. <span class="md-nav__icon md-icon"></span>
  603. Examples
  604. </label>
  605. <ul class="md-nav__list" data-md-scrollfix>
  606. <li class="md-nav__item">
  607. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  608. FluxCD
  609. </a>
  610. </li>
  611. <li class="md-nav__item">
  612. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  613. Anchore Engine
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  618. Jenkins
  619. </a>
  620. </li>
  621. </ul>
  622. </nav>
  623. </li>
  624. <li class="md-nav__item md-nav__item--nested">
  625. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  626. <label class="md-nav__link" for="__nav_6">
  627. Community
  628. <span class="md-nav__icon md-icon"></span>
  629. </label>
  630. <nav class="md-nav" aria-label="Community" data-md-level="1">
  631. <label class="md-nav__title" for="__nav_6">
  632. <span class="md-nav__icon md-icon"></span>
  633. Community
  634. </label>
  635. <ul class="md-nav__list" data-md-scrollfix>
  636. <li class="md-nav__item md-nav__item--nested">
  637. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  638. <label class="md-nav__link" for="__nav_6_1">
  639. Contributing
  640. <span class="md-nav__icon md-icon"></span>
  641. </label>
  642. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  643. <label class="md-nav__title" for="__nav_6_1">
  644. <span class="md-nav__icon md-icon"></span>
  645. Contributing
  646. </label>
  647. <ul class="md-nav__list" data-md-scrollfix>
  648. <li class="md-nav__item">
  649. <a href="../../contributing/devguide/" class="md-nav__link">
  650. Developer guide
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="../../contributing/process/" class="md-nav__link">
  655. Contributing Process
  656. </a>
  657. </li>
  658. <li class="md-nav__item">
  659. <a href="../../contributing/release/" class="md-nav__link">
  660. Release Process
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../../contributing/coc/" class="md-nav__link">
  665. Code of Conduct
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../contributing/roadmap/" class="md-nav__link">
  670. Roadmap
  671. </a>
  672. </li>
  673. </ul>
  674. </nav>
  675. </li>
  676. <li class="md-nav__item md-nav__item--nested">
  677. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  678. <label class="md-nav__link" for="__nav_6_2">
  679. External Resources
  680. <span class="md-nav__icon md-icon"></span>
  681. </label>
  682. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  683. <label class="md-nav__title" for="__nav_6_2">
  684. <span class="md-nav__icon md-icon"></span>
  685. External Resources
  686. </label>
  687. <ul class="md-nav__list" data-md-scrollfix>
  688. <li class="md-nav__item">
  689. <a href="../../eso-talks/" class="md-nav__link">
  690. Talks
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="../../eso-demos/" class="md-nav__link">
  695. Demos
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../../eso-blogs/" class="md-nav__link">
  700. Blogs
  701. </a>
  702. </li>
  703. </ul>
  704. </nav>
  705. </li>
  706. </ul>
  707. </nav>
  708. </li>
  709. </ul>
  710. </nav>
  711. </div>
  712. </div>
  713. </div>
  714. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  715. <div class="md-sidebar__scrollwrap">
  716. <div class="md-sidebar__inner">
  717. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  718. <label class="md-nav__title" for="__toc">
  719. <span class="md-nav__icon md-icon"></span>
  720. Table of contents
  721. </label>
  722. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  723. <li class="md-nav__item">
  724. <a href="#methods" class="md-nav__link">
  725. Methods
  726. </a>
  727. <nav class="md-nav" aria-label="Methods">
  728. <ul class="md-nav__list">
  729. <li class="md-nav__item">
  730. <a href="#regexp" class="md-nav__link">
  731. Regexp
  732. </a>
  733. </li>
  734. </ul>
  735. </nav>
  736. </li>
  737. <li class="md-nav__item">
  738. <a href="#examples" class="md-nav__link">
  739. Examples
  740. </a>
  741. <nav class="md-nav" aria-label="Examples">
  742. <ul class="md-nav__list">
  743. <li class="md-nav__item">
  744. <a href="#removing-a-common-path-from-find-operations" class="md-nav__link">
  745. Removing a common path from find operations
  746. </a>
  747. </li>
  748. <li class="md-nav__item">
  749. <a href="#avoiding-key-collisions" class="md-nav__link">
  750. Avoiding key collisions
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="#remove-invalid-characters" class="md-nav__link">
  755. Remove invalid characters
  756. </a>
  757. </li>
  758. </ul>
  759. </nav>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="#limitations" class="md-nav__link">
  763. Limitations
  764. </a>
  765. </li>
  766. </ul>
  767. </nav>
  768. </div>
  769. </div>
  770. </div>
  771. <div class="md-content" data-md-component="content">
  772. <article class="md-content__inner md-typeset">
  773. <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">
  774. <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>
  775. </a>
  776. <h1 id="rewriting-keys-in-datafrom">Rewriting Keys in DataFrom</h1>
  777. <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>
  778. <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>
  779. <p>Rewrite operations are all applied before <code>ConversionStrategy</code> is applied.</p>
  780. <h2 id="methods">Methods</h2>
  781. <h3 id="regexp">Regexp</h3>
  782. <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>
  783. <p>Some considerations about the implementation of Regexp Rewrite:</p>
  784. <ol>
  785. <li>The input of a subsequent rewrite operation are the outputs of the previous rewrite.</li>
  786. <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>
  787. <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>
  788. </ol>
  789. <h2 id="examples">Examples</h2>
  790. <h3 id="removing-a-common-path-from-find-operations">Removing a common path from find operations</h3>
  791. <p>The following ExternalSecret:
  792. <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>
  793. <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>
  794. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  795. <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>
  796. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  797. <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>
  798. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  799. <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>
  800. <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>
  801. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  802. <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>
  803. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  804. <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>
  805. <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>
  806. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span>
  807. <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>
  808. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  809. <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>
  810. <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>
  811. <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>
  812. </code></pre></div>
  813. Will get all the secrets matching <code>path/to/my/secrets/*</code> and then rewrite them by removing the common path away.</p>
  814. <p>In this example, if we had the following secrets available in the provider:
  815. <div class="highlight"><pre><span></span><code>path/to/my/secrets/username
  816. path/to/my/secrets/password
  817. </code></pre></div>
  818. the output kubernetes secret would be:
  819. <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>
  820. <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>
  821. <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>
  822. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  823. <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>
  824. <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>
  825. </code></pre></div></p>
  826. <h3 id="avoiding-key-collisions">Avoiding key collisions</h3>
  827. <p>The following ExternalSecret:
  828. <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>
  829. <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>
  830. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  831. <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>
  832. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  833. <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>
  834. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  835. <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>
  836. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">backend</span><span class="w"></span>
  837. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  838. <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>
  839. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  840. <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>
  841. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-secrets-dev</span><span class="w"></span>
  842. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  843. <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>
  844. <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>
  845. <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>
  846. <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>
  847. <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>
  848. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  849. <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>
  850. <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>
  851. <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>
  852. </code></pre></div>
  853. Will allow two secrets with the same JSON keys to be imported into a Kubernetes Secret without any conflict.
  854. In this example, if we had the following secrets available in the provider:
  855. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  856. <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>
  857. <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>
  858. <span class="w"> </span><span class="p">},</span><span class="w"></span>
  859. <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>
  860. <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>
  861. <span class="w"> </span><span class="p">}</span><span class="w"></span>
  862. <span class="p">}</span><span class="w"></span>
  863. </code></pre></div>
  864. the output kubernetes secret would be:
  865. <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>
  866. <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>
  867. <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>
  868. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  869. <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>
  870. <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>
  871. </code></pre></div></p>
  872. <h3 id="remove-invalid-characters">Remove invalid characters</h3>
  873. <p>The following ExternalSecret:
  874. <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>
  875. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  876. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  877. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"></span>
  878. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  879. <span class="w"> </span><span class="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>
  880. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  881. <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>
  882. <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>
  883. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  884. <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>
  885. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  886. <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>
  887. <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>
  888. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  889. <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>
  890. <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>
  891. <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>
  892. </code></pre></div>
  893. Will remove invalid characters from the secret key.
  894. In this example, if we had the following secrets available in the provider:
  895. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  896. <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>
  897. <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>
  898. <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>
  899. <span class="w"> </span><span class="p">}</span><span class="w"></span>
  900. <span class="p">}</span><span class="w"></span>
  901. </code></pre></div>
  902. the output kubernetes secret would be:
  903. <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>
  904. <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>
  905. <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>
  906. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  907. <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>
  908. <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>
  909. </code></pre></div></p>
  910. <h2 id="limitations">Limitations</h2>
  911. <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>
  912. <ul>
  913. <li>Lack of ability to do lookaheads or lookbehinds;</li>
  914. <li>Lack of negation expressions;</li>
  915. <li>Lack of support for conditional branches;</li>
  916. <li>Lack of support for possessive repetitions.</li>
  917. </ul>
  918. <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>
  919. </article>
  920. </div>
  921. </div>
  922. </main>
  923. <footer class="md-footer">
  924. <nav class="md-footer__inner md-grid" aria-label="Footer">
  925. <a href="../multi-tenancy/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Multi Tenancy" rel="prev">
  926. <div class="md-footer__button md-icon">
  927. <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>
  928. </div>
  929. <div class="md-footer__title">
  930. <div class="md-ellipsis">
  931. <span class="md-footer__direction">
  932. Previous
  933. </span>
  934. Multi Tenancy
  935. </div>
  936. </div>
  937. </a>
  938. <a href="../v1beta1/" class="md-footer__link md-footer__link--next" aria-label="Next: Upgrading to v1beta1" rel="next">
  939. <div class="md-footer__title">
  940. <div class="md-ellipsis">
  941. <span class="md-footer__direction">
  942. Next
  943. </span>
  944. Upgrading to v1beta1
  945. </div>
  946. </div>
  947. <div class="md-footer__button md-icon">
  948. <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>
  949. </div>
  950. </a>
  951. </nav>
  952. <div class="md-footer-meta md-typeset">
  953. <div class="md-footer-meta__inner md-grid">
  954. <div class="md-copyright">
  955. <div class="md-copyright__highlight">
  956. &copy; 2022 The external-secrets Authors.<br/>
  957. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  958. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  959. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  960. </div>
  961. Made with
  962. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  963. Material for MkDocs
  964. </a>
  965. </div>
  966. </div>
  967. </div>
  968. </footer>
  969. </div>
  970. <div class="md-dialog" data-md-component="dialog">
  971. <div class="md-dialog__inner md-typeset"></div>
  972. </div>
  973. <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>
  974. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  975. </body>
  976. </html>