index.html 59 KB

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