index.html 76 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118
  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="../../examples/bitwarden/">
  7. <link rel="next" href="../process/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.2">
  10. <title>Developer guide - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.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="#getting-started" 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. Developer guide
  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">
  137. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item md-tabs__item--active">
  147. <a href="./" 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/quay/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. Quay
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../../api/generator/vault/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. Vault Dynamic Secret
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/generator/password/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Password
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../api/generator/fake/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. Fake
  412. </span>
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../api/generator/webhook/" class="md-nav__link">
  417. <span class="md-ellipsis">
  418. Webhook
  419. </span>
  420. </a>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../../api/generator/github/" class="md-nav__link">
  424. <span class="md-ellipsis">
  425. Github
  426. </span>
  427. </a>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="../../api/generator/uuid/" class="md-nav__link">
  431. <span class="md-ellipsis">
  432. UUID
  433. </span>
  434. </a>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../../api/generator/mfa/" class="md-nav__link">
  438. <span class="md-ellipsis">
  439. MFA
  440. </span>
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../api/generator/sshkey/" class="md-nav__link">
  445. <span class="md-ellipsis">
  446. SSHKey
  447. </span>
  448. </a>
  449. </li>
  450. </ul>
  451. </nav>
  452. </li>
  453. <li class="md-nav__item md-nav__item--nested">
  454. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  455. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  456. <span class="md-ellipsis">
  457. Reference Docs
  458. </span>
  459. <span class="md-nav__icon md-icon"></span>
  460. </label>
  461. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  462. <label class="md-nav__title" for="__nav_2_4">
  463. <span class="md-nav__icon md-icon"></span>
  464. Reference Docs
  465. </label>
  466. <ul class="md-nav__list" data-md-scrollfix>
  467. <li class="md-nav__item">
  468. <a href="../../api/spec/" class="md-nav__link">
  469. <span class="md-ellipsis">
  470. API specification
  471. </span>
  472. </a>
  473. </li>
  474. <li class="md-nav__item">
  475. <a href="../../api/controller-options/" class="md-nav__link">
  476. <span class="md-ellipsis">
  477. Controller Options
  478. </span>
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../../api/metrics/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. Metrics
  485. </span>
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../api/selectable-fields/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. Selectable Fields
  492. </span>
  493. </a>
  494. </li>
  495. </ul>
  496. </nav>
  497. </li>
  498. </ul>
  499. </nav>
  500. </li>
  501. <li class="md-nav__item md-nav__item--nested">
  502. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  503. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  504. <span class="md-ellipsis">
  505. Guides
  506. </span>
  507. <span class="md-nav__icon md-icon"></span>
  508. </label>
  509. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  510. <label class="md-nav__title" for="__nav_3">
  511. <span class="md-nav__icon md-icon"></span>
  512. Guides
  513. </label>
  514. <ul class="md-nav__list" data-md-scrollfix>
  515. <li class="md-nav__item">
  516. <a href="../../guides/introduction/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. Introduction
  519. </span>
  520. </a>
  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_2" >
  524. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  525. <span class="md-ellipsis">
  526. External Secrets
  527. </span>
  528. <span class="md-nav__icon md-icon"></span>
  529. </label>
  530. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  531. <label class="md-nav__title" for="__nav_3_2">
  532. <span class="md-nav__icon md-icon"></span>
  533. External Secrets
  534. </label>
  535. <ul class="md-nav__list" data-md-scrollfix>
  536. <li class="md-nav__item">
  537. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  538. <span class="md-ellipsis">
  539. Extract structured data
  540. </span>
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../guides/getallsecrets/" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. Find Secrets by Name or Metadata
  547. </span>
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. Rewriting Keys
  554. </span>
  555. </a>
  556. </li>
  557. <li class="md-nav__item md-nav__item--nested">
  558. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  559. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  560. <span class="md-ellipsis">
  561. Advanced Templating
  562. </span>
  563. <span class="md-nav__icon md-icon"></span>
  564. </label>
  565. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  566. <label class="md-nav__title" for="__nav_3_2_4">
  567. <span class="md-nav__icon md-icon"></span>
  568. Advanced Templating
  569. </label>
  570. <ul class="md-nav__list" data-md-scrollfix>
  571. <li class="md-nav__item">
  572. <a href="../../guides/templating/" class="md-nav__link">
  573. <span class="md-ellipsis">
  574. v2
  575. </span>
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../guides/templating-v1/" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. v1
  582. </span>
  583. </a>
  584. </li>
  585. </ul>
  586. </nav>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  590. <span class="md-ellipsis">
  591. Kubernetes Secret Types
  592. </span>
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. Lifecycle: ownership & deletion
  599. </span>
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  604. <span class="md-ellipsis">
  605. Decoding Strategies
  606. </span>
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="../../guides/controller-class/" class="md-nav__link">
  611. <span class="md-ellipsis">
  612. Controller Classes
  613. </span>
  614. </a>
  615. </li>
  616. </ul>
  617. </nav>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../../guides/targeting-custom-resources/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Targeting Custom Resources
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../guides/generator/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Generators
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../guides/pushsecrets/" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. Push Secrets
  637. </span>
  638. </a>
  639. </li>
  640. <li class="md-nav__item md-nav__item--nested">
  641. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  642. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  643. <span class="md-ellipsis">
  644. Operations
  645. </span>
  646. <span class="md-nav__icon md-icon"></span>
  647. </label>
  648. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  649. <label class="md-nav__title" for="__nav_3_6">
  650. <span class="md-nav__icon md-icon"></span>
  651. Operations
  652. </label>
  653. <ul class="md-nav__list" data-md-scrollfix>
  654. <li class="md-nav__item">
  655. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. Multi Tenancy
  658. </span>
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../../guides/security-best-practices/" class="md-nav__link">
  663. <span class="md-ellipsis">
  664. Security Best Practices
  665. </span>
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../guides/threat-model/" class="md-nav__link">
  670. <span class="md-ellipsis">
  671. Threat Model
  672. </span>
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../guides/v1beta1/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. Upgrading to v1beta1
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../guides/using-latest-image/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. Using Latest Image
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Disable Cluster Features
  693. </span>
  694. </a>
  695. </li>
  696. </ul>
  697. </nav>
  698. </li>
  699. <li class="md-nav__item md-nav__item--nested">
  700. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_7" >
  701. <label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="0">
  702. <span class="md-ellipsis">
  703. Tooling
  704. </span>
  705. <span class="md-nav__icon md-icon"></span>
  706. </label>
  707. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
  708. <label class="md-nav__title" for="__nav_3_7">
  709. <span class="md-nav__icon md-icon"></span>
  710. Tooling
  711. </label>
  712. <ul class="md-nav__list" data-md-scrollfix>
  713. <li class="md-nav__item">
  714. <a href="../../guides/using-esoctl-tool/" class="md-nav__link">
  715. <span class="md-ellipsis">
  716. Using the esoctl tool
  717. </span>
  718. </a>
  719. </li>
  720. </ul>
  721. </nav>
  722. </li>
  723. </ul>
  724. </nav>
  725. </li>
  726. <li class="md-nav__item md-nav__item--nested">
  727. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  728. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  729. <span class="md-ellipsis">
  730. Provider
  731. </span>
  732. <span class="md-nav__icon md-icon"></span>
  733. </label>
  734. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  735. <label class="md-nav__title" for="__nav_4">
  736. <span class="md-nav__icon md-icon"></span>
  737. Provider
  738. </label>
  739. <ul class="md-nav__list" data-md-scrollfix>
  740. <li class="md-nav__item">
  741. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  742. <span class="md-ellipsis">
  743. AWS Secrets Manager
  744. </span>
  745. </a>
  746. </li>
  747. <li class="md-nav__item">
  748. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  749. <span class="md-ellipsis">
  750. AWS Parameter Store
  751. </span>
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="../../provider/aws-access/" class="md-nav__link">
  756. <span class="md-ellipsis">
  757. AWS Access
  758. </span>
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. Azure Key Vault
  765. </span>
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../../provider/barbican/" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Barbican
  772. </span>
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="../../provider/beyondtrust/" class="md-nav__link">
  777. <span class="md-ellipsis">
  778. BeyondTrust
  779. </span>
  780. </a>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. Bitwarden Secrets Manager
  786. </span>
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="../../provider/chef/" class="md-nav__link">
  791. <span class="md-ellipsis">
  792. Chef
  793. </span>
  794. </a>
  795. </li>
  796. <li class="md-nav__item">
  797. <a href="../../provider/cloudru/" class="md-nav__link">
  798. <span class="md-ellipsis">
  799. Cloud.ru Secret Manager
  800. </span>
  801. </a>
  802. </li>
  803. <li class="md-nav__item">
  804. <a href="../../provider/conjur/" class="md-nav__link">
  805. <span class="md-ellipsis">
  806. CyberArk Conjur
  807. </span>
  808. </a>
  809. </li>
  810. <li class="md-nav__item">
  811. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  812. <span class="md-ellipsis">
  813. Google Cloud Secret Manager
  814. </span>
  815. </a>
  816. </li>
  817. <li class="md-nav__item">
  818. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  819. <span class="md-ellipsis">
  820. HashiCorp Vault
  821. </span>
  822. </a>
  823. </li>
  824. <li class="md-nav__item">
  825. <a href="../../provider/kubernetes/" class="md-nav__link">
  826. <span class="md-ellipsis">
  827. Kubernetes
  828. </span>
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  833. <span class="md-ellipsis">
  834. IBM Secrets Manager
  835. </span>
  836. </a>
  837. </li>
  838. <li class="md-nav__item">
  839. <a href="../../provider/akeyless/" class="md-nav__link">
  840. <span class="md-ellipsis">
  841. Akeyless
  842. </span>
  843. </a>
  844. </li>
  845. <li class="md-nav__item">
  846. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  847. <span class="md-ellipsis">
  848. Yandex Certificate Manager
  849. </span>
  850. </a>
  851. </li>
  852. <li class="md-nav__item">
  853. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  854. <span class="md-ellipsis">
  855. Yandex Lockbox
  856. </span>
  857. </a>
  858. </li>
  859. <li class="md-nav__item">
  860. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  861. <span class="md-ellipsis">
  862. GitLab Variables
  863. </span>
  864. </a>
  865. </li>
  866. <li class="md-nav__item">
  867. <a href="../../provider/github/" class="md-nav__link">
  868. <span class="md-ellipsis">
  869. Github Actions Secrets
  870. </span>
  871. </a>
  872. </li>
  873. <li class="md-nav__item">
  874. <a href="../../provider/oracle-vault/" class="md-nav__link">
  875. <span class="md-ellipsis">
  876. Oracle Vault
  877. </span>
  878. </a>
  879. </li>
  880. <li class="md-nav__item">
  881. <a href="../../provider/1password-automation/" class="md-nav__link">
  882. <span class="md-ellipsis">
  883. 1Password Connect Server
  884. </span>
  885. </a>
  886. </li>
  887. <li class="md-nav__item">
  888. <a href="../../provider/1password-sdk/" class="md-nav__link">
  889. <span class="md-ellipsis">
  890. 1Password SDK
  891. </span>
  892. </a>
  893. </li>
  894. <li class="md-nav__item">
  895. <a href="../../provider/webhook/" class="md-nav__link">
  896. <span class="md-ellipsis">
  897. Webhook
  898. </span>
  899. </a>
  900. </li>
  901. <li class="md-nav__item">
  902. <a href="../../provider/fake/" class="md-nav__link">
  903. <span class="md-ellipsis">
  904. Fake
  905. </span>
  906. </a>
  907. </li>
  908. <li class="md-nav__item">
  909. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  910. <span class="md-ellipsis">
  911. senhasegura DevOps Secrets Management (DSM)
  912. </span>
  913. </a>
  914. </li>
  915. <li class="md-nav__item">
  916. <a href="../../provider/doppler/" class="md-nav__link">
  917. <span class="md-ellipsis">
  918. Doppler
  919. </span>
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="../../provider/keeper-security/" class="md-nav__link">
  924. <span class="md-ellipsis">
  925. Keeper Security
  926. </span>
  927. </a>
  928. </li>
  929. <li class="md-nav__item">
  930. <a href="../../provider/cloak/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. Cloak End 2 End Encrypted Secrets
  933. </span>
  934. </a>
  935. </li>
  936. <li class="md-nav__item">
  937. <a href="../../provider/scaleway/" class="md-nav__link">
  938. <span class="md-ellipsis">
  939. Scaleway
  940. </span>
  941. </a>
  942. </li>
  943. <li class="md-nav__item">
  944. <a href="../../provider/delinea/" class="md-nav__link">
  945. <span class="md-ellipsis">
  946. Delinea
  947. </span>
  948. </a>
  949. </li>
  950. <li class="md-nav__item">
  951. <a href="../../provider/secretserver/" class="md-nav__link">
  952. <span class="md-ellipsis">
  953. Secret Server
  954. </span>
  955. </a>
  956. </li>
  957. <li class="md-nav__item">
  958. <a href="../../provider/passbolt/" class="md-nav__link">
  959. <span class="md-ellipsis">
  960. Passbolt
  961. </span>
  962. </a>
  963. </li>
  964. <li class="md-nav__item">
  965. <a href="../../provider/pulumi/" class="md-nav__link">
  966. <span class="md-ellipsis">
  967. Pulumi ESC
  968. </span>
  969. </a>
  970. </li>
  971. <li class="md-nav__item">
  972. <a href="../../provider/onboardbase/" class="md-nav__link">
  973. <span class="md-ellipsis">
  974. Onboardbase
  975. </span>
  976. </a>
  977. </li>
  978. <li class="md-nav__item">
  979. <a href="../../provider-passworddepot/" class="md-nav__link">
  980. <span class="md-ellipsis">
  981. Password Depot
  982. </span>
  983. </a>
  984. </li>
  985. <li class="md-nav__item">
  986. <a href="../../provider/fortanix/" class="md-nav__link">
  987. <span class="md-ellipsis">
  988. Fortanix
  989. </span>
  990. </a>
  991. </li>
  992. <li class="md-nav__item">
  993. <a href="../../provider/infisical/" class="md-nav__link">
  994. <span class="md-ellipsis">
  995. Infisical
  996. </span>
  997. </a>
  998. </li>
  999. <li class="md-nav__item">
  1000. <a href="../../provider/previder/" class="md-nav__link">
  1001. <span class="md-ellipsis">
  1002. Previder
  1003. </span>
  1004. </a>
  1005. </li>
  1006. <li class="md-nav__item">
  1007. <a href="../../provider/openbao/" class="md-nav__link">
  1008. <span class="md-ellipsis">
  1009. OpenBao
  1010. </span>
  1011. </a>
  1012. </li>
  1013. <li class="md-nav__item">
  1014. <a href="../../provider/volcengine/" class="md-nav__link">
  1015. <span class="md-ellipsis">
  1016. Volcengine
  1017. </span>
  1018. </a>
  1019. </li>
  1020. <li class="md-nav__item">
  1021. <a href="../../provider/ngrok/" class="md-nav__link">
  1022. <span class="md-ellipsis">
  1023. ngrok
  1024. </span>
  1025. </a>
  1026. </li>
  1027. <li class="md-nav__item">
  1028. <a href="../../provider/devolutions-server/" class="md-nav__link">
  1029. <span class="md-ellipsis">
  1030. Devolutions Server
  1031. </span>
  1032. </a>
  1033. </li>
  1034. </ul>
  1035. </nav>
  1036. </li>
  1037. <li class="md-nav__item md-nav__item--nested">
  1038. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1039. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1040. <span class="md-ellipsis">
  1041. Examples
  1042. </span>
  1043. <span class="md-nav__icon md-icon"></span>
  1044. </label>
  1045. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1046. <label class="md-nav__title" for="__nav_5">
  1047. <span class="md-nav__icon md-icon"></span>
  1048. Examples
  1049. </label>
  1050. <ul class="md-nav__list" data-md-scrollfix>
  1051. <li class="md-nav__item">
  1052. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1053. <span class="md-ellipsis">
  1054. FluxCD
  1055. </span>
  1056. </a>
  1057. </li>
  1058. <li class="md-nav__item">
  1059. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1060. <span class="md-ellipsis">
  1061. Anchore Engine
  1062. </span>
  1063. </a>
  1064. </li>
  1065. <li class="md-nav__item">
  1066. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1067. <span class="md-ellipsis">
  1068. Jenkins
  1069. </span>
  1070. </a>
  1071. </li>
  1072. <li class="md-nav__item">
  1073. <a href="../../examples/bitwarden/" class="md-nav__link">
  1074. <span class="md-ellipsis">
  1075. Bitwarden
  1076. </span>
  1077. </a>
  1078. </li>
  1079. </ul>
  1080. </nav>
  1081. </li>
  1082. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  1083. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
  1084. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  1085. <span class="md-ellipsis">
  1086. Community
  1087. </span>
  1088. <span class="md-nav__icon md-icon"></span>
  1089. </label>
  1090. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
  1091. <label class="md-nav__title" for="__nav_6">
  1092. <span class="md-nav__icon md-icon"></span>
  1093. Community
  1094. </label>
  1095. <ul class="md-nav__list" data-md-scrollfix>
  1096. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  1097. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
  1098. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1099. <span class="md-ellipsis">
  1100. Contributing
  1101. </span>
  1102. <span class="md-nav__icon md-icon"></span>
  1103. </label>
  1104. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
  1105. <label class="md-nav__title" for="__nav_6_1">
  1106. <span class="md-nav__icon md-icon"></span>
  1107. Contributing
  1108. </label>
  1109. <ul class="md-nav__list" data-md-scrollfix>
  1110. <li class="md-nav__item md-nav__item--active">
  1111. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  1112. <label class="md-nav__link md-nav__link--active" for="__toc">
  1113. <span class="md-ellipsis">
  1114. Developer guide
  1115. </span>
  1116. <span class="md-nav__icon md-icon"></span>
  1117. </label>
  1118. <a href="./" class="md-nav__link md-nav__link--active">
  1119. <span class="md-ellipsis">
  1120. Developer guide
  1121. </span>
  1122. </a>
  1123. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1124. <label class="md-nav__title" for="__toc">
  1125. <span class="md-nav__icon md-icon"></span>
  1126. Table of contents
  1127. </label>
  1128. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1129. <li class="md-nav__item">
  1130. <a href="#getting-started" class="md-nav__link">
  1131. <span class="md-ellipsis">
  1132. Getting Started
  1133. </span>
  1134. </a>
  1135. </li>
  1136. <li class="md-nav__item">
  1137. <a href="#building-testing" class="md-nav__link">
  1138. <span class="md-ellipsis">
  1139. Building &amp; Testing
  1140. </span>
  1141. </a>
  1142. </li>
  1143. <li class="md-nav__item">
  1144. <a href="#license-headers" class="md-nav__link">
  1145. <span class="md-ellipsis">
  1146. License Headers
  1147. </span>
  1148. </a>
  1149. </li>
  1150. <li class="md-nav__item">
  1151. <a href="#using-tilt" class="md-nav__link">
  1152. <span class="md-ellipsis">
  1153. Using Tilt
  1154. </span>
  1155. </a>
  1156. </li>
  1157. <li class="md-nav__item">
  1158. <a href="#installing" class="md-nav__link">
  1159. <span class="md-ellipsis">
  1160. Installing
  1161. </span>
  1162. </a>
  1163. </li>
  1164. <li class="md-nav__item">
  1165. <a href="#documentation" class="md-nav__link">
  1166. <span class="md-ellipsis">
  1167. Documentation
  1168. </span>
  1169. </a>
  1170. </li>
  1171. </ul>
  1172. </nav>
  1173. </li>
  1174. <li class="md-nav__item">
  1175. <a href="../process/" class="md-nav__link">
  1176. <span class="md-ellipsis">
  1177. Contributing Process
  1178. </span>
  1179. </a>
  1180. </li>
  1181. <li class="md-nav__item">
  1182. <a href="../release/" class="md-nav__link">
  1183. <span class="md-ellipsis">
  1184. Release Process
  1185. </span>
  1186. </a>
  1187. </li>
  1188. <li class="md-nav__item">
  1189. <a href="../coc/" class="md-nav__link">
  1190. <span class="md-ellipsis">
  1191. Code of Conduct
  1192. </span>
  1193. </a>
  1194. </li>
  1195. <li class="md-nav__item">
  1196. <a href="../calendar/" class="md-nav__link">
  1197. <span class="md-ellipsis">
  1198. Community meetings calendar
  1199. </span>
  1200. </a>
  1201. </li>
  1202. <li class="md-nav__item">
  1203. <a href="../roadmap/" class="md-nav__link">
  1204. <span class="md-ellipsis">
  1205. Roadmap
  1206. </span>
  1207. </a>
  1208. </li>
  1209. <li class="md-nav__item">
  1210. <a href="../burnout-mitigation/" class="md-nav__link">
  1211. <span class="md-ellipsis">
  1212. Burnout Prevention
  1213. </span>
  1214. </a>
  1215. </li>
  1216. <li class="md-nav__item">
  1217. <a href="../llm-policy/" class="md-nav__link">
  1218. <span class="md-ellipsis">
  1219. LLM Policy
  1220. </span>
  1221. </a>
  1222. </li>
  1223. </ul>
  1224. </nav>
  1225. </li>
  1226. <li class="md-nav__item md-nav__item--nested">
  1227. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1228. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1229. <span class="md-ellipsis">
  1230. External Resources
  1231. </span>
  1232. <span class="md-nav__icon md-icon"></span>
  1233. </label>
  1234. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1235. <label class="md-nav__title" for="__nav_6_2">
  1236. <span class="md-nav__icon md-icon"></span>
  1237. External Resources
  1238. </label>
  1239. <ul class="md-nav__list" data-md-scrollfix>
  1240. <li class="md-nav__item">
  1241. <a href="../../eso-talks/" class="md-nav__link">
  1242. <span class="md-ellipsis">
  1243. Talks
  1244. </span>
  1245. </a>
  1246. </li>
  1247. <li class="md-nav__item">
  1248. <a href="../../eso-demos/" class="md-nav__link">
  1249. <span class="md-ellipsis">
  1250. Demos
  1251. </span>
  1252. </a>
  1253. </li>
  1254. <li class="md-nav__item">
  1255. <a href="../../eso-blogs/" class="md-nav__link">
  1256. <span class="md-ellipsis">
  1257. Blogs
  1258. </span>
  1259. </a>
  1260. </li>
  1261. <li class="md-nav__item">
  1262. <a href="../../eso-tools/" class="md-nav__link">
  1263. <span class="md-ellipsis">
  1264. Tools
  1265. </span>
  1266. </a>
  1267. </li>
  1268. </ul>
  1269. </nav>
  1270. </li>
  1271. </ul>
  1272. </nav>
  1273. </li>
  1274. </ul>
  1275. </nav>
  1276. </div>
  1277. </div>
  1278. </div>
  1279. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1280. <div class="md-sidebar__scrollwrap">
  1281. <div class="md-sidebar__inner">
  1282. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1283. <label class="md-nav__title" for="__toc">
  1284. <span class="md-nav__icon md-icon"></span>
  1285. Table of contents
  1286. </label>
  1287. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1288. <li class="md-nav__item">
  1289. <a href="#getting-started" class="md-nav__link">
  1290. <span class="md-ellipsis">
  1291. Getting Started
  1292. </span>
  1293. </a>
  1294. </li>
  1295. <li class="md-nav__item">
  1296. <a href="#building-testing" class="md-nav__link">
  1297. <span class="md-ellipsis">
  1298. Building &amp; Testing
  1299. </span>
  1300. </a>
  1301. </li>
  1302. <li class="md-nav__item">
  1303. <a href="#license-headers" class="md-nav__link">
  1304. <span class="md-ellipsis">
  1305. License Headers
  1306. </span>
  1307. </a>
  1308. </li>
  1309. <li class="md-nav__item">
  1310. <a href="#using-tilt" class="md-nav__link">
  1311. <span class="md-ellipsis">
  1312. Using Tilt
  1313. </span>
  1314. </a>
  1315. </li>
  1316. <li class="md-nav__item">
  1317. <a href="#installing" class="md-nav__link">
  1318. <span class="md-ellipsis">
  1319. Installing
  1320. </span>
  1321. </a>
  1322. </li>
  1323. <li class="md-nav__item">
  1324. <a href="#documentation" class="md-nav__link">
  1325. <span class="md-ellipsis">
  1326. Documentation
  1327. </span>
  1328. </a>
  1329. </li>
  1330. </ul>
  1331. </nav>
  1332. </div>
  1333. </div>
  1334. </div>
  1335. <div class="md-content" data-md-component="content">
  1336. <article class="md-content__inner md-typeset">
  1337. <h1>Developer guide</h1>
  1338. <h2 id="getting-started">Getting Started</h2>
  1339. <p>You must have a working <a href="https://golang.org/doc/install">Go environment</a> and
  1340. then clone the repo:</p>
  1341. <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/external-secrets/external-secrets.git
  1342. <span class="nb">cd</span><span class="w"> </span>external-secrets
  1343. </code></pre></div>
  1344. <p><em>Note: many of the <code>make</code> commands use <a href="https://github.com/mikefarah/yq">yq</a>, version 4.2X.X or higher.</em></p>
  1345. <p>Our helm chart is tested using <code>helm-unittest</code>. You will need it to run tests locally if you modify the helm chart.</p>
  1346. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>helm.test
  1347. make<span class="w"> </span>helm.test.update
  1348. </code></pre></div>
  1349. <h2 id="building-testing">Building &amp; Testing</h2>
  1350. <p>The project uses the <code>make</code> build system. It'll run code generators, tests and
  1351. static code analysis.</p>
  1352. <p>Building the operator binary and docker image:</p>
  1353. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>build
  1354. make<span class="w"> </span>docker.build<span class="w"> </span><span class="nv">IMAGE_NAME</span><span class="o">=</span>external-secrets<span class="w"> </span><span class="nv">IMAGE_TAG</span><span class="o">=</span>latest
  1355. </code></pre></div>
  1356. <p>Run tests and lint the code:
  1357. <div class="highlight"><pre><span></span><code>make<span class="w"> </span><span class="nb">test</span>
  1358. make<span class="w"> </span>lint<span class="w"> </span><span class="c1"># OR</span>
  1359. docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>-v<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>:/app<span class="w"> </span>-w<span class="w"> </span>/app<span class="w"> </span>golangci/golangci-lint:v1.49.0<span class="w"> </span>golangci-lint<span class="w"> </span>run
  1360. </code></pre></div></p>
  1361. <p>Build the documentation:
  1362. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs
  1363. </code></pre></div></p>
  1364. <h2 id="license-headers">License Headers</h2>
  1365. <p>All Go source files must include the Apache License 2.0 header. The CI automatically checks license headers for new files added in pull requests using <a href="https://github.com/apache/skywalking-eyes">Apache SkyWalking Eyes</a>.</p>
  1366. <p>If you need to check license headers locally, you can use the SkyWalking Eyes tool directly. The configuration is in <code>.licenserc.yaml</code> at the project root.</p>
  1367. <h2 id="using-tilt">Using Tilt</h2>
  1368. <p><a href="https://tilt.dev">Tilt</a> can be used to develop external-secrets. Tilt will hot-reload changes to the code and replace
  1369. the running binary in the container using a process manager of its own.</p>
  1370. <p>To run tilt, download the utility for your operating system and run <code>make tilt-up</code>. This will do two things:
  1371. - downloads tilt for the current OS and ARCH under <code>bin/tilt</code>
  1372. - make manifest files of your current changes and place them under <code>./bin/deploy/manifests/external-secrets.yaml</code>
  1373. - run tilt with <code>tilt run</code></p>
  1374. <p>Hit <code>space</code> and you can observe all the pods starting up and track their output in the tilt UI.</p>
  1375. <h2 id="installing">Installing</h2>
  1376. <p>To install the External Secret Operator into a Kubernetes Cluster run:</p>
  1377. <div class="highlight"><pre><span></span><code>helm<span class="w"> </span>repo<span class="w"> </span>add<span class="w"> </span>external-secrets<span class="w"> </span>https://charts.external-secrets.io
  1378. helm<span class="w"> </span>repo<span class="w"> </span>update
  1379. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span>external-secrets/external-secrets
  1380. </code></pre></div>
  1381. <p>You can alternatively run the controller on your host system for development purposes:</p>
  1382. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>crds.install
  1383. make<span class="w"> </span>run
  1384. </code></pre></div>
  1385. <p>To remove the CRDs run:</p>
  1386. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>crds.uninstall
  1387. </code></pre></div>
  1388. <p>If you need to test some other k8s integrations and need the operator to be deployed to the actual cluster while developing, you can use the following workflow:</p>
  1389. <div class="highlight"><pre><span></span><code><span class="c1"># Start a local K8S cluster with KinD</span>
  1390. kind<span class="w"> </span>create<span class="w"> </span>cluster<span class="w"> </span>--name<span class="w"> </span>external-secrets
  1391. <span class="nb">export</span><span class="w"> </span><span class="nv">TAG</span><span class="o">=</span><span class="k">$(</span>make<span class="w"> </span>docker.tag<span class="k">)</span>
  1392. <span class="nb">export</span><span class="w"> </span><span class="nv">IMAGE</span><span class="o">=</span><span class="k">$(</span>make<span class="w"> </span>docker.imagename<span class="k">)</span>
  1393. <span class="c1"># Build docker image</span>
  1394. make<span class="w"> </span>docker.build
  1395. <span class="c1"># Load docker image into local kind cluster</span>
  1396. kind<span class="w"> </span>load<span class="w"> </span>docker-image<span class="w"> </span><span class="nv">$IMAGE</span>:<span class="nv">$TAG</span><span class="w"> </span>--name<span class="w"> </span>external-secrets
  1397. <span class="c1"># (Optional) Pull the image from GitHub Repo to copy into kind</span>
  1398. <span class="c1"># docker pull ghcr.io/external-secrets/external-secrets:v0.8.2</span>
  1399. <span class="c1"># kind load docker-image ghcr.io/external-secrets/external-secrets:v0.8.2 -n external-secrets</span>
  1400. <span class="c1"># export TAG=v0.8.2</span>
  1401. <span class="c1"># Update helm charts and install to KinD cluster</span>
  1402. make<span class="w"> </span>helm.generate
  1403. helm<span class="w"> </span>upgrade<span class="w"> </span>--install<span class="w"> </span>external-secrets<span class="w"> </span>./deploy/charts/external-secrets/<span class="w"> </span><span class="se">\</span>
  1404. --set<span class="w"> </span>image.repository<span class="o">=</span><span class="nv">$IMAGE</span><span class="w"> </span>--set<span class="w"> </span>image.tag<span class="o">=</span><span class="nv">$TAG</span><span class="w"> </span><span class="se">\</span>
  1405. --set<span class="w"> </span>webhook.image.repository<span class="o">=</span><span class="nv">$IMAGE</span><span class="w"> </span>--set<span class="w"> </span>webhook.image.tag<span class="o">=</span><span class="nv">$TAG</span><span class="w"> </span><span class="se">\</span>
  1406. --set<span class="w"> </span>certController.image.repository<span class="o">=</span><span class="nv">$IMAGE</span><span class="w"> </span>--set<span class="w"> </span>certController.image.tag<span class="o">=</span><span class="nv">$TAG</span>
  1407. <span class="c1"># Command to delete the cluster when done</span>
  1408. <span class="c1"># kind delete cluster -n external-secrets</span>
  1409. </code></pre></div>
  1410. <div class="admonition note">
  1411. <p class="admonition-title">Contributing Flow</p>
  1412. <p>The HOW TO guide for contributing is at the <a href="../process/">Contributing Process</a> page.</p>
  1413. </div>
  1414. <h2 id="documentation">Documentation</h2>
  1415. <p>We use <a href="https://squidfunk.github.io/mkdocs-material/">mkdocs material</a> and <a href="https://github.com/jimporter/mike">mike</a> to generate this
  1416. documentation. See <code>/docs</code> for the source code and <code>/hack/api-docs</code> for the build process.</p>
  1417. <p>When writing documentation it is advised to run the mkdocs server with livereload:</p>
  1418. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs.serve
  1419. </code></pre></div>
  1420. <p>Run the following command to run a complete build. The rendered assets are available under <code>/site</code>.</p>
  1421. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs
  1422. make<span class="w"> </span>docs.serve
  1423. </code></pre></div>
  1424. <p>Open <code>http://localhost:8000</code> in your browser.</p>
  1425. <p>Since mike uses a branch to create/update documentation, any docs operation will create a diff on your local <code>gh-pages</code> branch.</p>
  1426. <p>When finished writing/reviewing the docs, clean up your local docs branch changes with <code>git branch -D gh-pages</code></p>
  1427. </article>
  1428. </div>
  1429. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1430. </div>
  1431. </main>
  1432. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1433. <footer class="md-footer">
  1434. <div class="md-footer-meta md-typeset">
  1435. <div class="md-footer-meta__inner md-grid">
  1436. <div class="md-copyright">
  1437. <div class="md-copyright__highlight">
  1438. &copy; 2025 The external-secrets Authors.<br/>
  1439. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1440. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1441. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1442. </div>
  1443. Made with
  1444. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1445. Material for MkDocs
  1446. </a>
  1447. </div>
  1448. </div>
  1449. </div>
  1450. </footer>
  1451. </div>
  1452. <div class="md-dialog" data-md-component="dialog">
  1453. <div class="md-dialog__inner md-typeset"></div>
  1454. </div>
  1455. <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>
  1456. <script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
  1457. </body>
  1458. </html>