| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566 |
- <!doctype html>
- <html lang="en" class="no-js">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1">
-
-
-
-
- <link rel="prev" href="../google-secrets-manager/">
-
-
- <link rel="next" href="../kubernetes/">
-
-
- <link rel="icon" href="../../pictures/eso-round-logo.svg">
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
-
-
-
- <title>HashiCorp Vault - External Secrets Operator</title>
-
-
-
- <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.min.css">
-
-
- <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
-
-
-
-
-
-
-
-
-
-
- <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
- <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">
- <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
-
-
-
- <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>
-
-
-
-
-
- <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>
-
- <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
-
-
-
-
- </head>
-
-
-
-
-
-
-
-
-
- <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
-
-
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" for="__drawer"></label>
- <div data-md-component="skip">
-
-
- <a href="#hashicorp-vault" class="md-skip">
- Skip to content
- </a>
-
- </div>
- <div data-md-component="announce">
-
- </div>
-
- <div data-md-color-scheme="default" data-md-component="outdated" hidden>
-
- <aside class="md-banner md-banner--warning">
- <div class="md-banner__inner md-grid md-typeset">
-
- You're not viewing the latest version.
- <a href="../../..">
- <strong>Click here to go to latest.</strong>
- </a>
- </div>
- <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
- </aside>
-
- </div>
-
-
-
- <header class="md-header" data-md-component="header">
- <nav class="md-header__inner md-grid" aria-label="Header">
- <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
- <img src="../../pictures/eso-round-logo.svg" alt="logo">
- </a>
- <label class="md-header__button md-icon" for="__drawer">
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
- </label>
- <div class="md-header__title" data-md-component="header-title">
- <div class="md-header__ellipsis">
- <div class="md-header__topic">
- <span class="md-ellipsis">
- External Secrets Operator
- </span>
- </div>
- <div class="md-header__topic" data-md-component="header-topic">
- <span class="md-ellipsis">
-
- HashiCorp Vault
-
- </span>
- </div>
- </div>
- </div>
-
-
- <form class="md-header__option" data-md-component="palette">
-
-
-
-
- <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">
-
- <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
- <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>
- </label>
-
-
-
-
-
- <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">
-
- <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
- <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>
- </label>
-
-
- </form>
-
-
-
- <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>
-
-
-
- <label class="md-header__button md-icon" for="__search">
-
- <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>
- </label>
- <div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <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>
- <label class="md-search__icon md-icon" for="__search">
-
- <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>
-
- <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>
- </label>
- <nav class="md-search__options" aria-label="Search">
-
- <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-
- <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>
- </button>
- </nav>
-
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
- <div class="md-search-result" data-md-component="search-result">
- <div class="md-search-result__meta">
- Initializing search
- </div>
- <ol class="md-search-result__list" role="presentation"></ol>
- </div>
- </div>
- </div>
- </div>
- </div>
-
-
- <div class="md-header__source">
- <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <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>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- </nav>
-
- </header>
-
- <div class="md-container" data-md-component="container">
-
-
-
-
-
- <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
- <div class="md-grid">
- <ul class="md-tabs__list">
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../.." class="md-tabs__link">
-
-
-
-
- Introduction
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../api/components/" class="md-tabs__link">
-
-
-
-
- API
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../guides/introduction/" class="md-tabs__link">
-
-
-
-
- Guides
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item md-tabs__item--active">
- <a href="../aws-secrets-manager/" class="md-tabs__link">
-
-
-
-
- Provider
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
-
-
-
-
- Examples
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../contributing/devguide/" class="md-tabs__link">
-
-
-
-
- Community
- </a>
- </li>
-
-
-
-
-
- </ul>
- </div>
- </nav>
-
-
-
- <main class="md-main" data-md-component="main">
- <div class="md-main__inner md-grid">
-
-
-
- <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
-
- <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
- <label class="md-nav__title" for="__drawer">
- <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
- <img src="../../pictures/eso-round-logo.svg" alt="logo">
- </a>
- External Secrets Operator
- </label>
-
- <div class="md-nav__source">
- <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <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>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
-
-
-
- <div class="md-nav__link md-nav__container">
- <a href="../.." class="md-nav__link ">
-
-
- <span class="md-ellipsis">
- Introduction
- </span>
-
- </a>
-
-
- <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- </div>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_1">
- <span class="md-nav__icon md-icon"></span>
- Introduction
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/overview/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Overview
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/getting-started/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Getting started
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/faq/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- FAQ
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/stability-support/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Stability and Support
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/deprecation-policy/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Deprecation Policy
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-
-
- <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- API
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_2">
- <span class="md-nav__icon md-icon"></span>
- API
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/components/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Components
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
-
-
- <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- Core Resources
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_2_2">
- <span class="md-nav__icon md-icon"></span>
- Core Resources
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/externalsecret/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- ExternalSecret
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/secretstore/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- SecretStore
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/clustersecretstore/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- ClusterSecretStore
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/clusterexternalsecret/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- ClusterExternalSecret
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/pushsecret/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- PushSecret
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
-
-
-
- <div class="md-nav__link md-nav__container">
- <a href="../../api/generator/" class="md-nav__link ">
-
-
- <span class="md-ellipsis">
- Generators
- </span>
-
- </a>
-
-
- <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- </div>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_2_3">
- <span class="md-nav__icon md-icon"></span>
- Generators
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/generator/acr/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Azure Container Registry
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/generator/ecr/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- AWS Elastic Container Registry
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/generator/gcr/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Google Container Registry
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/generator/vault/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Vault Dynamic Secret
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/generator/password/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Password
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/generator/fake/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Fake
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/generator/webhook/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Webhook
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/generator/github/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Github
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/generator/uuid/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- UUID
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
-
-
- <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- Reference Docs
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_2_4">
- <span class="md-nav__icon md-icon"></span>
- Reference Docs
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/spec/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- API specification
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/controller-options/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Controller Options
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../api/metrics/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Metrics
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-
-
- <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- Guides
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_3">
- <span class="md-nav__icon md-icon"></span>
- Guides
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/introduction/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Introduction
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
-
-
- <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- External Secrets
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_3_2">
- <span class="md-nav__icon md-icon"></span>
- External Secrets
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Extract structured data
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/getallsecrets/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Find Secrets by Name or Metadata
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Rewriting Keys
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
-
-
- <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- Advanced Templating
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_3_2_4">
- <span class="md-nav__icon md-icon"></span>
- Advanced Templating
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/templating/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- v2
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/templating-v1/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- v1
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Kubernetes Secret Types
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Lifecycle: ownership & deletion
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/decoding-strategy/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Decoding Strategies
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/controller-class/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Controller Classes
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/generator/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Generators
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/pushsecrets/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Push Secrets
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
-
-
- <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- Operations
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_3_5">
- <span class="md-nav__icon md-icon"></span>
- Operations
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/multi-tenancy/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Multi Tenancy
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/security-best-practices/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Security Best Practices
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/threat-model/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Threat Model
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/v1beta1/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Upgrading to v1beta1
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/using-latest-image/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Using Latest Image
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/disable-cluster-features/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Disable Cluster Features
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
-
-
- <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
-
-
- <span class="md-ellipsis">
- Provider
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
- <label class="md-nav__title" for="__nav_4">
- <span class="md-nav__icon md-icon"></span>
- Provider
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../aws-secrets-manager/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- AWS Secrets Manager
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../aws-parameter-store/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- AWS Parameter Store
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../azure-key-vault/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Azure Key Vault
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../beyondtrust/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- BeyondTrust
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../bitwarden-secrets-manager/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Bitwarden Secrets Manager
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../chef/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Chef
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../conjur/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- CyberArk Conjur
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../device42/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Device42
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../google-secrets-manager/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Google Cloud Secret Manager
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
-
-
-
- <label class="md-nav__link md-nav__link--active" for="__toc">
-
-
- <span class="md-ellipsis">
- HashiCorp Vault
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <a href="./" class="md-nav__link md-nav__link--active">
-
-
- <span class="md-ellipsis">
- HashiCorp Vault
- </span>
-
- </a>
-
-
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-
-
-
-
- <label class="md-nav__title" for="__toc">
- <span class="md-nav__icon md-icon"></span>
- Table of contents
- </label>
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-
- <li class="md-nav__item">
- <a href="#hashicorp-vault" class="md-nav__link">
- <span class="md-ellipsis">
- Hashicorp Vault
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Hashicorp Vault">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#example" class="md-nav__link">
- <span class="md-ellipsis">
- Example
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Example">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#fetching-raw-values" class="md-nav__link">
- <span class="md-ellipsis">
- Fetching Raw Values
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#nested-values" class="md-nav__link">
- <span class="md-ellipsis">
- Nested Values
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#multiple-nested-values" class="md-nav__link">
- <span class="md-ellipsis">
- Multiple nested Values
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#getting-multiple-secrets" class="md-nav__link">
- <span class="md-ellipsis">
- Getting multiple secrets
- </span>
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#authentication" class="md-nav__link">
- <span class="md-ellipsis">
- Authentication
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Authentication">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#token-based-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- Token-based authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#approle-authentication-example" class="md-nav__link">
- <span class="md-ellipsis">
- AppRole authentication example
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#kubernetes-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- Kubernetes authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#ldap-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- LDAP authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#userpass-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- UserPass authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#jwtoidc-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- JWT/OIDC authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#aws-iam-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- AWS IAM authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#tls-certificates-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- TLS certificates authentication
- </span>
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#mutual-authentication-mtls" class="md-nav__link">
- <span class="md-ellipsis">
- Mutual authentication (mTLS)
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#access-key-id-secret-access-key" class="md-nav__link">
- <span class="md-ellipsis">
- Access Key ID & Secret Access Key
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#eks-service-account-credentials" class="md-nav__link">
- <span class="md-ellipsis">
- EKS Service Account credentials
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#controllers-pod-identity" class="md-nav__link">
- <span class="md-ellipsis">
- Controller's Pod Identity
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#pushsecret" class="md-nav__link">
- <span class="md-ellipsis">
- PushSecret
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#vault-enterprise" class="md-nav__link">
- <span class="md-ellipsis">
- Vault Enterprise
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Vault Enterprise">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#eventual-consistency-and-performance-standby-nodes" class="md-nav__link">
- <span class="md-ellipsis">
- Eventual Consistency and Performance Standby Nodes
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#vault-namespaces" class="md-nav__link">
- <span class="md-ellipsis">
- Vault Namespaces
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Vault Namespaces">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#authenticating-into-a-different-namespace" class="md-nav__link">
- <span class="md-ellipsis">
- Authenticating into a different namespace
- </span>
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#read-your-writes" class="md-nav__link">
- <span class="md-ellipsis">
- Read Your Writes
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#forward-inconsistent" class="md-nav__link">
- <span class="md-ellipsis">
- Forward Inconsistent
- </span>
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
-
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../kubernetes/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Kubernetes
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../ibm-secrets-manager/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- IBM Secrets Manager
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../akeyless/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Akeyless
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../yandex-certificate-manager/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Yandex Certificate Manager
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../yandex-lockbox/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Yandex Lockbox
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../alibaba/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Alibaba Cloud
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../gitlab-variables/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- GitLab Variables
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../oracle-vault/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Oracle Vault
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../1password-automation/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- 1Password Secrets Automation
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../webhook/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Webhook
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../fake/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Fake
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../senhasegura-dsm/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- senhasegura DevOps Secrets Management (DSM)
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../doppler/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Doppler
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../keeper-security/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Keeper Security
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../cloak/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Cloak End 2 End Encrypted Secrets
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../scaleway/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Scaleway
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../delinea/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Delinea
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../secretserver/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Secret Server
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../passbolt/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Passbolt
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../pulumi/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Pulumi ESC
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../onboardbase/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Onboardbase
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider-passworddepot/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Password Depot
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../fortanix/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Fortanix
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../infisical/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Infisical
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../previder/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Previder
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
-
-
- <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- Examples
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_5">
- <span class="md-nav__icon md-icon"></span>
- Examples
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- FluxCD
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Anchore Engine
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Jenkins
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/bitwarden/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- BitWarden
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
-
-
- <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- Community
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_6">
- <span class="md-nav__icon md-icon"></span>
- Community
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
-
-
- <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- Contributing
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_6_1">
- <span class="md-nav__icon md-icon"></span>
- Contributing
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/devguide/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Developer guide
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/process/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Contributing Process
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/release/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Release Process
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/coc/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Code of Conduct
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/roadmap/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Roadmap
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
-
-
- <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
-
-
- <span class="md-ellipsis">
- External Resources
- </span>
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_6_2">
- <span class="md-nav__icon md-icon"></span>
- External Resources
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-talks/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Talks
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-demos/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Demos
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-blogs/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Blogs
- </span>
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-tools/" class="md-nav__link">
-
-
- <span class="md-ellipsis">
- Tools
- </span>
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
- </ul>
- </nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-
-
-
-
- <label class="md-nav__title" for="__toc">
- <span class="md-nav__icon md-icon"></span>
- Table of contents
- </label>
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-
- <li class="md-nav__item">
- <a href="#hashicorp-vault" class="md-nav__link">
- <span class="md-ellipsis">
- Hashicorp Vault
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Hashicorp Vault">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#example" class="md-nav__link">
- <span class="md-ellipsis">
- Example
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Example">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#fetching-raw-values" class="md-nav__link">
- <span class="md-ellipsis">
- Fetching Raw Values
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#nested-values" class="md-nav__link">
- <span class="md-ellipsis">
- Nested Values
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#multiple-nested-values" class="md-nav__link">
- <span class="md-ellipsis">
- Multiple nested Values
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#getting-multiple-secrets" class="md-nav__link">
- <span class="md-ellipsis">
- Getting multiple secrets
- </span>
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#authentication" class="md-nav__link">
- <span class="md-ellipsis">
- Authentication
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Authentication">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#token-based-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- Token-based authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#approle-authentication-example" class="md-nav__link">
- <span class="md-ellipsis">
- AppRole authentication example
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#kubernetes-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- Kubernetes authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#ldap-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- LDAP authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#userpass-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- UserPass authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#jwtoidc-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- JWT/OIDC authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#aws-iam-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- AWS IAM authentication
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#tls-certificates-authentication" class="md-nav__link">
- <span class="md-ellipsis">
- TLS certificates authentication
- </span>
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#mutual-authentication-mtls" class="md-nav__link">
- <span class="md-ellipsis">
- Mutual authentication (mTLS)
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#access-key-id-secret-access-key" class="md-nav__link">
- <span class="md-ellipsis">
- Access Key ID & Secret Access Key
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#eks-service-account-credentials" class="md-nav__link">
- <span class="md-ellipsis">
- EKS Service Account credentials
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#controllers-pod-identity" class="md-nav__link">
- <span class="md-ellipsis">
- Controller's Pod Identity
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#pushsecret" class="md-nav__link">
- <span class="md-ellipsis">
- PushSecret
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#vault-enterprise" class="md-nav__link">
- <span class="md-ellipsis">
- Vault Enterprise
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Vault Enterprise">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#eventual-consistency-and-performance-standby-nodes" class="md-nav__link">
- <span class="md-ellipsis">
- Eventual Consistency and Performance Standby Nodes
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#vault-namespaces" class="md-nav__link">
- <span class="md-ellipsis">
- Vault Namespaces
- </span>
- </a>
-
- <nav class="md-nav" aria-label="Vault Namespaces">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#authenticating-into-a-different-namespace" class="md-nav__link">
- <span class="md-ellipsis">
- Authenticating into a different namespace
- </span>
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#read-your-writes" class="md-nav__link">
- <span class="md-ellipsis">
- Read Your Writes
- </span>
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#forward-inconsistent" class="md-nav__link">
- <span class="md-ellipsis">
- Forward Inconsistent
- </span>
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
-
- </nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-content" data-md-component="content">
- <article class="md-content__inner md-typeset">
-
-
-
-
- <h1>HashiCorp Vault</h1>
- <p><img alt="HCP Vault" src="../../pictures/diagrams-provider-vault.png" /></p>
- <h2 id="hashicorp-vault">Hashicorp Vault</h2>
- <p>External Secrets Operator integrates with <a href="https://www.vaultproject.io/">HashiCorp Vault</a> for secret management.</p>
- <p>The <a href="https://www.vaultproject.io/docs/secrets/kv">KV Secrets Engine</a> is the only
- one supported by this provider. For other secrets engines, please refer to the
- <a href="../../api/generator/vault/">Vault Generator</a>.</p>
- <h3 id="example">Example</h3>
- <p>First, create a SecretStore with a vault backend. For the sake of simplicity we'll use a static token <code>root</code>:</p>
- <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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"http://my.vault.server:8200"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="c1"># Version is the Vault KV secret engine version.</span>
- <span class="w"> </span><span class="c1"># This can be either "v1" or "v2", defaults to "v2"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># points to a secret that contains a vault token</span>
- <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/token</span>
- <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"vault-token"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"token"</span>
- <span class="nn">---</span>
- <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
- <span class="nt">metadata</span><span class="p">:</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-token</span>
- <span class="nt">data</span><span class="p">:</span>
- <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"># "root"</span>
- </code></pre></div>
- <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>
- <p>Then create a simple k/v pair at path <code>secret/foo</code>:</p>
- <div class="highlight"><pre><span></span><code>vault kv put secret/foo my-value=s3cr3t
- </code></pre></div>
- <p>Can check kv version using following and check for <code>Options</code> column, it should indicate [version:2]:</p>
- <div class="highlight"><pre><span></span><code>vault secrets list -detailed
- </code></pre></div>
- <p>If you are using version: 1, just remember to update your SecretStore manifest appropriately</p>
- <p>Now create a ExternalSecret that uses the above SecretStore:</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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
- <span class="nt">metadata</span><span class="p">:</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-example</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">"15s"</span>
- <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</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-backend</span>
- <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="w"> </span><span class="nt">target</span><span class="p">:</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">example-sync</span>
- <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
- <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>
- <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span>
- <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>
- <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the labels in JSON format</span>
- <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>
- <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
- <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>
- <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>
- <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific label (dev) from the source secret</span>
- <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>
- <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
- <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>
- <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>
- <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>
- <span class="nn">---</span>
- <span class="c1"># That will automatically create a Kubernetes Secret with:</span>
- <span class="c1"># apiVersion: v1</span>
- <span class="c1"># kind: Secret</span>
- <span class="c1"># metadata:</span>
- <span class="c1"># name: example-sync</span>
- <span class="c1"># data:</span>
- <span class="c1"># foobar: czNjcjN0</span>
- </code></pre></div>
- <p>Keep in mind that fetching the labels with <code>metadataPolicy: Fetch</code> only works with KV sercrets engine version v2.</p>
- <h4 id="fetching-raw-values">Fetching Raw Values</h4>
- <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>
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
- <span class="nt">metadata</span><span class="p">:</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-example</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># ...</span>
- <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
- <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>
- <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/dev/package.json</span>
- </code></pre></div>
- <h4 id="nested-values">Nested Values</h4>
- <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>
- <p>Given the following secret - assume its path is <code>/dev/config</code>:
- <div class="highlight"><pre><span></span><code><span class="p">{</span>
- <span class="w"> </span><span class="nt">"foo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
- <span class="w"> </span><span class="nt">"nested"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
- <span class="w"> </span><span class="nt">"bar"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mysecret"</span>
- <span class="w"> </span><span class="p">}</span>
- <span class="w"> </span><span class="p">}</span>
- <span class="p">}</span>
- </code></pre></div></p>
- <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.
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
- <span class="nt">metadata</span><span class="p">:</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-example</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># ...</span>
- <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
- <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>
- <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/dev/config</span>
- <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>
- <span class="nn">---</span>
- <span class="c1"># creates a secret with:</span>
- <span class="c1"># foobar=mysecret</span>
- </code></pre></div></p>
- <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>
- <h4 id="multiple-nested-values">Multiple nested Values</h4>
- <p>You can extract multiple keys from a nested secret using <code>dataFrom</code>.</p>
- <p>Given the following secret - assume its path is <code>/dev/config</code>:
- <div class="highlight"><pre><span></span><code><span class="p">{</span>
- <span class="w"> </span><span class="nt">"foo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
- <span class="w"> </span><span class="nt">"nested"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
- <span class="w"> </span><span class="nt">"bar"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mysecret"</span><span class="p">,</span>
- <span class="w"> </span><span class="nt">"baz"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bang"</span>
- <span class="w"> </span><span class="p">}</span>
- <span class="w"> </span><span class="p">}</span>
- <span class="p">}</span>
- </code></pre></div></p>
- <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.
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
- <span class="nt">metadata</span><span class="p">:</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-example</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># ...</span>
- <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
- <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/dev/config</span>
- <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>
- </code></pre></div></p>
- <p>That results in a secret with these values:
- <div class="highlight"><pre><span></span><code>bar=mysecret
- baz=bang
- </code></pre></div></p>
- <h4 id="getting-multiple-secrets">Getting multiple secrets</h4>
- <p>You can extract multiple secrets from Hashicorp vault by using <code>dataFrom.Find</code></p>
- <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>
- <div class="admonition warning">
- <p class="admonition-title">Warning</p>
- <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>
- </div>
- <p>Given the following secret - assume its path is <code>/dev/config</code>:
- <div class="highlight"><pre><span></span><code><span class="p">{</span>
- <span class="w"> </span><span class="nt">"foo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
- <span class="w"> </span><span class="nt">"nested"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
- <span class="w"> </span><span class="nt">"bar"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mysecret"</span><span class="p">,</span>
- <span class="w"> </span><span class="nt">"baz"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bang"</span>
- <span class="w"> </span><span class="p">}</span>
- <span class="w"> </span><span class="p">}</span>
- <span class="p">}</span>
- </code></pre></div></p>
- <p>Also consider the following secret has the following <code>custom_metadata</code>:
- <div class="highlight"><pre><span></span><code><span class="p">{</span>
- <span class="w"> </span><span class="nt">"environment"</span><span class="p">:</span><span class="w"> </span><span class="s2">"dev"</span><span class="p">,</span>
- <span class="w"> </span><span class="nt">"component"</span><span class="p">:</span><span class="w"> </span><span class="s2">"app-1"</span>
- <span class="p">}</span>
- </code></pre></div></p>
- <p>It is possible to find this secret by all the following possibilities:
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
- <span class="nt">metadata</span><span class="p">:</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-example</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># ...</span>
- <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
- <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 'dev' in it (including paths)</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
- <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>
- <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>
- <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
- <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>
- </code></pre></div>
- will generate a secret with:
- <div class="highlight"><pre><span></span><code><span class="p">{</span>
- <span class="w"> </span><span class="nt">"dev_config"</span><span class="p">:</span><span class="s2">"{\"foo\":{\"nested\":{\"bar\":\"mysecret\",\"baz\":\"bang\"}}}"</span>
- <span class="p">}</span>
- </code></pre></div></p>
- <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:
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
- <span class="nt">metadata</span><span class="p">:</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-example</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># ...</span>
- <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
- <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>
- <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>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">".*"</span>
- <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>
- <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>
- <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
- <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>
- </code></pre></div>
- Will generate a secret with:
- <div class="highlight"><pre><span></span><code><span class="p">{</span>
- <span class="w"> </span><span class="nt">"config"</span><span class="p">:</span><span class="s2">"{\"foo\": {\"nested\": {\"bar\": \"mysecret\",\"baz\": \"bang\"}}}"</span>
- <span class="p">}</span>
- </code></pre></div></p>
- <h3 id="authentication">Authentication</h3>
- <p>We support five different modes for authentication:
- <a href="https://www.vaultproject.io/docs/auth/token">token-based</a>,
- <a href="https://www.vaultproject.io/docs/auth/approle">appRole</a>,
- <a href="https://www.vaultproject.io/docs/auth/kubernetes">kubernetes-native</a>,
- <a href="https://www.vaultproject.io/docs/auth/ldap">ldap</a>,
- <a href="https://www.vaultproject.io/docs/auth/userpass">userPass</a>,
- <a href="https://www.vaultproject.io/docs/auth/jwt">jwt/oidc</a>,
- <a href="https://developer.hashicorp.com/vault/docs/auth/aws">awsAuth</a> and
- <a href="https://developer.hashicorp.com/vault/docs/auth/cert">tlsCert</a>, each one comes with it's own
- trade-offs. Depending on the authentication method you need to adapt your environment.</p>
- <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>
- <h4 id="token-based-authentication">Token-based authentication</h4>
- <p>A static token is stored in a <code>Kind=Secret</code> and is used to authenticate with vault.</p>
- <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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <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>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"https://vault.acme.org"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># points to a secret that contains a vault token</span>
- <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/token</span>
- <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-secret"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"vault-token"</span>
- </code></pre></div>
- <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>
- <h4 id="approle-authentication-example">AppRole authentication example</h4>
- <p><a href="https://www.vaultproject.io/docs/auth/approle">AppRole authentication</a> reads the secret id from a
- <code>Kind=Secret</code> and uses the specified <code>roleId</code> to aquire a temporary token to fetch secrets.</p>
- <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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <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>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"https://vault.acme.org"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># VaultAppRole authenticates with Vault using the</span>
- <span class="w"> </span><span class="c1"># App Role auth mechanism</span>
- <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/approle</span>
- <span class="w"> </span><span class="nt">appRole</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Path where the App Role authentication backend is mounted</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"approle"</span>
- <span class="w"> </span><span class="c1"># RoleID configured in the App Role authentication backend</span>
- <span class="w"> </span><span class="nt">roleId</span><span class="p">:</span><span class="w"> </span><span class="s">"db02de05-fa39-4855-059b-67221c5c2f63"</span>
- <span class="w"> </span><span class="c1"># Reference to a key in a K8 Secret that contains the App Role SecretId</span>
- <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-secret"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"secret-id"</span>
- </code></pre></div>
- <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>
- <h4 id="kubernetes-authentication">Kubernetes authentication</h4>
- <p><a href="https://www.vaultproject.io/docs/auth/kubernetes">Kubernetes-native authentication</a> has three
- options of obtaining credentials for vault:</p>
- <ol>
- <li>by using a service account jwt referenced in <code>serviceAccountRef</code></li>
- <li>by using the jwt from a <code>Kind=Secret</code> referenced by the <code>secretRef</code></li>
- <li>by using transient credentials from the mounted service account token within the
- external-secrets operator</li>
- </ol>
- <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>
- <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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <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>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"https://vault.acme.org"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Authenticate against Vault using a Kubernetes ServiceAccount</span>
- <span class="w"> </span><span class="c1"># token stored in a Secret.</span>
- <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/kubernetes</span>
- <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Path where the Kubernetes authentication backend is mounted in Vault</span>
- <span class="w"> </span><span class="nt">mountPath</span><span class="p">:</span><span class="w"> </span><span class="s">"kubernetes"</span>
- <span class="w"> </span><span class="c1"># A required field containing the Vault Role to assume.</span>
- <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">"demo"</span>
- <span class="w"> </span><span class="c1"># Optional service account field containing the name</span>
- <span class="w"> </span><span class="c1"># of a kubernetes ServiceAccount</span>
- <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-sa"</span>
- <span class="w"> </span><span class="c1"># Optional secret field containing a Kubernetes ServiceAccount JWT</span>
- <span class="w"> </span><span class="c1"># used for authenticating with Vault</span>
- <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-secret"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"vault"</span>
- </code></pre></div>
- <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>
- <h4 id="ldap-authentication">LDAP authentication</h4>
- <p><a href="https://www.vaultproject.io/docs/auth/ldap">LDAP authentication</a> uses
- username/password pair to get an access token. Username is stored directly in
- a <code>Kind=SecretStore</code> or <code>Kind=ClusterSecretStore</code> resource, password is stored
- in a <code>Kind=Secret</code> referenced by the <code>secretRef</code>.</p>
- <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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <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>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"https://vault.acme.org"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># VaultLdap authenticates with Vault using the LDAP auth mechanism</span>
- <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/ldap</span>
- <span class="w"> </span><span class="nt">ldap</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Path where the LDAP authentication backend is mounted</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ldap"</span>
- <span class="w"> </span><span class="c1"># LDAP username</span>
- <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"username"</span>
- <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-secret"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"ldap-password"</span>
- </code></pre></div>
- <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>
- <h4 id="userpass-authentication">UserPass authentication</h4>
- <p><a href="https://www.vaultproject.io/docs/auth/userpass">UserPass authentication</a> uses
- username/password pair to get an access token. Username is stored directly in
- a <code>Kind=SecretStore</code> or <code>Kind=ClusterSecretStore</code> resource, password is stored
- in a <code>Kind=Secret</code> referenced by the <code>secretRef</code>.</p>
- <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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <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>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"https://vault.acme.org"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># VaultUserPass authenticates with Vault using the UserPass auth mechanism</span>
- <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/userpass</span>
- <span class="w"> </span><span class="nt">userPass</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Path where the UserPass authentication backend is mounted</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"userpass"</span>
- <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"username"</span>
- <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-secret"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"password"</span>
- </code></pre></div>
- <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>
- <h4 id="jwtoidc-authentication">JWT/OIDC authentication</h4>
- <p><a href="https://www.vaultproject.io/docs/auth/jwt">JWT/OIDC</a> uses either a
- <a href="https://jwt.io/">JWT</a> token stored in a <code>Kind=Secret</code> and referenced by the
- <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>
- or <code>Kind=ClusterSecretStore</code> resource.</p>
- <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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <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>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"https://vault.acme.org"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># VaultJwt authenticates with Vault using the JWT/OIDC auth mechanism</span>
- <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/jwt</span>
- <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Path where the JWT authentication backend is mounted</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"jwt"</span>
- <span class="w"> </span><span class="c1"># JWT role configured in a Vault server, optional.</span>
- <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">"vault-jwt-role"</span>
- <span class="w"> </span><span class="c1"># Retrieve JWT token from a Kubernetes secret</span>
- <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-secret"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"jwt-token"</span>
- <span class="w"> </span><span class="c1"># ... or retrieve a Kubernetes service account token via the `TokenRequest` API</span>
- <span class="w"> </span><span class="nt">kubernetesServiceAccountToken</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-sa"</span>
- <span class="w"> </span><span class="c1"># `audiences` defaults to `["vault"]` it not supplied</span>
- <span class="w"> </span><span class="nt">audiences</span><span class="p">:</span>
- <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault</span>
- <span class="w"> </span><span class="c1"># `expirationSeconds` defaults to 10 minutes if not supplied</span>
- <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>
- </code></pre></div>
- <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>
- <h4 id="aws-iam-authentication">AWS IAM authentication</h4>
- <p><a href="https://developer.hashicorp.com/vault/docs/auth/aws">AWS IAM</a> uses either a
- set of AWS Programmatic access credentials stored in a <code>Kind=Secret</code> and referenced by the
- <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>
- <h4 id="tls-certificates-authentication">TLS certificates authentication</h4>
- <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>
- <h3 id="mutual-authentication-mtls">Mutual authentication (mTLS)</h3>
- <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>
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <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>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"https://vault.acme.org"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="c1"># client TLS related configuration</span>
- <span class="w"> </span><span class="nt">caBundle</span><span class="p">:</span><span class="w"> </span><span class="s">"..."</span>
- <span class="w"> </span><span class="nt">tls</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">clientCert</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-cert-secret"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"tls.crt"</span>
- <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-cert-secret"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"tls.key"</span>
- <span class="w"> </span><span class="c1"># the authentication methods are not really related to the client TLS configuration</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
- </code></pre></div>
- <h3 id="access-key-id-secret-access-key">Access Key ID & Secret Access Key</h3>
- <p>You can store Access Key ID & Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend-aws-iam</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"http://my.vault.server:8200"</span>
- <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>
- <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>
- <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"><vault_namespace></span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">iam</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Path where the AWS auth method is enabled in Vault, e.g: "aws/". Defaults to aws</span>
- <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>
- <span class="w"> </span><span class="c1"># AWS Region. Defaults to us-east-1</span>
- <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>
- <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</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-iam-creds-secret</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access-key</span>
- <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</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-iam-creds-secret</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
- <span class="w"> </span><span class="nt">sessionTokenSecretRef</span><span class="p">:</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-iam-creds-secret</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-session-token</span>
- </code></pre></div>
- <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>
- <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
- <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
- 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>
- <p>The big advantage of this approach is that ESO runs without any credentials.</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">v1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
- <span class="nt">metadata</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
- <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>
- <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="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
- </code></pre></div>
- <p>Reference the service account from above in the Secret Store:</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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend-aws-iam</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"http://my.vault.server:8200"</span>
- <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>
- <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>
- <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"><vault_namespace></span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">iam</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Path where the AWS auth method is enabled in Vault, e.g: "aws/". Defaults to aws</span>
- <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>
- <span class="w"> </span><span class="c1"># AWS Region. Defaults to us-east-1</span>
- <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>
- <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>
- <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>
- <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>
- <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>
- <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</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">my-serviceaccount</span><span class="w"> </span><span class="c1">#Provide service account with IRSA enabled</span>
- </code></pre></div>
- <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
- <p>This is basicially a zero-configuration authentication approach that inherits the credentials from the controller's pod identity</p>
- <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>
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend-aws-iam</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"http://my.vault.server:8200"</span>
- <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>
- <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>
- <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"><vault_namespace></span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">iam</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Path where the AWS auth method is enabled in Vault, e.g: "aws/". Defaults to aws</span>
- <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>
- <span class="w"> </span><span class="c1"># AWS Region. Defaults to us-east-1</span>
- <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>
- <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>
- <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>
- <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>
- <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>
- </code></pre></div>
- <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>
- <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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <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>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"https://vault.acme.org"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># VaultJwt authenticates with Vault using the JWT/OIDC auth mechanism</span>
- <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/jwt</span>
- <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># Path where the JWT authentication backend is mounted</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"jwt"</span>
- <span class="w"> </span><span class="c1"># JWT role configured in a Vault server, optional.</span>
- <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">"vault-jwt-role"</span>
- <span class="w"> </span><span class="c1"># Retrieve JWT token from a Kubernetes secret</span>
- <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-secret"</span>
- <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">"jwt-token"</span>
- <span class="w"> </span><span class="c1"># ... or retrieve a Kubernetes service account token via the `TokenRequest` API</span>
- <span class="w"> </span><span class="nt">kubernetesServiceAccountToken</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"my-sa"</span>
- <span class="w"> </span><span class="c1"># `audiences` defaults to `["vault"]` it not supplied</span>
- <span class="w"> </span><span class="nt">audiences</span><span class="p">:</span>
- <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault</span>
- <span class="w"> </span><span class="c1"># `expirationSeconds` defaults to 10 minutes if not supplied</span>
- <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>
- </code></pre></div>
- <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>
- <h3 id="pushsecret">PushSecret</h3>
- <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>.
- 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>
- <div class="admonition note">
- <p class="admonition-title">Note</p>
- <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>
- </div>
- <p>Here is an example of how to set up <code>PushSecret</code>:</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">v1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
- <span class="nt">metadata</span><span class="p">:</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">source-secret</span>
- <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>
- <span class="nt">stringData</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">source-key1</span><span class="p">:</span><span class="w"> </span><span class="s">"{\"foo\":\"bar\"}"</span><span class="w"> </span><span class="c1"># Needs to be a JSON</span>
- <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>
- <span class="nn">---</span>
- <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>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
- <span class="nt">metadata</span><span class="p">:</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">pushsecret-example</span>
- <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>
- <span class="nt">spec</span><span class="p">:</span>
- <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>
- <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
- <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>
- <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">secret</span><span class="p">:</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">source-secret</span>
- <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
- <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</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">source-key1</span>
- <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
- <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>
- <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</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">source-key2</span>
- <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
- <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>
- <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>
- </code></pre></div>
- <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>
- <h3 id="vault-enterprise">Vault Enterprise</h3>
- <h4 id="eventual-consistency-and-performance-standby-nodes">Eventual Consistency and Performance Standby Nodes</h4>
- <p>When using Vault Enterprise with <a href="https://www.vaultproject.io/docs/enterprise/consistency#performance-standby-nodes">performance standby nodes</a>,
- any follower can handle read requests immediately after the provider has
- authenticated. Since Vault becomes eventually consistent in this mode, these
- requests can fail if the login has not yet propagated to each server's local
- state.</p>
- <p>Below are two different solutions to this scenario. You'll need to review them
- and pick the best fit for your environment and Vault configuration.</p>
- <h4 id="vault-namespaces">Vault Namespaces</h4>
- <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>
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"http://my.vault.server:8200"</span>
- <span class="w"> </span><span class="c1"># See https://www.vaultproject.io/docs/enterprise/namespaces</span>
- <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">"ns1"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="c1"># ...</span>
- </code></pre></div>
- <h5 id="authenticating-into-a-different-namespace">Authenticating into a different namespace</h5>
- <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>
- <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
- <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
- <span class="nt">metadata</span><span class="p">:</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-backend</span>
- <span class="nt">spec</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">"http://my.vault.server:8200"</span>
- <span class="w"> </span><span class="c1"># See https://www.vaultproject.io/docs/enterprise/namespaces</span>
- <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">"app-team"</span>
- <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
- <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"v2"</span>
- <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
- <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">"kubernetes-team"</span>
- <span class="w"> </span><span class="c1"># ...</span>
- </code></pre></div>
- <h4 id="read-your-writes">Read Your Writes</h4>
- <p>Vault 1.10.0 and later encodes information in the token to detect the case
- when a server is behind. If a Vault server does not have information about
- 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>
- so clients know to retry.</p>
- <p>A method supported in versions Vault 1.7 and later is to utilize the
- <code>X-Vault-Index</code> header returned on all write requests (including logins).
- Passing this header back on subsequent requests instructs the Vault client
- to retry the request until the server has an index greater than or equal
- to that returned with the last write. Obviously though, this has a performance
- hit because the read is blocked until the follower's local state has caught up.</p>
- <h4 id="forward-inconsistent">Forward Inconsistent</h4>
- <p>Vault also supports proxying inconsistent requests to the current cluster leader
- for immediate read-after-write consistency.</p>
- <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>
- <p>In Vault 1.7 forwarding can be achieved by setting the <code>X-Vault-Inconsistent</code>
- header to <code>forward-active-node</code>. By default, this behavior is disabled and must
- be explicitly enabled in the server's <a href="https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header">replication configuration</a>.</p>
-
-
- </article>
- </div>
-
-
- <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
- </div>
-
- </main>
-
- <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
-
- <footer class="md-footer">
-
- <div class="md-footer-meta md-typeset">
- <div class="md-footer-meta__inner md-grid">
- <div class="md-copyright">
-
- <div class="md-copyright__highlight">
- © 2024 The external-secrets Authors.<br/>
- © 2024 The Linux Foundation. All rights reserved.<br/><br/>
- The Linux Foundation has registered trademarks and uses trademarks.<br/>
- For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
- </div>
-
-
- Made with
- <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
- Material for MkDocs
- </a>
-
- </div>
-
- </div>
- </div>
- </footer>
-
- </div>
- <div class="md-dialog" data-md-component="dialog">
- <div class="md-dialog__inner md-typeset"></div>
- </div>
-
-
- <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>
-
-
- <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
-
-
- </body>
- </html>
|