index.html 86 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308
  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="../disable-cluster-features/">
  7. <link rel="next" href="../../provider/aws-secrets-manager/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
  10. <title>Using the esoctl tool - 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="#using-the-esoctl-tool" 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. Using the esoctl tool
  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 md-tabs__item--active">
  132. <a href="../introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item">
  137. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 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--active md-nav__item--section md-nav__item--nested">
  502. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  503. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  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="true">
  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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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--active md-nav__item--nested">
  700. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_7" checked>
  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="true">
  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 md-nav__item--active">
  714. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  715. <label class="md-nav__link md-nav__link--active" for="__toc">
  716. <span class="md-ellipsis">
  717. Using the esoctl tool
  718. </span>
  719. <span class="md-nav__icon md-icon"></span>
  720. </label>
  721. <a href="./" class="md-nav__link md-nav__link--active">
  722. <span class="md-ellipsis">
  723. Using the esoctl tool
  724. </span>
  725. </a>
  726. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  727. <label class="md-nav__title" for="__toc">
  728. <span class="md-nav__icon md-icon"></span>
  729. Table of contents
  730. </label>
  731. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  732. <li class="md-nav__item">
  733. <a href="#debugging-templates" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. Debugging templates
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="#bootstrapping-generator-code" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. Bootstrapping generator code
  743. </span>
  744. </a>
  745. <nav class="md-nav" aria-label="Bootstrapping generator code">
  746. <ul class="md-nav__list">
  747. <li class="md-nav__item">
  748. <a href="#example" class="md-nav__link">
  749. <span class="md-ellipsis">
  750. Example
  751. </span>
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="#flags" class="md-nav__link">
  756. <span class="md-ellipsis">
  757. flags
  758. </span>
  759. </a>
  760. <nav class="md-nav" aria-label="flags">
  761. <ul class="md-nav__list">
  762. <li class="md-nav__item">
  763. <a href="#name" class="md-nav__link">
  764. <span class="md-ellipsis">
  765. name
  766. </span>
  767. </a>
  768. </li>
  769. <li class="md-nav__item">
  770. <a href="#description" class="md-nav__link">
  771. <span class="md-ellipsis">
  772. description
  773. </span>
  774. </a>
  775. </li>
  776. <li class="md-nav__item">
  777. <a href="#package-optional" class="md-nav__link">
  778. <span class="md-ellipsis">
  779. package (optional)
  780. </span>
  781. </a>
  782. </li>
  783. </ul>
  784. </nav>
  785. </li>
  786. </ul>
  787. </nav>
  788. </li>
  789. </ul>
  790. </nav>
  791. </li>
  792. </ul>
  793. </nav>
  794. </li>
  795. </ul>
  796. </nav>
  797. </li>
  798. <li class="md-nav__item md-nav__item--nested">
  799. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  800. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  801. <span class="md-ellipsis">
  802. Provider
  803. </span>
  804. <span class="md-nav__icon md-icon"></span>
  805. </label>
  806. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  807. <label class="md-nav__title" for="__nav_4">
  808. <span class="md-nav__icon md-icon"></span>
  809. Provider
  810. </label>
  811. <ul class="md-nav__list" data-md-scrollfix>
  812. <li class="md-nav__item">
  813. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  814. <span class="md-ellipsis">
  815. AWS Secrets Manager
  816. </span>
  817. </a>
  818. </li>
  819. <li class="md-nav__item">
  820. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  821. <span class="md-ellipsis">
  822. AWS Parameter Store
  823. </span>
  824. </a>
  825. </li>
  826. <li class="md-nav__item">
  827. <a href="../../provider/aws-access/" class="md-nav__link">
  828. <span class="md-ellipsis">
  829. AWS Access
  830. </span>
  831. </a>
  832. </li>
  833. <li class="md-nav__item">
  834. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  835. <span class="md-ellipsis">
  836. Azure Key Vault
  837. </span>
  838. </a>
  839. </li>
  840. <li class="md-nav__item">
  841. <a href="../../provider/barbican/" class="md-nav__link">
  842. <span class="md-ellipsis">
  843. Barbican
  844. </span>
  845. </a>
  846. </li>
  847. <li class="md-nav__item">
  848. <a href="../../provider/beyondtrust/" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. BeyondTrust
  851. </span>
  852. </a>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  856. <span class="md-ellipsis">
  857. Bitwarden Secrets Manager
  858. </span>
  859. </a>
  860. </li>
  861. <li class="md-nav__item">
  862. <a href="../../provider/chef/" class="md-nav__link">
  863. <span class="md-ellipsis">
  864. Chef
  865. </span>
  866. </a>
  867. </li>
  868. <li class="md-nav__item">
  869. <a href="../../provider/cloudru/" class="md-nav__link">
  870. <span class="md-ellipsis">
  871. Cloud.ru Secret Manager
  872. </span>
  873. </a>
  874. </li>
  875. <li class="md-nav__item">
  876. <a href="../../provider/conjur/" class="md-nav__link">
  877. <span class="md-ellipsis">
  878. CyberArk Conjur
  879. </span>
  880. </a>
  881. </li>
  882. <li class="md-nav__item">
  883. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  884. <span class="md-ellipsis">
  885. Google Cloud Secret Manager
  886. </span>
  887. </a>
  888. </li>
  889. <li class="md-nav__item">
  890. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  891. <span class="md-ellipsis">
  892. HashiCorp Vault
  893. </span>
  894. </a>
  895. </li>
  896. <li class="md-nav__item">
  897. <a href="../../provider/kubernetes/" class="md-nav__link">
  898. <span class="md-ellipsis">
  899. Kubernetes
  900. </span>
  901. </a>
  902. </li>
  903. <li class="md-nav__item">
  904. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  905. <span class="md-ellipsis">
  906. IBM Secrets Manager
  907. </span>
  908. </a>
  909. </li>
  910. <li class="md-nav__item">
  911. <a href="../../provider/akeyless/" class="md-nav__link">
  912. <span class="md-ellipsis">
  913. Akeyless
  914. </span>
  915. </a>
  916. </li>
  917. <li class="md-nav__item">
  918. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  919. <span class="md-ellipsis">
  920. Yandex Certificate Manager
  921. </span>
  922. </a>
  923. </li>
  924. <li class="md-nav__item">
  925. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  926. <span class="md-ellipsis">
  927. Yandex Lockbox
  928. </span>
  929. </a>
  930. </li>
  931. <li class="md-nav__item">
  932. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  933. <span class="md-ellipsis">
  934. GitLab Variables
  935. </span>
  936. </a>
  937. </li>
  938. <li class="md-nav__item">
  939. <a href="../../provider/github/" class="md-nav__link">
  940. <span class="md-ellipsis">
  941. Github Actions Secrets
  942. </span>
  943. </a>
  944. </li>
  945. <li class="md-nav__item">
  946. <a href="../../provider/oracle-vault/" class="md-nav__link">
  947. <span class="md-ellipsis">
  948. Oracle Vault
  949. </span>
  950. </a>
  951. </li>
  952. <li class="md-nav__item">
  953. <a href="../../provider/1password-automation/" class="md-nav__link">
  954. <span class="md-ellipsis">
  955. 1Password Connect Server
  956. </span>
  957. </a>
  958. </li>
  959. <li class="md-nav__item">
  960. <a href="../../provider/1password-sdk/" class="md-nav__link">
  961. <span class="md-ellipsis">
  962. 1Password SDK
  963. </span>
  964. </a>
  965. </li>
  966. <li class="md-nav__item">
  967. <a href="../../provider/webhook/" class="md-nav__link">
  968. <span class="md-ellipsis">
  969. Webhook
  970. </span>
  971. </a>
  972. </li>
  973. <li class="md-nav__item">
  974. <a href="../../provider/fake/" class="md-nav__link">
  975. <span class="md-ellipsis">
  976. Fake
  977. </span>
  978. </a>
  979. </li>
  980. <li class="md-nav__item">
  981. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  982. <span class="md-ellipsis">
  983. senhasegura DevOps Secrets Management (DSM)
  984. </span>
  985. </a>
  986. </li>
  987. <li class="md-nav__item">
  988. <a href="../../provider/doppler/" class="md-nav__link">
  989. <span class="md-ellipsis">
  990. Doppler
  991. </span>
  992. </a>
  993. </li>
  994. <li class="md-nav__item">
  995. <a href="../../provider/keeper-security/" class="md-nav__link">
  996. <span class="md-ellipsis">
  997. Keeper Security
  998. </span>
  999. </a>
  1000. </li>
  1001. <li class="md-nav__item">
  1002. <a href="../../provider/cloak/" class="md-nav__link">
  1003. <span class="md-ellipsis">
  1004. Cloak End 2 End Encrypted Secrets
  1005. </span>
  1006. </a>
  1007. </li>
  1008. <li class="md-nav__item">
  1009. <a href="../../provider/scaleway/" class="md-nav__link">
  1010. <span class="md-ellipsis">
  1011. Scaleway
  1012. </span>
  1013. </a>
  1014. </li>
  1015. <li class="md-nav__item">
  1016. <a href="../../provider/delinea/" class="md-nav__link">
  1017. <span class="md-ellipsis">
  1018. Delinea
  1019. </span>
  1020. </a>
  1021. </li>
  1022. <li class="md-nav__item">
  1023. <a href="../../provider/secretserver/" class="md-nav__link">
  1024. <span class="md-ellipsis">
  1025. Secret Server
  1026. </span>
  1027. </a>
  1028. </li>
  1029. <li class="md-nav__item">
  1030. <a href="../../provider/passbolt/" class="md-nav__link">
  1031. <span class="md-ellipsis">
  1032. Passbolt
  1033. </span>
  1034. </a>
  1035. </li>
  1036. <li class="md-nav__item">
  1037. <a href="../../provider/pulumi/" class="md-nav__link">
  1038. <span class="md-ellipsis">
  1039. Pulumi ESC
  1040. </span>
  1041. </a>
  1042. </li>
  1043. <li class="md-nav__item">
  1044. <a href="../../provider/onboardbase/" class="md-nav__link">
  1045. <span class="md-ellipsis">
  1046. Onboardbase
  1047. </span>
  1048. </a>
  1049. </li>
  1050. <li class="md-nav__item">
  1051. <a href="../../provider-passworddepot/" class="md-nav__link">
  1052. <span class="md-ellipsis">
  1053. Password Depot
  1054. </span>
  1055. </a>
  1056. </li>
  1057. <li class="md-nav__item">
  1058. <a href="../../provider/fortanix/" class="md-nav__link">
  1059. <span class="md-ellipsis">
  1060. Fortanix
  1061. </span>
  1062. </a>
  1063. </li>
  1064. <li class="md-nav__item">
  1065. <a href="../../provider/infisical/" class="md-nav__link">
  1066. <span class="md-ellipsis">
  1067. Infisical
  1068. </span>
  1069. </a>
  1070. </li>
  1071. <li class="md-nav__item">
  1072. <a href="../../provider/previder/" class="md-nav__link">
  1073. <span class="md-ellipsis">
  1074. Previder
  1075. </span>
  1076. </a>
  1077. </li>
  1078. <li class="md-nav__item">
  1079. <a href="../../provider/openbao/" class="md-nav__link">
  1080. <span class="md-ellipsis">
  1081. OpenBao
  1082. </span>
  1083. </a>
  1084. </li>
  1085. <li class="md-nav__item">
  1086. <a href="../../provider/volcengine/" class="md-nav__link">
  1087. <span class="md-ellipsis">
  1088. Volcengine
  1089. </span>
  1090. </a>
  1091. </li>
  1092. <li class="md-nav__item">
  1093. <a href="../../provider/ngrok/" class="md-nav__link">
  1094. <span class="md-ellipsis">
  1095. ngrok
  1096. </span>
  1097. </a>
  1098. </li>
  1099. <li class="md-nav__item">
  1100. <a href="../../provider/devolutions-server/" class="md-nav__link">
  1101. <span class="md-ellipsis">
  1102. Devolutions Server
  1103. </span>
  1104. </a>
  1105. </li>
  1106. <li class="md-nav__item">
  1107. <a href="../../provider/nebius-mysterybox/" class="md-nav__link">
  1108. <span class="md-ellipsis">
  1109. Nebius MysteryBox
  1110. </span>
  1111. </a>
  1112. </li>
  1113. </ul>
  1114. </nav>
  1115. </li>
  1116. <li class="md-nav__item md-nav__item--nested">
  1117. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1118. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1119. <span class="md-ellipsis">
  1120. Examples
  1121. </span>
  1122. <span class="md-nav__icon md-icon"></span>
  1123. </label>
  1124. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1125. <label class="md-nav__title" for="__nav_5">
  1126. <span class="md-nav__icon md-icon"></span>
  1127. Examples
  1128. </label>
  1129. <ul class="md-nav__list" data-md-scrollfix>
  1130. <li class="md-nav__item">
  1131. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1132. <span class="md-ellipsis">
  1133. FluxCD
  1134. </span>
  1135. </a>
  1136. </li>
  1137. <li class="md-nav__item">
  1138. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1139. <span class="md-ellipsis">
  1140. Anchore Engine
  1141. </span>
  1142. </a>
  1143. </li>
  1144. <li class="md-nav__item">
  1145. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1146. <span class="md-ellipsis">
  1147. Jenkins
  1148. </span>
  1149. </a>
  1150. </li>
  1151. <li class="md-nav__item">
  1152. <a href="../../examples/bitwarden/" class="md-nav__link">
  1153. <span class="md-ellipsis">
  1154. Bitwarden
  1155. </span>
  1156. </a>
  1157. </li>
  1158. </ul>
  1159. </nav>
  1160. </li>
  1161. <li class="md-nav__item md-nav__item--nested">
  1162. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1163. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1164. <span class="md-ellipsis">
  1165. Community
  1166. </span>
  1167. <span class="md-nav__icon md-icon"></span>
  1168. </label>
  1169. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1170. <label class="md-nav__title" for="__nav_6">
  1171. <span class="md-nav__icon md-icon"></span>
  1172. Community
  1173. </label>
  1174. <ul class="md-nav__list" data-md-scrollfix>
  1175. <li class="md-nav__item md-nav__item--nested">
  1176. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1177. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1178. <span class="md-ellipsis">
  1179. Contributing
  1180. </span>
  1181. <span class="md-nav__icon md-icon"></span>
  1182. </label>
  1183. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1184. <label class="md-nav__title" for="__nav_6_1">
  1185. <span class="md-nav__icon md-icon"></span>
  1186. Contributing
  1187. </label>
  1188. <ul class="md-nav__list" data-md-scrollfix>
  1189. <li class="md-nav__item">
  1190. <a href="../../contributing/devguide/" class="md-nav__link">
  1191. <span class="md-ellipsis">
  1192. Developer guide
  1193. </span>
  1194. </a>
  1195. </li>
  1196. <li class="md-nav__item">
  1197. <a href="../../contributing/process/" class="md-nav__link">
  1198. <span class="md-ellipsis">
  1199. Contributing Process
  1200. </span>
  1201. </a>
  1202. </li>
  1203. <li class="md-nav__item">
  1204. <a href="../../contributing/release/" class="md-nav__link">
  1205. <span class="md-ellipsis">
  1206. Release Process
  1207. </span>
  1208. </a>
  1209. </li>
  1210. <li class="md-nav__item">
  1211. <a href="../../contributing/coc/" class="md-nav__link">
  1212. <span class="md-ellipsis">
  1213. Code of Conduct
  1214. </span>
  1215. </a>
  1216. </li>
  1217. <li class="md-nav__item">
  1218. <a href="../../contributing/calendar/" class="md-nav__link">
  1219. <span class="md-ellipsis">
  1220. Community meetings calendar
  1221. </span>
  1222. </a>
  1223. </li>
  1224. <li class="md-nav__item">
  1225. <a href="../../contributing/roadmap/" class="md-nav__link">
  1226. <span class="md-ellipsis">
  1227. Roadmap
  1228. </span>
  1229. </a>
  1230. </li>
  1231. <li class="md-nav__item">
  1232. <a href="../../contributing/burnout-mitigation/" class="md-nav__link">
  1233. <span class="md-ellipsis">
  1234. Burnout Prevention
  1235. </span>
  1236. </a>
  1237. </li>
  1238. <li class="md-nav__item">
  1239. <a href="../../contributing/llm-policy/" class="md-nav__link">
  1240. <span class="md-ellipsis">
  1241. LLM Policy
  1242. </span>
  1243. </a>
  1244. </li>
  1245. </ul>
  1246. </nav>
  1247. </li>
  1248. <li class="md-nav__item md-nav__item--nested">
  1249. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1250. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1251. <span class="md-ellipsis">
  1252. External Resources
  1253. </span>
  1254. <span class="md-nav__icon md-icon"></span>
  1255. </label>
  1256. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1257. <label class="md-nav__title" for="__nav_6_2">
  1258. <span class="md-nav__icon md-icon"></span>
  1259. External Resources
  1260. </label>
  1261. <ul class="md-nav__list" data-md-scrollfix>
  1262. <li class="md-nav__item">
  1263. <a href="../../eso-talks/" class="md-nav__link">
  1264. <span class="md-ellipsis">
  1265. Talks
  1266. </span>
  1267. </a>
  1268. </li>
  1269. <li class="md-nav__item">
  1270. <a href="../../eso-demos/" class="md-nav__link">
  1271. <span class="md-ellipsis">
  1272. Demos
  1273. </span>
  1274. </a>
  1275. </li>
  1276. <li class="md-nav__item">
  1277. <a href="../../eso-blogs/" class="md-nav__link">
  1278. <span class="md-ellipsis">
  1279. Blogs
  1280. </span>
  1281. </a>
  1282. </li>
  1283. <li class="md-nav__item">
  1284. <a href="../../eso-tools/" class="md-nav__link">
  1285. <span class="md-ellipsis">
  1286. Tools
  1287. </span>
  1288. </a>
  1289. </li>
  1290. </ul>
  1291. </nav>
  1292. </li>
  1293. </ul>
  1294. </nav>
  1295. </li>
  1296. </ul>
  1297. </nav>
  1298. </div>
  1299. </div>
  1300. </div>
  1301. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1302. <div class="md-sidebar__scrollwrap">
  1303. <div class="md-sidebar__inner">
  1304. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1305. <label class="md-nav__title" for="__toc">
  1306. <span class="md-nav__icon md-icon"></span>
  1307. Table of contents
  1308. </label>
  1309. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1310. <li class="md-nav__item">
  1311. <a href="#debugging-templates" class="md-nav__link">
  1312. <span class="md-ellipsis">
  1313. Debugging templates
  1314. </span>
  1315. </a>
  1316. </li>
  1317. <li class="md-nav__item">
  1318. <a href="#bootstrapping-generator-code" class="md-nav__link">
  1319. <span class="md-ellipsis">
  1320. Bootstrapping generator code
  1321. </span>
  1322. </a>
  1323. <nav class="md-nav" aria-label="Bootstrapping generator code">
  1324. <ul class="md-nav__list">
  1325. <li class="md-nav__item">
  1326. <a href="#example" class="md-nav__link">
  1327. <span class="md-ellipsis">
  1328. Example
  1329. </span>
  1330. </a>
  1331. </li>
  1332. <li class="md-nav__item">
  1333. <a href="#flags" class="md-nav__link">
  1334. <span class="md-ellipsis">
  1335. flags
  1336. </span>
  1337. </a>
  1338. <nav class="md-nav" aria-label="flags">
  1339. <ul class="md-nav__list">
  1340. <li class="md-nav__item">
  1341. <a href="#name" class="md-nav__link">
  1342. <span class="md-ellipsis">
  1343. name
  1344. </span>
  1345. </a>
  1346. </li>
  1347. <li class="md-nav__item">
  1348. <a href="#description" class="md-nav__link">
  1349. <span class="md-ellipsis">
  1350. description
  1351. </span>
  1352. </a>
  1353. </li>
  1354. <li class="md-nav__item">
  1355. <a href="#package-optional" class="md-nav__link">
  1356. <span class="md-ellipsis">
  1357. package (optional)
  1358. </span>
  1359. </a>
  1360. </li>
  1361. </ul>
  1362. </nav>
  1363. </li>
  1364. </ul>
  1365. </nav>
  1366. </li>
  1367. </ul>
  1368. </nav>
  1369. </div>
  1370. </div>
  1371. </div>
  1372. <div class="md-content" data-md-component="content">
  1373. <article class="md-content__inner md-typeset">
  1374. <h1 id="using-the-esoctl-tool">Using the esoctl tool</h1>
  1375. <p>The tool can be found under <code>cmd/esoctl</code>.</p>
  1376. <h2 id="debugging-templates">Debugging templates</h2>
  1377. <p>The <code>template</code> command can be used to test templates for <code>PushSecret</code> and <code>ExternalSecret</code>.</p>
  1378. <p>To run render simply execute <code>make build</code> in the <code>cmd/esoctl</code> folder. This will result in a binary under <code>cmd/esoctl/bin</code>.</p>
  1379. <p>Once the build succeeds, the command can be used as such:</p>
  1380. <div class="highlight"><pre><span></span><code>bin/esoctl template --source-templated-object template-test/push-secret.yaml --source-secret-data-file template-test/secret.yaml
  1381. </code></pre></div>
  1382. <p>Where template-test looks like this:</p>
  1383. <div class="highlight"><pre><span></span><code>❯ tree template-test/ (base)
  1384. template-test/
  1385. ├── push-secret.yaml
  1386. └── secret.yaml
  1387. 1 directory, 2 files
  1388. </code></pre></div>
  1389. <p><code>PushSecret</code> is simply the following:</p>
  1390. <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>
  1391. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1392. <span class="nt">metadata</span><span class="p">:</span>
  1393. <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-push-secret-with-template</span>
  1394. <span class="nt">spec</span><span class="p">:</span>
  1395. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10s</span>
  1396. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
  1397. <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">secret-store-name</span>
  1398. <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>
  1399. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1400. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1401. <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">git-sync-secret</span>
  1402. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1403. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1404. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1405. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.token</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">toString</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">upper</span><span class="nv"> </span><span class="s">}}</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">templated&quot;</span>
  1406. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1407. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1408. <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">token</span>
  1409. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1410. <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">git-sync-secret-copy-templated</span>
  1411. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">token</span>
  1412. </code></pre></div>
  1413. <p>And secret data is:</p>
  1414. <div class="highlight"><pre><span></span><code><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dG9rZW4=</span>
  1415. </code></pre></div>
  1416. <p>Therefore if there is a PushSecret or an ExternalSecret object that the user would like to test the template for,
  1417. simply put it into a file along with the data it's using, and run this command.</p>
  1418. <p>The output will be something like this:</p>
  1419. <div class="highlight"><pre><span></span><code>bin/esoctl template --source-templated-object template-test/push-secret.yaml --source-secret-data-file template-test/secret.yaml
  1420. data:
  1421. token: VE9LRU4gd2FzIHRlbXBsYXRlZA==
  1422. metadata:
  1423. creationTimestamp: null
  1424. echo -n &quot;VE9LRU4gd2FzIHRlbXBsYXRlZA==&quot; | base64 -d
  1425. TOKEN was templated⏎
  1426. </code></pre></div>
  1427. <p>Further options can be used to provide templates from a ConfigMap or a Secret:
  1428. <div class="highlight"><pre><span></span><code>bin/esoctl template --source-templated-object template-test/push-secret.yaml \
  1429. --source-secret-data-file template-test/secret.yaml \
  1430. --template-from-config-map template-test/template-config-map.yaml \
  1431. --template-from-secret template-test/template-secret.yaml
  1432. </code></pre></div></p>
  1433. <h2 id="bootstrapping-generator-code">Bootstrapping generator code</h2>
  1434. <p>The <code>bootstrap generator</code> command can be used to create a new generator.</p>
  1435. <p>When running it, it will automatically:</p>
  1436. <ul>
  1437. <li>Bootstrap a new generator CRD</li>
  1438. <li>Bootstrap a new generator implementation</li>
  1439. <li>Update the register file with the new generator</li>
  1440. <li>Update Cluster Generators to include the new generator</li>
  1441. <li>Update needed dependencies (go.mod, resolver file, etc)</li>
  1442. </ul>
  1443. <p>To run, simply execute:
  1444. <div class="highlight"><pre><span></span><code>bin/esoctl bootstrap generator --name GeneratorName --description &quot;A description of this generator&quot; --package generatorname
  1445. </code></pre></div></p>
  1446. <h3 id="example">Example</h3>
  1447. <div class="highlight"><pre><span></span><code>bin/esoctl bootstrap generator --name MyAwesomeGenerator --description &quot;An awesome generator I want to add to ESO :)&quot;
  1448. ✓ Created CRD: /home/gusfcarvalho/Documents/repos/external-secrets/apis/generators/v1alpha1/types_myawesomegenerator.go
  1449. ✓ Created implementation: /home/gusfcarvalho/Documents/repos/external-secrets/generators/v1/myawesomegenerator/myawesomegenerator.go
  1450. ✓ Created test file: /home/gusfcarvalho/Documents/repos/external-secrets/generators/v1/myawesomegenerator/myawesomegenerator_test.go
  1451. ✓ Created go.mod: /home/gusfcarvalho/Documents/repos/external-secrets/generators/v1/myawesomegenerator/go.mod
  1452. ✓ Created go.sum: /home/gusfcarvalho/Documents/repos/external-secrets/generators/v1/myawesomegenerator/go.sum
  1453. ✓ Updated register file: /home/gusfcarvalho/Documents/repos/external-secrets/pkg/register/generators.go
  1454. ✓ Updated types_cluster.go
  1455. ✓ Updated main go.mod
  1456. ✓ Updated resolver file: /home/gusfcarvalho/Documents/repos/external-secrets/runtime/esutils/resolvers/generator.go
  1457. ✓ Updated register.go
  1458. ✓ Successfully bootstrapped generator: MyAwesomeGenerator
  1459. Next steps:
  1460. 1. Review and customize: apis/generators/v1alpha1/types_myawesomegenerator.go
  1461. 2. Implement the generator logic in: generators/v1/myawesomegenerator/myawesomegenerator.go
  1462. 3. Run: go mod tidy
  1463. 4. Run: make generate
  1464. 5. Run: make manifests
  1465. 6. Add tests for your generator
  1466. </code></pre></div>
  1467. <p>You should also expect the following <code>git diff</code> with specific changes:</p>
  1468. <div class="highlight"><pre><span></span><code><span class="gh">diff --git a/apis/generators/v1alpha1/register.go b/apis/generators/v1alpha1/register.go</span>
  1469. <span class="gh">index 16c05154b..9538bcc57 100644</span>
  1470. <span class="gd">--- a/apis/generators/v1alpha1/register.go</span>
  1471. <span class="gi">+++ b/apis/generators/v1alpha1/register.go</span>
  1472. <span class="gu">@@ -73,6 +73,9 @@ var (</span>
  1473. <span class="w"> </span> ClusterGeneratorKind = reflect.TypeOf(ClusterGenerator{}).Name()
  1474. <span class="w"> </span> // CloudsmithAccessTokenKind is the kind name for CloudsmithAccessToken resource.
  1475. <span class="w"> </span> CloudsmithAccessTokenKind = reflect.TypeOf(CloudsmithAccessToken{}).Name()
  1476. <span class="gi">+</span>
  1477. <span class="gi">+ // MyAwesomeGeneratorKind is the kind name for MyAwesomeGenerator resource.</span>
  1478. <span class="gi">+ MyAwesomeGeneratorKind = reflect.TypeOf(MyAwesomeGenerator{}).Name()</span>
  1479. <span class="w"> </span>)
  1480. <span class="w"> </span>func init() {
  1481. <span class="gu">@@ -109,4 +112,5 @@ func init() {</span>
  1482. <span class="w"> </span> SchemeBuilder.Register(&amp;Webhook{}, &amp;WebhookList{})
  1483. <span class="w"> </span> SchemeBuilder.Register(&amp;Grafana{}, &amp;GrafanaList{})
  1484. <span class="w"> </span> SchemeBuilder.Register(&amp;MFA{}, &amp;MFAList{})
  1485. <span class="gi">+ SchemeBuilder.Register(&amp;MyAwesomeGenerator{}, &amp;MyAwesomeGeneratorList{})</span>
  1486. <span class="w"> </span>}
  1487. <span class="gh">diff --git a/apis/generators/v1alpha1/types_cluster.go b/apis/generators/v1alpha1/types_cluster.go</span>
  1488. <span class="gh">index e212dab76..0245e8f1c 100644</span>
  1489. <span class="gd">--- a/apis/generators/v1alpha1/types_cluster.go</span>
  1490. <span class="gi">+++ b/apis/generators/v1alpha1/types_cluster.go</span>
  1491. <span class="gu">@@ -30,7 +30,7 @@ type ClusterGeneratorSpec struct {</span>
  1492. <span class="w"> </span>}
  1493. <span class="w"> </span>// GeneratorKind represents a kind of generator.
  1494. <span class="gd">-// +kubebuilder:validation:Enum=ACRAccessToken;CloudsmithAccessToken;ECRAuthorizationToken;Fake;GCRAccessToken;GithubAccessToken;QuayAccessToken;Password;SSHKey;STSSessionToken;UUID;VaultDynamicSecret;Webhook;Grafana</span>
  1495. <span class="gi">+// +kubebuilder:validation:Enum=ACRAccessToken;CloudsmithAccessToken;ECRAuthorizationToken;Fake;GCRAccessToken;GithubAccessToken;QuayAccessToken;Password;SSHKey;STSSessionToken;UUID;VaultDynamicSecret;Webhook;Grafana;MyAwesomeGenerator</span>
  1496. <span class="w"> </span>type GeneratorKind string
  1497. <span class="w"> </span>const (
  1498. <span class="gu">@@ -64,6 +64,8 @@ const (</span>
  1499. <span class="w"> </span> GeneratorKindMFA GeneratorKind = &quot;MFA&quot;
  1500. <span class="w"> </span> // GeneratorKindCloudsmithAccessToken represents a Cloudsmith access token generator.
  1501. <span class="w"> </span> GeneratorKindCloudsmithAccessToken GeneratorKind = &quot;CloudsmithAccessToken&quot;
  1502. <span class="gi">+ // GeneratorKindMyAwesomeGenerator represents a myawesomegenerator generator.</span>
  1503. <span class="gi">+ GeneratorKindMyAwesomeGenerator GeneratorKind = &quot;MyAwesomeGenerator&quot;</span>
  1504. <span class="w"> </span>)
  1505. <span class="w"> </span>// GeneratorSpec defines the configuration for various supported generator types.
  1506. <span class="gu">@@ -85,6 +87,7 @@ type GeneratorSpec struct {</span>
  1507. <span class="w"> </span> WebhookSpec *WebhookSpec `json:&quot;webhookSpec,omitempty&quot;`
  1508. <span class="w"> </span> GrafanaSpec *GrafanaSpec `json:&quot;grafanaSpec,omitempty&quot;`
  1509. <span class="w"> </span> MFASpec *MFASpec `json:&quot;mfaSpec,omitempty&quot;`
  1510. <span class="gi">+ MyAwesomeGeneratorSpec *MyAwesomeGeneratorSpec `json:&quot;myawesomegeneratorSpec,omitempty&quot;`</span>
  1511. <span class="w"> </span>}
  1512. <span class="w"> </span>// ClusterGenerator represents a cluster-wide generator which can be referenced as part of `generatorRef` fields.
  1513. <span class="gh">diff --git a/go.mod b/go.mod</span>
  1514. <span class="gh">index ff95a9558..c73ecb0c7 100644</span>
  1515. <span class="gd">--- a/go.mod</span>
  1516. <span class="gi">+++ b/go.mod</span>
  1517. <span class="gu">@@ -14,6 +14,7 @@ replace (</span>
  1518. <span class="w"> </span> github.com/external-secrets/external-secrets/generators/v1/github =&gt; ./generators/v1/github
  1519. <span class="w"> </span> github.com/external-secrets/external-secrets/generators/v1/grafana =&gt; ./generators/v1/grafana
  1520. <span class="w"> </span> github.com/external-secrets/external-secrets/generators/v1/mfa =&gt; ./generators/v1/mfa
  1521. <span class="gi">+ github.com/external-secrets/external-secrets/generators/v1/myawesomegenerator =&gt; ./generators/v1/myawesomegenerator</span>
  1522. <span class="w"> </span> github.com/external-secrets/external-secrets/generators/v1/password =&gt; ./generators/v1/password
  1523. <span class="w"> </span> github.com/external-secrets/external-secrets/generators/v1/quay =&gt; ./generators/v1/quay
  1524. <span class="w"> </span> github.com/external-secrets/external-secrets/generators/v1/sshkey =&gt; ./generators/v1/sshkey
  1525. <span class="gh">diff --git a/pkg/register/generators.go b/pkg/register/generators.go</span>
  1526. <span class="gh">index dd9ad55fb..6aafd4089 100644</span>
  1527. <span class="gd">--- a/pkg/register/generators.go</span>
  1528. <span class="gi">+++ b/pkg/register/generators.go</span>
  1529. <span class="gu">@@ -34,6 +34,7 @@ import (</span>
  1530. <span class="w"> </span> uuid &quot;github.com/external-secrets/external-secrets/generators/v1/uuid&quot;
  1531. <span class="w"> </span> vaultgen &quot;github.com/external-secrets/external-secrets/generators/v1/vault&quot;
  1532. <span class="w"> </span> webhookgen &quot;github.com/external-secrets/external-secrets/generators/v1/webhook&quot;
  1533. <span class="gi">+ myawesomegenerator &quot;github.com/external-secrets/external-secrets/generators/v1/myawesomegenerator&quot;</span>
  1534. <span class="w"> </span>)
  1535. <span class="w"> </span>func init() {
  1536. <span class="gu">@@ -53,4 +54,5 @@ func init() {</span>
  1537. <span class="w"> </span> genv1alpha1.Register(uuid.Kind(), uuid.NewGenerator())
  1538. <span class="w"> </span> genv1alpha1.Register(vaultgen.Kind(), vaultgen.NewGenerator())
  1539. <span class="w"> </span> genv1alpha1.Register(webhookgen.Kind(), webhookgen.NewGenerator())
  1540. <span class="gi">+ genv1alpha1.Register(myawesomegenerator.Kind(), myawesomegenerator.NewGenerator())</span>
  1541. <span class="w"> </span>}
  1542. <span class="gh">diff --git a/runtime/esutils/resolvers/generator.go b/runtime/esutils/resolvers/generator.go</span>
  1543. <span class="gh">index 66f4b4037..938ccd6cd 100644</span>
  1544. <span class="gd">--- a/runtime/esutils/resolvers/generator.go</span>
  1545. <span class="gi">+++ b/runtime/esutils/resolvers/generator.go</span>
  1546. <span class="gu">@@ -302,6 +302,17 @@ func clusterGeneratorToVirtual(gen *genv1alpha1.ClusterGenerator) (client.Object</span>
  1547. <span class="w"> </span> },
  1548. <span class="w"> </span> Spec: *gen.Spec.Generator.MFASpec,
  1549. <span class="w"> </span> }, nil
  1550. <span class="gi">+ case genv1alpha1.GeneratorKindMyAwesomeGenerator:</span>
  1551. <span class="gi">+ if gen.Spec.Generator.MyAwesomeGeneratorSpec == nil {</span>
  1552. <span class="gi">+ return nil, fmt.Errorf(&quot;when kind is %s, MyAwesomeGeneratorSpec must be set&quot;, gen.Spec.Kind)</span>
  1553. <span class="gi">+ }</span>
  1554. <span class="gi">+ return &amp;genv1alpha1.MyAwesomeGenerator{</span>
  1555. <span class="gi">+ TypeMeta: metav1.TypeMeta{</span>
  1556. <span class="gi">+ APIVersion: genv1alpha1.SchemeGroupVersion.String(),</span>
  1557. <span class="gi">+ Kind: genv1alpha1.MyAwesomeGeneratorKind,</span>
  1558. <span class="gi">+ },</span>
  1559. <span class="gi">+ Spec: *gen.Spec.Generator.MyAwesomeGeneratorSpec,</span>
  1560. <span class="gi">+ }, nil</span>
  1561. <span class="w"> </span> default:
  1562. <span class="w"> </span> return nil, fmt.Errorf(&quot;unknown kind %s&quot;, gen.Spec.Kind)
  1563. <span class="w"> </span> }
  1564. </code></pre></div>
  1565. <h3 id="flags">flags</h3>
  1566. <h4 id="name">name</h4>
  1567. <p>Defines the generator name. Must be <code>PascalCase</code>.</p>
  1568. <h4 id="description">description</h4>
  1569. <p>Defines the generator description (added as a golang comment)</p>
  1570. <h4 id="package-optional">package (optional)</h4>
  1571. <p>Defines the package name for the generator. Must be <code>snake_case</code>. defaults to lowercase of <code>name</code></p>
  1572. </article>
  1573. </div>
  1574. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1575. </div>
  1576. </main>
  1577. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1578. <footer class="md-footer">
  1579. <div class="md-footer-meta md-typeset">
  1580. <div class="md-footer-meta__inner md-grid">
  1581. <div class="md-copyright">
  1582. <div class="md-copyright__highlight">
  1583. &copy; 2025 The external-secrets Authors.<br/>
  1584. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1585. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1586. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1587. </div>
  1588. Made with
  1589. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1590. Material for MkDocs
  1591. </a>
  1592. </div>
  1593. </div>
  1594. </div>
  1595. </footer>
  1596. </div>
  1597. <div class="md-dialog" data-md-component="dialog">
  1598. <div class="md-dialog__inner md-typeset"></div>
  1599. </div>
  1600. <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>
  1601. <script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
  1602. </body>
  1603. </html>