index.html 145 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566
  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="../google-secrets-manager/">
  7. <link rel="next" href="../kubernetes/">
  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>HashiCorp Vault - 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="#hashicorp-vault" 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. HashiCorp Vault
  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">
  132. <a href="../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item md-tabs__item--active">
  137. <a href="../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--nested">
  432. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  433. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  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="false">
  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="../../guides/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--nested">
  453. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  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="false">
  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="../../guides/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="../../guides/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">
  481. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  482. <span class="md-ellipsis">
  483. Rewriting Keys
  484. </span>
  485. </a>
  486. </li>
  487. <li class="md-nav__item md-nav__item--nested">
  488. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  489. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  490. <span class="md-ellipsis">
  491. Advanced Templating
  492. </span>
  493. <span class="md-nav__icon md-icon"></span>
  494. </label>
  495. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  496. <label class="md-nav__title" for="__nav_3_2_4">
  497. <span class="md-nav__icon md-icon"></span>
  498. Advanced Templating
  499. </label>
  500. <ul class="md-nav__list" data-md-scrollfix>
  501. <li class="md-nav__item">
  502. <a href="../../guides/templating/" class="md-nav__link">
  503. <span class="md-ellipsis">
  504. v2
  505. </span>
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../guides/templating-v1/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. v1
  512. </span>
  513. </a>
  514. </li>
  515. </ul>
  516. </nav>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  520. <span class="md-ellipsis">
  521. Kubernetes Secret Types
  522. </span>
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  527. <span class="md-ellipsis">
  528. Lifecycle: ownership & deletion
  529. </span>
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  534. <span class="md-ellipsis">
  535. Decoding Strategies
  536. </span>
  537. </a>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../guides/controller-class/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Controller Classes
  543. </span>
  544. </a>
  545. </li>
  546. </ul>
  547. </nav>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="../../guides/generator/" class="md-nav__link">
  551. <span class="md-ellipsis">
  552. Generators
  553. </span>
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../../guides/pushsecrets/" class="md-nav__link">
  558. <span class="md-ellipsis">
  559. Push Secrets
  560. </span>
  561. </a>
  562. </li>
  563. <li class="md-nav__item md-nav__item--nested">
  564. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  565. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  566. <span class="md-ellipsis">
  567. Operations
  568. </span>
  569. <span class="md-nav__icon md-icon"></span>
  570. </label>
  571. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  572. <label class="md-nav__title" for="__nav_3_5">
  573. <span class="md-nav__icon md-icon"></span>
  574. Operations
  575. </label>
  576. <ul class="md-nav__list" data-md-scrollfix>
  577. <li class="md-nav__item">
  578. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  579. <span class="md-ellipsis">
  580. Multi Tenancy
  581. </span>
  582. </a>
  583. </li>
  584. <li class="md-nav__item">
  585. <a href="../../guides/security-best-practices/" class="md-nav__link">
  586. <span class="md-ellipsis">
  587. Security Best Practices
  588. </span>
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../../guides/threat-model/" class="md-nav__link">
  593. <span class="md-ellipsis">
  594. Threat Model
  595. </span>
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../../guides/v1beta1/" class="md-nav__link">
  600. <span class="md-ellipsis">
  601. Upgrading to v1beta1
  602. </span>
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../guides/using-latest-image/" class="md-nav__link">
  607. <span class="md-ellipsis">
  608. Using Latest Image
  609. </span>
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. Disable Cluster Features
  616. </span>
  617. </a>
  618. </li>
  619. </ul>
  620. </nav>
  621. </li>
  622. </ul>
  623. </nav>
  624. </li>
  625. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  626. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  627. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  628. <span class="md-ellipsis">
  629. Provider
  630. </span>
  631. <span class="md-nav__icon md-icon"></span>
  632. </label>
  633. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  634. <label class="md-nav__title" for="__nav_4">
  635. <span class="md-nav__icon md-icon"></span>
  636. Provider
  637. </label>
  638. <ul class="md-nav__list" data-md-scrollfix>
  639. <li class="md-nav__item">
  640. <a href="../aws-secrets-manager/" class="md-nav__link">
  641. <span class="md-ellipsis">
  642. AWS Secrets Manager
  643. </span>
  644. </a>
  645. </li>
  646. <li class="md-nav__item">
  647. <a href="../aws-parameter-store/" class="md-nav__link">
  648. <span class="md-ellipsis">
  649. AWS Parameter Store
  650. </span>
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="../azure-key-vault/" class="md-nav__link">
  655. <span class="md-ellipsis">
  656. Azure Key Vault
  657. </span>
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="../beyondtrust/" class="md-nav__link">
  662. <span class="md-ellipsis">
  663. BeyondTrust
  664. </span>
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  669. <span class="md-ellipsis">
  670. Bitwarden Secrets Manager
  671. </span>
  672. </a>
  673. </li>
  674. <li class="md-nav__item">
  675. <a href="../chef/" class="md-nav__link">
  676. <span class="md-ellipsis">
  677. Chef
  678. </span>
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="../conjur/" class="md-nav__link">
  683. <span class="md-ellipsis">
  684. CyberArk Conjur
  685. </span>
  686. </a>
  687. </li>
  688. <li class="md-nav__item">
  689. <a href="../device42/" class="md-nav__link">
  690. <span class="md-ellipsis">
  691. Device42
  692. </span>
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="../google-secrets-manager/" class="md-nav__link">
  697. <span class="md-ellipsis">
  698. Google Cloud Secret Manager
  699. </span>
  700. </a>
  701. </li>
  702. <li class="md-nav__item md-nav__item--active">
  703. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  704. <label class="md-nav__link md-nav__link--active" for="__toc">
  705. <span class="md-ellipsis">
  706. HashiCorp Vault
  707. </span>
  708. <span class="md-nav__icon md-icon"></span>
  709. </label>
  710. <a href="./" class="md-nav__link md-nav__link--active">
  711. <span class="md-ellipsis">
  712. HashiCorp Vault
  713. </span>
  714. </a>
  715. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  716. <label class="md-nav__title" for="__toc">
  717. <span class="md-nav__icon md-icon"></span>
  718. Table of contents
  719. </label>
  720. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  721. <li class="md-nav__item">
  722. <a href="#hashicorp-vault" class="md-nav__link">
  723. <span class="md-ellipsis">
  724. Hashicorp Vault
  725. </span>
  726. </a>
  727. <nav class="md-nav" aria-label="Hashicorp Vault">
  728. <ul class="md-nav__list">
  729. <li class="md-nav__item">
  730. <a href="#example" class="md-nav__link">
  731. <span class="md-ellipsis">
  732. Example
  733. </span>
  734. </a>
  735. <nav class="md-nav" aria-label="Example">
  736. <ul class="md-nav__list">
  737. <li class="md-nav__item">
  738. <a href="#fetching-raw-values" class="md-nav__link">
  739. <span class="md-ellipsis">
  740. Fetching Raw Values
  741. </span>
  742. </a>
  743. </li>
  744. <li class="md-nav__item">
  745. <a href="#nested-values" class="md-nav__link">
  746. <span class="md-ellipsis">
  747. Nested Values
  748. </span>
  749. </a>
  750. </li>
  751. <li class="md-nav__item">
  752. <a href="#multiple-nested-values" class="md-nav__link">
  753. <span class="md-ellipsis">
  754. Multiple nested Values
  755. </span>
  756. </a>
  757. </li>
  758. <li class="md-nav__item">
  759. <a href="#getting-multiple-secrets" class="md-nav__link">
  760. <span class="md-ellipsis">
  761. Getting multiple secrets
  762. </span>
  763. </a>
  764. </li>
  765. </ul>
  766. </nav>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="#authentication" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Authentication
  772. </span>
  773. </a>
  774. <nav class="md-nav" aria-label="Authentication">
  775. <ul class="md-nav__list">
  776. <li class="md-nav__item">
  777. <a href="#token-based-authentication" class="md-nav__link">
  778. <span class="md-ellipsis">
  779. Token-based authentication
  780. </span>
  781. </a>
  782. </li>
  783. <li class="md-nav__item">
  784. <a href="#approle-authentication-example" class="md-nav__link">
  785. <span class="md-ellipsis">
  786. AppRole authentication example
  787. </span>
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="#kubernetes-authentication" class="md-nav__link">
  792. <span class="md-ellipsis">
  793. Kubernetes authentication
  794. </span>
  795. </a>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="#ldap-authentication" class="md-nav__link">
  799. <span class="md-ellipsis">
  800. LDAP authentication
  801. </span>
  802. </a>
  803. </li>
  804. <li class="md-nav__item">
  805. <a href="#userpass-authentication" class="md-nav__link">
  806. <span class="md-ellipsis">
  807. UserPass authentication
  808. </span>
  809. </a>
  810. </li>
  811. <li class="md-nav__item">
  812. <a href="#jwtoidc-authentication" class="md-nav__link">
  813. <span class="md-ellipsis">
  814. JWT/OIDC authentication
  815. </span>
  816. </a>
  817. </li>
  818. <li class="md-nav__item">
  819. <a href="#aws-iam-authentication" class="md-nav__link">
  820. <span class="md-ellipsis">
  821. AWS IAM authentication
  822. </span>
  823. </a>
  824. </li>
  825. <li class="md-nav__item">
  826. <a href="#tls-certificates-authentication" class="md-nav__link">
  827. <span class="md-ellipsis">
  828. TLS certificates authentication
  829. </span>
  830. </a>
  831. </li>
  832. </ul>
  833. </nav>
  834. </li>
  835. <li class="md-nav__item">
  836. <a href="#mutual-authentication-mtls" class="md-nav__link">
  837. <span class="md-ellipsis">
  838. Mutual authentication (mTLS)
  839. </span>
  840. </a>
  841. </li>
  842. <li class="md-nav__item">
  843. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. Access Key ID &amp; Secret Access Key
  846. </span>
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="#eks-service-account-credentials" class="md-nav__link">
  851. <span class="md-ellipsis">
  852. EKS Service Account credentials
  853. </span>
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="#controllers-pod-identity" class="md-nav__link">
  858. <span class="md-ellipsis">
  859. Controller's Pod Identity
  860. </span>
  861. </a>
  862. </li>
  863. <li class="md-nav__item">
  864. <a href="#pushsecret" class="md-nav__link">
  865. <span class="md-ellipsis">
  866. PushSecret
  867. </span>
  868. </a>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="#vault-enterprise" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. Vault Enterprise
  874. </span>
  875. </a>
  876. <nav class="md-nav" aria-label="Vault Enterprise">
  877. <ul class="md-nav__list">
  878. <li class="md-nav__item">
  879. <a href="#eventual-consistency-and-performance-standby-nodes" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Eventual Consistency and Performance Standby Nodes
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="#vault-namespaces" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Vault Namespaces
  889. </span>
  890. </a>
  891. <nav class="md-nav" aria-label="Vault Namespaces">
  892. <ul class="md-nav__list">
  893. <li class="md-nav__item">
  894. <a href="#authenticating-into-a-different-namespace" class="md-nav__link">
  895. <span class="md-ellipsis">
  896. Authenticating into a different namespace
  897. </span>
  898. </a>
  899. </li>
  900. </ul>
  901. </nav>
  902. </li>
  903. <li class="md-nav__item">
  904. <a href="#read-your-writes" class="md-nav__link">
  905. <span class="md-ellipsis">
  906. Read Your Writes
  907. </span>
  908. </a>
  909. </li>
  910. <li class="md-nav__item">
  911. <a href="#forward-inconsistent" class="md-nav__link">
  912. <span class="md-ellipsis">
  913. Forward Inconsistent
  914. </span>
  915. </a>
  916. </li>
  917. </ul>
  918. </nav>
  919. </li>
  920. </ul>
  921. </nav>
  922. </li>
  923. </ul>
  924. </nav>
  925. </li>
  926. <li class="md-nav__item">
  927. <a href="../kubernetes/" class="md-nav__link">
  928. <span class="md-ellipsis">
  929. Kubernetes
  930. </span>
  931. </a>
  932. </li>
  933. <li class="md-nav__item">
  934. <a href="../ibm-secrets-manager/" class="md-nav__link">
  935. <span class="md-ellipsis">
  936. IBM Secrets Manager
  937. </span>
  938. </a>
  939. </li>
  940. <li class="md-nav__item">
  941. <a href="../akeyless/" class="md-nav__link">
  942. <span class="md-ellipsis">
  943. Akeyless
  944. </span>
  945. </a>
  946. </li>
  947. <li class="md-nav__item">
  948. <a href="../yandex-certificate-manager/" class="md-nav__link">
  949. <span class="md-ellipsis">
  950. Yandex Certificate Manager
  951. </span>
  952. </a>
  953. </li>
  954. <li class="md-nav__item">
  955. <a href="../yandex-lockbox/" class="md-nav__link">
  956. <span class="md-ellipsis">
  957. Yandex Lockbox
  958. </span>
  959. </a>
  960. </li>
  961. <li class="md-nav__item">
  962. <a href="../alibaba/" class="md-nav__link">
  963. <span class="md-ellipsis">
  964. Alibaba Cloud
  965. </span>
  966. </a>
  967. </li>
  968. <li class="md-nav__item">
  969. <a href="../gitlab-variables/" class="md-nav__link">
  970. <span class="md-ellipsis">
  971. GitLab Variables
  972. </span>
  973. </a>
  974. </li>
  975. <li class="md-nav__item">
  976. <a href="../oracle-vault/" class="md-nav__link">
  977. <span class="md-ellipsis">
  978. Oracle Vault
  979. </span>
  980. </a>
  981. </li>
  982. <li class="md-nav__item">
  983. <a href="../1password-automation/" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. 1Password Secrets Automation
  986. </span>
  987. </a>
  988. </li>
  989. <li class="md-nav__item">
  990. <a href="../webhook/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. Webhook
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../fake/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Fake
  1000. </span>
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="../senhasegura-dsm/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. senhasegura DevOps Secrets Management (DSM)
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../doppler/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Doppler
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../keeper-security/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Keeper Security
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../cloak/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Cloak End 2 End Encrypted Secrets
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../scaleway/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Scaleway
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="../delinea/" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Delinea
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="../secretserver/" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Secret Server
  1049. </span>
  1050. </a>
  1051. </li>
  1052. <li class="md-nav__item">
  1053. <a href="../passbolt/" class="md-nav__link">
  1054. <span class="md-ellipsis">
  1055. Passbolt
  1056. </span>
  1057. </a>
  1058. </li>
  1059. <li class="md-nav__item">
  1060. <a href="../pulumi/" class="md-nav__link">
  1061. <span class="md-ellipsis">
  1062. Pulumi ESC
  1063. </span>
  1064. </a>
  1065. </li>
  1066. <li class="md-nav__item">
  1067. <a href="../onboardbase/" class="md-nav__link">
  1068. <span class="md-ellipsis">
  1069. Onboardbase
  1070. </span>
  1071. </a>
  1072. </li>
  1073. <li class="md-nav__item">
  1074. <a href="../../provider-passworddepot/" class="md-nav__link">
  1075. <span class="md-ellipsis">
  1076. Password Depot
  1077. </span>
  1078. </a>
  1079. </li>
  1080. <li class="md-nav__item">
  1081. <a href="../fortanix/" class="md-nav__link">
  1082. <span class="md-ellipsis">
  1083. Fortanix
  1084. </span>
  1085. </a>
  1086. </li>
  1087. <li class="md-nav__item">
  1088. <a href="../infisical/" class="md-nav__link">
  1089. <span class="md-ellipsis">
  1090. Infisical
  1091. </span>
  1092. </a>
  1093. </li>
  1094. <li class="md-nav__item">
  1095. <a href="../previder/" class="md-nav__link">
  1096. <span class="md-ellipsis">
  1097. Previder
  1098. </span>
  1099. </a>
  1100. </li>
  1101. </ul>
  1102. </nav>
  1103. </li>
  1104. <li class="md-nav__item md-nav__item--nested">
  1105. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1106. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1107. <span class="md-ellipsis">
  1108. Examples
  1109. </span>
  1110. <span class="md-nav__icon md-icon"></span>
  1111. </label>
  1112. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1113. <label class="md-nav__title" for="__nav_5">
  1114. <span class="md-nav__icon md-icon"></span>
  1115. Examples
  1116. </label>
  1117. <ul class="md-nav__list" data-md-scrollfix>
  1118. <li class="md-nav__item">
  1119. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1120. <span class="md-ellipsis">
  1121. FluxCD
  1122. </span>
  1123. </a>
  1124. </li>
  1125. <li class="md-nav__item">
  1126. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1127. <span class="md-ellipsis">
  1128. Anchore Engine
  1129. </span>
  1130. </a>
  1131. </li>
  1132. <li class="md-nav__item">
  1133. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1134. <span class="md-ellipsis">
  1135. Jenkins
  1136. </span>
  1137. </a>
  1138. </li>
  1139. <li class="md-nav__item">
  1140. <a href="../../examples/bitwarden/" class="md-nav__link">
  1141. <span class="md-ellipsis">
  1142. BitWarden
  1143. </span>
  1144. </a>
  1145. </li>
  1146. </ul>
  1147. </nav>
  1148. </li>
  1149. <li class="md-nav__item md-nav__item--nested">
  1150. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1151. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1152. <span class="md-ellipsis">
  1153. Community
  1154. </span>
  1155. <span class="md-nav__icon md-icon"></span>
  1156. </label>
  1157. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1158. <label class="md-nav__title" for="__nav_6">
  1159. <span class="md-nav__icon md-icon"></span>
  1160. Community
  1161. </label>
  1162. <ul class="md-nav__list" data-md-scrollfix>
  1163. <li class="md-nav__item md-nav__item--nested">
  1164. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1165. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1166. <span class="md-ellipsis">
  1167. Contributing
  1168. </span>
  1169. <span class="md-nav__icon md-icon"></span>
  1170. </label>
  1171. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1172. <label class="md-nav__title" for="__nav_6_1">
  1173. <span class="md-nav__icon md-icon"></span>
  1174. Contributing
  1175. </label>
  1176. <ul class="md-nav__list" data-md-scrollfix>
  1177. <li class="md-nav__item">
  1178. <a href="../../contributing/devguide/" class="md-nav__link">
  1179. <span class="md-ellipsis">
  1180. Developer guide
  1181. </span>
  1182. </a>
  1183. </li>
  1184. <li class="md-nav__item">
  1185. <a href="../../contributing/process/" class="md-nav__link">
  1186. <span class="md-ellipsis">
  1187. Contributing Process
  1188. </span>
  1189. </a>
  1190. </li>
  1191. <li class="md-nav__item">
  1192. <a href="../../contributing/release/" class="md-nav__link">
  1193. <span class="md-ellipsis">
  1194. Release Process
  1195. </span>
  1196. </a>
  1197. </li>
  1198. <li class="md-nav__item">
  1199. <a href="../../contributing/coc/" class="md-nav__link">
  1200. <span class="md-ellipsis">
  1201. Code of Conduct
  1202. </span>
  1203. </a>
  1204. </li>
  1205. <li class="md-nav__item">
  1206. <a href="../../contributing/roadmap/" class="md-nav__link">
  1207. <span class="md-ellipsis">
  1208. Roadmap
  1209. </span>
  1210. </a>
  1211. </li>
  1212. </ul>
  1213. </nav>
  1214. </li>
  1215. <li class="md-nav__item md-nav__item--nested">
  1216. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1217. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1218. <span class="md-ellipsis">
  1219. External Resources
  1220. </span>
  1221. <span class="md-nav__icon md-icon"></span>
  1222. </label>
  1223. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1224. <label class="md-nav__title" for="__nav_6_2">
  1225. <span class="md-nav__icon md-icon"></span>
  1226. External Resources
  1227. </label>
  1228. <ul class="md-nav__list" data-md-scrollfix>
  1229. <li class="md-nav__item">
  1230. <a href="../../eso-talks/" class="md-nav__link">
  1231. <span class="md-ellipsis">
  1232. Talks
  1233. </span>
  1234. </a>
  1235. </li>
  1236. <li class="md-nav__item">
  1237. <a href="../../eso-demos/" class="md-nav__link">
  1238. <span class="md-ellipsis">
  1239. Demos
  1240. </span>
  1241. </a>
  1242. </li>
  1243. <li class="md-nav__item">
  1244. <a href="../../eso-blogs/" class="md-nav__link">
  1245. <span class="md-ellipsis">
  1246. Blogs
  1247. </span>
  1248. </a>
  1249. </li>
  1250. <li class="md-nav__item">
  1251. <a href="../../eso-tools/" class="md-nav__link">
  1252. <span class="md-ellipsis">
  1253. Tools
  1254. </span>
  1255. </a>
  1256. </li>
  1257. </ul>
  1258. </nav>
  1259. </li>
  1260. </ul>
  1261. </nav>
  1262. </li>
  1263. </ul>
  1264. </nav>
  1265. </div>
  1266. </div>
  1267. </div>
  1268. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1269. <div class="md-sidebar__scrollwrap">
  1270. <div class="md-sidebar__inner">
  1271. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1272. <label class="md-nav__title" for="__toc">
  1273. <span class="md-nav__icon md-icon"></span>
  1274. Table of contents
  1275. </label>
  1276. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1277. <li class="md-nav__item">
  1278. <a href="#hashicorp-vault" class="md-nav__link">
  1279. <span class="md-ellipsis">
  1280. Hashicorp Vault
  1281. </span>
  1282. </a>
  1283. <nav class="md-nav" aria-label="Hashicorp Vault">
  1284. <ul class="md-nav__list">
  1285. <li class="md-nav__item">
  1286. <a href="#example" class="md-nav__link">
  1287. <span class="md-ellipsis">
  1288. Example
  1289. </span>
  1290. </a>
  1291. <nav class="md-nav" aria-label="Example">
  1292. <ul class="md-nav__list">
  1293. <li class="md-nav__item">
  1294. <a href="#fetching-raw-values" class="md-nav__link">
  1295. <span class="md-ellipsis">
  1296. Fetching Raw Values
  1297. </span>
  1298. </a>
  1299. </li>
  1300. <li class="md-nav__item">
  1301. <a href="#nested-values" class="md-nav__link">
  1302. <span class="md-ellipsis">
  1303. Nested Values
  1304. </span>
  1305. </a>
  1306. </li>
  1307. <li class="md-nav__item">
  1308. <a href="#multiple-nested-values" class="md-nav__link">
  1309. <span class="md-ellipsis">
  1310. Multiple nested Values
  1311. </span>
  1312. </a>
  1313. </li>
  1314. <li class="md-nav__item">
  1315. <a href="#getting-multiple-secrets" class="md-nav__link">
  1316. <span class="md-ellipsis">
  1317. Getting multiple secrets
  1318. </span>
  1319. </a>
  1320. </li>
  1321. </ul>
  1322. </nav>
  1323. </li>
  1324. <li class="md-nav__item">
  1325. <a href="#authentication" class="md-nav__link">
  1326. <span class="md-ellipsis">
  1327. Authentication
  1328. </span>
  1329. </a>
  1330. <nav class="md-nav" aria-label="Authentication">
  1331. <ul class="md-nav__list">
  1332. <li class="md-nav__item">
  1333. <a href="#token-based-authentication" class="md-nav__link">
  1334. <span class="md-ellipsis">
  1335. Token-based authentication
  1336. </span>
  1337. </a>
  1338. </li>
  1339. <li class="md-nav__item">
  1340. <a href="#approle-authentication-example" class="md-nav__link">
  1341. <span class="md-ellipsis">
  1342. AppRole authentication example
  1343. </span>
  1344. </a>
  1345. </li>
  1346. <li class="md-nav__item">
  1347. <a href="#kubernetes-authentication" class="md-nav__link">
  1348. <span class="md-ellipsis">
  1349. Kubernetes authentication
  1350. </span>
  1351. </a>
  1352. </li>
  1353. <li class="md-nav__item">
  1354. <a href="#ldap-authentication" class="md-nav__link">
  1355. <span class="md-ellipsis">
  1356. LDAP authentication
  1357. </span>
  1358. </a>
  1359. </li>
  1360. <li class="md-nav__item">
  1361. <a href="#userpass-authentication" class="md-nav__link">
  1362. <span class="md-ellipsis">
  1363. UserPass authentication
  1364. </span>
  1365. </a>
  1366. </li>
  1367. <li class="md-nav__item">
  1368. <a href="#jwtoidc-authentication" class="md-nav__link">
  1369. <span class="md-ellipsis">
  1370. JWT/OIDC authentication
  1371. </span>
  1372. </a>
  1373. </li>
  1374. <li class="md-nav__item">
  1375. <a href="#aws-iam-authentication" class="md-nav__link">
  1376. <span class="md-ellipsis">
  1377. AWS IAM authentication
  1378. </span>
  1379. </a>
  1380. </li>
  1381. <li class="md-nav__item">
  1382. <a href="#tls-certificates-authentication" class="md-nav__link">
  1383. <span class="md-ellipsis">
  1384. TLS certificates authentication
  1385. </span>
  1386. </a>
  1387. </li>
  1388. </ul>
  1389. </nav>
  1390. </li>
  1391. <li class="md-nav__item">
  1392. <a href="#mutual-authentication-mtls" class="md-nav__link">
  1393. <span class="md-ellipsis">
  1394. Mutual authentication (mTLS)
  1395. </span>
  1396. </a>
  1397. </li>
  1398. <li class="md-nav__item">
  1399. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  1400. <span class="md-ellipsis">
  1401. Access Key ID &amp; Secret Access Key
  1402. </span>
  1403. </a>
  1404. </li>
  1405. <li class="md-nav__item">
  1406. <a href="#eks-service-account-credentials" class="md-nav__link">
  1407. <span class="md-ellipsis">
  1408. EKS Service Account credentials
  1409. </span>
  1410. </a>
  1411. </li>
  1412. <li class="md-nav__item">
  1413. <a href="#controllers-pod-identity" class="md-nav__link">
  1414. <span class="md-ellipsis">
  1415. Controller's Pod Identity
  1416. </span>
  1417. </a>
  1418. </li>
  1419. <li class="md-nav__item">
  1420. <a href="#pushsecret" class="md-nav__link">
  1421. <span class="md-ellipsis">
  1422. PushSecret
  1423. </span>
  1424. </a>
  1425. </li>
  1426. <li class="md-nav__item">
  1427. <a href="#vault-enterprise" class="md-nav__link">
  1428. <span class="md-ellipsis">
  1429. Vault Enterprise
  1430. </span>
  1431. </a>
  1432. <nav class="md-nav" aria-label="Vault Enterprise">
  1433. <ul class="md-nav__list">
  1434. <li class="md-nav__item">
  1435. <a href="#eventual-consistency-and-performance-standby-nodes" class="md-nav__link">
  1436. <span class="md-ellipsis">
  1437. Eventual Consistency and Performance Standby Nodes
  1438. </span>
  1439. </a>
  1440. </li>
  1441. <li class="md-nav__item">
  1442. <a href="#vault-namespaces" class="md-nav__link">
  1443. <span class="md-ellipsis">
  1444. Vault Namespaces
  1445. </span>
  1446. </a>
  1447. <nav class="md-nav" aria-label="Vault Namespaces">
  1448. <ul class="md-nav__list">
  1449. <li class="md-nav__item">
  1450. <a href="#authenticating-into-a-different-namespace" class="md-nav__link">
  1451. <span class="md-ellipsis">
  1452. Authenticating into a different namespace
  1453. </span>
  1454. </a>
  1455. </li>
  1456. </ul>
  1457. </nav>
  1458. </li>
  1459. <li class="md-nav__item">
  1460. <a href="#read-your-writes" class="md-nav__link">
  1461. <span class="md-ellipsis">
  1462. Read Your Writes
  1463. </span>
  1464. </a>
  1465. </li>
  1466. <li class="md-nav__item">
  1467. <a href="#forward-inconsistent" class="md-nav__link">
  1468. <span class="md-ellipsis">
  1469. Forward Inconsistent
  1470. </span>
  1471. </a>
  1472. </li>
  1473. </ul>
  1474. </nav>
  1475. </li>
  1476. </ul>
  1477. </nav>
  1478. </li>
  1479. </ul>
  1480. </nav>
  1481. </div>
  1482. </div>
  1483. </div>
  1484. <div class="md-content" data-md-component="content">
  1485. <article class="md-content__inner md-typeset">
  1486. <h1>HashiCorp Vault</h1>
  1487. <p><img alt="HCP Vault" src="../../pictures/diagrams-provider-vault.png" /></p>
  1488. <h2 id="hashicorp-vault">Hashicorp Vault</h2>
  1489. <p>External Secrets Operator integrates with <a href="https://www.vaultproject.io/">HashiCorp Vault</a> for secret management.</p>
  1490. <p>The <a href="https://www.vaultproject.io/docs/secrets/kv">KV Secrets Engine</a> is the only
  1491. one supported by this provider. For other secrets engines, please refer to the
  1492. <a href="../../api/generator/vault/">Vault Generator</a>.</p>
  1493. <h3 id="example">Example</h3>
  1494. <p>First, create a SecretStore with a vault backend. For the sake of simplicity we'll use a static token <code>root</code>:</p>
  1495. <p><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>
  1496. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1497. <span class="nt">metadata</span><span class="p">:</span>
  1498. <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">vault-backend</span>
  1499. <span class="nt">spec</span><span class="p">:</span>
  1500. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1501. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1502. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://my.vault.server:8200&quot;</span>
  1503. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1504. <span class="w"> </span><span class="c1"># Version is the Vault KV secret engine version.</span>
  1505. <span class="w"> </span><span class="c1"># This can be either &quot;v1&quot; or &quot;v2&quot;, defaults to &quot;v2&quot;</span>
  1506. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1507. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1508. <span class="w"> </span><span class="c1"># points to a secret that contains a vault token</span>
  1509. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/token</span>
  1510. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span>
  1511. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token&quot;</span>
  1512. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;token&quot;</span>
  1513. <span class="nn">---</span>
  1514. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1515. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1516. <span class="nt">metadata</span><span class="p">:</span>
  1517. <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">vault-token</span>
  1518. <span class="nt">data</span><span class="p">:</span>
  1519. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">cm9vdA==</span><span class="w"> </span><span class="c1"># &quot;root&quot;</span>
  1520. </code></pre></div>
  1521. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> for <code>tokenSecretRef</code> with the namespace of the secret that we just created.</p>
  1522. <p>Then create a simple k/v pair at path <code>secret/foo</code>:</p>
  1523. <div class="highlight"><pre><span></span><code>vault kv put secret/foo my-value=s3cr3t
  1524. </code></pre></div>
  1525. <p>Can check kv version using following and check for <code>Options</code> column, it should indicate [version:2]:</p>
  1526. <div class="highlight"><pre><span></span><code>vault secrets list -detailed
  1527. </code></pre></div>
  1528. <p>If you are using version: 1, just remember to update your SecretStore manifest appropriately</p>
  1529. <p>Now create a ExternalSecret that uses the above SecretStore:</p>
  1530. <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>
  1531. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1532. <span class="nt">metadata</span><span class="p">:</span>
  1533. <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">vault-example</span>
  1534. <span class="nt">spec</span><span class="p">:</span>
  1535. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;15s&quot;</span>
  1536. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1537. <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">vault-backend</span>
  1538. <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>
  1539. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1540. <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-sync</span>
  1541. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1542. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foobar</span>
  1543. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1544. <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">foo</span>
  1545. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-value</span>
  1546. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the labels in JSON format</span>
  1547. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tags</span>
  1548. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1549. <span class="w"> </span><span class="nt">metadataPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Fetch</span>
  1550. <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">foo</span>
  1551. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific label (dev) from the source secret</span>
  1552. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">developer</span>
  1553. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1554. <span class="w"> </span><span class="nt">metadataPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Fetch</span>
  1555. <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">foo</span>
  1556. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dev</span>
  1557. <span class="nn">---</span>
  1558. <span class="c1"># That will automatically create a Kubernetes Secret with:</span>
  1559. <span class="c1"># apiVersion: v1</span>
  1560. <span class="c1"># kind: Secret</span>
  1561. <span class="c1"># metadata:</span>
  1562. <span class="c1"># name: example-sync</span>
  1563. <span class="c1"># data:</span>
  1564. <span class="c1"># foobar: czNjcjN0</span>
  1565. </code></pre></div>
  1566. <p>Keep in mind that fetching the labels with <code>metadataPolicy: Fetch</code> only works with KV sercrets engine version v2.</p>
  1567. <h4 id="fetching-raw-values">Fetching Raw Values</h4>
  1568. <p>You can fetch all key/value pairs for a given path If you leave the <code>remoteRef.property</code> empty. This returns the json-encoded secret value for that path.</p>
  1569. <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>
  1570. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1571. <span class="nt">metadata</span><span class="p">:</span>
  1572. <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">vault-example</span>
  1573. <span class="nt">spec</span><span class="p">:</span>
  1574. <span class="w"> </span><span class="c1"># ...</span>
  1575. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1576. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foobar</span>
  1577. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1578. <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">/dev/package.json</span>
  1579. </code></pre></div>
  1580. <h4 id="nested-values">Nested Values</h4>
  1581. <p>Vault supports nested key/value pairs. You can specify a <a href="https://github.com/tidwall/gjson">gjson</a> expression at <code>remoteRef.property</code> to get a nested value.</p>
  1582. <p>Given the following secret - assume its path is <code>/dev/config</code>:
  1583. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1584. <span class="w"> </span><span class="nt">&quot;foo&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1585. <span class="w"> </span><span class="nt">&quot;nested&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1586. <span class="w"> </span><span class="nt">&quot;bar&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;mysecret&quot;</span>
  1587. <span class="w"> </span><span class="p">}</span>
  1588. <span class="w"> </span><span class="p">}</span>
  1589. <span class="p">}</span>
  1590. </code></pre></div></p>
  1591. <p>You can set the <code>remoteRef.property</code> to point to the nested key using a <a href="https://github.com/tidwall/gjson">gjson</a> expression.
  1592. <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>
  1593. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1594. <span class="nt">metadata</span><span class="p">:</span>
  1595. <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">vault-example</span>
  1596. <span class="nt">spec</span><span class="p">:</span>
  1597. <span class="w"> </span><span class="c1"># ...</span>
  1598. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1599. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foobar</span>
  1600. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1601. <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">/dev/config</span>
  1602. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo.nested.bar</span>
  1603. <span class="nn">---</span>
  1604. <span class="c1"># creates a secret with:</span>
  1605. <span class="c1"># foobar=mysecret</span>
  1606. </code></pre></div></p>
  1607. <p>If you would set the <code>remoteRef.property</code> to just <code>foo</code> then you would get the json-encoded value of that property: <code>{"nested":{"bar":"mysecret"}}</code>.</p>
  1608. <h4 id="multiple-nested-values">Multiple nested Values</h4>
  1609. <p>You can extract multiple keys from a nested secret using <code>dataFrom</code>.</p>
  1610. <p>Given the following secret - assume its path is <code>/dev/config</code>:
  1611. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1612. <span class="w"> </span><span class="nt">&quot;foo&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1613. <span class="w"> </span><span class="nt">&quot;nested&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1614. <span class="w"> </span><span class="nt">&quot;bar&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;mysecret&quot;</span><span class="p">,</span>
  1615. <span class="w"> </span><span class="nt">&quot;baz&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;bang&quot;</span>
  1616. <span class="w"> </span><span class="p">}</span>
  1617. <span class="w"> </span><span class="p">}</span>
  1618. <span class="p">}</span>
  1619. </code></pre></div></p>
  1620. <p>You can set the <code>remoteRef.property</code> to point to the nested key using a <a href="https://github.com/tidwall/gjson">gjson</a> expression.
  1621. <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>
  1622. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1623. <span class="nt">metadata</span><span class="p">:</span>
  1624. <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">vault-example</span>
  1625. <span class="nt">spec</span><span class="p">:</span>
  1626. <span class="w"> </span><span class="c1"># ...</span>
  1627. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1628. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1629. <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">/dev/config</span>
  1630. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo.nested</span>
  1631. </code></pre></div></p>
  1632. <p>That results in a secret with these values:
  1633. <div class="highlight"><pre><span></span><code>bar=mysecret
  1634. baz=bang
  1635. </code></pre></div></p>
  1636. <h4 id="getting-multiple-secrets">Getting multiple secrets</h4>
  1637. <p>You can extract multiple secrets from Hashicorp vault by using <code>dataFrom.Find</code></p>
  1638. <p>Currently, <code>dataFrom.Find</code> allows users to fetch secret names that match a given regexp pattern, or fetch secrets whose <code>custom_metadata</code> tags match a predefined set.</p>
  1639. <div class="admonition warning">
  1640. <p class="admonition-title">Warning</p>
  1641. <p>The way hashicorp Vault currently allows LIST operations is through the existence of a secret metadata. If you delete the secret, you will also need to delete the secret's metadata or this will currently make Find operations fail.</p>
  1642. </div>
  1643. <p>Given the following secret - assume its path is <code>/dev/config</code>:
  1644. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1645. <span class="w"> </span><span class="nt">&quot;foo&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1646. <span class="w"> </span><span class="nt">&quot;nested&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1647. <span class="w"> </span><span class="nt">&quot;bar&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;mysecret&quot;</span><span class="p">,</span>
  1648. <span class="w"> </span><span class="nt">&quot;baz&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;bang&quot;</span>
  1649. <span class="w"> </span><span class="p">}</span>
  1650. <span class="w"> </span><span class="p">}</span>
  1651. <span class="p">}</span>
  1652. </code></pre></div></p>
  1653. <p>Also consider the following secret has the following <code>custom_metadata</code>:
  1654. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1655. <span class="w"> </span><span class="nt">&quot;environment&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;dev&quot;</span><span class="p">,</span>
  1656. <span class="w"> </span><span class="nt">&quot;component&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;app-1&quot;</span>
  1657. <span class="p">}</span>
  1658. </code></pre></div></p>
  1659. <p>It is possible to find this secret by all the following possibilities:
  1660. <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>
  1661. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1662. <span class="nt">metadata</span><span class="p">:</span>
  1663. <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">vault-example</span>
  1664. <span class="nt">spec</span><span class="p">:</span>
  1665. <span class="w"> </span><span class="c1"># ...</span>
  1666. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1667. <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><span class="c1">#will return every secret with &#39;dev&#39; in it (including paths)</span>
  1668. <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
  1669. <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">dev</span>
  1670. <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><span class="c1">#will return every secret matching environment:dev tags from dev/ folder and beyond</span>
  1671. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
  1672. <span class="w"> </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dev</span>
  1673. </code></pre></div>
  1674. will generate a secret with:
  1675. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1676. <span class="w"> </span><span class="nt">&quot;dev_config&quot;</span><span class="p">:</span><span class="s2">&quot;{\&quot;foo\&quot;:{\&quot;nested\&quot;:{\&quot;bar\&quot;:\&quot;mysecret\&quot;,\&quot;baz\&quot;:\&quot;bang\&quot;}}}&quot;</span>
  1677. <span class="p">}</span>
  1678. </code></pre></div></p>
  1679. <p>Currently, <code>Find</code> operations are recursive throughout a given vault folder, starting on <code>provider.Path</code> definition. It is recommended to narrow down the scope of search by setting a <code>find.path</code> variable. This is also useful to automatically reduce the resulting secret key names:
  1680. <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>
  1681. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1682. <span class="nt">metadata</span><span class="p">:</span>
  1683. <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">vault-example</span>
  1684. <span class="nt">spec</span><span class="p">:</span>
  1685. <span class="w"> </span><span class="c1"># ...</span>
  1686. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1687. <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><span class="c1">#will return every secret from dev/ folder</span>
  1688. <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">dev</span>
  1689. <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
  1690. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;.*&quot;</span>
  1691. <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><span class="c1">#will return every secret matching environment:dev tags from dev/ folder</span>
  1692. <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">dev</span>
  1693. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
  1694. <span class="w"> </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dev</span>
  1695. </code></pre></div>
  1696. Will generate a secret with:
  1697. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1698. <span class="w"> </span><span class="nt">&quot;config&quot;</span><span class="p">:</span><span class="s2">&quot;{\&quot;foo\&quot;: {\&quot;nested\&quot;: {\&quot;bar\&quot;: \&quot;mysecret\&quot;,\&quot;baz\&quot;: \&quot;bang\&quot;}}}&quot;</span>
  1699. <span class="p">}</span>
  1700. </code></pre></div></p>
  1701. <h3 id="authentication">Authentication</h3>
  1702. <p>We support five different modes for authentication:
  1703. <a href="https://www.vaultproject.io/docs/auth/token">token-based</a>,
  1704. <a href="https://www.vaultproject.io/docs/auth/approle">appRole</a>,
  1705. <a href="https://www.vaultproject.io/docs/auth/kubernetes">kubernetes-native</a>,
  1706. <a href="https://www.vaultproject.io/docs/auth/ldap">ldap</a>,
  1707. <a href="https://www.vaultproject.io/docs/auth/userpass">userPass</a>,
  1708. <a href="https://www.vaultproject.io/docs/auth/jwt">jwt/oidc</a>,
  1709. <a href="https://developer.hashicorp.com/vault/docs/auth/aws">awsAuth</a> and
  1710. <a href="https://developer.hashicorp.com/vault/docs/auth/cert">tlsCert</a>, each one comes with it's own
  1711. trade-offs. Depending on the authentication method you need to adapt your environment.</p>
  1712. <p>If you're using Vault namespaces, you can authenticate into one namespace and use the vault token against a different namespace, if desired.</p>
  1713. <h4 id="token-based-authentication">Token-based authentication</h4>
  1714. <p>A static token is stored in a <code>Kind=Secret</code> and is used to authenticate with vault.</p>
  1715. <p><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>
  1716. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1717. <span class="nt">metadata</span><span class="p">:</span>
  1718. <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">vault-backend</span>
  1719. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1720. <span class="nt">spec</span><span class="p">:</span>
  1721. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1722. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1723. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  1724. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1725. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1726. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1727. <span class="w"> </span><span class="c1"># points to a secret that contains a vault token</span>
  1728. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/token</span>
  1729. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span>
  1730. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1731. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token&quot;</span>
  1732. </code></pre></div>
  1733. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>tokenSecretRef</code> with the namespace where the secret resides.</p>
  1734. <h4 id="approle-authentication-example">AppRole authentication example</h4>
  1735. <p><a href="https://www.vaultproject.io/docs/auth/approle">AppRole authentication</a> reads the secret id from a
  1736. <code>Kind=Secret</code> and uses the specified <code>roleId</code> to aquire a temporary token to fetch secrets.</p>
  1737. <p><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>
  1738. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1739. <span class="nt">metadata</span><span class="p">:</span>
  1740. <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">vault-backend</span>
  1741. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1742. <span class="nt">spec</span><span class="p">:</span>
  1743. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1744. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1745. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  1746. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1747. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1748. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1749. <span class="w"> </span><span class="c1"># VaultAppRole authenticates with Vault using the</span>
  1750. <span class="w"> </span><span class="c1"># App Role auth mechanism</span>
  1751. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/approle</span>
  1752. <span class="w"> </span><span class="nt">appRole</span><span class="p">:</span>
  1753. <span class="w"> </span><span class="c1"># Path where the App Role authentication backend is mounted</span>
  1754. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;approle&quot;</span>
  1755. <span class="w"> </span><span class="c1"># RoleID configured in the App Role authentication backend</span>
  1756. <span class="w"> </span><span class="nt">roleId</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;db02de05-fa39-4855-059b-67221c5c2f63&quot;</span>
  1757. <span class="w"> </span><span class="c1"># Reference to a key in a K8 Secret that contains the App Role SecretId</span>
  1758. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1759. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1760. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-id&quot;</span>
  1761. </code></pre></div>
  1762. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>secretRef</code> with the namespace where the secret resides.</p>
  1763. <h4 id="kubernetes-authentication">Kubernetes authentication</h4>
  1764. <p><a href="https://www.vaultproject.io/docs/auth/kubernetes">Kubernetes-native authentication</a> has three
  1765. options of obtaining credentials for vault:</p>
  1766. <ol>
  1767. <li>by using a service account jwt referenced in <code>serviceAccountRef</code></li>
  1768. <li>by using the jwt from a <code>Kind=Secret</code> referenced by the <code>secretRef</code></li>
  1769. <li>by using transient credentials from the mounted service account token within the
  1770. external-secrets operator</li>
  1771. </ol>
  1772. <p>Vault validates the service account token by using the TokenReview API. ⚠️ You have to bind the <code>system:auth-delegator</code> ClusterRole to the service account that is used for authentication. Please follow the <a href="https://developer.hashicorp.com/vault/docs/auth/kubernetes#configuring-kubernetes">Vault documentation</a>.</p>
  1773. <p><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>
  1774. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1775. <span class="nt">metadata</span><span class="p">:</span>
  1776. <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">vault-backend</span>
  1777. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1778. <span class="nt">spec</span><span class="p">:</span>
  1779. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1780. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1781. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  1782. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1783. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1784. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1785. <span class="w"> </span><span class="c1"># Authenticate against Vault using a Kubernetes ServiceAccount</span>
  1786. <span class="w"> </span><span class="c1"># token stored in a Secret.</span>
  1787. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/kubernetes</span>
  1788. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1789. <span class="w"> </span><span class="c1"># Path where the Kubernetes authentication backend is mounted in Vault</span>
  1790. <span class="w"> </span><span class="nt">mountPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;kubernetes&quot;</span>
  1791. <span class="w"> </span><span class="c1"># A required field containing the Vault Role to assume.</span>
  1792. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;demo&quot;</span>
  1793. <span class="w"> </span><span class="c1"># Optional service account field containing the name</span>
  1794. <span class="w"> </span><span class="c1"># of a kubernetes ServiceAccount</span>
  1795. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1796. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-sa&quot;</span>
  1797. <span class="w"> </span><span class="c1"># Optional secret field containing a Kubernetes ServiceAccount JWT</span>
  1798. <span class="w"> </span><span class="c1"># used for authenticating with Vault</span>
  1799. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1800. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1801. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault&quot;</span>
  1802. </code></pre></div>
  1803. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>serviceAccountRef</code> or in <code>secretRef</code>, if used.</p>
  1804. <h4 id="ldap-authentication">LDAP authentication</h4>
  1805. <p><a href="https://www.vaultproject.io/docs/auth/ldap">LDAP authentication</a> uses
  1806. username/password pair to get an access token. Username is stored directly in
  1807. a <code>Kind=SecretStore</code> or <code>Kind=ClusterSecretStore</code> resource, password is stored
  1808. in a <code>Kind=Secret</code> referenced by the <code>secretRef</code>.</p>
  1809. <p><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>
  1810. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1811. <span class="nt">metadata</span><span class="p">:</span>
  1812. <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">vault-backend</span>
  1813. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1814. <span class="nt">spec</span><span class="p">:</span>
  1815. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1816. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1817. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  1818. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1819. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1820. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1821. <span class="w"> </span><span class="c1"># VaultLdap authenticates with Vault using the LDAP auth mechanism</span>
  1822. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/ldap</span>
  1823. <span class="w"> </span><span class="nt">ldap</span><span class="p">:</span>
  1824. <span class="w"> </span><span class="c1"># Path where the LDAP authentication backend is mounted</span>
  1825. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ldap&quot;</span>
  1826. <span class="w"> </span><span class="c1"># LDAP username</span>
  1827. <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;username&quot;</span>
  1828. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1829. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1830. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ldap-password&quot;</span>
  1831. </code></pre></div>
  1832. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>secretRef</code> with the namespace where the secret resides.</p>
  1833. <h4 id="userpass-authentication">UserPass authentication</h4>
  1834. <p><a href="https://www.vaultproject.io/docs/auth/userpass">UserPass authentication</a> uses
  1835. username/password pair to get an access token. Username is stored directly in
  1836. a <code>Kind=SecretStore</code> or <code>Kind=ClusterSecretStore</code> resource, password is stored
  1837. in a <code>Kind=Secret</code> referenced by the <code>secretRef</code>.</p>
  1838. <p><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>
  1839. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1840. <span class="nt">metadata</span><span class="p">:</span>
  1841. <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">vault-backend</span>
  1842. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1843. <span class="nt">spec</span><span class="p">:</span>
  1844. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1845. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1846. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  1847. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1848. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1849. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1850. <span class="w"> </span><span class="c1"># VaultUserPass authenticates with Vault using the UserPass auth mechanism</span>
  1851. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/userpass</span>
  1852. <span class="w"> </span><span class="nt">userPass</span><span class="p">:</span>
  1853. <span class="w"> </span><span class="c1"># Path where the UserPass authentication backend is mounted</span>
  1854. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;userpass&quot;</span>
  1855. <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;username&quot;</span>
  1856. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1857. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1858. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;password&quot;</span>
  1859. </code></pre></div>
  1860. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>secretRef</code> with the namespace where the secret resides.</p>
  1861. <h4 id="jwtoidc-authentication">JWT/OIDC authentication</h4>
  1862. <p><a href="https://www.vaultproject.io/docs/auth/jwt">JWT/OIDC</a> uses either a
  1863. <a href="https://jwt.io/">JWT</a> token stored in a <code>Kind=Secret</code> and referenced by the
  1864. <code>secretRef</code> or a temporary Kubernetes service account token retrieved via the <code>TokenRequest</code> API. Optionally a <code>role</code> field can be defined in a <code>Kind=SecretStore</code>
  1865. or <code>Kind=ClusterSecretStore</code> resource.</p>
  1866. <p><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>
  1867. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1868. <span class="nt">metadata</span><span class="p">:</span>
  1869. <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">vault-backend</span>
  1870. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1871. <span class="nt">spec</span><span class="p">:</span>
  1872. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1873. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1874. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  1875. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1876. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1877. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1878. <span class="w"> </span><span class="c1"># VaultJwt authenticates with Vault using the JWT/OIDC auth mechanism</span>
  1879. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/jwt</span>
  1880. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  1881. <span class="w"> </span><span class="c1"># Path where the JWT authentication backend is mounted</span>
  1882. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;jwt&quot;</span>
  1883. <span class="w"> </span><span class="c1"># JWT role configured in a Vault server, optional.</span>
  1884. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-jwt-role&quot;</span>
  1885. <span class="w"> </span><span class="c1"># Retrieve JWT token from a Kubernetes secret</span>
  1886. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1887. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1888. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;jwt-token&quot;</span>
  1889. <span class="w"> </span><span class="c1"># ... or retrieve a Kubernetes service account token via the `TokenRequest` API</span>
  1890. <span class="w"> </span><span class="nt">kubernetesServiceAccountToken</span><span class="p">:</span>
  1891. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1892. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-sa&quot;</span>
  1893. <span class="w"> </span><span class="c1"># `audiences` defaults to `[&quot;vault&quot;]` it not supplied</span>
  1894. <span class="w"> </span><span class="nt">audiences</span><span class="p">:</span>
  1895. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault</span>
  1896. <span class="w"> </span><span class="c1"># `expirationSeconds` defaults to 10 minutes if not supplied</span>
  1897. <span class="w"> </span><span class="nt">expirationSeconds</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">600</span>
  1898. </code></pre></div>
  1899. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>secretRef</code> with the namespace where the secret resides.</p>
  1900. <h4 id="aws-iam-authentication">AWS IAM authentication</h4>
  1901. <p><a href="https://developer.hashicorp.com/vault/docs/auth/aws">AWS IAM</a> uses either a
  1902. set of AWS Programmatic access credentials stored in a <code>Kind=Secret</code> and referenced by the
  1903. <code>secretRef</code> or by getting the authentication token from an <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">IRSA</a> enabled service account</p>
  1904. <h4 id="tls-certificates-authentication">TLS certificates authentication</h4>
  1905. <p><a href="https://developer.hashicorp.com/vault/docs/auth/cert">TLS certificates auth method</a> allows authentication using SSL/TLS client certificates which are either signed by a CA or self-signed. SSL/TLS client certificates are defined as having an ExtKeyUsage extension with the usage set to either ClientAuth or Any.</p>
  1906. <h3 id="mutual-authentication-mtls">Mutual authentication (mTLS)</h3>
  1907. <p>Under specific compliance requirements, the Vault server can be set up to enforce mutual authentication from clients across all APIs by configuring the server with <code>tls_require_and_verify_client_cert = true</code>. This configuration differs fundamentally from the <a href="#tls-certificates-authentication">TLS certificates auth method</a>. While the TLS certificates auth method allows the issuance of a Vault token through the <code>/v1/auth/cert/login</code> API, the mTLS configuration solely focuses on TLS transport layer authentication and lacks any authorization-related capabilities. It's important to note that the Vault token must still be included in the request, following any of the supported authentication methods mentioned earlier.</p>
  1908. <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>
  1909. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1910. <span class="nt">metadata</span><span class="p">:</span>
  1911. <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">vault-backend</span>
  1912. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1913. <span class="nt">spec</span><span class="p">:</span>
  1914. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1915. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1916. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  1917. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1918. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1919. <span class="w"> </span><span class="c1"># client TLS related configuration</span>
  1920. <span class="w"> </span><span class="nt">caBundle</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;...&quot;</span>
  1921. <span class="w"> </span><span class="nt">tls</span><span class="p">:</span>
  1922. <span class="w"> </span><span class="nt">clientCert</span><span class="p">:</span>
  1923. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-cert-secret&quot;</span>
  1924. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls.crt&quot;</span>
  1925. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1926. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-cert-secret&quot;</span>
  1927. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls.key&quot;</span>
  1928. <span class="w"> </span><span class="c1"># the authentication methods are not really related to the client TLS configuration</span>
  1929. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1930. <span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
  1931. </code></pre></div>
  1932. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  1933. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  1934. <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>
  1935. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1936. <span class="nt">metadata</span><span class="p">:</span>
  1937. <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">vault-backend-aws-iam</span>
  1938. <span class="nt">spec</span><span class="p">:</span>
  1939. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1940. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1941. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://my.vault.server:8200&quot;</span>
  1942. <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">secret</span>
  1943. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1944. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;vault_namespace&gt;</span>
  1945. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1946. <span class="w"> </span><span class="nt">iam</span><span class="p">:</span>
  1947. <span class="w"> </span><span class="c1"># Path where the AWS auth method is enabled in Vault, e.g: &quot;aws/&quot;. Defaults to aws</span>
  1948. <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">aws</span>
  1949. <span class="w"> </span><span class="c1"># AWS Region. Defaults to us-east-1</span>
  1950. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-east-1</span>
  1951. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span>
  1952. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arn:aws:iam::1234567890:role/role-a</span>
  1953. <span class="w"> </span><span class="c1"># Vault Role. In vault, a role describes an identity with a set of permissions, groups, or policies you want to attach a user of the secrets engine</span>
  1954. <span class="w"> </span><span class="nt">vaultRole</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault-role-for-aws-iam-auth</span>
  1955. <span class="w"> </span><span class="c1"># Optional. Placeholder to supply header X-Vault-AWS-IAM-Server-ID. It is an additional (optional) header used by Vault IAM auth method to mitigate against different types of replay attacks. More details here: https://developer.hashicorp.com/vault/docs/auth/aws</span>
  1956. <span class="w"> </span><span class="nt">vaultAwsIamServerID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-vaultAwsIamServerID</span>
  1957. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"> </span><span class="c1">#Use this method when you have static AWS creds.</span>
  1958. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1959. <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">vault-iam-creds-secret</span>
  1960. <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">access-key</span>
  1961. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1962. <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">vault-iam-creds-secret</span>
  1963. <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">secret-access-key</span>
  1964. <span class="w"> </span><span class="nt">sessionTokenSecretRef</span><span class="p">:</span>
  1965. <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">vault-iam-creds-secret</span>
  1966. <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">secret-session-token</span>
  1967. </code></pre></div>
  1968. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>accessKeyIDSecretRef</code>, <code>secretAccessKeySecretRef</code> with the namespaces where the secrets reside.</p>
  1969. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  1970. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  1971. You must have <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection">Service Account Volume Projection</a> enabled - it is by default on EKS. See <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-technical-overview.html">EKS guide</a> on how to set up IAM roles for service accounts.</p>
  1972. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  1973. <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>
  1974. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  1975. <span class="nt">metadata</span><span class="p">:</span>
  1976. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1977. <span class="w"> </span><span class="nt">eks.amazonaws.com/role-arn</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arn:aws:iam::123456789012:role/my-irsa-enabled-role</span>
  1978. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-serviceaccount</span>
  1979. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
  1980. </code></pre></div>
  1981. <p>Reference the service account from above in the Secret Store:</p>
  1982. <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>
  1983. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1984. <span class="nt">metadata</span><span class="p">:</span>
  1985. <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">vault-backend-aws-iam</span>
  1986. <span class="nt">spec</span><span class="p">:</span>
  1987. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1988. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1989. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://my.vault.server:8200&quot;</span>
  1990. <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">secret</span>
  1991. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1992. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;vault_namespace&gt;</span>
  1993. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1994. <span class="w"> </span><span class="nt">iam</span><span class="p">:</span>
  1995. <span class="w"> </span><span class="c1"># Path where the AWS auth method is enabled in Vault, e.g: &quot;aws/&quot;. Defaults to aws</span>
  1996. <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">aws</span>
  1997. <span class="w"> </span><span class="c1"># AWS Region. Defaults to us-east-1</span>
  1998. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-east-1</span>
  1999. <span class="w"> </span><span class="c1"># Vault Role. In vault, a role describes an identity with a set of permissions, groups, or policies you want to attach a user of the secrets engine</span>
  2000. <span class="w"> </span><span class="nt">vaultRole</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault-role-for-aws-iam-auth</span>
  2001. <span class="w"> </span><span class="c1"># Optional. Placeholder to supply header X-Vault-AWS-IAM-Server-ID. It is an additional (optional) header used by Vault IAM auth method to mitigate against different types of replay attacks. More details here: https://developer.hashicorp.com/vault/docs/auth/aws</span>
  2002. <span class="w"> </span><span class="nt">vaultAwsIamServerID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-vaultAwsIamServerID</span>
  2003. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  2004. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  2005. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-serviceaccount</span><span class="w"> </span><span class="c1">#Provide service account with IRSA enabled</span>
  2006. </code></pre></div>
  2007. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  2008. <p>This is basicially a zero-configuration authentication approach that inherits the credentials from the controller's pod identity</p>
  2009. <p>This approach assumes that appropriate IRSA setup is done controller's pod (i.e. IRSA enabled IAM role is created appropriately and controller's service account is annotated appropriately with the annotation "eks.amazonaws.com/role-arn" to enable IRSA)</p>
  2010. <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>
  2011. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  2012. <span class="nt">metadata</span><span class="p">:</span>
  2013. <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">vault-backend-aws-iam</span>
  2014. <span class="nt">spec</span><span class="p">:</span>
  2015. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  2016. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  2017. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://my.vault.server:8200&quot;</span>
  2018. <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">secret</span>
  2019. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  2020. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;vault_namespace&gt;</span>
  2021. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  2022. <span class="w"> </span><span class="nt">iam</span><span class="p">:</span>
  2023. <span class="w"> </span><span class="c1"># Path where the AWS auth method is enabled in Vault, e.g: &quot;aws/&quot;. Defaults to aws</span>
  2024. <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">aws</span>
  2025. <span class="w"> </span><span class="c1"># AWS Region. Defaults to us-east-1</span>
  2026. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-east-1</span>
  2027. <span class="w"> </span><span class="c1"># Vault Role. In vault, a role describes an identity with a set of permissions, groups, or policies you want to attach a user of the secrets engine</span>
  2028. <span class="w"> </span><span class="nt">vaultRole</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault-role-for-aws-iam-auth</span>
  2029. <span class="w"> </span><span class="c1"># Optional. Placeholder to supply header X-Vault-AWS-IAM-Server-ID. It is an additional (optional) header used by Vault IAM auth method to mitigate against different types of replay attacks. More details here: https://developer.hashicorp.com/vault/docs/auth/aws</span>
  2030. <span class="w"> </span><span class="nt">vaultAwsIamServerID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-vaultAwsIamServerID</span>
  2031. </code></pre></div>
  2032. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> for <code>serviceAccountRef</code> with the namespace where the service account resides.</p>
  2033. <p><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>
  2034. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  2035. <span class="nt">metadata</span><span class="p">:</span>
  2036. <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">vault-backend</span>
  2037. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  2038. <span class="nt">spec</span><span class="p">:</span>
  2039. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  2040. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  2041. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  2042. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  2043. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  2044. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  2045. <span class="w"> </span><span class="c1"># VaultJwt authenticates with Vault using the JWT/OIDC auth mechanism</span>
  2046. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/jwt</span>
  2047. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  2048. <span class="w"> </span><span class="c1"># Path where the JWT authentication backend is mounted</span>
  2049. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;jwt&quot;</span>
  2050. <span class="w"> </span><span class="c1"># JWT role configured in a Vault server, optional.</span>
  2051. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-jwt-role&quot;</span>
  2052. <span class="w"> </span><span class="c1"># Retrieve JWT token from a Kubernetes secret</span>
  2053. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  2054. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  2055. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;jwt-token&quot;</span>
  2056. <span class="w"> </span><span class="c1"># ... or retrieve a Kubernetes service account token via the `TokenRequest` API</span>
  2057. <span class="w"> </span><span class="nt">kubernetesServiceAccountToken</span><span class="p">:</span>
  2058. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  2059. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-sa&quot;</span>
  2060. <span class="w"> </span><span class="c1"># `audiences` defaults to `[&quot;vault&quot;]` it not supplied</span>
  2061. <span class="w"> </span><span class="nt">audiences</span><span class="p">:</span>
  2062. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault</span>
  2063. <span class="w"> </span><span class="c1"># `expirationSeconds` defaults to 10 minutes if not supplied</span>
  2064. <span class="w"> </span><span class="nt">expirationSeconds</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">600</span>
  2065. </code></pre></div>
  2066. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>secretRef</code> with the namespace where the secret resides.</p>
  2067. <h3 id="pushsecret">PushSecret</h3>
  2068. <p>Vault supports PushSecret features which allow you to sync a given Kubernetes secret key into a Hashicorp vault secret. To do so, it is expected that the secret key is a valid JSON object or that the <code>property</code> attribute has been specified under the <code>remoteRef</code>.
  2069. To use PushSecret, you need to give <code>create</code>, <code>read</code> and <code>update</code> permissions to the path where you want to push secrets for both <code>data</code> and <code>metadata</code> of the secret. Use it with care!</p>
  2070. <div class="admonition note">
  2071. <p class="admonition-title">Note</p>
  2072. <p>Since Vault KV v1 API is not supported with storing secrets metadata, PushSecret will add a <code>custom_metadata</code> map to each secret in Vault that he will manage. It means pushing secret keys named <code>custom_metadata</code> is not supported with Vault KV v1.</p>
  2073. </div>
  2074. <p>Here is an example of how to set up <code>PushSecret</code>:</p>
  2075. <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>
  2076. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  2077. <span class="nt">metadata</span><span class="p">:</span>
  2078. <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">source-secret</span>
  2079. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
  2080. <span class="nt">stringData</span><span class="p">:</span>
  2081. <span class="w"> </span><span class="nt">source-key1</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{\&quot;foo\&quot;:\&quot;bar\&quot;}&quot;</span><span class="w"> </span><span class="c1"># Needs to be a JSON</span>
  2082. <span class="w"> </span><span class="nt">source-key2</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bar</span><span class="w"> </span><span class="c1"># Could be a plain string</span>
  2083. <span class="nn">---</span>
  2084. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  2085. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  2086. <span class="nt">metadata</span><span class="p">:</span>
  2087. <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">pushsecret-example</span>
  2088. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
  2089. <span class="nt">spec</span><span class="p">:</span>
  2090. <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">10s</span>
  2091. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
  2092. <span class="w"> </span><span class="p p-Indicator">-</span><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">vault-secretstore</span>
  2093. <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>
  2094. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  2095. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  2096. <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">source-secret</span>
  2097. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  2098. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  2099. <span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source-key1</span>
  2100. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  2101. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault/secret1</span>
  2102. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  2103. <span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source-key2</span>
  2104. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  2105. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault/secret2</span>
  2106. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span>
  2107. </code></pre></div>
  2108. <p>Note that in this example, we are generating two secrets in the target vault with the same structure but using different input formats.</p>
  2109. <h3 id="vault-enterprise">Vault Enterprise</h3>
  2110. <h4 id="eventual-consistency-and-performance-standby-nodes">Eventual Consistency and Performance Standby Nodes</h4>
  2111. <p>When using Vault Enterprise with <a href="https://www.vaultproject.io/docs/enterprise/consistency#performance-standby-nodes">performance standby nodes</a>,
  2112. any follower can handle read requests immediately after the provider has
  2113. authenticated. Since Vault becomes eventually consistent in this mode, these
  2114. requests can fail if the login has not yet propagated to each server's local
  2115. state.</p>
  2116. <p>Below are two different solutions to this scenario. You'll need to review them
  2117. and pick the best fit for your environment and Vault configuration.</p>
  2118. <h4 id="vault-namespaces">Vault Namespaces</h4>
  2119. <p><a href="https://www.vaultproject.io/docs/enterprise/namespaces">Vault namespaces</a> are an enterprise feature that support multi-tenancy. You can specify a vault namespace using the <code>namespace</code> property when you define a SecretStore:</p>
  2120. <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>
  2121. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  2122. <span class="nt">metadata</span><span class="p">:</span>
  2123. <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">vault-backend</span>
  2124. <span class="nt">spec</span><span class="p">:</span>
  2125. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  2126. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  2127. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://my.vault.server:8200&quot;</span>
  2128. <span class="w"> </span><span class="c1"># See https://www.vaultproject.io/docs/enterprise/namespaces</span>
  2129. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ns1&quot;</span>
  2130. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  2131. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  2132. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  2133. <span class="w"> </span><span class="c1"># ...</span>
  2134. </code></pre></div>
  2135. <h5 id="authenticating-into-a-different-namespace">Authenticating into a different namespace</h5>
  2136. <p>In some situations your authentication backend may be in one namespace, and your secrets in another. You can authenticate into one namespace, and use that token against another, by setting <code>provider.vault.namespace</code> and <code>provider.vault.auth.namespace</code> to different values. If <code>provider.vault.auth.namespace</code> is unset but <code>provider.vault.namespace</code> is, it will default to the <code>provider.vault.namespace</code> value.</p>
  2137. <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>
  2138. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  2139. <span class="nt">metadata</span><span class="p">:</span>
  2140. <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">vault-backend</span>
  2141. <span class="nt">spec</span><span class="p">:</span>
  2142. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  2143. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  2144. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://my.vault.server:8200&quot;</span>
  2145. <span class="w"> </span><span class="c1"># See https://www.vaultproject.io/docs/enterprise/namespaces</span>
  2146. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;app-team&quot;</span>
  2147. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  2148. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  2149. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  2150. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;kubernetes-team&quot;</span>
  2151. <span class="w"> </span><span class="c1"># ...</span>
  2152. </code></pre></div>
  2153. <h4 id="read-your-writes">Read Your Writes</h4>
  2154. <p>Vault 1.10.0 and later encodes information in the token to detect the case
  2155. when a server is behind. If a Vault server does not have information about
  2156. the provided token, <a href="https://www.vaultproject.io/docs/faq/ssct#q-is-there-anything-else-i-need-to-consider-to-achieve-consistency-besides-upgrading-to-vault-1-10">Vault returns a 412 error</a>
  2157. so clients know to retry.</p>
  2158. <p>A method supported in versions Vault 1.7 and later is to utilize the
  2159. <code>X-Vault-Index</code> header returned on all write requests (including logins).
  2160. Passing this header back on subsequent requests instructs the Vault client
  2161. to retry the request until the server has an index greater than or equal
  2162. to that returned with the last write. Obviously though, this has a performance
  2163. hit because the read is blocked until the follower's local state has caught up.</p>
  2164. <h4 id="forward-inconsistent">Forward Inconsistent</h4>
  2165. <p>Vault also supports proxying inconsistent requests to the current cluster leader
  2166. for immediate read-after-write consistency.</p>
  2167. <p>Vault 1.10.0 and later <a href="https://www.vaultproject.io/docs/faq/ssct#q-is-there-a-new-configuration-that-this-feature-introduces">support a replication configuration</a> that detects when forwarding should occur and does it transparently to the client.</p>
  2168. <p>In Vault 1.7 forwarding can be achieved by setting the <code>X-Vault-Inconsistent</code>
  2169. header to <code>forward-active-node</code>. By default, this behavior is disabled and must
  2170. be explicitly enabled in the server's <a href="https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header">replication configuration</a>.</p>
  2171. </article>
  2172. </div>
  2173. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  2174. </div>
  2175. </main>
  2176. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  2177. <footer class="md-footer">
  2178. <div class="md-footer-meta md-typeset">
  2179. <div class="md-footer-meta__inner md-grid">
  2180. <div class="md-copyright">
  2181. <div class="md-copyright__highlight">
  2182. &copy; 2024 The external-secrets Authors.<br/>
  2183. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  2184. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  2185. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  2186. </div>
  2187. Made with
  2188. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  2189. Material for MkDocs
  2190. </a>
  2191. </div>
  2192. </div>
  2193. </div>
  2194. </footer>
  2195. </div>
  2196. <div class="md-dialog" data-md-component="dialog">
  2197. <div class="md-dialog__inner md-typeset"></div>
  2198. </div>
  2199. <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>
  2200. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  2201. </body>
  2202. </html>