index.html 74 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../getallsecrets/">
  7. <link rel="next" href="../templating/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
  10. <title>Rewriting Keys - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#rewriting-keys-in-datafrom" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Rewriting Keys
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <form class="md-header__option" data-md-component="palette">
  65. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  68. </label>
  69. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  72. </label>
  73. </form>
  74. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  75. <label class="md-header__button md-icon" for="__search">
  76. <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.52 6.52 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 5"/></svg>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <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>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <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.52 6.52 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 5"/></svg>
  85. <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 11z"/></svg>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <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 12z"/></svg>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item">
  127. <a href="../../api/components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item md-tabs__item--active">
  132. <a href="../introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item">
  137. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../introduction/getting-started/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Getting started
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/faq/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. FAQ
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/stability-support/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Stability and Support
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. Deprecation Policy
  227. </span>
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  235. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  236. <span class="md-ellipsis">
  237. API
  238. </span>
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  242. <label class="md-nav__title" for="__nav_2">
  243. <span class="md-nav__icon md-icon"></span>
  244. API
  245. </label>
  246. <ul class="md-nav__list" data-md-scrollfix>
  247. <li class="md-nav__item">
  248. <a href="../../api/components/" class="md-nav__link">
  249. <span class="md-ellipsis">
  250. Components
  251. </span>
  252. </a>
  253. </li>
  254. <li class="md-nav__item md-nav__item--nested">
  255. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  256. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  257. <span class="md-ellipsis">
  258. Core Resources
  259. </span>
  260. <span class="md-nav__icon md-icon"></span>
  261. </label>
  262. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  263. <label class="md-nav__title" for="__nav_2_2">
  264. <span class="md-nav__icon md-icon"></span>
  265. Core Resources
  266. </label>
  267. <ul class="md-nav__list" data-md-scrollfix>
  268. <li class="md-nav__item">
  269. <a href="../../api/externalsecret/" class="md-nav__link">
  270. <span class="md-ellipsis">
  271. ExternalSecret
  272. </span>
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../../api/secretstore/" class="md-nav__link">
  277. <span class="md-ellipsis">
  278. SecretStore
  279. </span>
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/clustersecretstore/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ClusterSecretStore
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. ClusterExternalSecret
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../api/pushsecret/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. PushSecret
  300. </span>
  301. </a>
  302. </li>
  303. </ul>
  304. </nav>
  305. </li>
  306. <li class="md-nav__item md-nav__item--nested">
  307. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  308. <div class="md-nav__link md-nav__container">
  309. <a href="../../api/generator/" class="md-nav__link ">
  310. <span class="md-ellipsis">
  311. Generators
  312. </span>
  313. </a>
  314. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  315. <span class="md-nav__icon md-icon"></span>
  316. </label>
  317. </div>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_3">
  320. <span class="md-nav__icon md-icon"></span>
  321. Generators
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../../api/generator/acr/" class="md-nav__link">
  326. <span class="md-ellipsis">
  327. Azure Container Registry
  328. </span>
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../../api/generator/ecr/" class="md-nav__link">
  333. <span class="md-ellipsis">
  334. AWS Elastic Container Registry
  335. </span>
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../../api/generator/gcr/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. Google Container Registry
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/vault/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Vault Dynamic Secret
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/password/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. Password
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/fake/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. Fake
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/webhook/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Webhook
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/github/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Github
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/uuid/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. UUID
  384. </span>
  385. </a>
  386. </li>
  387. </ul>
  388. </nav>
  389. </li>
  390. <li class="md-nav__item md-nav__item--nested">
  391. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  392. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  393. <span class="md-ellipsis">
  394. Reference Docs
  395. </span>
  396. <span class="md-nav__icon md-icon"></span>
  397. </label>
  398. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  399. <label class="md-nav__title" for="__nav_2_4">
  400. <span class="md-nav__icon md-icon"></span>
  401. Reference Docs
  402. </label>
  403. <ul class="md-nav__list" data-md-scrollfix>
  404. <li class="md-nav__item">
  405. <a href="../../api/spec/" class="md-nav__link">
  406. <span class="md-ellipsis">
  407. API specification
  408. </span>
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="../../api/controller-options/" class="md-nav__link">
  413. <span class="md-ellipsis">
  414. Controller Options
  415. </span>
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../api/metrics/" class="md-nav__link">
  420. <span class="md-ellipsis">
  421. Metrics
  422. </span>
  423. </a>
  424. </li>
  425. </ul>
  426. </nav>
  427. </li>
  428. </ul>
  429. </nav>
  430. </li>
  431. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  432. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  433. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  434. <span class="md-ellipsis">
  435. Guides
  436. </span>
  437. <span class="md-nav__icon md-icon"></span>
  438. </label>
  439. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
  440. <label class="md-nav__title" for="__nav_3">
  441. <span class="md-nav__icon md-icon"></span>
  442. Guides
  443. </label>
  444. <ul class="md-nav__list" data-md-scrollfix>
  445. <li class="md-nav__item">
  446. <a href="../introduction/" class="md-nav__link">
  447. <span class="md-ellipsis">
  448. Introduction
  449. </span>
  450. </a>
  451. </li>
  452. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  453. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" checked>
  454. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  455. <span class="md-ellipsis">
  456. External Secrets
  457. </span>
  458. <span class="md-nav__icon md-icon"></span>
  459. </label>
  460. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true">
  461. <label class="md-nav__title" for="__nav_3_2">
  462. <span class="md-nav__icon md-icon"></span>
  463. External Secrets
  464. </label>
  465. <ul class="md-nav__list" data-md-scrollfix>
  466. <li class="md-nav__item">
  467. <a href="../all-keys-one-secret/" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. Extract structured data
  470. </span>
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../getallsecrets/" class="md-nav__link">
  475. <span class="md-ellipsis">
  476. Find Secrets by Name or Metadata
  477. </span>
  478. </a>
  479. </li>
  480. <li class="md-nav__item md-nav__item--active">
  481. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  482. <label class="md-nav__link md-nav__link--active" for="__toc">
  483. <span class="md-ellipsis">
  484. Rewriting Keys
  485. </span>
  486. <span class="md-nav__icon md-icon"></span>
  487. </label>
  488. <a href="./" class="md-nav__link md-nav__link--active">
  489. <span class="md-ellipsis">
  490. Rewriting Keys
  491. </span>
  492. </a>
  493. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  494. <label class="md-nav__title" for="__toc">
  495. <span class="md-nav__icon md-icon"></span>
  496. Table of contents
  497. </label>
  498. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  499. <li class="md-nav__item">
  500. <a href="#methods" class="md-nav__link">
  501. <span class="md-ellipsis">
  502. Methods
  503. </span>
  504. </a>
  505. <nav class="md-nav" aria-label="Methods">
  506. <ul class="md-nav__list">
  507. <li class="md-nav__item">
  508. <a href="#regexp" class="md-nav__link">
  509. <span class="md-ellipsis">
  510. Regexp
  511. </span>
  512. </a>
  513. </li>
  514. </ul>
  515. </nav>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="#examples" class="md-nav__link">
  519. <span class="md-ellipsis">
  520. Examples
  521. </span>
  522. </a>
  523. <nav class="md-nav" aria-label="Examples">
  524. <ul class="md-nav__list">
  525. <li class="md-nav__item">
  526. <a href="#removing-a-common-path-from-find-operations" class="md-nav__link">
  527. <span class="md-ellipsis">
  528. Removing a common path from find operations
  529. </span>
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="#avoiding-key-collisions" class="md-nav__link">
  534. <span class="md-ellipsis">
  535. Avoiding key collisions
  536. </span>
  537. </a>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="#remove-invalid-characters" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Remove invalid characters
  543. </span>
  544. </a>
  545. </li>
  546. </ul>
  547. </nav>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="#limitations" class="md-nav__link">
  551. <span class="md-ellipsis">
  552. Limitations
  553. </span>
  554. </a>
  555. </li>
  556. </ul>
  557. </nav>
  558. </li>
  559. <li class="md-nav__item md-nav__item--nested">
  560. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  561. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  562. <span class="md-ellipsis">
  563. Advanced Templating
  564. </span>
  565. <span class="md-nav__icon md-icon"></span>
  566. </label>
  567. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  568. <label class="md-nav__title" for="__nav_3_2_4">
  569. <span class="md-nav__icon md-icon"></span>
  570. Advanced Templating
  571. </label>
  572. <ul class="md-nav__list" data-md-scrollfix>
  573. <li class="md-nav__item">
  574. <a href="../templating/" class="md-nav__link">
  575. <span class="md-ellipsis">
  576. v2
  577. </span>
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../templating-v1/" class="md-nav__link">
  582. <span class="md-ellipsis">
  583. v1
  584. </span>
  585. </a>
  586. </li>
  587. </ul>
  588. </nav>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="../common-k8s-secret-types/" class="md-nav__link">
  592. <span class="md-ellipsis">
  593. Kubernetes Secret Types
  594. </span>
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../ownership-deletion-policy/" class="md-nav__link">
  599. <span class="md-ellipsis">
  600. Lifecycle: ownership & deletion
  601. </span>
  602. </a>
  603. </li>
  604. <li class="md-nav__item">
  605. <a href="../decoding-strategy/" class="md-nav__link">
  606. <span class="md-ellipsis">
  607. Decoding Strategies
  608. </span>
  609. </a>
  610. </li>
  611. <li class="md-nav__item">
  612. <a href="../controller-class/" class="md-nav__link">
  613. <span class="md-ellipsis">
  614. Controller Classes
  615. </span>
  616. </a>
  617. </li>
  618. </ul>
  619. </nav>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../generator/" class="md-nav__link">
  623. <span class="md-ellipsis">
  624. Generators
  625. </span>
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../pushsecrets/" class="md-nav__link">
  630. <span class="md-ellipsis">
  631. Push Secrets
  632. </span>
  633. </a>
  634. </li>
  635. <li class="md-nav__item md-nav__item--nested">
  636. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  637. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  638. <span class="md-ellipsis">
  639. Operations
  640. </span>
  641. <span class="md-nav__icon md-icon"></span>
  642. </label>
  643. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  644. <label class="md-nav__title" for="__nav_3_5">
  645. <span class="md-nav__icon md-icon"></span>
  646. Operations
  647. </label>
  648. <ul class="md-nav__list" data-md-scrollfix>
  649. <li class="md-nav__item">
  650. <a href="../multi-tenancy/" class="md-nav__link">
  651. <span class="md-ellipsis">
  652. Multi Tenancy
  653. </span>
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../security-best-practices/" class="md-nav__link">
  658. <span class="md-ellipsis">
  659. Security Best Practices
  660. </span>
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../threat-model/" class="md-nav__link">
  665. <span class="md-ellipsis">
  666. Threat Model
  667. </span>
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../v1beta1/" class="md-nav__link">
  672. <span class="md-ellipsis">
  673. Upgrading to v1beta1
  674. </span>
  675. </a>
  676. </li>
  677. <li class="md-nav__item">
  678. <a href="../using-latest-image/" class="md-nav__link">
  679. <span class="md-ellipsis">
  680. Using Latest Image
  681. </span>
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../disable-cluster-features/" class="md-nav__link">
  686. <span class="md-ellipsis">
  687. Disable Cluster Features
  688. </span>
  689. </a>
  690. </li>
  691. </ul>
  692. </nav>
  693. </li>
  694. </ul>
  695. </nav>
  696. </li>
  697. <li class="md-nav__item md-nav__item--nested">
  698. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  699. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  700. <span class="md-ellipsis">
  701. Provider
  702. </span>
  703. <span class="md-nav__icon md-icon"></span>
  704. </label>
  705. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  706. <label class="md-nav__title" for="__nav_4">
  707. <span class="md-nav__icon md-icon"></span>
  708. Provider
  709. </label>
  710. <ul class="md-nav__list" data-md-scrollfix>
  711. <li class="md-nav__item">
  712. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. AWS Secrets Manager
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. AWS Parameter Store
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. Azure Key Vault
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="../../provider/beyondtrust/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. BeyondTrust
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. Bitwarden Secrets Manager
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../../provider/chef/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. Chef
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="../../provider/conjur/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. CyberArk Conjur
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../provider/device42/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. Device42
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Google Cloud Secret Manager
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. HashiCorp Vault
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../../provider/kubernetes/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. Kubernetes
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. IBM Secrets Manager
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../../provider/akeyless/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. Akeyless
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. Yandex Certificate Manager
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. Yandex Lockbox
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="../../provider/alibaba/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. Alibaba Cloud
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. GitLab Variables
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="../../provider/oracle-vault/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. Oracle Vault
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="../../provider/1password-automation/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. 1Password Secrets Automation
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="../../provider/webhook/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Webhook
  848. </span>
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="../../provider/fake/" class="md-nav__link">
  853. <span class="md-ellipsis">
  854. Fake
  855. </span>
  856. </a>
  857. </li>
  858. <li class="md-nav__item">
  859. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  860. <span class="md-ellipsis">
  861. senhasegura DevOps Secrets Management (DSM)
  862. </span>
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="../../provider/doppler/" class="md-nav__link">
  867. <span class="md-ellipsis">
  868. Doppler
  869. </span>
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="../../provider/keeper-security/" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. Keeper Security
  876. </span>
  877. </a>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="../../provider/cloak/" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. Cloak End 2 End Encrypted Secrets
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="../../provider/scaleway/" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. Scaleway
  890. </span>
  891. </a>
  892. </li>
  893. <li class="md-nav__item">
  894. <a href="../../provider/delinea/" class="md-nav__link">
  895. <span class="md-ellipsis">
  896. Delinea
  897. </span>
  898. </a>
  899. </li>
  900. <li class="md-nav__item">
  901. <a href="../../provider/secretserver/" class="md-nav__link">
  902. <span class="md-ellipsis">
  903. Secret Server
  904. </span>
  905. </a>
  906. </li>
  907. <li class="md-nav__item">
  908. <a href="../../provider/passbolt/" class="md-nav__link">
  909. <span class="md-ellipsis">
  910. Passbolt
  911. </span>
  912. </a>
  913. </li>
  914. <li class="md-nav__item">
  915. <a href="../../provider/pulumi/" class="md-nav__link">
  916. <span class="md-ellipsis">
  917. Pulumi ESC
  918. </span>
  919. </a>
  920. </li>
  921. <li class="md-nav__item">
  922. <a href="../../provider/onboardbase/" class="md-nav__link">
  923. <span class="md-ellipsis">
  924. Onboardbase
  925. </span>
  926. </a>
  927. </li>
  928. <li class="md-nav__item">
  929. <a href="../../provider-passworddepot/" class="md-nav__link">
  930. <span class="md-ellipsis">
  931. Password Depot
  932. </span>
  933. </a>
  934. </li>
  935. <li class="md-nav__item">
  936. <a href="../../provider/fortanix/" class="md-nav__link">
  937. <span class="md-ellipsis">
  938. Fortanix
  939. </span>
  940. </a>
  941. </li>
  942. <li class="md-nav__item">
  943. <a href="../../provider/infisical/" class="md-nav__link">
  944. <span class="md-ellipsis">
  945. Infisical
  946. </span>
  947. </a>
  948. </li>
  949. <li class="md-nav__item">
  950. <a href="../../provider/previder/" class="md-nav__link">
  951. <span class="md-ellipsis">
  952. Previder
  953. </span>
  954. </a>
  955. </li>
  956. </ul>
  957. </nav>
  958. </li>
  959. <li class="md-nav__item md-nav__item--nested">
  960. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  961. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  962. <span class="md-ellipsis">
  963. Examples
  964. </span>
  965. <span class="md-nav__icon md-icon"></span>
  966. </label>
  967. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  968. <label class="md-nav__title" for="__nav_5">
  969. <span class="md-nav__icon md-icon"></span>
  970. Examples
  971. </label>
  972. <ul class="md-nav__list" data-md-scrollfix>
  973. <li class="md-nav__item">
  974. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  975. <span class="md-ellipsis">
  976. FluxCD
  977. </span>
  978. </a>
  979. </li>
  980. <li class="md-nav__item">
  981. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  982. <span class="md-ellipsis">
  983. Anchore Engine
  984. </span>
  985. </a>
  986. </li>
  987. <li class="md-nav__item">
  988. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  989. <span class="md-ellipsis">
  990. Jenkins
  991. </span>
  992. </a>
  993. </li>
  994. <li class="md-nav__item">
  995. <a href="../../examples/bitwarden/" class="md-nav__link">
  996. <span class="md-ellipsis">
  997. BitWarden
  998. </span>
  999. </a>
  1000. </li>
  1001. </ul>
  1002. </nav>
  1003. </li>
  1004. <li class="md-nav__item md-nav__item--nested">
  1005. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1006. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1007. <span class="md-ellipsis">
  1008. Community
  1009. </span>
  1010. <span class="md-nav__icon md-icon"></span>
  1011. </label>
  1012. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1013. <label class="md-nav__title" for="__nav_6">
  1014. <span class="md-nav__icon md-icon"></span>
  1015. Community
  1016. </label>
  1017. <ul class="md-nav__list" data-md-scrollfix>
  1018. <li class="md-nav__item md-nav__item--nested">
  1019. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1020. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1021. <span class="md-ellipsis">
  1022. Contributing
  1023. </span>
  1024. <span class="md-nav__icon md-icon"></span>
  1025. </label>
  1026. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1027. <label class="md-nav__title" for="__nav_6_1">
  1028. <span class="md-nav__icon md-icon"></span>
  1029. Contributing
  1030. </label>
  1031. <ul class="md-nav__list" data-md-scrollfix>
  1032. <li class="md-nav__item">
  1033. <a href="../../contributing/devguide/" class="md-nav__link">
  1034. <span class="md-ellipsis">
  1035. Developer guide
  1036. </span>
  1037. </a>
  1038. </li>
  1039. <li class="md-nav__item">
  1040. <a href="../../contributing/process/" class="md-nav__link">
  1041. <span class="md-ellipsis">
  1042. Contributing Process
  1043. </span>
  1044. </a>
  1045. </li>
  1046. <li class="md-nav__item">
  1047. <a href="../../contributing/release/" class="md-nav__link">
  1048. <span class="md-ellipsis">
  1049. Release Process
  1050. </span>
  1051. </a>
  1052. </li>
  1053. <li class="md-nav__item">
  1054. <a href="../../contributing/coc/" class="md-nav__link">
  1055. <span class="md-ellipsis">
  1056. Code of Conduct
  1057. </span>
  1058. </a>
  1059. </li>
  1060. <li class="md-nav__item">
  1061. <a href="../../contributing/roadmap/" class="md-nav__link">
  1062. <span class="md-ellipsis">
  1063. Roadmap
  1064. </span>
  1065. </a>
  1066. </li>
  1067. </ul>
  1068. </nav>
  1069. </li>
  1070. <li class="md-nav__item md-nav__item--nested">
  1071. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1072. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1073. <span class="md-ellipsis">
  1074. External Resources
  1075. </span>
  1076. <span class="md-nav__icon md-icon"></span>
  1077. </label>
  1078. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1079. <label class="md-nav__title" for="__nav_6_2">
  1080. <span class="md-nav__icon md-icon"></span>
  1081. External Resources
  1082. </label>
  1083. <ul class="md-nav__list" data-md-scrollfix>
  1084. <li class="md-nav__item">
  1085. <a href="../../eso-talks/" class="md-nav__link">
  1086. <span class="md-ellipsis">
  1087. Talks
  1088. </span>
  1089. </a>
  1090. </li>
  1091. <li class="md-nav__item">
  1092. <a href="../../eso-demos/" class="md-nav__link">
  1093. <span class="md-ellipsis">
  1094. Demos
  1095. </span>
  1096. </a>
  1097. </li>
  1098. <li class="md-nav__item">
  1099. <a href="../../eso-blogs/" class="md-nav__link">
  1100. <span class="md-ellipsis">
  1101. Blogs
  1102. </span>
  1103. </a>
  1104. </li>
  1105. <li class="md-nav__item">
  1106. <a href="../../eso-tools/" class="md-nav__link">
  1107. <span class="md-ellipsis">
  1108. Tools
  1109. </span>
  1110. </a>
  1111. </li>
  1112. </ul>
  1113. </nav>
  1114. </li>
  1115. </ul>
  1116. </nav>
  1117. </li>
  1118. </ul>
  1119. </nav>
  1120. </div>
  1121. </div>
  1122. </div>
  1123. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1124. <div class="md-sidebar__scrollwrap">
  1125. <div class="md-sidebar__inner">
  1126. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1127. <label class="md-nav__title" for="__toc">
  1128. <span class="md-nav__icon md-icon"></span>
  1129. Table of contents
  1130. </label>
  1131. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1132. <li class="md-nav__item">
  1133. <a href="#methods" class="md-nav__link">
  1134. <span class="md-ellipsis">
  1135. Methods
  1136. </span>
  1137. </a>
  1138. <nav class="md-nav" aria-label="Methods">
  1139. <ul class="md-nav__list">
  1140. <li class="md-nav__item">
  1141. <a href="#regexp" class="md-nav__link">
  1142. <span class="md-ellipsis">
  1143. Regexp
  1144. </span>
  1145. </a>
  1146. </li>
  1147. </ul>
  1148. </nav>
  1149. </li>
  1150. <li class="md-nav__item">
  1151. <a href="#examples" class="md-nav__link">
  1152. <span class="md-ellipsis">
  1153. Examples
  1154. </span>
  1155. </a>
  1156. <nav class="md-nav" aria-label="Examples">
  1157. <ul class="md-nav__list">
  1158. <li class="md-nav__item">
  1159. <a href="#removing-a-common-path-from-find-operations" class="md-nav__link">
  1160. <span class="md-ellipsis">
  1161. Removing a common path from find operations
  1162. </span>
  1163. </a>
  1164. </li>
  1165. <li class="md-nav__item">
  1166. <a href="#avoiding-key-collisions" class="md-nav__link">
  1167. <span class="md-ellipsis">
  1168. Avoiding key collisions
  1169. </span>
  1170. </a>
  1171. </li>
  1172. <li class="md-nav__item">
  1173. <a href="#remove-invalid-characters" class="md-nav__link">
  1174. <span class="md-ellipsis">
  1175. Remove invalid characters
  1176. </span>
  1177. </a>
  1178. </li>
  1179. </ul>
  1180. </nav>
  1181. </li>
  1182. <li class="md-nav__item">
  1183. <a href="#limitations" class="md-nav__link">
  1184. <span class="md-ellipsis">
  1185. Limitations
  1186. </span>
  1187. </a>
  1188. </li>
  1189. </ul>
  1190. </nav>
  1191. </div>
  1192. </div>
  1193. </div>
  1194. <div class="md-content" data-md-component="content">
  1195. <article class="md-content__inner md-typeset">
  1196. <h1 id="rewriting-keys-in-datafrom">Rewriting Keys in DataFrom</h1>
  1197. <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>
  1198. <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>
  1199. <p>Rewrite operations are all applied before <code>ConversionStrategy</code> is applied.</p>
  1200. <h2 id="methods">Methods</h2>
  1201. <h3 id="regexp">Regexp</h3>
  1202. <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>
  1203. <p>Some considerations about the implementation of Regexp Rewrite:</p>
  1204. <ol>
  1205. <li>The input of a subsequent rewrite operation are the outputs of the previous rewrite.</li>
  1206. <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>
  1207. <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>
  1208. </ol>
  1209. <h2 id="examples">Examples</h2>
  1210. <h3 id="removing-a-common-path-from-find-operations">Removing a common path from find operations</h3>
  1211. <p>The following ExternalSecret:
  1212. <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>
  1213. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1214. <span class="nt">metadata</span><span class="p">:</span>
  1215. <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>
  1216. <span class="nt">spec</span><span class="p">:</span>
  1217. <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>
  1218. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1219. <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>
  1220. <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>
  1221. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1222. <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>
  1223. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1224. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span>
  1225. <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>
  1226. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span>
  1227. <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>
  1228. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1229. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1230. <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>
  1231. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$1&quot;</span>
  1232. </code></pre></div>
  1233. Will get all the secrets matching <code>path/to/my/secrets/*</code> and then rewrite them by removing the common path away.</p>
  1234. <p>In this example, if we had the following secrets available in the provider:
  1235. <div class="highlight"><pre><span></span><code>path/to/my/secrets/username
  1236. path/to/my/secrets/password
  1237. </code></pre></div>
  1238. the output kubernetes secret would be:
  1239. <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>
  1240. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1241. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span>
  1242. <span class="nt">data</span><span class="p">:</span>
  1243. <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>
  1244. <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>
  1245. </code></pre></div></p>
  1246. <h3 id="avoiding-key-collisions">Avoiding key collisions</h3>
  1247. <p>The following ExternalSecret:
  1248. <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>
  1249. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1250. <span class="nt">metadata</span><span class="p">:</span>
  1251. <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>
  1252. <span class="nt">spec</span><span class="p">:</span>
  1253. <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>
  1254. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1255. <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>
  1256. <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>
  1257. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1258. <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>
  1259. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1260. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1261. <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>
  1262. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1263. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1264. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;(.*)&quot;</span>
  1265. <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>
  1266. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1267. <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>
  1268. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1269. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1270. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;(.*)&quot;</span>
  1271. <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>
  1272. </code></pre></div>
  1273. Will allow two secrets with the same JSON keys to be imported into a Kubernetes Secret without any conflict.
  1274. In this example, if we had the following secrets available in the provider:
  1275. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1276. <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>
  1277. <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>
  1278. <span class="w"> </span><span class="p">},</span>
  1279. <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>
  1280. <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>
  1281. <span class="w"> </span><span class="p">}</span>
  1282. <span class="p">}</span>
  1283. </code></pre></div>
  1284. the output kubernetes secret would be:
  1285. <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>
  1286. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1287. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span>
  1288. <span class="nt">data</span><span class="p">:</span>
  1289. <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>
  1290. <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>
  1291. </code></pre></div></p>
  1292. <h3 id="remove-invalid-characters">Remove invalid characters</h3>
  1293. <p>The following ExternalSecret:
  1294. <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>
  1295. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1296. <span class="nt">metadata</span><span class="p">:</span>
  1297. <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>
  1298. <span class="nt">spec</span><span class="p">:</span>
  1299. <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>
  1300. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1301. <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>
  1302. <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>
  1303. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1304. <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>
  1305. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1306. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1307. <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>
  1308. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1309. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1310. <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>
  1311. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;_&quot;</span>
  1312. </code></pre></div>
  1313. Will remove invalid characters from the secret key.
  1314. In this example, if we had the following secrets available in the provider:
  1315. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1316. <span class="w"> </span><span class="nt">&quot;development&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1317. <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>
  1318. <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>
  1319. <span class="w"> </span><span class="p">}</span>
  1320. <span class="p">}</span>
  1321. </code></pre></div>
  1322. the output kubernetes secret would be:
  1323. <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>
  1324. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1325. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span>
  1326. <span class="nt">data</span><span class="p">:</span>
  1327. <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>
  1328. <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>
  1329. </code></pre></div></p>
  1330. <h2 id="limitations">Limitations</h2>
  1331. <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>
  1332. <ul>
  1333. <li>Lack of ability to do lookaheads or lookbehinds;</li>
  1334. <li>Lack of negation expressions;</li>
  1335. <li>Lack of support for conditional branches;</li>
  1336. <li>Lack of support for possessive repetitions.</li>
  1337. </ul>
  1338. <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>
  1339. </article>
  1340. </div>
  1341. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1342. </div>
  1343. </main>
  1344. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1345. <footer class="md-footer">
  1346. <div class="md-footer-meta md-typeset">
  1347. <div class="md-footer-meta__inner md-grid">
  1348. <div class="md-copyright">
  1349. <div class="md-copyright__highlight">
  1350. &copy; 2024 The external-secrets Authors.<br/>
  1351. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1352. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1353. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1354. </div>
  1355. Made with
  1356. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1357. Material for MkDocs
  1358. </a>
  1359. </div>
  1360. </div>
  1361. </div>
  1362. </footer>
  1363. </div>
  1364. <div class="md-dialog" data-md-component="dialog">
  1365. <div class="md-dialog__inner md-typeset"></div>
  1366. </div>
  1367. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1368. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  1369. </body>
  1370. </html>