index.html 72 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132
  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="../../guides/introduction/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">
  10. <title>Metrics - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <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">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <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>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#metrics" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. Metrics
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(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([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  64. <label class="md-header__button md-icon" for="__search">
  65. <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.516 6.516 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 5Z"/></svg>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <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>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <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.516 6.516 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 5Z"/></svg>
  74. <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 11h12Z"/></svg>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <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 12 19 6.41Z"/></svg>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 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 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item md-tabs__item--active">
  116. <a href="../components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. <li class="md-tabs__item">
  146. <a href="../../contributing-devguide.md" class="md-tabs__link">
  147. Contributing
  148. </a>
  149. </li>
  150. <li class="md-tabs__item">
  151. <a href="../../deprecation-policy.md" class="md-tabs__link">
  152. Deprecation Policy
  153. </a>
  154. </li>
  155. </ul>
  156. </div>
  157. </nav>
  158. <main class="md-main" data-md-component="main">
  159. <div class="md-main__inner md-grid">
  160. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  161. <div class="md-sidebar__scrollwrap">
  162. <div class="md-sidebar__inner">
  163. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  164. <label class="md-nav__title" for="__drawer">
  165. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  166. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  167. </a>
  168. External Secrets Operator
  169. </label>
  170. <div class="md-nav__source">
  171. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  172. <div class="md-source__icon md-icon">
  173. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 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 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  174. </div>
  175. <div class="md-source__repository">
  176. External Secrets Operator
  177. </div>
  178. </a>
  179. </div>
  180. <ul class="md-nav__list" data-md-scrollfix>
  181. <li class="md-nav__item md-nav__item--nested">
  182. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  183. <div class="md-nav__link md-nav__container">
  184. <a href="../.." class="md-nav__link ">
  185. <span class="md-ellipsis">
  186. Introduction
  187. </span>
  188. </a>
  189. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  190. <span class="md-nav__icon md-icon"></span>
  191. </label>
  192. </div>
  193. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  194. <label class="md-nav__title" for="__nav_1">
  195. <span class="md-nav__icon md-icon"></span>
  196. Introduction
  197. </label>
  198. <ul class="md-nav__list" data-md-scrollfix>
  199. <li class="md-nav__item">
  200. <a href="../../introduction/overview/" class="md-nav__link">
  201. <span class="md-ellipsis">
  202. Overview
  203. </span>
  204. </a>
  205. </li>
  206. <li class="md-nav__item">
  207. <a href="../../introduction/getting-started/" class="md-nav__link">
  208. <span class="md-ellipsis">
  209. Getting started
  210. </span>
  211. </a>
  212. </li>
  213. <li class="md-nav__item">
  214. <a href="../../introduction/faq/" class="md-nav__link">
  215. <span class="md-ellipsis">
  216. FAQ
  217. </span>
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../../introduction/stability-support/" class="md-nav__link">
  222. <span class="md-ellipsis">
  223. Stability and Support
  224. </span>
  225. </a>
  226. </li>
  227. <li class="md-nav__item">
  228. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  229. <span class="md-ellipsis">
  230. Deprecation Policy
  231. </span>
  232. </a>
  233. </li>
  234. </ul>
  235. </nav>
  236. </li>
  237. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  238. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  239. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  240. <span class="md-ellipsis">
  241. API
  242. </span>
  243. <span class="md-nav__icon md-icon"></span>
  244. </label>
  245. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  246. <label class="md-nav__title" for="__nav_2">
  247. <span class="md-nav__icon md-icon"></span>
  248. API
  249. </label>
  250. <ul class="md-nav__list" data-md-scrollfix>
  251. <li class="md-nav__item">
  252. <a href="../components/" class="md-nav__link">
  253. <span class="md-ellipsis">
  254. Components
  255. </span>
  256. </a>
  257. </li>
  258. <li class="md-nav__item md-nav__item--nested">
  259. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  260. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  261. <span class="md-ellipsis">
  262. Core Resources
  263. </span>
  264. <span class="md-nav__icon md-icon"></span>
  265. </label>
  266. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  267. <label class="md-nav__title" for="__nav_2_2">
  268. <span class="md-nav__icon md-icon"></span>
  269. Core Resources
  270. </label>
  271. <ul class="md-nav__list" data-md-scrollfix>
  272. <li class="md-nav__item">
  273. <a href="../externalsecret/" class="md-nav__link">
  274. <span class="md-ellipsis">
  275. ExternalSecret
  276. </span>
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../secretstore/" class="md-nav__link">
  281. <span class="md-ellipsis">
  282. SecretStore
  283. </span>
  284. </a>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../clustersecretstore/" class="md-nav__link">
  288. <span class="md-ellipsis">
  289. ClusterSecretStore
  290. </span>
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="../clusterexternalsecret/" class="md-nav__link">
  295. <span class="md-ellipsis">
  296. ClusterExternalSecret
  297. </span>
  298. </a>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="../pushsecret/" class="md-nav__link">
  302. <span class="md-ellipsis">
  303. PushSecret
  304. </span>
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  312. <div class="md-nav__link md-nav__container">
  313. <a href="../generator/" class="md-nav__link ">
  314. <span class="md-ellipsis">
  315. Generators
  316. </span>
  317. </a>
  318. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  319. <span class="md-nav__icon md-icon"></span>
  320. </label>
  321. </div>
  322. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  323. <label class="md-nav__title" for="__nav_2_3">
  324. <span class="md-nav__icon md-icon"></span>
  325. Generators
  326. </label>
  327. <ul class="md-nav__list" data-md-scrollfix>
  328. <li class="md-nav__item">
  329. <a href="../generator/acr/" class="md-nav__link">
  330. <span class="md-ellipsis">
  331. Azure Container Registry
  332. </span>
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../generator/ecr/" class="md-nav__link">
  337. <span class="md-ellipsis">
  338. AWS Elastic Container Registry
  339. </span>
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="../generator/gcr/" class="md-nav__link">
  344. <span class="md-ellipsis">
  345. Google Container Registry
  346. </span>
  347. </a>
  348. </li>
  349. <li class="md-nav__item">
  350. <a href="../generator/vault/" class="md-nav__link">
  351. <span class="md-ellipsis">
  352. Vault Dynamic Secret
  353. </span>
  354. </a>
  355. </li>
  356. <li class="md-nav__item">
  357. <a href="../generator/password/" class="md-nav__link">
  358. <span class="md-ellipsis">
  359. Password
  360. </span>
  361. </a>
  362. </li>
  363. <li class="md-nav__item">
  364. <a href="../generator/fake/" class="md-nav__link">
  365. <span class="md-ellipsis">
  366. Fake
  367. </span>
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../generator/webhook/" class="md-nav__link">
  372. <span class="md-ellipsis">
  373. Webhook
  374. </span>
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  381. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
  382. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  383. <span class="md-ellipsis">
  384. Reference Docs
  385. </span>
  386. <span class="md-nav__icon md-icon"></span>
  387. </label>
  388. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="true">
  389. <label class="md-nav__title" for="__nav_2_4">
  390. <span class="md-nav__icon md-icon"></span>
  391. Reference Docs
  392. </label>
  393. <ul class="md-nav__list" data-md-scrollfix>
  394. <li class="md-nav__item">
  395. <a href="../spec/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. API specification
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../controller-options/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Controller Options
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item md-nav__item--active">
  409. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  410. <label class="md-nav__link md-nav__link--active" for="__toc">
  411. <span class="md-ellipsis">
  412. Metrics
  413. </span>
  414. <span class="md-nav__icon md-icon"></span>
  415. </label>
  416. <a href="./" class="md-nav__link md-nav__link--active">
  417. <span class="md-ellipsis">
  418. Metrics
  419. </span>
  420. </a>
  421. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  422. <label class="md-nav__title" for="__toc">
  423. <span class="md-nav__icon md-icon"></span>
  424. Table of contents
  425. </label>
  426. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  427. <li class="md-nav__item">
  428. <a href="#cluster-external-secret-metrics" class="md-nav__link">
  429. <span class="md-ellipsis">
  430. Cluster External Secret Metrics
  431. </span>
  432. </a>
  433. </li>
  434. <li class="md-nav__item">
  435. <a href="#external-secret-metrics" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. External Secret Metrics
  438. </span>
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="#cluster-secret-store-metrics" class="md-nav__link">
  443. <span class="md-ellipsis">
  444. Cluster Secret Store Metrics
  445. </span>
  446. </a>
  447. </li>
  448. </ul>
  449. </nav>
  450. </li>
  451. </ul>
  452. </nav>
  453. </li>
  454. </ul>
  455. </nav>
  456. </li>
  457. <li class="md-nav__item md-nav__item--nested">
  458. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  459. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  460. <span class="md-ellipsis">
  461. Guides
  462. </span>
  463. <span class="md-nav__icon md-icon"></span>
  464. </label>
  465. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  466. <label class="md-nav__title" for="__nav_3">
  467. <span class="md-nav__icon md-icon"></span>
  468. Guides
  469. </label>
  470. <ul class="md-nav__list" data-md-scrollfix>
  471. <li class="md-nav__item">
  472. <a href="../../guides/introduction/" class="md-nav__link">
  473. <span class="md-ellipsis">
  474. Introduction
  475. </span>
  476. </a>
  477. </li>
  478. <li class="md-nav__item md-nav__item--nested">
  479. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  480. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  481. <span class="md-ellipsis">
  482. External Secrets
  483. </span>
  484. <span class="md-nav__icon md-icon"></span>
  485. </label>
  486. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  487. <label class="md-nav__title" for="__nav_3_2">
  488. <span class="md-nav__icon md-icon"></span>
  489. External Secrets
  490. </label>
  491. <ul class="md-nav__list" data-md-scrollfix>
  492. <li class="md-nav__item">
  493. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  494. <span class="md-ellipsis">
  495. Extract structured data
  496. </span>
  497. </a>
  498. </li>
  499. <li class="md-nav__item">
  500. <a href="../../guides/getallsecrets/" class="md-nav__link">
  501. <span class="md-ellipsis">
  502. Find Secrets by Name or Metadata
  503. </span>
  504. </a>
  505. </li>
  506. <li class="md-nav__item">
  507. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  508. <span class="md-ellipsis">
  509. Rewriting Keys
  510. </span>
  511. </a>
  512. </li>
  513. <li class="md-nav__item md-nav__item--nested">
  514. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  515. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  516. <span class="md-ellipsis">
  517. Advanced Templating
  518. </span>
  519. <span class="md-nav__icon md-icon"></span>
  520. </label>
  521. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  522. <label class="md-nav__title" for="__nav_3_2_4">
  523. <span class="md-nav__icon md-icon"></span>
  524. Advanced Templating
  525. </label>
  526. <ul class="md-nav__list" data-md-scrollfix>
  527. <li class="md-nav__item">
  528. <a href="../../guides/templating/" class="md-nav__link">
  529. <span class="md-ellipsis">
  530. v2
  531. </span>
  532. </a>
  533. </li>
  534. <li class="md-nav__item">
  535. <a href="../../guides/templating-v1/" class="md-nav__link">
  536. <span class="md-ellipsis">
  537. v1
  538. </span>
  539. </a>
  540. </li>
  541. </ul>
  542. </nav>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  546. <span class="md-ellipsis">
  547. Kubernetes Secret Types
  548. </span>
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  553. <span class="md-ellipsis">
  554. Lifecycle: ownership & deletion
  555. </span>
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  560. <span class="md-ellipsis">
  561. Decoding Strategies
  562. </span>
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="../../guides/controller-class/" class="md-nav__link">
  567. <span class="md-ellipsis">
  568. Controller Classes
  569. </span>
  570. </a>
  571. </li>
  572. </ul>
  573. </nav>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../guides/generator/" class="md-nav__link">
  577. <span class="md-ellipsis">
  578. Generators
  579. </span>
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../../guides/pushsecrets/" class="md-nav__link">
  584. <span class="md-ellipsis">
  585. Push Secrets
  586. </span>
  587. </a>
  588. </li>
  589. <li class="md-nav__item md-nav__item--nested">
  590. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  591. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  592. <span class="md-ellipsis">
  593. Operations
  594. </span>
  595. <span class="md-nav__icon md-icon"></span>
  596. </label>
  597. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  598. <label class="md-nav__title" for="__nav_3_5">
  599. <span class="md-nav__icon md-icon"></span>
  600. Operations
  601. </label>
  602. <ul class="md-nav__list" data-md-scrollfix>
  603. <li class="md-nav__item">
  604. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  605. <span class="md-ellipsis">
  606. Multi Tenancy
  607. </span>
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../../guides/security-best-practices/" class="md-nav__link">
  612. <span class="md-ellipsis">
  613. Security Best Practices
  614. </span>
  615. </a>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="../../guides/threat-model/" class="md-nav__link">
  619. <span class="md-ellipsis">
  620. Threat Model
  621. </span>
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="../../guides/v1beta1/" class="md-nav__link">
  626. <span class="md-ellipsis">
  627. Upgrading to v1beta1
  628. </span>
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../../guides/using-latest-image/" class="md-nav__link">
  633. <span class="md-ellipsis">
  634. Using Latest Image
  635. </span>
  636. </a>
  637. </li>
  638. <li class="md-nav__item">
  639. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  640. <span class="md-ellipsis">
  641. Disable Cluster Features
  642. </span>
  643. </a>
  644. </li>
  645. </ul>
  646. </nav>
  647. </li>
  648. </ul>
  649. </nav>
  650. </li>
  651. <li class="md-nav__item md-nav__item--nested">
  652. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  653. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  654. <span class="md-ellipsis">
  655. Provider
  656. </span>
  657. <span class="md-nav__icon md-icon"></span>
  658. </label>
  659. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  660. <label class="md-nav__title" for="__nav_4">
  661. <span class="md-nav__icon md-icon"></span>
  662. Provider
  663. </label>
  664. <ul class="md-nav__list" data-md-scrollfix>
  665. <li class="md-nav__item">
  666. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  667. <span class="md-ellipsis">
  668. AWS Secrets Manager
  669. </span>
  670. </a>
  671. </li>
  672. <li class="md-nav__item">
  673. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  674. <span class="md-ellipsis">
  675. AWS Parameter Store
  676. </span>
  677. </a>
  678. </li>
  679. <li class="md-nav__item">
  680. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  681. <span class="md-ellipsis">
  682. Azure Key Vault
  683. </span>
  684. </a>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="../../provider/chef/" class="md-nav__link">
  688. <span class="md-ellipsis">
  689. Chef
  690. </span>
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="../../provider/conjur/" class="md-nav__link">
  695. <span class="md-ellipsis">
  696. CyberArk Conjur
  697. </span>
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  702. <span class="md-ellipsis">
  703. Google Cloud Secret Manager
  704. </span>
  705. </a>
  706. </li>
  707. <li class="md-nav__item">
  708. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  709. <span class="md-ellipsis">
  710. HashiCorp Vault
  711. </span>
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="../../provider/kubernetes/" class="md-nav__link">
  716. <span class="md-ellipsis">
  717. Kubernetes
  718. </span>
  719. </a>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  723. <span class="md-ellipsis">
  724. IBM Secrets Manager
  725. </span>
  726. </a>
  727. </li>
  728. <li class="md-nav__item">
  729. <a href="../../provider/akeyless/" class="md-nav__link">
  730. <span class="md-ellipsis">
  731. Akeyless
  732. </span>
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  737. <span class="md-ellipsis">
  738. Yandex Certificate Manager
  739. </span>
  740. </a>
  741. </li>
  742. <li class="md-nav__item">
  743. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  744. <span class="md-ellipsis">
  745. Yandex Lockbox
  746. </span>
  747. </a>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="../../provider/alibaba/" class="md-nav__link">
  751. <span class="md-ellipsis">
  752. Alibaba Cloud
  753. </span>
  754. </a>
  755. </li>
  756. <li class="md-nav__item">
  757. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  758. <span class="md-ellipsis">
  759. GitLab Variables
  760. </span>
  761. </a>
  762. </li>
  763. <li class="md-nav__item">
  764. <a href="../../provider/oracle-vault/" class="md-nav__link">
  765. <span class="md-ellipsis">
  766. Oracle Vault
  767. </span>
  768. </a>
  769. </li>
  770. <li class="md-nav__item">
  771. <a href="../../provider/1password-automation/" class="md-nav__link">
  772. <span class="md-ellipsis">
  773. 1Password Secrets Automation
  774. </span>
  775. </a>
  776. </li>
  777. <li class="md-nav__item">
  778. <a href="../../provider/webhook/" class="md-nav__link">
  779. <span class="md-ellipsis">
  780. Webhook
  781. </span>
  782. </a>
  783. </li>
  784. <li class="md-nav__item">
  785. <a href="../../provider/fake/" class="md-nav__link">
  786. <span class="md-ellipsis">
  787. Fake
  788. </span>
  789. </a>
  790. </li>
  791. <li class="md-nav__item">
  792. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  793. <span class="md-ellipsis">
  794. senhasegura DevOps Secrets Management (DSM)
  795. </span>
  796. </a>
  797. </li>
  798. <li class="md-nav__item">
  799. <a href="../../provider/doppler/" class="md-nav__link">
  800. <span class="md-ellipsis">
  801. Doppler
  802. </span>
  803. </a>
  804. </li>
  805. <li class="md-nav__item">
  806. <a href="../../provider/keeper-security/" class="md-nav__link">
  807. <span class="md-ellipsis">
  808. Keeper Security
  809. </span>
  810. </a>
  811. </li>
  812. <li class="md-nav__item">
  813. <a href="../../provider/cloak/" class="md-nav__link">
  814. <span class="md-ellipsis">
  815. Cloak End 2 End Encrypted Secrets
  816. </span>
  817. </a>
  818. </li>
  819. <li class="md-nav__item">
  820. <a href="../../provider/scaleway/" class="md-nav__link">
  821. <span class="md-ellipsis">
  822. Scaleway
  823. </span>
  824. </a>
  825. </li>
  826. <li class="md-nav__item">
  827. <a href="../../provider/delinea/" class="md-nav__link">
  828. <span class="md-ellipsis">
  829. Delinea
  830. </span>
  831. </a>
  832. </li>
  833. <li class="md-nav__item">
  834. <a href="../../provider/passbolt/" class="md-nav__link">
  835. <span class="md-ellipsis">
  836. Passbolt
  837. </span>
  838. </a>
  839. </li>
  840. <li class="md-nav__item">
  841. <a href="../../provider/pulumi/" class="md-nav__link">
  842. <span class="md-ellipsis">
  843. Pulumi ESC
  844. </span>
  845. </a>
  846. </li>
  847. <li class="md-nav__item">
  848. <a href="../../provider/onboardbase/" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. Onboardbase
  851. </span>
  852. </a>
  853. </li>
  854. </ul>
  855. </nav>
  856. </li>
  857. <li class="md-nav__item md-nav__item--nested">
  858. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  859. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  860. <span class="md-ellipsis">
  861. Examples
  862. </span>
  863. <span class="md-nav__icon md-icon"></span>
  864. </label>
  865. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  866. <label class="md-nav__title" for="__nav_5">
  867. <span class="md-nav__icon md-icon"></span>
  868. Examples
  869. </label>
  870. <ul class="md-nav__list" data-md-scrollfix>
  871. <li class="md-nav__item">
  872. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  873. <span class="md-ellipsis">
  874. FluxCD
  875. </span>
  876. </a>
  877. </li>
  878. <li class="md-nav__item">
  879. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Anchore Engine
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Jenkins
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../examples/bitwarden/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. BitWarden
  896. </span>
  897. </a>
  898. </li>
  899. </ul>
  900. </nav>
  901. </li>
  902. <li class="md-nav__item md-nav__item--nested">
  903. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  904. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  905. <span class="md-ellipsis">
  906. Community
  907. </span>
  908. <span class="md-nav__icon md-icon"></span>
  909. </label>
  910. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  911. <label class="md-nav__title" for="__nav_6">
  912. <span class="md-nav__icon md-icon"></span>
  913. Community
  914. </label>
  915. <ul class="md-nav__list" data-md-scrollfix>
  916. <li class="md-nav__item md-nav__item--nested">
  917. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  918. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  919. <span class="md-ellipsis">
  920. Contributing
  921. </span>
  922. <span class="md-nav__icon md-icon"></span>
  923. </label>
  924. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  925. <label class="md-nav__title" for="__nav_6_1">
  926. <span class="md-nav__icon md-icon"></span>
  927. Contributing
  928. </label>
  929. <ul class="md-nav__list" data-md-scrollfix>
  930. <li class="md-nav__item">
  931. <a href="../../contributing/devguide/" class="md-nav__link">
  932. <span class="md-ellipsis">
  933. Developer guide
  934. </span>
  935. </a>
  936. </li>
  937. <li class="md-nav__item">
  938. <a href="../../contributing/process/" class="md-nav__link">
  939. <span class="md-ellipsis">
  940. Contributing Process
  941. </span>
  942. </a>
  943. </li>
  944. <li class="md-nav__item">
  945. <a href="../../contributing/release/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. Release Process
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../../contributing/coc/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. Code of Conduct
  955. </span>
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="../../contributing/roadmap/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. Roadmap
  962. </span>
  963. </a>
  964. </li>
  965. </ul>
  966. </nav>
  967. </li>
  968. <li class="md-nav__item md-nav__item--nested">
  969. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  970. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  971. <span class="md-ellipsis">
  972. External Resources
  973. </span>
  974. <span class="md-nav__icon md-icon"></span>
  975. </label>
  976. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  977. <label class="md-nav__title" for="__nav_6_2">
  978. <span class="md-nav__icon md-icon"></span>
  979. External Resources
  980. </label>
  981. <ul class="md-nav__list" data-md-scrollfix>
  982. <li class="md-nav__item">
  983. <a href="../../eso-talks/" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. Talks
  986. </span>
  987. </a>
  988. </li>
  989. <li class="md-nav__item">
  990. <a href="../../eso-demos/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. Demos
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../../eso-blogs/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Blogs
  1000. </span>
  1001. </a>
  1002. </li>
  1003. </ul>
  1004. </nav>
  1005. </li>
  1006. <li class="md-nav__item md-nav__item--nested">
  1007. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_3" >
  1008. <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
  1009. <span class="md-ellipsis">
  1010. AWS
  1011. </span>
  1012. <span class="md-nav__icon md-icon"></span>
  1013. </label>
  1014. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
  1015. <label class="md-nav__title" for="__nav_6_3">
  1016. <span class="md-nav__icon md-icon"></span>
  1017. AWS
  1018. </label>
  1019. <ul class="md-nav__list" data-md-scrollfix>
  1020. <li class="md-nav__item">
  1021. <a href="../../provider-aws-secrets-manager.md" class="md-nav__link">
  1022. <span class="md-ellipsis">
  1023. Secrets Manager
  1024. </span>
  1025. </a>
  1026. </li>
  1027. <li class="md-nav__item">
  1028. <a href="../../provider-aws-parameter-store.md" class="md-nav__link">
  1029. <span class="md-ellipsis">
  1030. Parameter Store
  1031. </span>
  1032. </a>
  1033. </li>
  1034. </ul>
  1035. </nav>
  1036. </li>
  1037. <li class="md-nav__item md-nav__item--nested">
  1038. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_4" >
  1039. <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
  1040. <span class="md-ellipsis">
  1041. Azure
  1042. </span>
  1043. <span class="md-nav__icon md-icon"></span>
  1044. </label>
  1045. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
  1046. <label class="md-nav__title" for="__nav_6_4">
  1047. <span class="md-nav__icon md-icon"></span>
  1048. Azure
  1049. </label>
  1050. <ul class="md-nav__list" data-md-scrollfix>
  1051. <li class="md-nav__item">
  1052. <a href="../../provider-azure-key-vault.md" class="md-nav__link">
  1053. <span class="md-ellipsis">
  1054. Key Vault
  1055. </span>
  1056. </a>
  1057. </li>
  1058. </ul>
  1059. </nav>
  1060. </li>
  1061. <li class="md-nav__item md-nav__item--nested">
  1062. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_5" >
  1063. <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
  1064. <span class="md-ellipsis">
  1065. Google
  1066. </span>
  1067. <span class="md-nav__icon md-icon"></span>
  1068. </label>
  1069. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
  1070. <label class="md-nav__title" for="__nav_6_5">
  1071. <span class="md-nav__icon md-icon"></span>
  1072. Google
  1073. </label>
  1074. <ul class="md-nav__list" data-md-scrollfix>
  1075. <li class="md-nav__item">
  1076. <a href="../../provider-google-secrets-manager.md" class="md-nav__link">
  1077. <span class="md-ellipsis">
  1078. Secrets Manager
  1079. </span>
  1080. </a>
  1081. </li>
  1082. </ul>
  1083. </nav>
  1084. </li>
  1085. <li class="md-nav__item md-nav__item--nested">
  1086. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_6" >
  1087. <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
  1088. <span class="md-ellipsis">
  1089. IBM
  1090. </span>
  1091. <span class="md-nav__icon md-icon"></span>
  1092. </label>
  1093. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
  1094. <label class="md-nav__title" for="__nav_6_6">
  1095. <span class="md-nav__icon md-icon"></span>
  1096. IBM
  1097. </label>
  1098. <ul class="md-nav__list" data-md-scrollfix>
  1099. <li class="md-nav__item">
  1100. <a href="../../provider-ibm-secrets-manager.md" class="md-nav__link">
  1101. <span class="md-ellipsis">
  1102. Secrets Manager
  1103. </span>
  1104. </a>
  1105. </li>
  1106. </ul>
  1107. </nav>
  1108. </li>
  1109. <li class="md-nav__item">
  1110. <a href="../../provider-hashicorp-vault.md" class="md-nav__link">
  1111. <span class="md-ellipsis">
  1112. HashiCorp Vault
  1113. </span>
  1114. </a>
  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_6_8" >
  1118. <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
  1119. <span class="md-ellipsis">
  1120. Yandex
  1121. </span>
  1122. <span class="md-nav__icon md-icon"></span>
  1123. </label>
  1124. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
  1125. <label class="md-nav__title" for="__nav_6_8">
  1126. <span class="md-nav__icon md-icon"></span>
  1127. Yandex
  1128. </label>
  1129. <ul class="md-nav__list" data-md-scrollfix>
  1130. <li class="md-nav__item">
  1131. <a href="../../provider-yandex-lockbox.md" class="md-nav__link">
  1132. <span class="md-ellipsis">
  1133. Lockbox
  1134. </span>
  1135. </a>
  1136. </li>
  1137. </ul>
  1138. </nav>
  1139. </li>
  1140. <li class="md-nav__item">
  1141. <a href="../../provider-passworddepot/" class="md-nav__link">
  1142. <span class="md-ellipsis">
  1143. Password Depot
  1144. </span>
  1145. </a>
  1146. </li>
  1147. <li class="md-nav__item md-nav__item--nested">
  1148. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_10" >
  1149. <label class="md-nav__link" for="__nav_6_10" id="__nav_6_10_label" tabindex="0">
  1150. <span class="md-ellipsis">
  1151. Gitlab
  1152. </span>
  1153. <span class="md-nav__icon md-icon"></span>
  1154. </label>
  1155. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_10_label" aria-expanded="false">
  1156. <label class="md-nav__title" for="__nav_6_10">
  1157. <span class="md-nav__icon md-icon"></span>
  1158. Gitlab
  1159. </label>
  1160. <ul class="md-nav__list" data-md-scrollfix>
  1161. <li class="md-nav__item">
  1162. <a href="../../provider-gitlab-project-variables.md" class="md-nav__link">
  1163. <span class="md-ellipsis">
  1164. Gitlab Project Variables
  1165. </span>
  1166. </a>
  1167. </li>
  1168. </ul>
  1169. </nav>
  1170. </li>
  1171. <li class="md-nav__item md-nav__item--nested">
  1172. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_11" >
  1173. <label class="md-nav__link" for="__nav_6_11" id="__nav_6_11_label" tabindex="0">
  1174. <span class="md-ellipsis">
  1175. Oracle
  1176. </span>
  1177. <span class="md-nav__icon md-icon"></span>
  1178. </label>
  1179. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_11_label" aria-expanded="false">
  1180. <label class="md-nav__title" for="__nav_6_11">
  1181. <span class="md-nav__icon md-icon"></span>
  1182. Oracle
  1183. </label>
  1184. <ul class="md-nav__list" data-md-scrollfix>
  1185. <li class="md-nav__item">
  1186. <a href="../../provider-oracle-vault.md" class="md-nav__link">
  1187. <span class="md-ellipsis">
  1188. Oracle Vault
  1189. </span>
  1190. </a>
  1191. </li>
  1192. </ul>
  1193. </nav>
  1194. </li>
  1195. </ul>
  1196. </nav>
  1197. </li>
  1198. <li class="md-nav__item md-nav__item--nested">
  1199. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1200. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1201. <span class="md-ellipsis">
  1202. References
  1203. </span>
  1204. <span class="md-nav__icon md-icon"></span>
  1205. </label>
  1206. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1207. <label class="md-nav__title" for="__nav_7">
  1208. <span class="md-nav__icon md-icon"></span>
  1209. References
  1210. </label>
  1211. <ul class="md-nav__list" data-md-scrollfix>
  1212. <li class="md-nav__item">
  1213. <a href="../../spec/" class="md-nav__link">
  1214. <span class="md-ellipsis">
  1215. API specification
  1216. </span>
  1217. </a>
  1218. </li>
  1219. </ul>
  1220. </nav>
  1221. </li>
  1222. <li class="md-nav__item md-nav__item--nested">
  1223. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
  1224. <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
  1225. <span class="md-ellipsis">
  1226. Contributing
  1227. </span>
  1228. <span class="md-nav__icon md-icon"></span>
  1229. </label>
  1230. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  1231. <label class="md-nav__title" for="__nav_8">
  1232. <span class="md-nav__icon md-icon"></span>
  1233. Contributing
  1234. </label>
  1235. <ul class="md-nav__list" data-md-scrollfix>
  1236. <li class="md-nav__item">
  1237. <a href="../../contributing-devguide.md" class="md-nav__link">
  1238. <span class="md-ellipsis">
  1239. Developer guide
  1240. </span>
  1241. </a>
  1242. </li>
  1243. <li class="md-nav__item">
  1244. <a href="../../contributing-process.md" class="md-nav__link">
  1245. <span class="md-ellipsis">
  1246. Contributing Process
  1247. </span>
  1248. </a>
  1249. </li>
  1250. <li class="md-nav__item">
  1251. <a href="../../contributing-coc.md" class="md-nav__link">
  1252. <span class="md-ellipsis">
  1253. Code of Conduct
  1254. </span>
  1255. </a>
  1256. </li>
  1257. </ul>
  1258. </nav>
  1259. </li>
  1260. <li class="md-nav__item">
  1261. <a href="../../deprecation-policy.md" class="md-nav__link">
  1262. <span class="md-ellipsis">
  1263. Deprecation Policy
  1264. </span>
  1265. </a>
  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="#cluster-secret-store-metrics" class="md-nav__link">
  1297. <span class="md-ellipsis">
  1298. Cluster Secret Store Metrics
  1299. </span>
  1300. </a>
  1301. </li>
  1302. </ul>
  1303. </nav>
  1304. </div>
  1305. </div>
  1306. </div>
  1307. <div class="md-content" data-md-component="content">
  1308. <article class="md-content__inner md-typeset">
  1309. <h1 id="metrics">Metrics</h1>
  1310. <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>
  1311. <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>
  1312. <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>
  1313. <h2 id="cluster-external-secret-metrics">Cluster External Secret Metrics</h2>
  1314. <table>
  1315. <thead>
  1316. <tr>
  1317. <th>Name</th>
  1318. <th>Type</th>
  1319. <th>Description</th>
  1320. </tr>
  1321. </thead>
  1322. <tbody>
  1323. <tr>
  1324. <td><code>clusterexternalsecret_status_condition</code></td>
  1325. <td>Gauge</td>
  1326. <td>The status condition of a specific Cluster External Secret</td>
  1327. </tr>
  1328. <tr>
  1329. <td><code>clusterexternalsecret_reconcile_duration</code></td>
  1330. <td>Gauge</td>
  1331. <td>The duration time to reconcile the Cluster External Secret</td>
  1332. </tr>
  1333. </tbody>
  1334. </table>
  1335. <h2 id="external-secret-metrics">External Secret Metrics</h2>
  1336. <table>
  1337. <thead>
  1338. <tr>
  1339. <th>Name</th>
  1340. <th>Type</th>
  1341. <th>Description</th>
  1342. </tr>
  1343. </thead>
  1344. <tbody>
  1345. <tr>
  1346. <td><code>externalsecret_provider_api_calls_count</code></td>
  1347. <td>Counter</td>
  1348. <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>
  1349. </tr>
  1350. <tr>
  1351. <td><code>externalsecret_sync_calls_total</code></td>
  1352. <td>Counter</td>
  1353. <td>Total number of the External Secret sync calls</td>
  1354. </tr>
  1355. <tr>
  1356. <td><code>externalsecret_sync_calls_error</code></td>
  1357. <td>Counter</td>
  1358. <td>Total number of the External Secret sync errors</td>
  1359. </tr>
  1360. <tr>
  1361. <td><code>externalsecret_status_condition</code></td>
  1362. <td>Gauge</td>
  1363. <td>The status condition of a specific External Secret</td>
  1364. </tr>
  1365. <tr>
  1366. <td><code>externalsecret_reconcile_duration</code></td>
  1367. <td>Gauge</td>
  1368. <td>The duration time to reconcile the External Secret</td>
  1369. </tr>
  1370. </tbody>
  1371. </table>
  1372. <h2 id="cluster-secret-store-metrics">Cluster Secret Store Metrics</h2>
  1373. <table>
  1374. <thead>
  1375. <tr>
  1376. <th>Name</th>
  1377. <th>Type</th>
  1378. <th>Description</th>
  1379. </tr>
  1380. </thead>
  1381. <tbody>
  1382. <tr>
  1383. <td><code>clustersecretstore_status_condition</code></td>
  1384. <td>Gauge</td>
  1385. <td>The status condition of a specific Cluster Secret Store</td>
  1386. </tr>
  1387. <tr>
  1388. <td><code>clustersecretstore_reconcile_duration</code></td>
  1389. <td>Gauge</td>
  1390. <td>The duration time to reconcile the Cluster Secret Store</td>
  1391. </tr>
  1392. </tbody>
  1393. </table>
  1394. <h1 id="secret-store-metrics">Secret Store Metrics</h1>
  1395. <table>
  1396. <thead>
  1397. <tr>
  1398. <th>Name</th>
  1399. <th>Type</th>
  1400. <th>Description</th>
  1401. </tr>
  1402. </thead>
  1403. <tbody>
  1404. <tr>
  1405. <td><code>secretstore_status_condition</code></td>
  1406. <td>Gauge</td>
  1407. <td>The status condition of a specific Secret Store</td>
  1408. </tr>
  1409. <tr>
  1410. <td><code>secretstore_reconcile_duration</code></td>
  1411. <td>Gauge</td>
  1412. <td>The duration time to reconcile the Secret Store</td>
  1413. </tr>
  1414. </tbody>
  1415. </table>
  1416. <h2 id="controller-runtime-metrics">Controller Runtime Metrics</h2>
  1417. <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>
  1418. <h2 id="dashboard">Dashboard</h2>
  1419. <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>
  1420. <p><img alt="ESO Dashboard" src="../../pictures/eso-dashboard-1.png" />
  1421. <img alt="ESO Dashboard" src="../../pictures/eso-dashboard-2.png" /></p>
  1422. <h2 id="service-level-indicators-and-alerts">Service Level Indicators and Alerts</h2>
  1423. <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>
  1424. <h4 id="webhook-http-status-codes">Webhook HTTP Status Codes</h4>
  1425. <p>The webhook HTTP status code indicates that a HTTP Request was answered successfully or not.
  1426. 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>
  1427. <p>SLI Example: request error percentage.
  1428. <div class="highlight"><pre><span></span><code>sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;,code=&quot;500&quot;}[1m]))
  1429. /
  1430. sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;}[1m]))
  1431. </code></pre></div></p>
  1432. <h4 id="webhook-http-request-latency">Webhook HTTP Request Latency</h4>
  1433. <p>If the webhook server is not able to respond in time then that may cause a timeout at the client.
  1434. This failure may cascade down to the controller or any other user of <code>kube-apiserver</code>.</p>
  1435. <p>SLI Example: p99 across all webhook requests.
  1436. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  1437. sum(rate(controller_runtime_webhook_latency_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  1438. )
  1439. </code></pre></div></p>
  1440. <h4 id="controller-workqueue-depth">Controller Workqueue Depth</h4>
  1441. <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>
  1442. <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>
  1443. <div class="highlight"><pre><span></span><code>sum(
  1444. workqueue_depth{service=~&quot;external-secrets.*&quot;}
  1445. ) by (name)
  1446. </code></pre></div>
  1447. <h4 id="controller-reconcile-latency">Controller Reconcile Latency</h4>
  1448. <p>The controller should be able to reconcile resources within a reasonable timeframe. When latency is high secret delivery may impacted.</p>
  1449. <p>SLI Example: p99 across all controllers.
  1450. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  1451. sum(rate(controller_runtime_reconcile_time_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  1452. )
  1453. </code></pre></div></p>
  1454. <h4 id="controller-reconcile-error">Controller Reconcile Error</h4>
  1455. <p>The controller should be able to reconcile resources without errors. When errors occurr secret delivery may be impacted which could cascade down to the secret consuming applications.</p>
  1456. <div class="highlight"><pre><span></span><code>sum(increase(
  1457. controller_runtime_reconcile_total{service=~&quot;external-secrets.*&quot;,controller=~&quot;$controller&quot;,result=&quot;error&quot;}[1m])
  1458. ) by (result)
  1459. </code></pre></div>
  1460. </article>
  1461. </div>
  1462. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1463. </div>
  1464. </main>
  1465. <footer class="md-footer">
  1466. <div class="md-footer-meta md-typeset">
  1467. <div class="md-footer-meta__inner md-grid">
  1468. <div class="md-copyright">
  1469. <div class="md-copyright__highlight">
  1470. &copy; 2024 The external-secrets Authors.<br/>
  1471. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1472. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1473. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1474. </div>
  1475. Made with
  1476. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1477. Material for MkDocs
  1478. </a>
  1479. </div>
  1480. </div>
  1481. </div>
  1482. </footer>
  1483. </div>
  1484. <div class="md-dialog" data-md-component="dialog">
  1485. <div class="md-dialog__inner md-typeset"></div>
  1486. </div>
  1487. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1488. <script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>
  1489. </body>
  1490. </html>