index.html 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563
  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.6.1, mkdocs-material-9.5.42">
  10. <title>Metrics - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.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]"),outdated=__md_get("__outdated",sessionStorage);!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 6.6.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 2024 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.81"/></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 6.6.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 2024 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.81"/></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/getting-started/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Getting started
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/faq/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. FAQ
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/stability-support/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Stability and Support
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. Deprecation Policy
  227. </span>
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  235. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  236. <span class="md-ellipsis">
  237. API
  238. </span>
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  242. <label class="md-nav__title" for="__nav_2">
  243. <span class="md-nav__icon md-icon"></span>
  244. API
  245. </label>
  246. <ul class="md-nav__list" data-md-scrollfix>
  247. <li class="md-nav__item">
  248. <a href="../components/" class="md-nav__link">
  249. <span class="md-ellipsis">
  250. Components
  251. </span>
  252. </a>
  253. </li>
  254. <li class="md-nav__item md-nav__item--nested">
  255. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  256. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  257. <span class="md-ellipsis">
  258. Core Resources
  259. </span>
  260. <span class="md-nav__icon md-icon"></span>
  261. </label>
  262. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  263. <label class="md-nav__title" for="__nav_2_2">
  264. <span class="md-nav__icon md-icon"></span>
  265. Core Resources
  266. </label>
  267. <ul class="md-nav__list" data-md-scrollfix>
  268. <li class="md-nav__item">
  269. <a href="../externalsecret/" class="md-nav__link">
  270. <span class="md-ellipsis">
  271. ExternalSecret
  272. </span>
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../secretstore/" class="md-nav__link">
  277. <span class="md-ellipsis">
  278. SecretStore
  279. </span>
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../clustersecretstore/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ClusterSecretStore
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../clusterexternalsecret/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. ClusterExternalSecret
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../pushsecret/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. PushSecret
  300. </span>
  301. </a>
  302. </li>
  303. </ul>
  304. </nav>
  305. </li>
  306. <li class="md-nav__item md-nav__item--nested">
  307. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  308. <div class="md-nav__link md-nav__container">
  309. <a href="../generator/" class="md-nav__link ">
  310. <span class="md-ellipsis">
  311. Generators
  312. </span>
  313. </a>
  314. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  315. <span class="md-nav__icon md-icon"></span>
  316. </label>
  317. </div>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_3">
  320. <span class="md-nav__icon md-icon"></span>
  321. Generators
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../generator/acr/" class="md-nav__link">
  326. <span class="md-ellipsis">
  327. Azure Container Registry
  328. </span>
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../generator/ecr/" class="md-nav__link">
  333. <span class="md-ellipsis">
  334. AWS Elastic Container Registry
  335. </span>
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../generator/gcr/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. Google Container Registry
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../generator/vault/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Vault Dynamic Secret
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../generator/password/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. Password
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../generator/fake/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. Fake
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../generator/webhook/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Webhook
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../generator/github/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Github
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../generator/uuid/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. UUID
  384. </span>
  385. </a>
  386. </li>
  387. </ul>
  388. </nav>
  389. </li>
  390. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  391. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
  392. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  393. <span class="md-ellipsis">
  394. Reference Docs
  395. </span>
  396. <span class="md-nav__icon md-icon"></span>
  397. </label>
  398. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="true">
  399. <label class="md-nav__title" for="__nav_2_4">
  400. <span class="md-nav__icon md-icon"></span>
  401. Reference Docs
  402. </label>
  403. <ul class="md-nav__list" data-md-scrollfix>
  404. <li class="md-nav__item">
  405. <a href="../spec/" class="md-nav__link">
  406. <span class="md-ellipsis">
  407. API specification
  408. </span>
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="../controller-options/" class="md-nav__link">
  413. <span class="md-ellipsis">
  414. Controller Options
  415. </span>
  416. </a>
  417. </li>
  418. <li class="md-nav__item md-nav__item--active">
  419. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  420. <label class="md-nav__link md-nav__link--active" for="__toc">
  421. <span class="md-ellipsis">
  422. Metrics
  423. </span>
  424. <span class="md-nav__icon md-icon"></span>
  425. </label>
  426. <a href="./" class="md-nav__link md-nav__link--active">
  427. <span class="md-ellipsis">
  428. Metrics
  429. </span>
  430. </a>
  431. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  432. <label class="md-nav__title" for="__toc">
  433. <span class="md-nav__icon md-icon"></span>
  434. Table of contents
  435. </label>
  436. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  437. <li class="md-nav__item">
  438. <a href="#cluster-external-secret-metrics" class="md-nav__link">
  439. <span class="md-ellipsis">
  440. Cluster External Secret Metrics
  441. </span>
  442. </a>
  443. </li>
  444. <li class="md-nav__item">
  445. <a href="#external-secret-metrics" class="md-nav__link">
  446. <span class="md-ellipsis">
  447. External Secret Metrics
  448. </span>
  449. </a>
  450. </li>
  451. <li class="md-nav__item">
  452. <a href="#cluster-secret-store-metrics" class="md-nav__link">
  453. <span class="md-ellipsis">
  454. Cluster Secret Store Metrics
  455. </span>
  456. </a>
  457. </li>
  458. </ul>
  459. </nav>
  460. </li>
  461. </ul>
  462. </nav>
  463. </li>
  464. </ul>
  465. </nav>
  466. </li>
  467. <li class="md-nav__item md-nav__item--nested">
  468. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  469. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  470. <span class="md-ellipsis">
  471. Guides
  472. </span>
  473. <span class="md-nav__icon md-icon"></span>
  474. </label>
  475. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  476. <label class="md-nav__title" for="__nav_3">
  477. <span class="md-nav__icon md-icon"></span>
  478. Guides
  479. </label>
  480. <ul class="md-nav__list" data-md-scrollfix>
  481. <li class="md-nav__item">
  482. <a href="../../guides/introduction/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. Introduction
  485. </span>
  486. </a>
  487. </li>
  488. <li class="md-nav__item md-nav__item--nested">
  489. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  490. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  491. <span class="md-ellipsis">
  492. External Secrets
  493. </span>
  494. <span class="md-nav__icon md-icon"></span>
  495. </label>
  496. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  497. <label class="md-nav__title" for="__nav_3_2">
  498. <span class="md-nav__icon md-icon"></span>
  499. External Secrets
  500. </label>
  501. <ul class="md-nav__list" data-md-scrollfix>
  502. <li class="md-nav__item">
  503. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  504. <span class="md-ellipsis">
  505. Extract structured data
  506. </span>
  507. </a>
  508. </li>
  509. <li class="md-nav__item">
  510. <a href="../../guides/getallsecrets/" class="md-nav__link">
  511. <span class="md-ellipsis">
  512. Find Secrets by Name or Metadata
  513. </span>
  514. </a>
  515. </li>
  516. <li class="md-nav__item">
  517. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  518. <span class="md-ellipsis">
  519. Rewriting Keys
  520. </span>
  521. </a>
  522. </li>
  523. <li class="md-nav__item md-nav__item--nested">
  524. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  525. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  526. <span class="md-ellipsis">
  527. Advanced Templating
  528. </span>
  529. <span class="md-nav__icon md-icon"></span>
  530. </label>
  531. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  532. <label class="md-nav__title" for="__nav_3_2_4">
  533. <span class="md-nav__icon md-icon"></span>
  534. Advanced Templating
  535. </label>
  536. <ul class="md-nav__list" data-md-scrollfix>
  537. <li class="md-nav__item">
  538. <a href="../../guides/templating/" class="md-nav__link">
  539. <span class="md-ellipsis">
  540. v2
  541. </span>
  542. </a>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="../../guides/templating-v1/" class="md-nav__link">
  546. <span class="md-ellipsis">
  547. v1
  548. </span>
  549. </a>
  550. </li>
  551. </ul>
  552. </nav>
  553. </li>
  554. <li class="md-nav__item">
  555. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  556. <span class="md-ellipsis">
  557. Kubernetes Secret Types
  558. </span>
  559. </a>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  563. <span class="md-ellipsis">
  564. Lifecycle: ownership & deletion
  565. </span>
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  570. <span class="md-ellipsis">
  571. Decoding Strategies
  572. </span>
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../guides/controller-class/" class="md-nav__link">
  577. <span class="md-ellipsis">
  578. Controller Classes
  579. </span>
  580. </a>
  581. </li>
  582. </ul>
  583. </nav>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../guides/generator/" class="md-nav__link">
  587. <span class="md-ellipsis">
  588. Generators
  589. </span>
  590. </a>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../guides/pushsecrets/" class="md-nav__link">
  594. <span class="md-ellipsis">
  595. Push Secrets
  596. </span>
  597. </a>
  598. </li>
  599. <li class="md-nav__item md-nav__item--nested">
  600. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  601. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  602. <span class="md-ellipsis">
  603. Operations
  604. </span>
  605. <span class="md-nav__icon md-icon"></span>
  606. </label>
  607. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  608. <label class="md-nav__title" for="__nav_3_5">
  609. <span class="md-nav__icon md-icon"></span>
  610. Operations
  611. </label>
  612. <ul class="md-nav__list" data-md-scrollfix>
  613. <li class="md-nav__item">
  614. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  615. <span class="md-ellipsis">
  616. Multi Tenancy
  617. </span>
  618. </a>
  619. </li>
  620. <li class="md-nav__item">
  621. <a href="../../guides/security-best-practices/" class="md-nav__link">
  622. <span class="md-ellipsis">
  623. Security Best Practices
  624. </span>
  625. </a>
  626. </li>
  627. <li class="md-nav__item">
  628. <a href="../../guides/threat-model/" class="md-nav__link">
  629. <span class="md-ellipsis">
  630. Threat Model
  631. </span>
  632. </a>
  633. </li>
  634. <li class="md-nav__item">
  635. <a href="../../guides/v1beta1/" class="md-nav__link">
  636. <span class="md-ellipsis">
  637. Upgrading to v1beta1
  638. </span>
  639. </a>
  640. </li>
  641. <li class="md-nav__item">
  642. <a href="../../guides/using-latest-image/" class="md-nav__link">
  643. <span class="md-ellipsis">
  644. Using Latest Image
  645. </span>
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  650. <span class="md-ellipsis">
  651. Disable Cluster Features
  652. </span>
  653. </a>
  654. </li>
  655. </ul>
  656. </nav>
  657. </li>
  658. </ul>
  659. </nav>
  660. </li>
  661. <li class="md-nav__item md-nav__item--nested">
  662. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  663. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  664. <span class="md-ellipsis">
  665. Provider
  666. </span>
  667. <span class="md-nav__icon md-icon"></span>
  668. </label>
  669. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  670. <label class="md-nav__title" for="__nav_4">
  671. <span class="md-nav__icon md-icon"></span>
  672. Provider
  673. </label>
  674. <ul class="md-nav__list" data-md-scrollfix>
  675. <li class="md-nav__item">
  676. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. AWS Secrets Manager
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. AWS Parameter Store
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Azure Key Vault
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../provider/beyondtrust/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. BeyondTrust
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. Bitwarden Secrets Manager
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/chef/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Chef
  714. </span>
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../provider/conjur/" class="md-nav__link">
  719. <span class="md-ellipsis">
  720. CyberArk Conjur
  721. </span>
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../provider/device42/" class="md-nav__link">
  726. <span class="md-ellipsis">
  727. Device42
  728. </span>
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. Google Cloud Secret Manager
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. HashiCorp Vault
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/kubernetes/" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. Kubernetes
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. IBM Secrets Manager
  756. </span>
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="../../provider/akeyless/" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. Akeyless
  763. </span>
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. Yandex Certificate Manager
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Yandex Lockbox
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../provider/alibaba/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Alibaba Cloud
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. GitLab Variables
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../provider/oracle-vault/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. Oracle Vault
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../../provider/1password-automation/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. 1Password Secrets Automation
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../../provider/webhook/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. Webhook
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="../../provider/fake/" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Fake
  819. </span>
  820. </a>
  821. </li>
  822. <li class="md-nav__item">
  823. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  824. <span class="md-ellipsis">
  825. senhasegura DevOps Secrets Management (DSM)
  826. </span>
  827. </a>
  828. </li>
  829. <li class="md-nav__item">
  830. <a href="../../provider/doppler/" class="md-nav__link">
  831. <span class="md-ellipsis">
  832. Doppler
  833. </span>
  834. </a>
  835. </li>
  836. <li class="md-nav__item">
  837. <a href="../../provider/keeper-security/" class="md-nav__link">
  838. <span class="md-ellipsis">
  839. Keeper Security
  840. </span>
  841. </a>
  842. </li>
  843. <li class="md-nav__item">
  844. <a href="../../provider/cloak/" class="md-nav__link">
  845. <span class="md-ellipsis">
  846. Cloak End 2 End Encrypted Secrets
  847. </span>
  848. </a>
  849. </li>
  850. <li class="md-nav__item">
  851. <a href="../../provider/scaleway/" class="md-nav__link">
  852. <span class="md-ellipsis">
  853. Scaleway
  854. </span>
  855. </a>
  856. </li>
  857. <li class="md-nav__item">
  858. <a href="../../provider/delinea/" class="md-nav__link">
  859. <span class="md-ellipsis">
  860. Delinea
  861. </span>
  862. </a>
  863. </li>
  864. <li class="md-nav__item">
  865. <a href="../../provider/secretserver/" class="md-nav__link">
  866. <span class="md-ellipsis">
  867. Secret Server
  868. </span>
  869. </a>
  870. </li>
  871. <li class="md-nav__item">
  872. <a href="../../provider/passbolt/" class="md-nav__link">
  873. <span class="md-ellipsis">
  874. Passbolt
  875. </span>
  876. </a>
  877. </li>
  878. <li class="md-nav__item">
  879. <a href="../../provider/pulumi/" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Pulumi ESC
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="../../provider/onboardbase/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Onboardbase
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../provider-passworddepot/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. Password Depot
  896. </span>
  897. </a>
  898. </li>
  899. <li class="md-nav__item">
  900. <a href="../../provider/fortanix/" class="md-nav__link">
  901. <span class="md-ellipsis">
  902. Fortanix
  903. </span>
  904. </a>
  905. </li>
  906. <li class="md-nav__item">
  907. <a href="../../provider/infisical/" class="md-nav__link">
  908. <span class="md-ellipsis">
  909. Infisical
  910. </span>
  911. </a>
  912. </li>
  913. <li class="md-nav__item">
  914. <a href="../../provider/previder/" class="md-nav__link">
  915. <span class="md-ellipsis">
  916. Previder
  917. </span>
  918. </a>
  919. </li>
  920. </ul>
  921. </nav>
  922. </li>
  923. <li class="md-nav__item md-nav__item--nested">
  924. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  925. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  926. <span class="md-ellipsis">
  927. Examples
  928. </span>
  929. <span class="md-nav__icon md-icon"></span>
  930. </label>
  931. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  932. <label class="md-nav__title" for="__nav_5">
  933. <span class="md-nav__icon md-icon"></span>
  934. Examples
  935. </label>
  936. <ul class="md-nav__list" data-md-scrollfix>
  937. <li class="md-nav__item">
  938. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  939. <span class="md-ellipsis">
  940. FluxCD
  941. </span>
  942. </a>
  943. </li>
  944. <li class="md-nav__item">
  945. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. Anchore Engine
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. Jenkins
  955. </span>
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="../../examples/bitwarden/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. BitWarden
  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" >
  970. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  971. <span class="md-ellipsis">
  972. Community
  973. </span>
  974. <span class="md-nav__icon md-icon"></span>
  975. </label>
  976. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  977. <label class="md-nav__title" for="__nav_6">
  978. <span class="md-nav__icon md-icon"></span>
  979. Community
  980. </label>
  981. <ul class="md-nav__list" data-md-scrollfix>
  982. <li class="md-nav__item md-nav__item--nested">
  983. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  984. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  985. <span class="md-ellipsis">
  986. Contributing
  987. </span>
  988. <span class="md-nav__icon md-icon"></span>
  989. </label>
  990. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  991. <label class="md-nav__title" for="__nav_6_1">
  992. <span class="md-nav__icon md-icon"></span>
  993. Contributing
  994. </label>
  995. <ul class="md-nav__list" data-md-scrollfix>
  996. <li class="md-nav__item">
  997. <a href="../../contributing/devguide/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Developer guide
  1000. </span>
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="../../contributing/process/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Contributing Process
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../../contributing/release/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Release Process
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../../contributing/coc/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Code of Conduct
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../../contributing/roadmap/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Roadmap
  1028. </span>
  1029. </a>
  1030. </li>
  1031. </ul>
  1032. </nav>
  1033. </li>
  1034. <li class="md-nav__item md-nav__item--nested">
  1035. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1036. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1037. <span class="md-ellipsis">
  1038. External Resources
  1039. </span>
  1040. <span class="md-nav__icon md-icon"></span>
  1041. </label>
  1042. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1043. <label class="md-nav__title" for="__nav_6_2">
  1044. <span class="md-nav__icon md-icon"></span>
  1045. External Resources
  1046. </label>
  1047. <ul class="md-nav__list" data-md-scrollfix>
  1048. <li class="md-nav__item">
  1049. <a href="../../eso-talks/" class="md-nav__link">
  1050. <span class="md-ellipsis">
  1051. Talks
  1052. </span>
  1053. </a>
  1054. </li>
  1055. <li class="md-nav__item">
  1056. <a href="../../eso-demos/" class="md-nav__link">
  1057. <span class="md-ellipsis">
  1058. Demos
  1059. </span>
  1060. </a>
  1061. </li>
  1062. <li class="md-nav__item">
  1063. <a href="../../eso-blogs/" class="md-nav__link">
  1064. <span class="md-ellipsis">
  1065. Blogs
  1066. </span>
  1067. </a>
  1068. </li>
  1069. <li class="md-nav__item">
  1070. <a href="../../eso-tools/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Tools
  1073. </span>
  1074. </a>
  1075. </li>
  1076. </ul>
  1077. </nav>
  1078. </li>
  1079. </ul>
  1080. </nav>
  1081. </li>
  1082. </ul>
  1083. </nav>
  1084. </div>
  1085. </div>
  1086. </div>
  1087. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  1088. <div class="md-sidebar__scrollwrap">
  1089. <div class="md-sidebar__inner">
  1090. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1091. <label class="md-nav__title" for="__toc">
  1092. <span class="md-nav__icon md-icon"></span>
  1093. Table of contents
  1094. </label>
  1095. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1096. <li class="md-nav__item">
  1097. <a href="#cluster-external-secret-metrics" class="md-nav__link">
  1098. <span class="md-ellipsis">
  1099. Cluster External Secret Metrics
  1100. </span>
  1101. </a>
  1102. </li>
  1103. <li class="md-nav__item">
  1104. <a href="#external-secret-metrics" class="md-nav__link">
  1105. <span class="md-ellipsis">
  1106. External Secret Metrics
  1107. </span>
  1108. </a>
  1109. </li>
  1110. <li class="md-nav__item">
  1111. <a href="#cluster-secret-store-metrics" class="md-nav__link">
  1112. <span class="md-ellipsis">
  1113. Cluster Secret Store Metrics
  1114. </span>
  1115. </a>
  1116. </li>
  1117. </ul>
  1118. </nav>
  1119. </div>
  1120. </div>
  1121. </div>
  1122. <div class="md-content" data-md-component="content">
  1123. <article class="md-content__inner md-typeset">
  1124. <h1 id="metrics">Metrics</h1>
  1125. <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>
  1126. <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>
  1127. <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>
  1128. <h2 id="cluster-external-secret-metrics">Cluster External Secret Metrics</h2>
  1129. <table>
  1130. <thead>
  1131. <tr>
  1132. <th>Name</th>
  1133. <th>Type</th>
  1134. <th>Description</th>
  1135. </tr>
  1136. </thead>
  1137. <tbody>
  1138. <tr>
  1139. <td><code>clusterexternalsecret_status_condition</code></td>
  1140. <td>Gauge</td>
  1141. <td>The status condition of a specific Cluster External Secret</td>
  1142. </tr>
  1143. <tr>
  1144. <td><code>clusterexternalsecret_reconcile_duration</code></td>
  1145. <td>Gauge</td>
  1146. <td>The duration time to reconcile the Cluster External Secret</td>
  1147. </tr>
  1148. </tbody>
  1149. </table>
  1150. <h2 id="external-secret-metrics">External Secret Metrics</h2>
  1151. <table>
  1152. <thead>
  1153. <tr>
  1154. <th>Name</th>
  1155. <th>Type</th>
  1156. <th>Description</th>
  1157. </tr>
  1158. </thead>
  1159. <tbody>
  1160. <tr>
  1161. <td><code>externalsecret_provider_api_calls_count</code></td>
  1162. <td>Counter</td>
  1163. <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>
  1164. </tr>
  1165. <tr>
  1166. <td><code>externalsecret_sync_calls_total</code></td>
  1167. <td>Counter</td>
  1168. <td>Total number of the External Secret sync calls</td>
  1169. </tr>
  1170. <tr>
  1171. <td><code>externalsecret_sync_calls_error</code></td>
  1172. <td>Counter</td>
  1173. <td>Total number of the External Secret sync errors</td>
  1174. </tr>
  1175. <tr>
  1176. <td><code>externalsecret_status_condition</code></td>
  1177. <td>Gauge</td>
  1178. <td>The status condition of a specific External Secret</td>
  1179. </tr>
  1180. <tr>
  1181. <td><code>externalsecret_reconcile_duration</code></td>
  1182. <td>Gauge</td>
  1183. <td>The duration time to reconcile the External Secret</td>
  1184. </tr>
  1185. </tbody>
  1186. </table>
  1187. <h2 id="cluster-secret-store-metrics">Cluster Secret Store Metrics</h2>
  1188. <table>
  1189. <thead>
  1190. <tr>
  1191. <th>Name</th>
  1192. <th>Type</th>
  1193. <th>Description</th>
  1194. </tr>
  1195. </thead>
  1196. <tbody>
  1197. <tr>
  1198. <td><code>clustersecretstore_status_condition</code></td>
  1199. <td>Gauge</td>
  1200. <td>The status condition of a specific Cluster Secret Store</td>
  1201. </tr>
  1202. <tr>
  1203. <td><code>clustersecretstore_reconcile_duration</code></td>
  1204. <td>Gauge</td>
  1205. <td>The duration time to reconcile the Cluster Secret Store</td>
  1206. </tr>
  1207. </tbody>
  1208. </table>
  1209. <h1 id="secret-store-metrics">Secret Store Metrics</h1>
  1210. <table>
  1211. <thead>
  1212. <tr>
  1213. <th>Name</th>
  1214. <th>Type</th>
  1215. <th>Description</th>
  1216. </tr>
  1217. </thead>
  1218. <tbody>
  1219. <tr>
  1220. <td><code>secretstore_status_condition</code></td>
  1221. <td>Gauge</td>
  1222. <td>The status condition of a specific Secret Store</td>
  1223. </tr>
  1224. <tr>
  1225. <td><code>secretstore_reconcile_duration</code></td>
  1226. <td>Gauge</td>
  1227. <td>The duration time to reconcile the Secret Store</td>
  1228. </tr>
  1229. </tbody>
  1230. </table>
  1231. <h2 id="controller-runtime-metrics">Controller Runtime Metrics</h2>
  1232. <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>
  1233. <h2 id="dashboard">Dashboard</h2>
  1234. <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>
  1235. <p><img alt="ESO Dashboard" src="../../pictures/eso-dashboard-1.png" />
  1236. <img alt="ESO Dashboard" src="../../pictures/eso-dashboard-2.png" /></p>
  1237. <h2 id="service-level-indicators-and-alerts">Service Level Indicators and Alerts</h2>
  1238. <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>
  1239. <h4 id="webhook-http-status-codes">Webhook HTTP Status Codes</h4>
  1240. <p>The webhook HTTP status code indicates that a HTTP Request was answered successfully or not.
  1241. 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>
  1242. <p>SLI Example: request error percentage.
  1243. <div class="highlight"><pre><span></span><code>sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;,code=&quot;500&quot;}[1m]))
  1244. /
  1245. sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;}[1m]))
  1246. </code></pre></div></p>
  1247. <h4 id="webhook-http-request-latency">Webhook HTTP Request Latency</h4>
  1248. <p>If the webhook server is not able to respond in time then that may cause a timeout at the client.
  1249. This failure may cascade down to the controller or any other user of <code>kube-apiserver</code>.</p>
  1250. <p>SLI Example: p99 across all webhook requests.
  1251. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  1252. sum(rate(controller_runtime_webhook_latency_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  1253. )
  1254. </code></pre></div></p>
  1255. <h4 id="controller-workqueue-depth">Controller Workqueue Depth</h4>
  1256. <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>
  1257. <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>
  1258. <div class="highlight"><pre><span></span><code>sum(
  1259. workqueue_depth{service=~&quot;external-secrets.*&quot;}
  1260. ) by (name)
  1261. </code></pre></div>
  1262. <h4 id="controller-reconcile-latency">Controller Reconcile Latency</h4>
  1263. <p>The controller should be able to reconcile resources within a reasonable timeframe. When latency is high secret delivery may impacted.</p>
  1264. <p>SLI Example: p99 across all controllers.
  1265. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  1266. sum(rate(controller_runtime_reconcile_time_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  1267. )
  1268. </code></pre></div></p>
  1269. <h4 id="controller-reconcile-error">Controller Reconcile Error</h4>
  1270. <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>
  1271. <div class="highlight"><pre><span></span><code>sum(increase(
  1272. controller_runtime_reconcile_total{service=~&quot;external-secrets.*&quot;,controller=~&quot;$controller&quot;,result=&quot;error&quot;}[1m])
  1273. ) by (result)
  1274. </code></pre></div>
  1275. </article>
  1276. </div>
  1277. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1278. </div>
  1279. </main>
  1280. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1281. <footer class="md-footer">
  1282. <div class="md-footer-meta md-typeset">
  1283. <div class="md-footer-meta__inner md-grid">
  1284. <div class="md-copyright">
  1285. <div class="md-copyright__highlight">
  1286. &copy; 2024 The external-secrets Authors.<br/>
  1287. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1288. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1289. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1290. </div>
  1291. Made with
  1292. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1293. Material for MkDocs
  1294. </a>
  1295. </div>
  1296. </div>
  1297. </div>
  1298. </footer>
  1299. </div>
  1300. <div class="md-dialog" data-md-component="dialog">
  1301. <div class="md-dialog__inner md-typeset"></div>
  1302. </div>
  1303. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.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>
  1304. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  1305. </body>
  1306. </html>