index.html 62 KB

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