index.html 108 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../1password-sdk/">
  7. <link rel="next" href="../fake/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
  10. <title>Webhook - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.ec1eaa64.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#generic-webhook" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL("../.."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Webhook
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <form class="md-header__option" data-md-component="palette">
  65. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  68. </label>
  69. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  72. </label>
  73. </form>
  74. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  75. <label class="md-header__button md-icon" for="__search">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  85. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.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 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item">
  127. <a href="../../api/components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item">
  132. <a href="../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item md-tabs__item--active">
  137. <a href="../aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.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 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../introduction/glossary/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Glossary
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/prerequisites/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. Prerequisites
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/getting-started/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Getting started
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/faq/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. FAQ
  227. </span>
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../../introduction/stability-support/" class="md-nav__link">
  232. <span class="md-ellipsis">
  233. Stability and Support
  234. </span>
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  239. <span class="md-ellipsis">
  240. Deprecation Policy
  241. </span>
  242. </a>
  243. </li>
  244. </ul>
  245. </nav>
  246. </li>
  247. <li class="md-nav__item md-nav__item--nested">
  248. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  249. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  250. <span class="md-ellipsis">
  251. API
  252. </span>
  253. <span class="md-nav__icon md-icon"></span>
  254. </label>
  255. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  256. <label class="md-nav__title" for="__nav_2">
  257. <span class="md-nav__icon md-icon"></span>
  258. API
  259. </label>
  260. <ul class="md-nav__list" data-md-scrollfix>
  261. <li class="md-nav__item">
  262. <a href="../../api/components/" class="md-nav__link">
  263. <span class="md-ellipsis">
  264. Components
  265. </span>
  266. </a>
  267. </li>
  268. <li class="md-nav__item md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  270. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  271. <span class="md-ellipsis">
  272. Core Resources
  273. </span>
  274. <span class="md-nav__icon md-icon"></span>
  275. </label>
  276. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  277. <label class="md-nav__title" for="__nav_2_2">
  278. <span class="md-nav__icon md-icon"></span>
  279. Core Resources
  280. </label>
  281. <ul class="md-nav__list" data-md-scrollfix>
  282. <li class="md-nav__item">
  283. <a href="../../api/externalsecret/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ExternalSecret
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/secretstore/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. SecretStore
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../api/clustersecretstore/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. ClusterSecretStore
  300. </span>
  301. </a>
  302. </li>
  303. <li class="md-nav__item">
  304. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  305. <span class="md-ellipsis">
  306. ClusterExternalSecret
  307. </span>
  308. </a>
  309. </li>
  310. <li class="md-nav__item">
  311. <a href="../../api/clusterpushsecret/" class="md-nav__link">
  312. <span class="md-ellipsis">
  313. ClusterPushSecret
  314. </span>
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../../api/pushsecret/" class="md-nav__link">
  319. <span class="md-ellipsis">
  320. PushSecret
  321. </span>
  322. </a>
  323. </li>
  324. </ul>
  325. </nav>
  326. </li>
  327. <li class="md-nav__item md-nav__item--nested">
  328. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  329. <div class="md-nav__link md-nav__container">
  330. <a href="../../api/generator/" class="md-nav__link ">
  331. <span class="md-ellipsis">
  332. Generators
  333. </span>
  334. </a>
  335. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  336. <span class="md-nav__icon md-icon"></span>
  337. </label>
  338. </div>
  339. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  340. <label class="md-nav__title" for="__nav_2_3">
  341. <span class="md-nav__icon md-icon"></span>
  342. Generators
  343. </label>
  344. <ul class="md-nav__list" data-md-scrollfix>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/acr/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Azure Container Registry
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/ecr/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. AWS Elastic Container Registry
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/sts/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. AWS STS Session Token
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/cloudsmith/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Cloudsmith
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/cluster/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Cluster Generator
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/gcr/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. Google Container Registry
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../../api/generator/grafana/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. Grafana
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../../api/generator/quay/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. Quay
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/generator/vault/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Vault Dynamic Secret
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../api/generator/beyondtrustworkloadcredentials/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. BeyondTrust Workload Credentials
  412. </span>
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../api/generator/password/" class="md-nav__link">
  417. <span class="md-ellipsis">
  418. Password
  419. </span>
  420. </a>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../../api/generator/fake/" class="md-nav__link">
  424. <span class="md-ellipsis">
  425. Fake
  426. </span>
  427. </a>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="../../api/generator/webhook/" class="md-nav__link">
  431. <span class="md-ellipsis">
  432. Webhook
  433. </span>
  434. </a>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../../api/generator/github/" class="md-nav__link">
  438. <span class="md-ellipsis">
  439. Github
  440. </span>
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../api/generator/gitlab/" class="md-nav__link">
  445. <span class="md-ellipsis">
  446. Gitlab
  447. </span>
  448. </a>
  449. </li>
  450. <li class="md-nav__item">
  451. <a href="../../api/generator/uuid/" class="md-nav__link">
  452. <span class="md-ellipsis">
  453. UUID
  454. </span>
  455. </a>
  456. </li>
  457. <li class="md-nav__item">
  458. <a href="../../api/generator/mfa/" class="md-nav__link">
  459. <span class="md-ellipsis">
  460. MFA
  461. </span>
  462. </a>
  463. </li>
  464. <li class="md-nav__item">
  465. <a href="../../api/generator/sshkey/" class="md-nav__link">
  466. <span class="md-ellipsis">
  467. SSHKey
  468. </span>
  469. </a>
  470. </li>
  471. </ul>
  472. </nav>
  473. </li>
  474. <li class="md-nav__item md-nav__item--nested">
  475. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  476. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  477. <span class="md-ellipsis">
  478. Reference Docs
  479. </span>
  480. <span class="md-nav__icon md-icon"></span>
  481. </label>
  482. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  483. <label class="md-nav__title" for="__nav_2_4">
  484. <span class="md-nav__icon md-icon"></span>
  485. Reference Docs
  486. </label>
  487. <ul class="md-nav__list" data-md-scrollfix>
  488. <li class="md-nav__item">
  489. <a href="../../api/spec/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. API specification
  492. </span>
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../api/controller-options/" class="md-nav__link">
  497. <span class="md-ellipsis">
  498. Controller Options
  499. </span>
  500. </a>
  501. </li>
  502. <li class="md-nav__item">
  503. <a href="../../api/metrics/" class="md-nav__link">
  504. <span class="md-ellipsis">
  505. Metrics
  506. </span>
  507. </a>
  508. </li>
  509. <li class="md-nav__item">
  510. <a href="../../api/selectable-fields/" class="md-nav__link">
  511. <span class="md-ellipsis">
  512. Selectable Fields
  513. </span>
  514. </a>
  515. </li>
  516. </ul>
  517. </nav>
  518. </li>
  519. </ul>
  520. </nav>
  521. </li>
  522. <li class="md-nav__item md-nav__item--nested">
  523. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  524. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  525. <span class="md-ellipsis">
  526. Guides
  527. </span>
  528. <span class="md-nav__icon md-icon"></span>
  529. </label>
  530. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  531. <label class="md-nav__title" for="__nav_3">
  532. <span class="md-nav__icon md-icon"></span>
  533. Guides
  534. </label>
  535. <ul class="md-nav__list" data-md-scrollfix>
  536. <li class="md-nav__item">
  537. <a href="../../guides/introduction/" class="md-nav__link">
  538. <span class="md-ellipsis">
  539. Introduction
  540. </span>
  541. </a>
  542. </li>
  543. <li class="md-nav__item md-nav__item--nested">
  544. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  545. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  546. <span class="md-ellipsis">
  547. External Secrets
  548. </span>
  549. <span class="md-nav__icon md-icon"></span>
  550. </label>
  551. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  552. <label class="md-nav__title" for="__nav_3_2">
  553. <span class="md-nav__icon md-icon"></span>
  554. External Secrets
  555. </label>
  556. <ul class="md-nav__list" data-md-scrollfix>
  557. <li class="md-nav__item">
  558. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  559. <span class="md-ellipsis">
  560. Extract structured data
  561. </span>
  562. </a>
  563. </li>
  564. <li class="md-nav__item">
  565. <a href="../../guides/getallsecrets/" class="md-nav__link">
  566. <span class="md-ellipsis">
  567. Find Secrets by Name or Metadata
  568. </span>
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  573. <span class="md-ellipsis">
  574. Rewriting Keys
  575. </span>
  576. </a>
  577. </li>
  578. <li class="md-nav__item md-nav__item--nested">
  579. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  580. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  581. <span class="md-ellipsis">
  582. Advanced Templating
  583. </span>
  584. <span class="md-nav__icon md-icon"></span>
  585. </label>
  586. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  587. <label class="md-nav__title" for="__nav_3_2_4">
  588. <span class="md-nav__icon md-icon"></span>
  589. Advanced Templating
  590. </label>
  591. <ul class="md-nav__list" data-md-scrollfix>
  592. <li class="md-nav__item">
  593. <a href="../../guides/templating/" class="md-nav__link">
  594. <span class="md-ellipsis">
  595. v2
  596. </span>
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="../../guides/templating-v1/" class="md-nav__link">
  601. <span class="md-ellipsis">
  602. v1
  603. </span>
  604. </a>
  605. </li>
  606. </ul>
  607. </nav>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  611. <span class="md-ellipsis">
  612. Kubernetes Secret Types
  613. </span>
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  618. <span class="md-ellipsis">
  619. Lifecycle: ownership & deletion
  620. </span>
  621. </a>
  622. </li>
  623. <li class="md-nav__item">
  624. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  625. <span class="md-ellipsis">
  626. Decoding Strategies
  627. </span>
  628. </a>
  629. </li>
  630. <li class="md-nav__item">
  631. <a href="../../guides/controller-class/" class="md-nav__link">
  632. <span class="md-ellipsis">
  633. Controller Classes
  634. </span>
  635. </a>
  636. </li>
  637. </ul>
  638. </nav>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../guides/targeting-custom-resources/" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. Targeting Custom Resources
  644. </span>
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../../guides/generator/" class="md-nav__link">
  649. <span class="md-ellipsis">
  650. Generators
  651. </span>
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../guides/pushsecrets/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. Push Secrets
  658. </span>
  659. </a>
  660. </li>
  661. <li class="md-nav__item md-nav__item--nested">
  662. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  663. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  664. <span class="md-ellipsis">
  665. Operations
  666. </span>
  667. <span class="md-nav__icon md-icon"></span>
  668. </label>
  669. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  670. <label class="md-nav__title" for="__nav_3_6">
  671. <span class="md-nav__icon md-icon"></span>
  672. Operations
  673. </label>
  674. <ul class="md-nav__list" data-md-scrollfix>
  675. <li class="md-nav__item">
  676. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. Multi Tenancy
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../guides/security-best-practices/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. Security Best Practices
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../guides/threat-model/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Threat Model
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../guides/v1beta1/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. Upgrading to v1beta1
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../guides/using-latest-image/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. Using Latest Image
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Disable Cluster Features
  714. </span>
  715. </a>
  716. </li>
  717. </ul>
  718. </nav>
  719. </li>
  720. <li class="md-nav__item md-nav__item--nested">
  721. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_7" >
  722. <label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="0">
  723. <span class="md-ellipsis">
  724. Tooling
  725. </span>
  726. <span class="md-nav__icon md-icon"></span>
  727. </label>
  728. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
  729. <label class="md-nav__title" for="__nav_3_7">
  730. <span class="md-nav__icon md-icon"></span>
  731. Tooling
  732. </label>
  733. <ul class="md-nav__list" data-md-scrollfix>
  734. <li class="md-nav__item">
  735. <a href="../../guides/using-esoctl-tool/" class="md-nav__link">
  736. <span class="md-ellipsis">
  737. Using the esoctl tool
  738. </span>
  739. </a>
  740. </li>
  741. </ul>
  742. </nav>
  743. </li>
  744. </ul>
  745. </nav>
  746. </li>
  747. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  748. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  749. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  750. <span class="md-ellipsis">
  751. Provider
  752. </span>
  753. <span class="md-nav__icon md-icon"></span>
  754. </label>
  755. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  756. <label class="md-nav__title" for="__nav_4">
  757. <span class="md-nav__icon md-icon"></span>
  758. Provider
  759. </label>
  760. <ul class="md-nav__list" data-md-scrollfix>
  761. <li class="md-nav__item">
  762. <a href="../aws-secrets-manager/" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. AWS Secrets Manager
  765. </span>
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../aws-parameter-store/" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. AWS Parameter Store
  772. </span>
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="../aws-certificate-manager/" class="md-nav__link">
  777. <span class="md-ellipsis">
  778. AWS Certificate Manager
  779. </span>
  780. </a>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="../aws-access/" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. AWS Access
  786. </span>
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="../azure-key-vault/" class="md-nav__link">
  791. <span class="md-ellipsis">
  792. Azure Key Vault
  793. </span>
  794. </a>
  795. </li>
  796. <li class="md-nav__item">
  797. <a href="../barbican/" class="md-nav__link">
  798. <span class="md-ellipsis">
  799. Barbican
  800. </span>
  801. </a>
  802. </li>
  803. <li class="md-nav__item">
  804. <a href="../beyondtrust/" class="md-nav__link">
  805. <span class="md-ellipsis">
  806. BeyondTrust
  807. </span>
  808. </a>
  809. </li>
  810. <li class="md-nav__item">
  811. <a href="../beyondtrustworkloadcredentials/" class="md-nav__link">
  812. <span class="md-ellipsis">
  813. BeyondTrust Workload Credentials
  814. </span>
  815. </a>
  816. </li>
  817. <li class="md-nav__item">
  818. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  819. <span class="md-ellipsis">
  820. Bitwarden Secrets Manager
  821. </span>
  822. </a>
  823. </li>
  824. <li class="md-nav__item">
  825. <a href="../chef/" class="md-nav__link">
  826. <span class="md-ellipsis">
  827. Chef
  828. </span>
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="../cloudru/" class="md-nav__link">
  833. <span class="md-ellipsis">
  834. Cloud.ru Secret Manager
  835. </span>
  836. </a>
  837. </li>
  838. <li class="md-nav__item">
  839. <a href="../conjur/" class="md-nav__link">
  840. <span class="md-ellipsis">
  841. CyberArk Conjur
  842. </span>
  843. </a>
  844. </li>
  845. <li class="md-nav__item">
  846. <a href="../google-secrets-manager/" class="md-nav__link">
  847. <span class="md-ellipsis">
  848. Google Cloud Secret Manager
  849. </span>
  850. </a>
  851. </li>
  852. <li class="md-nav__item">
  853. <a href="../hashicorp-vault/" class="md-nav__link">
  854. <span class="md-ellipsis">
  855. HashiCorp Vault
  856. </span>
  857. </a>
  858. </li>
  859. <li class="md-nav__item">
  860. <a href="../kubernetes/" class="md-nav__link">
  861. <span class="md-ellipsis">
  862. Kubernetes
  863. </span>
  864. </a>
  865. </li>
  866. <li class="md-nav__item">
  867. <a href="../crd/" class="md-nav__link">
  868. <span class="md-ellipsis">
  869. Kubernetes CRD
  870. </span>
  871. </a>
  872. </li>
  873. <li class="md-nav__item">
  874. <a href="../ibm-secrets-manager/" class="md-nav__link">
  875. <span class="md-ellipsis">
  876. IBM Secrets Manager
  877. </span>
  878. </a>
  879. </li>
  880. <li class="md-nav__item">
  881. <a href="../akeyless/" class="md-nav__link">
  882. <span class="md-ellipsis">
  883. Akeyless
  884. </span>
  885. </a>
  886. </li>
  887. <li class="md-nav__item">
  888. <a href="../yandex-certificate-manager/" class="md-nav__link">
  889. <span class="md-ellipsis">
  890. Yandex Certificate Manager
  891. </span>
  892. </a>
  893. </li>
  894. <li class="md-nav__item">
  895. <a href="../yandex-lockbox/" class="md-nav__link">
  896. <span class="md-ellipsis">
  897. Yandex Lockbox
  898. </span>
  899. </a>
  900. </li>
  901. <li class="md-nav__item">
  902. <a href="../gitlab-variables/" class="md-nav__link">
  903. <span class="md-ellipsis">
  904. GitLab Variables
  905. </span>
  906. </a>
  907. </li>
  908. <li class="md-nav__item">
  909. <a href="../github/" class="md-nav__link">
  910. <span class="md-ellipsis">
  911. GitHub Actions and Dependabot Secrets
  912. </span>
  913. </a>
  914. </li>
  915. <li class="md-nav__item">
  916. <a href="../oracle-vault/" class="md-nav__link">
  917. <span class="md-ellipsis">
  918. Oracle Vault
  919. </span>
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="../ovhcloud/" class="md-nav__link">
  924. <span class="md-ellipsis">
  925. OVHcloud
  926. </span>
  927. </a>
  928. </li>
  929. <li class="md-nav__item">
  930. <a href="../1password-automation/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. 1Password Connect Server
  933. </span>
  934. </a>
  935. </li>
  936. <li class="md-nav__item">
  937. <a href="../1password-sdk/" class="md-nav__link">
  938. <span class="md-ellipsis">
  939. 1Password SDK
  940. </span>
  941. </a>
  942. </li>
  943. <li class="md-nav__item md-nav__item--active">
  944. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  945. <label class="md-nav__link md-nav__link--active" for="__toc">
  946. <span class="md-ellipsis">
  947. Webhook
  948. </span>
  949. <span class="md-nav__icon md-icon"></span>
  950. </label>
  951. <a href="./" class="md-nav__link md-nav__link--active">
  952. <span class="md-ellipsis">
  953. Webhook
  954. </span>
  955. </a>
  956. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  957. <label class="md-nav__title" for="__toc">
  958. <span class="md-nav__icon md-icon"></span>
  959. Table of contents
  960. </label>
  961. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  962. <li class="md-nav__item">
  963. <a href="#generic-webhook" class="md-nav__link">
  964. <span class="md-ellipsis">
  965. Generic Webhook
  966. </span>
  967. </a>
  968. <nav class="md-nav" aria-label="Generic Webhook">
  969. <ul class="md-nav__list">
  970. <li class="md-nav__item">
  971. <a href="#example" class="md-nav__link">
  972. <span class="md-ellipsis">
  973. Example
  974. </span>
  975. </a>
  976. <nav class="md-nav" aria-label="Example">
  977. <ul class="md-nav__list">
  978. <li class="md-nav__item">
  979. <a href="#push-secret" class="md-nav__link">
  980. <span class="md-ellipsis">
  981. Push secret
  982. </span>
  983. </a>
  984. </li>
  985. <li class="md-nav__item">
  986. <a href="#authentication" class="md-nav__link">
  987. <span class="md-ellipsis">
  988. Authentication
  989. </span>
  990. </a>
  991. </li>
  992. </ul>
  993. </nav>
  994. </li>
  995. <li class="md-nav__item">
  996. <a href="#templating" class="md-nav__link">
  997. <span class="md-ellipsis">
  998. Templating
  999. </span>
  1000. </a>
  1001. </li>
  1002. <li class="md-nav__item">
  1003. <a href="#all-parameters" class="md-nav__link">
  1004. <span class="md-ellipsis">
  1005. All Parameters
  1006. </span>
  1007. </a>
  1008. </li>
  1009. <li class="md-nav__item">
  1010. <a href="#webhook-as-generators" class="md-nav__link">
  1011. <span class="md-ellipsis">
  1012. Webhook as generators
  1013. </span>
  1014. </a>
  1015. </li>
  1016. <li class="md-nav__item">
  1017. <a href="#debugging" class="md-nav__link">
  1018. <span class="md-ellipsis">
  1019. Debugging
  1020. </span>
  1021. </a>
  1022. <nav class="md-nav" aria-label="Debugging">
  1023. <ul class="md-nav__list">
  1024. <li class="md-nav__item">
  1025. <a href="#start-with-the-store-status-and-events" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Start with the store status and events
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="#increase-the-operator-log-level" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Increase the operator log level
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="#why-there-is-no-built-in-request-or-response-dump" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Why there is no built-in request or response dump
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="#inspecting-traffic-with-a-logging-proxy" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Inspecting traffic with a logging proxy
  1049. </span>
  1050. </a>
  1051. </li>
  1052. <li class="md-nav__item">
  1053. <a href="#referenced-secrets-must-be-labeled" class="md-nav__link">
  1054. <span class="md-ellipsis">
  1055. Referenced secrets must be labeled
  1056. </span>
  1057. </a>
  1058. </li>
  1059. <li class="md-nav__item">
  1060. <a href="#template-values-are-two-levels-deep" class="md-nav__link">
  1061. <span class="md-ellipsis">
  1062. Template values are two levels deep
  1063. </span>
  1064. </a>
  1065. </li>
  1066. <li class="md-nav__item">
  1067. <a href="#a-templated-url-is-validated-before-templating" class="md-nav__link">
  1068. <span class="md-ellipsis">
  1069. A templated url is validated before templating
  1070. </span>
  1071. </a>
  1072. </li>
  1073. </ul>
  1074. </nav>
  1075. </li>
  1076. </ul>
  1077. </nav>
  1078. </li>
  1079. </ul>
  1080. </nav>
  1081. </li>
  1082. <li class="md-nav__item">
  1083. <a href="../fake/" class="md-nav__link">
  1084. <span class="md-ellipsis">
  1085. Fake
  1086. </span>
  1087. </a>
  1088. </li>
  1089. <li class="md-nav__item">
  1090. <a href="../senhasegura-dsm/" class="md-nav__link">
  1091. <span class="md-ellipsis">
  1092. senhasegura DevOps Secrets Management (DSM)
  1093. </span>
  1094. </a>
  1095. </li>
  1096. <li class="md-nav__item">
  1097. <a href="../doppler/" class="md-nav__link">
  1098. <span class="md-ellipsis">
  1099. Doppler
  1100. </span>
  1101. </a>
  1102. </li>
  1103. <li class="md-nav__item">
  1104. <a href="../keeper-security/" class="md-nav__link">
  1105. <span class="md-ellipsis">
  1106. Keeper Security
  1107. </span>
  1108. </a>
  1109. </li>
  1110. <li class="md-nav__item">
  1111. <a href="../cloak/" class="md-nav__link">
  1112. <span class="md-ellipsis">
  1113. Cloak End 2 End Encrypted Secrets
  1114. </span>
  1115. </a>
  1116. </li>
  1117. <li class="md-nav__item">
  1118. <a href="../scaleway/" class="md-nav__link">
  1119. <span class="md-ellipsis">
  1120. Scaleway
  1121. </span>
  1122. </a>
  1123. </li>
  1124. <li class="md-nav__item">
  1125. <a href="../delinea/" class="md-nav__link">
  1126. <span class="md-ellipsis">
  1127. Delinea
  1128. </span>
  1129. </a>
  1130. </li>
  1131. <li class="md-nav__item">
  1132. <a href="../secretserver/" class="md-nav__link">
  1133. <span class="md-ellipsis">
  1134. Secret Server
  1135. </span>
  1136. </a>
  1137. </li>
  1138. <li class="md-nav__item">
  1139. <a href="../passbolt/" class="md-nav__link">
  1140. <span class="md-ellipsis">
  1141. Passbolt
  1142. </span>
  1143. </a>
  1144. </li>
  1145. <li class="md-nav__item">
  1146. <a href="../pulumi/" class="md-nav__link">
  1147. <span class="md-ellipsis">
  1148. Pulumi ESC
  1149. </span>
  1150. </a>
  1151. </li>
  1152. <li class="md-nav__item">
  1153. <a href="../onboardbase/" class="md-nav__link">
  1154. <span class="md-ellipsis">
  1155. Onboardbase
  1156. </span>
  1157. </a>
  1158. </li>
  1159. <li class="md-nav__item">
  1160. <a href="../../provider-passworddepot/" class="md-nav__link">
  1161. <span class="md-ellipsis">
  1162. Password Depot
  1163. </span>
  1164. </a>
  1165. </li>
  1166. <li class="md-nav__item">
  1167. <a href="../fortanix/" class="md-nav__link">
  1168. <span class="md-ellipsis">
  1169. Fortanix
  1170. </span>
  1171. </a>
  1172. </li>
  1173. <li class="md-nav__item">
  1174. <a href="../infisical/" class="md-nav__link">
  1175. <span class="md-ellipsis">
  1176. Infisical
  1177. </span>
  1178. </a>
  1179. </li>
  1180. <li class="md-nav__item">
  1181. <a href="../previder/" class="md-nav__link">
  1182. <span class="md-ellipsis">
  1183. Previder
  1184. </span>
  1185. </a>
  1186. </li>
  1187. <li class="md-nav__item">
  1188. <a href="../openbao/" class="md-nav__link">
  1189. <span class="md-ellipsis">
  1190. OpenBao
  1191. </span>
  1192. </a>
  1193. </li>
  1194. <li class="md-nav__item">
  1195. <a href="../volcengine/" class="md-nav__link">
  1196. <span class="md-ellipsis">
  1197. Volcengine
  1198. </span>
  1199. </a>
  1200. </li>
  1201. <li class="md-nav__item">
  1202. <a href="../ngrok/" class="md-nav__link">
  1203. <span class="md-ellipsis">
  1204. ngrok
  1205. </span>
  1206. </a>
  1207. </li>
  1208. <li class="md-nav__item">
  1209. <a href="../devolutions-server/" class="md-nav__link">
  1210. <span class="md-ellipsis">
  1211. Devolutions Server
  1212. </span>
  1213. </a>
  1214. </li>
  1215. <li class="md-nav__item">
  1216. <a href="../nebius-mysterybox/" class="md-nav__link">
  1217. <span class="md-ellipsis">
  1218. Nebius MysteryBox
  1219. </span>
  1220. </a>
  1221. </li>
  1222. </ul>
  1223. </nav>
  1224. </li>
  1225. <li class="md-nav__item md-nav__item--nested">
  1226. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1227. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1228. <span class="md-ellipsis">
  1229. Examples
  1230. </span>
  1231. <span class="md-nav__icon md-icon"></span>
  1232. </label>
  1233. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1234. <label class="md-nav__title" for="__nav_5">
  1235. <span class="md-nav__icon md-icon"></span>
  1236. Examples
  1237. </label>
  1238. <ul class="md-nav__list" data-md-scrollfix>
  1239. <li class="md-nav__item">
  1240. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1241. <span class="md-ellipsis">
  1242. FluxCD
  1243. </span>
  1244. </a>
  1245. </li>
  1246. <li class="md-nav__item">
  1247. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1248. <span class="md-ellipsis">
  1249. Anchore Engine
  1250. </span>
  1251. </a>
  1252. </li>
  1253. <li class="md-nav__item">
  1254. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1255. <span class="md-ellipsis">
  1256. Jenkins
  1257. </span>
  1258. </a>
  1259. </li>
  1260. <li class="md-nav__item">
  1261. <a href="../../examples/bitwarden/" class="md-nav__link">
  1262. <span class="md-ellipsis">
  1263. Bitwarden
  1264. </span>
  1265. </a>
  1266. </li>
  1267. </ul>
  1268. </nav>
  1269. </li>
  1270. <li class="md-nav__item md-nav__item--nested">
  1271. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1272. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1273. <span class="md-ellipsis">
  1274. Community
  1275. </span>
  1276. <span class="md-nav__icon md-icon"></span>
  1277. </label>
  1278. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1279. <label class="md-nav__title" for="__nav_6">
  1280. <span class="md-nav__icon md-icon"></span>
  1281. Community
  1282. </label>
  1283. <ul class="md-nav__list" data-md-scrollfix>
  1284. <li class="md-nav__item md-nav__item--nested">
  1285. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1286. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1287. <span class="md-ellipsis">
  1288. Contributing
  1289. </span>
  1290. <span class="md-nav__icon md-icon"></span>
  1291. </label>
  1292. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1293. <label class="md-nav__title" for="__nav_6_1">
  1294. <span class="md-nav__icon md-icon"></span>
  1295. Contributing
  1296. </label>
  1297. <ul class="md-nav__list" data-md-scrollfix>
  1298. <li class="md-nav__item">
  1299. <a href="../../contributing/devguide/" class="md-nav__link">
  1300. <span class="md-ellipsis">
  1301. Developer guide
  1302. </span>
  1303. </a>
  1304. </li>
  1305. <li class="md-nav__item">
  1306. <a href="../../contributing/process/" class="md-nav__link">
  1307. <span class="md-ellipsis">
  1308. Contributing Process
  1309. </span>
  1310. </a>
  1311. </li>
  1312. <li class="md-nav__item">
  1313. <a href="../../contributing/release/" class="md-nav__link">
  1314. <span class="md-ellipsis">
  1315. Release Process
  1316. </span>
  1317. </a>
  1318. </li>
  1319. <li class="md-nav__item">
  1320. <a href="../../contributing/coc/" class="md-nav__link">
  1321. <span class="md-ellipsis">
  1322. Code of Conduct
  1323. </span>
  1324. </a>
  1325. </li>
  1326. <li class="md-nav__item">
  1327. <a href="../../contributing/calendar/" class="md-nav__link">
  1328. <span class="md-ellipsis">
  1329. Community meetings calendar
  1330. </span>
  1331. </a>
  1332. </li>
  1333. <li class="md-nav__item">
  1334. <a href="../../contributing/roadmap/" class="md-nav__link">
  1335. <span class="md-ellipsis">
  1336. Roadmap
  1337. </span>
  1338. </a>
  1339. </li>
  1340. <li class="md-nav__item">
  1341. <a href="../../contributing/burnout-mitigation/" class="md-nav__link">
  1342. <span class="md-ellipsis">
  1343. Burnout Prevention
  1344. </span>
  1345. </a>
  1346. </li>
  1347. <li class="md-nav__item">
  1348. <a href="../../contributing/llm-policy/" class="md-nav__link">
  1349. <span class="md-ellipsis">
  1350. LLM Policy
  1351. </span>
  1352. </a>
  1353. </li>
  1354. </ul>
  1355. </nav>
  1356. </li>
  1357. <li class="md-nav__item md-nav__item--nested">
  1358. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1359. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1360. <span class="md-ellipsis">
  1361. External Resources
  1362. </span>
  1363. <span class="md-nav__icon md-icon"></span>
  1364. </label>
  1365. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1366. <label class="md-nav__title" for="__nav_6_2">
  1367. <span class="md-nav__icon md-icon"></span>
  1368. External Resources
  1369. </label>
  1370. <ul class="md-nav__list" data-md-scrollfix>
  1371. <li class="md-nav__item">
  1372. <a href="../../eso-talks/" class="md-nav__link">
  1373. <span class="md-ellipsis">
  1374. Talks
  1375. </span>
  1376. </a>
  1377. </li>
  1378. <li class="md-nav__item">
  1379. <a href="../../eso-demos/" class="md-nav__link">
  1380. <span class="md-ellipsis">
  1381. Demos
  1382. </span>
  1383. </a>
  1384. </li>
  1385. <li class="md-nav__item">
  1386. <a href="../../eso-blogs/" class="md-nav__link">
  1387. <span class="md-ellipsis">
  1388. Blogs
  1389. </span>
  1390. </a>
  1391. </li>
  1392. <li class="md-nav__item">
  1393. <a href="../../eso-tools/" class="md-nav__link">
  1394. <span class="md-ellipsis">
  1395. Tools
  1396. </span>
  1397. </a>
  1398. </li>
  1399. </ul>
  1400. </nav>
  1401. </li>
  1402. </ul>
  1403. </nav>
  1404. </li>
  1405. </ul>
  1406. </nav>
  1407. </div>
  1408. </div>
  1409. </div>
  1410. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1411. <div class="md-sidebar__scrollwrap">
  1412. <div class="md-sidebar__inner">
  1413. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1414. <label class="md-nav__title" for="__toc">
  1415. <span class="md-nav__icon md-icon"></span>
  1416. Table of contents
  1417. </label>
  1418. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1419. <li class="md-nav__item">
  1420. <a href="#generic-webhook" class="md-nav__link">
  1421. <span class="md-ellipsis">
  1422. Generic Webhook
  1423. </span>
  1424. </a>
  1425. <nav class="md-nav" aria-label="Generic Webhook">
  1426. <ul class="md-nav__list">
  1427. <li class="md-nav__item">
  1428. <a href="#example" class="md-nav__link">
  1429. <span class="md-ellipsis">
  1430. Example
  1431. </span>
  1432. </a>
  1433. <nav class="md-nav" aria-label="Example">
  1434. <ul class="md-nav__list">
  1435. <li class="md-nav__item">
  1436. <a href="#push-secret" class="md-nav__link">
  1437. <span class="md-ellipsis">
  1438. Push secret
  1439. </span>
  1440. </a>
  1441. </li>
  1442. <li class="md-nav__item">
  1443. <a href="#authentication" class="md-nav__link">
  1444. <span class="md-ellipsis">
  1445. Authentication
  1446. </span>
  1447. </a>
  1448. </li>
  1449. </ul>
  1450. </nav>
  1451. </li>
  1452. <li class="md-nav__item">
  1453. <a href="#templating" class="md-nav__link">
  1454. <span class="md-ellipsis">
  1455. Templating
  1456. </span>
  1457. </a>
  1458. </li>
  1459. <li class="md-nav__item">
  1460. <a href="#all-parameters" class="md-nav__link">
  1461. <span class="md-ellipsis">
  1462. All Parameters
  1463. </span>
  1464. </a>
  1465. </li>
  1466. <li class="md-nav__item">
  1467. <a href="#webhook-as-generators" class="md-nav__link">
  1468. <span class="md-ellipsis">
  1469. Webhook as generators
  1470. </span>
  1471. </a>
  1472. </li>
  1473. <li class="md-nav__item">
  1474. <a href="#debugging" class="md-nav__link">
  1475. <span class="md-ellipsis">
  1476. Debugging
  1477. </span>
  1478. </a>
  1479. <nav class="md-nav" aria-label="Debugging">
  1480. <ul class="md-nav__list">
  1481. <li class="md-nav__item">
  1482. <a href="#start-with-the-store-status-and-events" class="md-nav__link">
  1483. <span class="md-ellipsis">
  1484. Start with the store status and events
  1485. </span>
  1486. </a>
  1487. </li>
  1488. <li class="md-nav__item">
  1489. <a href="#increase-the-operator-log-level" class="md-nav__link">
  1490. <span class="md-ellipsis">
  1491. Increase the operator log level
  1492. </span>
  1493. </a>
  1494. </li>
  1495. <li class="md-nav__item">
  1496. <a href="#why-there-is-no-built-in-request-or-response-dump" class="md-nav__link">
  1497. <span class="md-ellipsis">
  1498. Why there is no built-in request or response dump
  1499. </span>
  1500. </a>
  1501. </li>
  1502. <li class="md-nav__item">
  1503. <a href="#inspecting-traffic-with-a-logging-proxy" class="md-nav__link">
  1504. <span class="md-ellipsis">
  1505. Inspecting traffic with a logging proxy
  1506. </span>
  1507. </a>
  1508. </li>
  1509. <li class="md-nav__item">
  1510. <a href="#referenced-secrets-must-be-labeled" class="md-nav__link">
  1511. <span class="md-ellipsis">
  1512. Referenced secrets must be labeled
  1513. </span>
  1514. </a>
  1515. </li>
  1516. <li class="md-nav__item">
  1517. <a href="#template-values-are-two-levels-deep" class="md-nav__link">
  1518. <span class="md-ellipsis">
  1519. Template values are two levels deep
  1520. </span>
  1521. </a>
  1522. </li>
  1523. <li class="md-nav__item">
  1524. <a href="#a-templated-url-is-validated-before-templating" class="md-nav__link">
  1525. <span class="md-ellipsis">
  1526. A templated url is validated before templating
  1527. </span>
  1528. </a>
  1529. </li>
  1530. </ul>
  1531. </nav>
  1532. </li>
  1533. </ul>
  1534. </nav>
  1535. </li>
  1536. </ul>
  1537. </nav>
  1538. </div>
  1539. </div>
  1540. </div>
  1541. <div class="md-content" data-md-component="content">
  1542. <article class="md-content__inner md-typeset">
  1543. <h1>Webhook</h1>
  1544. <h2 id="generic-webhook">Generic Webhook</h2>
  1545. <p>External Secrets Operator can integrate with simple web apis by specifying the endpoint</p>
  1546. <h3 id="example">Example</h3>
  1547. <p>First, create a SecretStore with a webhook backend. We'll use a static user/password <code>test</code>:</p>
  1548. <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/v1</span>
  1549. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1550. <span class="nt">metadata</span><span class="p">:</span>
  1551. <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">webhook-backend</span>
  1552. <span class="nt">spec</span><span class="p">:</span>
  1553. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1554. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span>
  1555. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://httpbin.org/get?parameter={{</span><span class="nv"> </span><span class="s">.remoteRef.key</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1556. <span class="w"> </span><span class="nt">result</span><span class="p">:</span>
  1557. <span class="w"> </span><span class="nt">jsonPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$.args.parameter&quot;</span>
  1558. <span class="w"> </span><span class="nt">headers</span><span class="p">:</span>
  1559. <span class="w"> </span><span class="nt">Content-Type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">application/json</span>
  1560. <span class="w"> </span><span class="nt">Authorization</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Basic {{ print .auth.username &quot;:&quot; .auth.password | b64enc }}</span>
  1561. <span class="w"> </span><span class="nt">secrets</span><span class="p">:</span>
  1562. <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">auth</span>
  1563. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1564. <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">webhook-credentials</span>
  1565. <span class="nn">---</span>
  1566. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1567. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1568. <span class="nt">metadata</span><span class="p">:</span>
  1569. <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">webhook-credentials</span>
  1570. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1571. <span class="w"> </span><span class="nt">external-secrets.io/type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">webhook</span><span class="w"> </span><span class="c1">#Needed to allow webhook to use this secret</span>
  1572. <span class="nt">data</span><span class="p">:</span>
  1573. <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span><span class="w"> </span><span class="c1"># &quot;test&quot;</span>
  1574. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span><span class="w"> </span><span class="c1"># &quot;test&quot;</span>
  1575. </code></pre></div>
  1576. <p>NB: This is obviously not practical because it just returns the key as the result, but it shows how it works</p>
  1577. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in all <code>secrets</code> references with the namespaces where the secrets reside.</p>
  1578. <p>Now create an ExternalSecret that uses the above SecretStore:</p>
  1579. <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/v1</span>
  1580. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1581. <span class="nt">metadata</span><span class="p">:</span>
  1582. <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">webhook-example</span>
  1583. <span class="nt">spec</span><span class="p">:</span>
  1584. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;15s&quot;</span>
  1585. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1586. <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">webhook-backend</span>
  1587. <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>
  1588. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1589. <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>
  1590. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1591. <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>
  1592. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1593. <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</span>
  1594. <span class="nn">---</span>
  1595. <span class="c1"># will create a secret with:</span>
  1596. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1597. <span class="nt">metadata</span><span class="p">:</span>
  1598. <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>
  1599. <span class="nt">data</span><span class="p">:</span>
  1600. <span class="w"> </span><span class="nt">foobar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">c2VjcmV0</span>
  1601. </code></pre></div>
  1602. <h4 id="push-secret">Push secret</h4>
  1603. <p>To push a secret, create the following store:</p>
  1604. <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/v1</span>
  1605. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1606. <span class="nt">metadata</span><span class="p">:</span>
  1607. <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">webhook-backend</span>
  1608. <span class="nt">spec</span><span class="p">:</span>
  1609. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1610. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span>
  1611. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://httpbin.org/push?id={{</span><span class="nv"> </span><span class="s">.remoteRef.remoteKey</span><span class="nv"> </span><span class="s">}}&amp;secret={{</span><span class="nv"> </span><span class="s">.remoteRef.secretKey</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1612. <span class="w"> </span><span class="nt">body</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;{&quot;secret-field&quot;:</span><span class="nv"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">index</span><span class="nv"> </span><span class="s">.remoteRef</span><span class="nv"> </span><span class="s">.remoteRef.remoteKey</span><span class="nv"> </span><span class="s">}}&quot;}&#39;</span>
  1613. <span class="w"> </span><span class="nt">headers</span><span class="p">:</span>
  1614. <span class="w"> </span><span class="nt">Content-Type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">application/json</span>
  1615. <span class="w"> </span><span class="nt">Authorization</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Basic {{ print .auth.username &quot;:&quot; .auth.password | b64enc }}</span>
  1616. <span class="w"> </span><span class="nt">secrets</span><span class="p">:</span>
  1617. <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">auth</span>
  1618. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1619. <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">webhook-credentials</span>
  1620. </code></pre></div>
  1621. <p>Then create a push secret:</p>
  1622. <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/v1alpha1</span>
  1623. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1624. <span class="nt">metadata</span><span class="p">:</span>
  1625. <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="c1"># Customisable</span>
  1626. <span class="nt">spec</span><span class="p">:</span>
  1627. <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">1h0m0s</span><span class="w"> </span><span class="c1"># Refresh interval for which push secret will reconcile</span>
  1628. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span><span class="w"> </span><span class="c1"># A list of secret stores to push secrets to</span>
  1629. <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">webhook-backend</span>
  1630. <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>
  1631. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1632. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1633. <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">test-secret</span>
  1634. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1635. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span>
  1636. <span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1637. <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">testsecret</span>
  1638. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1639. <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">remotekey</span>
  1640. </code></pre></div>
  1641. If <code>secretKey</code> is not provided, the whole secret is provided JSON encoded.</p>
  1642. <p>The secret will be added to the <code>remoteRef</code> object so that it is retrievable in the templating engine. The secret will be sent in the body when the body field of the provider is empty. In the rare case that the body should be empty, the provider can be configured to use <code>'{{ "" }}'</code> for the body value.</p>
  1643. <h4 id="authentication">Authentication</h4>
  1644. <p>Webhook also supports using NTLM for authorization:</p>
  1645. <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/v1</span>
  1646. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1647. <span class="nt">metadata</span><span class="p">:</span>
  1648. <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">webhook-backend</span>
  1649. <span class="nt">spec</span><span class="p">:</span>
  1650. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1651. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span>
  1652. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://httpbin.org/get?parameter={{</span><span class="nv"> </span><span class="s">.remoteRef.key</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1653. <span class="w"> </span><span class="nt">result</span><span class="p">:</span>
  1654. <span class="w"> </span><span class="nt">jsonPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$.args.parameter&quot;</span>
  1655. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1656. <span class="w"> </span><span class="nt">ntlm</span><span class="p">:</span>
  1657. <span class="w"> </span><span class="nt">usernameSecret</span><span class="p">:</span>
  1658. <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">webhook-credentials</span>
  1659. <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">username</span>
  1660. <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">externalsecrets</span>
  1661. <span class="w"> </span><span class="nt">passwordSecret</span><span class="p">:</span>
  1662. <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">webhook-credentials</span>
  1663. <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">password</span>
  1664. <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">externalsecrets</span>
  1665. <span class="nn">---</span>
  1666. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1667. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1668. <span class="nt">metadata</span><span class="p">:</span>
  1669. <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">webhook-credentials</span>
  1670. <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">externalsecrets</span>
  1671. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1672. <span class="w"> </span><span class="nt">external-secrets.io/type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">webhook</span><span class="w"> </span><span class="c1"># Also required for auth.ntlm secrets</span>
  1673. <span class="nt">data</span><span class="p">:</span>
  1674. <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span><span class="w"> </span><span class="c1"># &quot;test&quot;</span>
  1675. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span><span class="w"> </span><span class="c1"># &quot;test&quot;</span>
  1676. </code></pre></div>
  1677. <div class="admonition note">
  1678. <p class="admonition-title">Note</p>
  1679. <p>If a webhook endpoint for a given <code>ExternalSecret</code> returns a 404 status code, the secret is considered to have been deleted. This will trigger the <code>deletionPolicy</code> set on the <code>ExternalSecret</code>.</p>
  1680. </div>
  1681. <h3 id="templating">Templating</h3>
  1682. <p>Generic WebHook provider uses the templating engine to generate the API call. It can be used in the url, headers, body and result.jsonPath fields.</p>
  1683. <p>The provider inserts the secret to be retrieved in the object named <code>remoteRef</code>.</p>
  1684. <p>In addition, secrets can be added as named objects, for example to use in authorization headers.
  1685. Each secret has a <code>name</code> property which determines the name of the object in the templating engine.</p>
  1686. <h3 id="all-parameters">All Parameters</h3>
  1687. <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/v1</span>
  1688. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1689. <span class="nt">metadata</span><span class="p">:</span>
  1690. <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">statervault</span>
  1691. <span class="nt">spec</span><span class="p">:</span>
  1692. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1693. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span>
  1694. <span class="w"> </span><span class="c1"># Url to call. Use templating engine to fill in the request parameters</span>
  1695. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;url&gt;</span>
  1696. <span class="w"> </span><span class="c1"># http method, defaults to GET</span>
  1697. <span class="w"> </span><span class="nt">method</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;method&gt;</span>
  1698. <span class="w"> </span><span class="c1"># Timeout in duration (1s, 1m, etc)</span>
  1699. <span class="w"> </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1s</span>
  1700. <span class="w"> </span><span class="nt">result</span><span class="p">:</span>
  1701. <span class="w"> </span><span class="c1"># [jsonPath](https://jsonpath.com) syntax, which also can be templated</span>
  1702. <span class="w"> </span><span class="nt">jsonPath</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;jsonPath&gt;</span>
  1703. <span class="w"> </span><span class="c1"># Map of headers, can be templated</span>
  1704. <span class="w"> </span><span class="nt">headers</span><span class="p">:</span>
  1705. <span class="w"> </span><span class="nt">&lt;Header-Name&gt;</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;header contents&gt;</span>
  1706. <span class="w"> </span><span class="c1"># Body to sent as request, can be templated (optional)</span>
  1707. <span class="w"> </span><span class="nt">body</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;body&gt;</span>
  1708. <span class="w"> </span><span class="c1"># List of secrets to expose to the templating engine</span>
  1709. <span class="w"> </span><span class="nt">secrets</span><span class="p">:</span>
  1710. <span class="w"> </span><span class="c1"># Use this name to refer to this secret in templating, above</span>
  1711. <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">&lt;name&gt;</span>
  1712. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1713. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;namespace&gt;</span><span class="w"> </span><span class="c1"># Only used in ClusterSecretStores</span>
  1714. <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">&lt;name&gt;</span>
  1715. <span class="w"> </span><span class="c1"># Add CAs here for the TLS handshake</span>
  1716. <span class="w"> </span><span class="nt">caBundle</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;base64 encoded cabundle&gt;</span>
  1717. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span>
  1718. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret or ConfigMap</span>
  1719. <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">&lt;name of secret or configmap&gt;</span>
  1720. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;namespace&gt;</span><span class="w"> </span><span class="c1"># Only used in ClusterSecretStores</span>
  1721. <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">&lt;key inside secret&gt;</span>
  1722. </code></pre></div>
  1723. <h3 id="webhook-as-generators">Webhook as generators</h3>
  1724. <p>You can also leverage webhooks as generators, following the same syntax. Please see the
  1725. <a href="../../api/generator/webhook/">generator-webhook</a> documentation for more information.</p>
  1726. <p>Note that source secrets must be labeled for both secretstores and generators, see
  1727. <a href="#referenced-secrets-must-be-labeled">Referenced secrets must be labeled</a> below.</p>
  1728. <h3 id="debugging">Debugging</h3>
  1729. <h4 id="start-with-the-store-status-and-events">Start with the store status and events</h4>
  1730. <p>Most webhook problems surface on the <code>SecretStore</code> itself rather than in the logs:</p>
  1731. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>describe<span class="w"> </span>secretstore<span class="w"> </span>&lt;name&gt;<span class="w"> </span>-n<span class="w"> </span>&lt;namespace&gt;
  1732. <span class="c1"># or, for a cluster-scoped store</span>
  1733. kubectl<span class="w"> </span>describe<span class="w"> </span>clustersecretstore<span class="w"> </span>&lt;name&gt;
  1734. </code></pre></div>
  1735. <p>A <code>Ready</code> condition of <code>False</code> with reason <code>InvalidProviderConfig</code> means the client could
  1736. not be created or that store validation failed. The accompanying event carries the
  1737. underlying error, which is usually more specific than the condition message.</p>
  1738. <p>Reason <code>ProviderNotFound</code> is narrower: the provider named in <code>spec.provider</code> could not be
  1739. resolved at all, so no provider code ran. There the condition message names the backend and
  1740. is as specific as the event.</p>
  1741. <p>For per-secret failures, check the <code>ExternalSecret</code> instead:</p>
  1742. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>describe<span class="w"> </span>externalsecret<span class="w"> </span>&lt;name&gt;<span class="w"> </span>-n<span class="w"> </span>&lt;namespace&gt;
  1743. </code></pre></div>
  1744. <h4 id="increase-the-operator-log-level">Increase the operator log level</h4>
  1745. <p>Run the controller with <code>--loglevel debug</code> to get the reconcile decisions for each object.
  1746. This logs what the operator did and why, but it deliberately does not log HTTP request or
  1747. response contents, see below.</p>
  1748. <h4 id="why-there-is-no-built-in-request-or-response-dump">Why there is no built-in request or response dump</h4>
  1749. <p>The webhook provider renders <code>url</code>, <code>headers</code> and <code>body</code> through the templating engine, and
  1750. those templates typically contain credentials pulled from the referenced secrets. Dumping
  1751. requests or responses would therefore write those credentials to the operator log, where
  1752. anyone with log access could read them. That is why no trace or wire-dump option is
  1753. provided, and why one is unlikely to be added.</p>
  1754. <div class="admonition warning">
  1755. <p class="admonition-title">Warning</p>
  1756. <p>Setting <code>GODEBUG=http2debug=2</code> on the operator does produce HTTP/2 frame dumps
  1757. including authorization headers and full bodies, entirely unredacted. It only covers
  1758. HTTP/2, it is not a supported debugging path, and it must not be enabled against a
  1759. production instance.</p>
  1760. </div>
  1761. <h4 id="inspecting-traffic-with-a-logging-proxy">Inspecting traffic with a logging proxy</h4>
  1762. <p>The supported way to see the traffic is to put a proxy between the operator and the target
  1763. service, and read the proxy's logs. Point the webhook <code>url</code> at the proxy over plain HTTP so
  1764. the request is readable there, and let the proxy terminate TLS towards the real endpoint.
  1765. Running it as a sidecar keeps the plaintext hop inside the pod.</p>
  1766. <p>Add the sidecar and its config volume to the external-secrets deployment. Only the fields
  1767. relevant to the proxy are shown; keep the rest of the pod spec as it is.</p>
  1768. <div class="highlight"><pre><span></span><code><span class="c1"># spec.template.spec.containers</span>
  1769. <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">debug-proxy</span>
  1770. <span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx:alpine</span>
  1771. <span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
  1772. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containerPort</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8080</span>
  1773. <span class="w"> </span><span class="nt">volumeMounts</span><span class="p">:</span>
  1774. <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">debug-proxy-config</span>
  1775. <span class="w"> </span><span class="nt">mountPath</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/nginx/conf.d</span>
  1776. <span class="c1"># spec.template.spec.volumes</span>
  1777. <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">debug-proxy-config</span>
  1778. <span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1779. <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">debug-proxy-config</span>
  1780. </code></pre></div>
  1781. <p>The key must end in <code>.conf</code>, because the stock nginx config only includes
  1782. <code>/etc/nginx/conf.d/*.conf</code>. With any other key the sidecar starts and serves the default
  1783. nginx page instead of proxying.</p>
  1784. <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>
  1785. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ConfigMap</span>
  1786. <span class="nt">metadata</span><span class="p">:</span>
  1787. <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">debug-proxy-config</span>
  1788. <span class="nt">data</span><span class="p">:</span>
  1789. <span class="w"> </span><span class="nt">debug-proxy.conf</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1790. <span class="w"> </span><span class="no">log_format dump escape=none &#39;$request_method $uri $args -&gt; $upstream_status&#39;</span>
  1791. <span class="w"> </span><span class="no">&#39; authorization=&quot;$http_authorization&quot;&#39;;</span>
  1792. <span class="w"> </span><span class="no">server {</span>
  1793. <span class="w"> </span><span class="no">listen 8080;</span>
  1794. <span class="w"> </span><span class="no">access_log /dev/stdout dump;</span>
  1795. <span class="w"> </span><span class="no">location / {</span>
  1796. <span class="w"> </span><span class="no">proxy_pass https://secrets.example.com;</span>
  1797. <span class="w"> </span><span class="no">proxy_set_header Host secrets.example.com;</span>
  1798. <span class="w"> </span><span class="no"># nginx sends no SNI by default, which breaks endpoints that select a</span>
  1799. <span class="w"> </span><span class="no"># certificate by server name.</span>
  1800. <span class="w"> </span><span class="no">proxy_ssl_server_name on;</span>
  1801. <span class="w"> </span><span class="no">}</span>
  1802. <span class="w"> </span><span class="no">}</span>
  1803. </code></pre></div>
  1804. <p>That logs the request method, path and query, the upstream status, and the <code>Authorization</code>
  1805. header. Add more <code>$http_&lt;header&gt;</code> variables to the <code>log_format</code> for other headers. Request
  1806. and response bodies are not captured; use <code>mirror</code> or a dedicated capture proxy if you need
  1807. them.</p>
  1808. <p>Then set <code>url: "http://localhost:8080/..."</code> on the store while debugging. Remember that the
  1809. proxy log now contains the same credentials the operator refuses to log, so treat it as
  1810. sensitive and remove the sidecar when you are done.</p>
  1811. <div class="admonition warning">
  1812. <p class="admonition-title">Warning</p>
  1813. <p>nginx does not verify the upstream certificate unless <code>proxy_ssl_verify on</code> and
  1814. <code>proxy_ssl_trusted_certificate</code> are set, so this proxy is deliberately more permissive
  1815. than the operator. Do not use it to diagnose TLS trust problems: a <code>caProvider</code> or
  1816. certificate error will appear to go away as soon as the proxy is in the path.</p>
  1817. </div>
  1818. <h4 id="referenced-secrets-must-be-labeled">Referenced secrets must be labeled</h4>
  1819. <p>Every Secret the webhook reads must carry the label <code>external-secrets.io/type: webhook</code>.
  1820. That covers <code>spec.provider.webhook.secrets</code> on a <code>SecretStore</code> or <code>ClusterSecretStore</code>,
  1821. <code>spec.secrets</code> on a <code>Webhook</code> generator, and the <code>usernameSecret</code> and <code>passwordSecret</code> of
  1822. <code>auth.ntlm</code>, which resolve through the same code path. Without it the lookup fails with:</p>
  1823. <div class="highlight"><pre><span></span><code>secret does not contain needed label &#39;external-secrets.io/type: webhook&#39;. Update secret label to use it with webhook
  1824. </code></pre></div>
  1825. <h4 id="template-values-are-two-levels-deep">Template values are two levels deep</h4>
  1826. <p>Secrets listed under <code>secrets</code> are exposed as <code>.&lt;name&gt;.&lt;keyInSecret&gt;</code>, not <code>.&lt;name&gt;</code>. For:</p>
  1827. <div class="highlight"><pre><span></span><code><span class="nt">secrets</span><span class="p">:</span>
  1828. <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">creds</span>
  1829. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1830. <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">webhook-credentials</span>
  1831. </code></pre></div>
  1832. <p>the values are <code>{{ .creds.username }}</code> and <code>{{ .creds.password }}</code>. Referring to
  1833. <code>{{ .creds }}</code> renders a Go map rather than a value. Note also that every key of the
  1834. referenced secret is exposed; a <code>key</code> field on the <code>secretRef</code> does not narrow it.</p>
  1835. <h4 id="a-templated-url-is-validated-before-templating">A templated <code>url</code> is validated before templating</h4>
  1836. <p>Store validation performs a reachability check against <code>spec.provider.webhook.url</code> as
  1837. written, before the templating engine runs. A url whose host comes from a template
  1838. therefore fails validation with a message such as:</p>
  1839. <div class="highlight"><pre><span></span><code>error accessing external store: dial tcp :443: connect: connection refused
  1840. </code></pre></div>
  1841. <p>even when the templated request itself would succeed. Keep the host literal and template
  1842. only the path or query string.</p>
  1843. </article>
  1844. </div>
  1845. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1846. </div>
  1847. </main>
  1848. <img referrerpolicy="no-referrer-when-downgrade"
  1849. src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""
  1850. hidden />
  1851. <footer class="md-footer">
  1852. <div class="md-footer-meta md-typeset">
  1853. <div class="md-footer-meta__inner md-grid">
  1854. <div class="md-copyright">
  1855. <div class="md-copyright__highlight">
  1856. &copy; 2025 The external-secrets Authors.<br/>
  1857. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1858. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1859. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1860. </div>
  1861. Made with
  1862. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1863. Material for MkDocs
  1864. </a>
  1865. </div>
  1866. </div>
  1867. </div>
  1868. </footer>
  1869. </div>
  1870. <div class="md-dialog" data-md-component="dialog">
  1871. <div class="md-dialog__inner md-typeset"></div>
  1872. </div>
  1873. <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "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>
  1874. <script src="../../assets/javascripts/bundle.d7400e89.min.js"></script>
  1875. </body>
  1876. </html>