index.html 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194
  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="../controller-options/">
  7. <link rel="next" href="../selectable-fields/">
  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>Metrics - 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="#metrics" 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. Metrics
  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 md-tabs__item--active">
  127. <a href="../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">
  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--active md-nav__item--section md-nav__item--nested">
  248. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  249. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  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="true">
  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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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--active md-nav__item--nested">
  454. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
  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="true">
  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="../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="../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 md-nav__item--active">
  482. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  483. <label class="md-nav__link md-nav__link--active" for="__toc">
  484. <span class="md-ellipsis">
  485. Metrics
  486. </span>
  487. <span class="md-nav__icon md-icon"></span>
  488. </label>
  489. <a href="./" class="md-nav__link md-nav__link--active">
  490. <span class="md-ellipsis">
  491. Metrics
  492. </span>
  493. </a>
  494. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  495. <label class="md-nav__title" for="__toc">
  496. <span class="md-nav__icon md-icon"></span>
  497. Table of contents
  498. </label>
  499. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  500. <li class="md-nav__item">
  501. <a href="#cluster-external-secret-metrics" class="md-nav__link">
  502. <span class="md-ellipsis">
  503. Cluster External Secret Metrics
  504. </span>
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="#external-secret-metrics" class="md-nav__link">
  509. <span class="md-ellipsis">
  510. External Secret Metrics
  511. </span>
  512. </a>
  513. </li>
  514. <li class="md-nav__item">
  515. <a href="#push-secret-metrics" class="md-nav__link">
  516. <span class="md-ellipsis">
  517. Push Secret Metrics
  518. </span>
  519. </a>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="#cluster-secret-store-metrics" class="md-nav__link">
  523. <span class="md-ellipsis">
  524. Cluster Secret Store Metrics
  525. </span>
  526. </a>
  527. </li>
  528. </ul>
  529. </nav>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../selectable-fields/" class="md-nav__link">
  533. <span class="md-ellipsis">
  534. Selectable Fields
  535. </span>
  536. </a>
  537. </li>
  538. </ul>
  539. </nav>
  540. </li>
  541. </ul>
  542. </nav>
  543. </li>
  544. <li class="md-nav__item md-nav__item--nested">
  545. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  546. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  547. <span class="md-ellipsis">
  548. Guides
  549. </span>
  550. <span class="md-nav__icon md-icon"></span>
  551. </label>
  552. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  553. <label class="md-nav__title" for="__nav_3">
  554. <span class="md-nav__icon md-icon"></span>
  555. Guides
  556. </label>
  557. <ul class="md-nav__list" data-md-scrollfix>
  558. <li class="md-nav__item">
  559. <a href="../../guides/introduction/" class="md-nav__link">
  560. <span class="md-ellipsis">
  561. Introduction
  562. </span>
  563. </a>
  564. </li>
  565. <li class="md-nav__item md-nav__item--nested">
  566. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  567. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  568. <span class="md-ellipsis">
  569. External Secrets
  570. </span>
  571. <span class="md-nav__icon md-icon"></span>
  572. </label>
  573. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  574. <label class="md-nav__title" for="__nav_3_2">
  575. <span class="md-nav__icon md-icon"></span>
  576. External Secrets
  577. </label>
  578. <ul class="md-nav__list" data-md-scrollfix>
  579. <li class="md-nav__item">
  580. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  581. <span class="md-ellipsis">
  582. Extract structured data
  583. </span>
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../../guides/getallsecrets/" class="md-nav__link">
  588. <span class="md-ellipsis">
  589. Find Secrets by Name or Metadata
  590. </span>
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  595. <span class="md-ellipsis">
  596. Rewriting Keys
  597. </span>
  598. </a>
  599. </li>
  600. <li class="md-nav__item md-nav__item--nested">
  601. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  602. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  603. <span class="md-ellipsis">
  604. Advanced Templating
  605. </span>
  606. <span class="md-nav__icon md-icon"></span>
  607. </label>
  608. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  609. <label class="md-nav__title" for="__nav_3_2_4">
  610. <span class="md-nav__icon md-icon"></span>
  611. Advanced Templating
  612. </label>
  613. <ul class="md-nav__list" data-md-scrollfix>
  614. <li class="md-nav__item">
  615. <a href="../../guides/templating/" class="md-nav__link">
  616. <span class="md-ellipsis">
  617. v2
  618. </span>
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../../guides/templating-v1/" class="md-nav__link">
  623. <span class="md-ellipsis">
  624. v1
  625. </span>
  626. </a>
  627. </li>
  628. </ul>
  629. </nav>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  633. <span class="md-ellipsis">
  634. Kubernetes Secret Types
  635. </span>
  636. </a>
  637. </li>
  638. <li class="md-nav__item">
  639. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  640. <span class="md-ellipsis">
  641. Lifecycle: ownership & deletion
  642. </span>
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  647. <span class="md-ellipsis">
  648. Decoding Strategies
  649. </span>
  650. </a>
  651. </li>
  652. <li class="md-nav__item">
  653. <a href="../../guides/controller-class/" class="md-nav__link">
  654. <span class="md-ellipsis">
  655. Controller Classes
  656. </span>
  657. </a>
  658. </li>
  659. </ul>
  660. </nav>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../../guides/targeting-custom-resources/" class="md-nav__link">
  664. <span class="md-ellipsis">
  665. Targeting Custom Resources
  666. </span>
  667. </a>
  668. </li>
  669. <li class="md-nav__item">
  670. <a href="../../guides/generator/" class="md-nav__link">
  671. <span class="md-ellipsis">
  672. Generators
  673. </span>
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../../guides/pushsecrets/" class="md-nav__link">
  678. <span class="md-ellipsis">
  679. Push Secrets
  680. </span>
  681. </a>
  682. </li>
  683. <li class="md-nav__item md-nav__item--nested">
  684. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  685. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  686. <span class="md-ellipsis">
  687. Operations
  688. </span>
  689. <span class="md-nav__icon md-icon"></span>
  690. </label>
  691. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  692. <label class="md-nav__title" for="__nav_3_6">
  693. <span class="md-nav__icon md-icon"></span>
  694. Operations
  695. </label>
  696. <ul class="md-nav__list" data-md-scrollfix>
  697. <li class="md-nav__item">
  698. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  699. <span class="md-ellipsis">
  700. Multi Tenancy
  701. </span>
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="../../guides/security-best-practices/" class="md-nav__link">
  706. <span class="md-ellipsis">
  707. Security Best Practices
  708. </span>
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../../guides/threat-model/" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. Threat Model
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../guides/v1beta1/" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. Upgrading to v1beta1
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../guides/using-latest-image/" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. Using Latest Image
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. Disable Cluster Features
  736. </span>
  737. </a>
  738. </li>
  739. </ul>
  740. </nav>
  741. </li>
  742. <li class="md-nav__item md-nav__item--nested">
  743. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_7" >
  744. <label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="0">
  745. <span class="md-ellipsis">
  746. Tooling
  747. </span>
  748. <span class="md-nav__icon md-icon"></span>
  749. </label>
  750. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
  751. <label class="md-nav__title" for="__nav_3_7">
  752. <span class="md-nav__icon md-icon"></span>
  753. Tooling
  754. </label>
  755. <ul class="md-nav__list" data-md-scrollfix>
  756. <li class="md-nav__item">
  757. <a href="../../guides/using-esoctl-tool/" class="md-nav__link">
  758. <span class="md-ellipsis">
  759. Using the esoctl tool
  760. </span>
  761. </a>
  762. </li>
  763. </ul>
  764. </nav>
  765. </li>
  766. </ul>
  767. </nav>
  768. </li>
  769. <li class="md-nav__item md-nav__item--nested">
  770. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  771. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  772. <span class="md-ellipsis">
  773. Provider
  774. </span>
  775. <span class="md-nav__icon md-icon"></span>
  776. </label>
  777. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  778. <label class="md-nav__title" for="__nav_4">
  779. <span class="md-nav__icon md-icon"></span>
  780. Provider
  781. </label>
  782. <ul class="md-nav__list" data-md-scrollfix>
  783. <li class="md-nav__item">
  784. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  785. <span class="md-ellipsis">
  786. AWS Secrets Manager
  787. </span>
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  792. <span class="md-ellipsis">
  793. AWS Parameter Store
  794. </span>
  795. </a>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="../../provider/aws-access/" class="md-nav__link">
  799. <span class="md-ellipsis">
  800. AWS Access
  801. </span>
  802. </a>
  803. </li>
  804. <li class="md-nav__item">
  805. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  806. <span class="md-ellipsis">
  807. Azure Key Vault
  808. </span>
  809. </a>
  810. </li>
  811. <li class="md-nav__item">
  812. <a href="../../provider/barbican/" class="md-nav__link">
  813. <span class="md-ellipsis">
  814. Barbican
  815. </span>
  816. </a>
  817. </li>
  818. <li class="md-nav__item">
  819. <a href="../../provider/beyondtrust/" class="md-nav__link">
  820. <span class="md-ellipsis">
  821. BeyondTrust
  822. </span>
  823. </a>
  824. </li>
  825. <li class="md-nav__item">
  826. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  827. <span class="md-ellipsis">
  828. Bitwarden Secrets Manager
  829. </span>
  830. </a>
  831. </li>
  832. <li class="md-nav__item">
  833. <a href="../../provider/chef/" class="md-nav__link">
  834. <span class="md-ellipsis">
  835. Chef
  836. </span>
  837. </a>
  838. </li>
  839. <li class="md-nav__item">
  840. <a href="../../provider/cloudru/" class="md-nav__link">
  841. <span class="md-ellipsis">
  842. Cloud.ru Secret Manager
  843. </span>
  844. </a>
  845. </li>
  846. <li class="md-nav__item">
  847. <a href="../../provider/conjur/" class="md-nav__link">
  848. <span class="md-ellipsis">
  849. CyberArk Conjur
  850. </span>
  851. </a>
  852. </li>
  853. <li class="md-nav__item">
  854. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  855. <span class="md-ellipsis">
  856. Google Cloud Secret Manager
  857. </span>
  858. </a>
  859. </li>
  860. <li class="md-nav__item">
  861. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  862. <span class="md-ellipsis">
  863. HashiCorp Vault
  864. </span>
  865. </a>
  866. </li>
  867. <li class="md-nav__item">
  868. <a href="../../provider/kubernetes/" class="md-nav__link">
  869. <span class="md-ellipsis">
  870. Kubernetes
  871. </span>
  872. </a>
  873. </li>
  874. <li class="md-nav__item">
  875. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  876. <span class="md-ellipsis">
  877. IBM Secrets Manager
  878. </span>
  879. </a>
  880. </li>
  881. <li class="md-nav__item">
  882. <a href="../../provider/akeyless/" class="md-nav__link">
  883. <span class="md-ellipsis">
  884. Akeyless
  885. </span>
  886. </a>
  887. </li>
  888. <li class="md-nav__item">
  889. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  890. <span class="md-ellipsis">
  891. Yandex Certificate Manager
  892. </span>
  893. </a>
  894. </li>
  895. <li class="md-nav__item">
  896. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  897. <span class="md-ellipsis">
  898. Yandex Lockbox
  899. </span>
  900. </a>
  901. </li>
  902. <li class="md-nav__item">
  903. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  904. <span class="md-ellipsis">
  905. GitLab Variables
  906. </span>
  907. </a>
  908. </li>
  909. <li class="md-nav__item">
  910. <a href="../../provider/github/" class="md-nav__link">
  911. <span class="md-ellipsis">
  912. Github Actions Secrets
  913. </span>
  914. </a>
  915. </li>
  916. <li class="md-nav__item">
  917. <a href="../../provider/oracle-vault/" class="md-nav__link">
  918. <span class="md-ellipsis">
  919. Oracle Vault
  920. </span>
  921. </a>
  922. </li>
  923. <li class="md-nav__item">
  924. <a href="../../provider/1password-automation/" class="md-nav__link">
  925. <span class="md-ellipsis">
  926. 1Password Connect Server
  927. </span>
  928. </a>
  929. </li>
  930. <li class="md-nav__item">
  931. <a href="../../provider/1password-sdk/" class="md-nav__link">
  932. <span class="md-ellipsis">
  933. 1Password SDK
  934. </span>
  935. </a>
  936. </li>
  937. <li class="md-nav__item">
  938. <a href="../../provider/webhook/" class="md-nav__link">
  939. <span class="md-ellipsis">
  940. Webhook
  941. </span>
  942. </a>
  943. </li>
  944. <li class="md-nav__item">
  945. <a href="../../provider/fake/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. Fake
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. senhasegura DevOps Secrets Management (DSM)
  955. </span>
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="../../provider/doppler/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. Doppler
  962. </span>
  963. </a>
  964. </li>
  965. <li class="md-nav__item">
  966. <a href="../../provider/keeper-security/" class="md-nav__link">
  967. <span class="md-ellipsis">
  968. Keeper Security
  969. </span>
  970. </a>
  971. </li>
  972. <li class="md-nav__item">
  973. <a href="../../provider/cloak/" class="md-nav__link">
  974. <span class="md-ellipsis">
  975. Cloak End 2 End Encrypted Secrets
  976. </span>
  977. </a>
  978. </li>
  979. <li class="md-nav__item">
  980. <a href="../../provider/scaleway/" class="md-nav__link">
  981. <span class="md-ellipsis">
  982. Scaleway
  983. </span>
  984. </a>
  985. </li>
  986. <li class="md-nav__item">
  987. <a href="../../provider/delinea/" class="md-nav__link">
  988. <span class="md-ellipsis">
  989. Delinea
  990. </span>
  991. </a>
  992. </li>
  993. <li class="md-nav__item">
  994. <a href="../../provider/secretserver/" class="md-nav__link">
  995. <span class="md-ellipsis">
  996. Secret Server
  997. </span>
  998. </a>
  999. </li>
  1000. <li class="md-nav__item">
  1001. <a href="../../provider/passbolt/" class="md-nav__link">
  1002. <span class="md-ellipsis">
  1003. Passbolt
  1004. </span>
  1005. </a>
  1006. </li>
  1007. <li class="md-nav__item">
  1008. <a href="../../provider/pulumi/" class="md-nav__link">
  1009. <span class="md-ellipsis">
  1010. Pulumi ESC
  1011. </span>
  1012. </a>
  1013. </li>
  1014. <li class="md-nav__item">
  1015. <a href="../../provider/onboardbase/" class="md-nav__link">
  1016. <span class="md-ellipsis">
  1017. Onboardbase
  1018. </span>
  1019. </a>
  1020. </li>
  1021. <li class="md-nav__item">
  1022. <a href="../../provider-passworddepot/" class="md-nav__link">
  1023. <span class="md-ellipsis">
  1024. Password Depot
  1025. </span>
  1026. </a>
  1027. </li>
  1028. <li class="md-nav__item">
  1029. <a href="../../provider/fortanix/" class="md-nav__link">
  1030. <span class="md-ellipsis">
  1031. Fortanix
  1032. </span>
  1033. </a>
  1034. </li>
  1035. <li class="md-nav__item">
  1036. <a href="../../provider/infisical/" class="md-nav__link">
  1037. <span class="md-ellipsis">
  1038. Infisical
  1039. </span>
  1040. </a>
  1041. </li>
  1042. <li class="md-nav__item">
  1043. <a href="../../provider/previder/" class="md-nav__link">
  1044. <span class="md-ellipsis">
  1045. Previder
  1046. </span>
  1047. </a>
  1048. </li>
  1049. <li class="md-nav__item">
  1050. <a href="../../provider/openbao/" class="md-nav__link">
  1051. <span class="md-ellipsis">
  1052. OpenBao
  1053. </span>
  1054. </a>
  1055. </li>
  1056. <li class="md-nav__item">
  1057. <a href="../../provider/volcengine/" class="md-nav__link">
  1058. <span class="md-ellipsis">
  1059. Volcengine
  1060. </span>
  1061. </a>
  1062. </li>
  1063. <li class="md-nav__item">
  1064. <a href="../../provider/ngrok/" class="md-nav__link">
  1065. <span class="md-ellipsis">
  1066. ngrok
  1067. </span>
  1068. </a>
  1069. </li>
  1070. <li class="md-nav__item">
  1071. <a href="../../provider/devolutions-server/" class="md-nav__link">
  1072. <span class="md-ellipsis">
  1073. Devolutions Server
  1074. </span>
  1075. </a>
  1076. </li>
  1077. <li class="md-nav__item">
  1078. <a href="../../provider/nebius-mysterybox/" class="md-nav__link">
  1079. <span class="md-ellipsis">
  1080. Nebius MysteryBox
  1081. </span>
  1082. </a>
  1083. </li>
  1084. </ul>
  1085. </nav>
  1086. </li>
  1087. <li class="md-nav__item md-nav__item--nested">
  1088. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1089. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1090. <span class="md-ellipsis">
  1091. Examples
  1092. </span>
  1093. <span class="md-nav__icon md-icon"></span>
  1094. </label>
  1095. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1096. <label class="md-nav__title" for="__nav_5">
  1097. <span class="md-nav__icon md-icon"></span>
  1098. Examples
  1099. </label>
  1100. <ul class="md-nav__list" data-md-scrollfix>
  1101. <li class="md-nav__item">
  1102. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1103. <span class="md-ellipsis">
  1104. FluxCD
  1105. </span>
  1106. </a>
  1107. </li>
  1108. <li class="md-nav__item">
  1109. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1110. <span class="md-ellipsis">
  1111. Anchore Engine
  1112. </span>
  1113. </a>
  1114. </li>
  1115. <li class="md-nav__item">
  1116. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1117. <span class="md-ellipsis">
  1118. Jenkins
  1119. </span>
  1120. </a>
  1121. </li>
  1122. <li class="md-nav__item">
  1123. <a href="../../examples/bitwarden/" class="md-nav__link">
  1124. <span class="md-ellipsis">
  1125. Bitwarden
  1126. </span>
  1127. </a>
  1128. </li>
  1129. </ul>
  1130. </nav>
  1131. </li>
  1132. <li class="md-nav__item md-nav__item--nested">
  1133. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1134. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1135. <span class="md-ellipsis">
  1136. Community
  1137. </span>
  1138. <span class="md-nav__icon md-icon"></span>
  1139. </label>
  1140. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1141. <label class="md-nav__title" for="__nav_6">
  1142. <span class="md-nav__icon md-icon"></span>
  1143. Community
  1144. </label>
  1145. <ul class="md-nav__list" data-md-scrollfix>
  1146. <li class="md-nav__item md-nav__item--nested">
  1147. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1148. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1149. <span class="md-ellipsis">
  1150. Contributing
  1151. </span>
  1152. <span class="md-nav__icon md-icon"></span>
  1153. </label>
  1154. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1155. <label class="md-nav__title" for="__nav_6_1">
  1156. <span class="md-nav__icon md-icon"></span>
  1157. Contributing
  1158. </label>
  1159. <ul class="md-nav__list" data-md-scrollfix>
  1160. <li class="md-nav__item">
  1161. <a href="../../contributing/devguide/" class="md-nav__link">
  1162. <span class="md-ellipsis">
  1163. Developer guide
  1164. </span>
  1165. </a>
  1166. </li>
  1167. <li class="md-nav__item">
  1168. <a href="../../contributing/process/" class="md-nav__link">
  1169. <span class="md-ellipsis">
  1170. Contributing Process
  1171. </span>
  1172. </a>
  1173. </li>
  1174. <li class="md-nav__item">
  1175. <a href="../../contributing/release/" class="md-nav__link">
  1176. <span class="md-ellipsis">
  1177. Release Process
  1178. </span>
  1179. </a>
  1180. </li>
  1181. <li class="md-nav__item">
  1182. <a href="../../contributing/coc/" class="md-nav__link">
  1183. <span class="md-ellipsis">
  1184. Code of Conduct
  1185. </span>
  1186. </a>
  1187. </li>
  1188. <li class="md-nav__item">
  1189. <a href="../../contributing/calendar/" class="md-nav__link">
  1190. <span class="md-ellipsis">
  1191. Community meetings calendar
  1192. </span>
  1193. </a>
  1194. </li>
  1195. <li class="md-nav__item">
  1196. <a href="../../contributing/roadmap/" class="md-nav__link">
  1197. <span class="md-ellipsis">
  1198. Roadmap
  1199. </span>
  1200. </a>
  1201. </li>
  1202. <li class="md-nav__item">
  1203. <a href="../../contributing/burnout-mitigation/" class="md-nav__link">
  1204. <span class="md-ellipsis">
  1205. Burnout Prevention
  1206. </span>
  1207. </a>
  1208. </li>
  1209. <li class="md-nav__item">
  1210. <a href="../../contributing/llm-policy/" class="md-nav__link">
  1211. <span class="md-ellipsis">
  1212. LLM Policy
  1213. </span>
  1214. </a>
  1215. </li>
  1216. </ul>
  1217. </nav>
  1218. </li>
  1219. <li class="md-nav__item md-nav__item--nested">
  1220. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1221. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1222. <span class="md-ellipsis">
  1223. External Resources
  1224. </span>
  1225. <span class="md-nav__icon md-icon"></span>
  1226. </label>
  1227. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1228. <label class="md-nav__title" for="__nav_6_2">
  1229. <span class="md-nav__icon md-icon"></span>
  1230. External Resources
  1231. </label>
  1232. <ul class="md-nav__list" data-md-scrollfix>
  1233. <li class="md-nav__item">
  1234. <a href="../../eso-talks/" class="md-nav__link">
  1235. <span class="md-ellipsis">
  1236. Talks
  1237. </span>
  1238. </a>
  1239. </li>
  1240. <li class="md-nav__item">
  1241. <a href="../../eso-demos/" class="md-nav__link">
  1242. <span class="md-ellipsis">
  1243. Demos
  1244. </span>
  1245. </a>
  1246. </li>
  1247. <li class="md-nav__item">
  1248. <a href="../../eso-blogs/" class="md-nav__link">
  1249. <span class="md-ellipsis">
  1250. Blogs
  1251. </span>
  1252. </a>
  1253. </li>
  1254. <li class="md-nav__item">
  1255. <a href="../../eso-tools/" class="md-nav__link">
  1256. <span class="md-ellipsis">
  1257. Tools
  1258. </span>
  1259. </a>
  1260. </li>
  1261. </ul>
  1262. </nav>
  1263. </li>
  1264. </ul>
  1265. </nav>
  1266. </li>
  1267. </ul>
  1268. </nav>
  1269. </div>
  1270. </div>
  1271. </div>
  1272. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  1273. <div class="md-sidebar__scrollwrap">
  1274. <div class="md-sidebar__inner">
  1275. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1276. <label class="md-nav__title" for="__toc">
  1277. <span class="md-nav__icon md-icon"></span>
  1278. Table of contents
  1279. </label>
  1280. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1281. <li class="md-nav__item">
  1282. <a href="#cluster-external-secret-metrics" class="md-nav__link">
  1283. <span class="md-ellipsis">
  1284. Cluster External Secret Metrics
  1285. </span>
  1286. </a>
  1287. </li>
  1288. <li class="md-nav__item">
  1289. <a href="#external-secret-metrics" class="md-nav__link">
  1290. <span class="md-ellipsis">
  1291. External Secret Metrics
  1292. </span>
  1293. </a>
  1294. </li>
  1295. <li class="md-nav__item">
  1296. <a href="#push-secret-metrics" class="md-nav__link">
  1297. <span class="md-ellipsis">
  1298. Push Secret Metrics
  1299. </span>
  1300. </a>
  1301. </li>
  1302. <li class="md-nav__item">
  1303. <a href="#cluster-secret-store-metrics" class="md-nav__link">
  1304. <span class="md-ellipsis">
  1305. Cluster Secret Store Metrics
  1306. </span>
  1307. </a>
  1308. </li>
  1309. </ul>
  1310. </nav>
  1311. </div>
  1312. </div>
  1313. </div>
  1314. <div class="md-content" data-md-component="content">
  1315. <article class="md-content__inner md-typeset">
  1316. <h1 id="metrics">Metrics</h1>
  1317. <p>The External Secrets Operator exposes its Prometheus metrics in the <code>/metrics</code> path. To enable it, set the <code>serviceMonitor.enabled</code> Helm flag to <code>true</code>.</p>
  1318. <p>If you are using a different monitoring tool that also needs a <code>/metrics</code> endpoint, you can set the <code>metrics.service.enabled</code> Helm flag to <code>true</code>. In addition you can also set <code>webhook.metrics.service.enabled</code> and <code>certController.metrics.service.enabled</code> to scrape the other components.</p>
  1319. <p>The Operator has <a href="https://book.kubebuilder.io/reference/metrics-reference.html">the controller-runtime metrics inherited from kubebuilder</a> plus some custom metrics with a resource name prefix, such as <code>externalsecret_</code>.</p>
  1320. <h2 id="cluster-external-secret-metrics">Cluster External Secret Metrics</h2>
  1321. <table>
  1322. <thead>
  1323. <tr>
  1324. <th>Name</th>
  1325. <th>Type</th>
  1326. <th>Description</th>
  1327. </tr>
  1328. </thead>
  1329. <tbody>
  1330. <tr>
  1331. <td><code>clusterexternalsecret_status_condition</code></td>
  1332. <td>Gauge</td>
  1333. <td>The status condition of a specific Cluster External Secret</td>
  1334. </tr>
  1335. <tr>
  1336. <td><code>clusterexternalsecret_reconcile_duration</code></td>
  1337. <td>Gauge</td>
  1338. <td>The duration time to reconcile the Cluster External Secret</td>
  1339. </tr>
  1340. </tbody>
  1341. </table>
  1342. <h2 id="external-secret-metrics">External Secret Metrics</h2>
  1343. <table>
  1344. <thead>
  1345. <tr>
  1346. <th>Name</th>
  1347. <th>Type</th>
  1348. <th>Description</th>
  1349. </tr>
  1350. </thead>
  1351. <tbody>
  1352. <tr>
  1353. <td><code>externalsecret_provider_api_calls_count</code></td>
  1354. <td>Counter</td>
  1355. <td>Number of API calls made to an upstream secret provider API. The metric provides a <code>provider</code>, <code>call</code> and <code>status</code> labels.</td>
  1356. </tr>
  1357. <tr>
  1358. <td><code>externalsecret_sync_calls_total</code></td>
  1359. <td>Counter</td>
  1360. <td>Total number of the External Secret sync calls</td>
  1361. </tr>
  1362. <tr>
  1363. <td><code>externalsecret_sync_calls_error</code></td>
  1364. <td>Counter</td>
  1365. <td>Total number of the External Secret sync errors</td>
  1366. </tr>
  1367. <tr>
  1368. <td><code>externalsecret_status_condition</code></td>
  1369. <td>Gauge</td>
  1370. <td>The status condition of a specific External Secret</td>
  1371. </tr>
  1372. <tr>
  1373. <td><code>externalsecret_reconcile_duration</code></td>
  1374. <td>Gauge</td>
  1375. <td>The duration time to reconcile the External Secret</td>
  1376. </tr>
  1377. </tbody>
  1378. </table>
  1379. <h2 id="push-secret-metrics">Push Secret Metrics</h2>
  1380. <table>
  1381. <thead>
  1382. <tr>
  1383. <th>Name</th>
  1384. <th>Type</th>
  1385. <th>Description</th>
  1386. </tr>
  1387. </thead>
  1388. <tbody>
  1389. <tr>
  1390. <td><code>pushsecret_status_condition</code></td>
  1391. <td>Gauge</td>
  1392. <td>The status condition of a specific Push Secret</td>
  1393. </tr>
  1394. <tr>
  1395. <td><code>pushsecret_reconcile_duration</code></td>
  1396. <td>Gauge</td>
  1397. <td>The duration time to reconcile the Push Secret</td>
  1398. </tr>
  1399. </tbody>
  1400. </table>
  1401. <h2 id="cluster-secret-store-metrics">Cluster Secret Store Metrics</h2>
  1402. <table>
  1403. <thead>
  1404. <tr>
  1405. <th>Name</th>
  1406. <th>Type</th>
  1407. <th>Description</th>
  1408. </tr>
  1409. </thead>
  1410. <tbody>
  1411. <tr>
  1412. <td><code>clustersecretstore_status_condition</code></td>
  1413. <td>Gauge</td>
  1414. <td>The status condition of a specific Cluster Secret Store</td>
  1415. </tr>
  1416. <tr>
  1417. <td><code>clustersecretstore_reconcile_duration</code></td>
  1418. <td>Gauge</td>
  1419. <td>The duration time to reconcile the Cluster Secret Store</td>
  1420. </tr>
  1421. </tbody>
  1422. </table>
  1423. <h1 id="secret-store-metrics">Secret Store Metrics</h1>
  1424. <table>
  1425. <thead>
  1426. <tr>
  1427. <th>Name</th>
  1428. <th>Type</th>
  1429. <th>Description</th>
  1430. </tr>
  1431. </thead>
  1432. <tbody>
  1433. <tr>
  1434. <td><code>secretstore_status_condition</code></td>
  1435. <td>Gauge</td>
  1436. <td>The status condition of a specific Secret Store</td>
  1437. </tr>
  1438. <tr>
  1439. <td><code>secretstore_reconcile_duration</code></td>
  1440. <td>Gauge</td>
  1441. <td>The duration time to reconcile the Secret Store</td>
  1442. </tr>
  1443. </tbody>
  1444. </table>
  1445. <h2 id="controller-runtime-metrics">Controller Runtime Metrics</h2>
  1446. <p>See <a href="https://book.kubebuilder.io/reference/metrics-reference.html">the kubebuilder documentation</a> on the default exported metrics by controller-runtime.</p>
  1447. <h2 id="dashboard">Dashboard</h2>
  1448. <p>We provide a <a href="https://raw.githubusercontent.com/external-secrets/external-secrets/main/docs/snippets/dashboard.json">Grafana Dashboard</a> that gives you an overview of External Secrets Operator:</p>
  1449. <p><img alt="ESO Dashboard" src="../../pictures/eso-dashboard-1.png" />
  1450. <img alt="ESO Dashboard" src="../../pictures/eso-dashboard-2.png" /></p>
  1451. <h2 id="service-level-indicators-and-alerts">Service Level Indicators and Alerts</h2>
  1452. <p>We find the following Service Level Indicators (SLIs) useful when operating ESO. They should give you a good starting point and hints to develop your own Service Level Objectives (SLOs).</p>
  1453. <h4 id="webhook-http-status-codes">Webhook HTTP Status Codes</h4>
  1454. <p>The webhook HTTP status code indicates that a HTTP Request was answered successfully or not.
  1455. If the Webhook pod is not able to serve the requests properly then that failure may cascade down to the controller or any other user of <code>kube-apiserver</code>.</p>
  1456. <p>SLI Example: request error percentage.
  1457. <div class="highlight"><pre><span></span><code>sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;,code=&quot;500&quot;}[1m]))
  1458. /
  1459. sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;}[1m]))
  1460. </code></pre></div></p>
  1461. <h4 id="webhook-http-request-latency">Webhook HTTP Request Latency</h4>
  1462. <p>If the webhook server is not able to respond in time then that may cause a timeout at the client.
  1463. This failure may cascade down to the controller or any other user of <code>kube-apiserver</code>.</p>
  1464. <p>SLI Example: p99 across all webhook requests.
  1465. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  1466. sum(rate(controller_runtime_webhook_latency_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  1467. )
  1468. </code></pre></div></p>
  1469. <h4 id="controller-workqueue-depth">Controller Workqueue Depth</h4>
  1470. <p>If the workqueue depth is &gt; 0 for a longer period of time then this is an indicator for the controller not being able to reconcile resources in time. I.e. delivery of secret updates is delayed.</p>
  1471. <p>Note: when a controller is restarted, then <code>queue length = total number of resources</code>. Make sure to measure the time it takes for the controller to fully reconcile all secrets after a restart. In large clusters this may take a while, make sure to define an acceptable timeframe to fully reconcile all resources.</p>
  1472. <div class="highlight"><pre><span></span><code>sum(
  1473. workqueue_depth{service=~&quot;external-secrets.*&quot;}
  1474. ) by (name)
  1475. </code></pre></div>
  1476. <h4 id="controller-reconcile-latency">Controller Reconcile Latency</h4>
  1477. <p>The controller should be able to reconcile resources within a reasonable timeframe. When latency is high secret delivery may impacted.</p>
  1478. <p>SLI Example: p99 across all controllers.
  1479. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  1480. sum(rate(controller_runtime_reconcile_time_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  1481. )
  1482. </code></pre></div></p>
  1483. <h4 id="controller-reconcile-error">Controller Reconcile Error</h4>
  1484. <p>The controller should be able to reconcile resources without errors. When errors occur secret delivery may be impacted which could cascade down to the secret consuming applications.</p>
  1485. <div class="highlight"><pre><span></span><code>sum(increase(
  1486. controller_runtime_reconcile_total{service=~&quot;external-secrets.*&quot;,controller=~&quot;$controller&quot;,result=&quot;error&quot;}[1m])
  1487. ) by (result)
  1488. </code></pre></div>
  1489. </article>
  1490. </div>
  1491. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1492. </div>
  1493. </main>
  1494. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1495. <footer class="md-footer">
  1496. <div class="md-footer-meta md-typeset">
  1497. <div class="md-footer-meta__inner md-grid">
  1498. <div class="md-copyright">
  1499. <div class="md-copyright__highlight">
  1500. &copy; 2025 The external-secrets Authors.<br/>
  1501. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1502. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1503. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1504. </div>
  1505. Made with
  1506. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1507. Material for MkDocs
  1508. </a>
  1509. </div>
  1510. </div>
  1511. </div>
  1512. </footer>
  1513. </div>
  1514. <div class="md-dialog" data-md-component="dialog">
  1515. <div class="md-dialog__inner md-typeset"></div>
  1516. </div>
  1517. <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>
  1518. <script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
  1519. </body>
  1520. </html>