index.html 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267
  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="../decoding-strategy/">
  7. <link rel="next" href="../generator/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
  10. <title>Controller Classes - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.6543a935.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="#controller-classes" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. Controller Classes
  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.2 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.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">
  116. <a href="../../api/components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item md-tabs__item--active">
  121. <a href="../introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. </ul>
  146. </div>
  147. </nav>
  148. <main class="md-main" data-md-component="main">
  149. <div class="md-main__inner md-grid">
  150. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  151. <div class="md-sidebar__scrollwrap">
  152. <div class="md-sidebar__inner">
  153. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  154. <label class="md-nav__title" for="__drawer">
  155. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  156. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  157. </a>
  158. External Secrets Operator
  159. </label>
  160. <div class="md-nav__source">
  161. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  162. <div class="md-source__icon md-icon">
  163. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 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.81z"/></svg>
  164. </div>
  165. <div class="md-source__repository">
  166. External Secrets Operator
  167. </div>
  168. </a>
  169. </div>
  170. <ul class="md-nav__list" data-md-scrollfix>
  171. <li class="md-nav__item md-nav__item--nested">
  172. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  173. <div class="md-nav__link md-nav__container">
  174. <a href="../.." class="md-nav__link ">
  175. <span class="md-ellipsis">
  176. Introduction
  177. </span>
  178. </a>
  179. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  180. <span class="md-nav__icon md-icon"></span>
  181. </label>
  182. </div>
  183. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  184. <label class="md-nav__title" for="__nav_1">
  185. <span class="md-nav__icon md-icon"></span>
  186. Introduction
  187. </label>
  188. <ul class="md-nav__list" data-md-scrollfix>
  189. <li class="md-nav__item">
  190. <a href="../../introduction/overview/" class="md-nav__link">
  191. <span class="md-ellipsis">
  192. Overview
  193. </span>
  194. </a>
  195. </li>
  196. <li class="md-nav__item">
  197. <a href="../../introduction/getting-started/" class="md-nav__link">
  198. <span class="md-ellipsis">
  199. Getting started
  200. </span>
  201. </a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="../../introduction/faq/" class="md-nav__link">
  205. <span class="md-ellipsis">
  206. FAQ
  207. </span>
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../../introduction/stability-support/" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. Stability and Support
  214. </span>
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Deprecation Policy
  221. </span>
  222. </a>
  223. </li>
  224. </ul>
  225. </nav>
  226. </li>
  227. <li class="md-nav__item md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  229. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  230. <span class="md-ellipsis">
  231. API
  232. </span>
  233. <span class="md-nav__icon md-icon"></span>
  234. </label>
  235. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  236. <label class="md-nav__title" for="__nav_2">
  237. <span class="md-nav__icon md-icon"></span>
  238. API
  239. </label>
  240. <ul class="md-nav__list" data-md-scrollfix>
  241. <li class="md-nav__item">
  242. <a href="../../api/components/" class="md-nav__link">
  243. <span class="md-ellipsis">
  244. Components
  245. </span>
  246. </a>
  247. </li>
  248. <li class="md-nav__item md-nav__item--nested">
  249. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  250. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  251. <span class="md-ellipsis">
  252. Core Resources
  253. </span>
  254. <span class="md-nav__icon md-icon"></span>
  255. </label>
  256. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  257. <label class="md-nav__title" for="__nav_2_2">
  258. <span class="md-nav__icon md-icon"></span>
  259. Core Resources
  260. </label>
  261. <ul class="md-nav__list" data-md-scrollfix>
  262. <li class="md-nav__item">
  263. <a href="../../api/externalsecret/" class="md-nav__link">
  264. <span class="md-ellipsis">
  265. ExternalSecret
  266. </span>
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="../../api/secretstore/" class="md-nav__link">
  271. <span class="md-ellipsis">
  272. SecretStore
  273. </span>
  274. </a>
  275. </li>
  276. <li class="md-nav__item">
  277. <a href="../../api/clustersecretstore/" class="md-nav__link">
  278. <span class="md-ellipsis">
  279. ClusterSecretStore
  280. </span>
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  285. <span class="md-ellipsis">
  286. ClusterExternalSecret
  287. </span>
  288. </a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="../../api/pushsecret/" class="md-nav__link">
  292. <span class="md-ellipsis">
  293. PushSecret
  294. </span>
  295. </a>
  296. </li>
  297. </ul>
  298. </nav>
  299. </li>
  300. <li class="md-nav__item md-nav__item--nested">
  301. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  302. <div class="md-nav__link md-nav__container">
  303. <a href="../../api/generator/" class="md-nav__link ">
  304. <span class="md-ellipsis">
  305. Generators
  306. </span>
  307. </a>
  308. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. </div>
  312. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  313. <label class="md-nav__title" for="__nav_2_3">
  314. <span class="md-nav__icon md-icon"></span>
  315. Generators
  316. </label>
  317. <ul class="md-nav__list" data-md-scrollfix>
  318. <li class="md-nav__item">
  319. <a href="../../api/generator/acr/" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. Azure Container Registry
  322. </span>
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../../api/generator/ecr/" class="md-nav__link">
  327. <span class="md-ellipsis">
  328. AWS Elastic Container Registry
  329. </span>
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/generator/gcr/" class="md-nav__link">
  334. <span class="md-ellipsis">
  335. Google Container Registry
  336. </span>
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="../../api/generator/vault/" class="md-nav__link">
  341. <span class="md-ellipsis">
  342. Vault Dynamic Secret
  343. </span>
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="../../api/generator/password/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. Password
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../../api/generator/fake/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. Fake
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../../api/generator/webhook/" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. Webhook
  364. </span>
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../../api/generator/github/" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. Github
  371. </span>
  372. </a>
  373. </li>
  374. </ul>
  375. </nav>
  376. </li>
  377. <li class="md-nav__item md-nav__item--nested">
  378. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  379. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  380. <span class="md-ellipsis">
  381. Reference Docs
  382. </span>
  383. <span class="md-nav__icon md-icon"></span>
  384. </label>
  385. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  386. <label class="md-nav__title" for="__nav_2_4">
  387. <span class="md-nav__icon md-icon"></span>
  388. Reference Docs
  389. </label>
  390. <ul class="md-nav__list" data-md-scrollfix>
  391. <li class="md-nav__item">
  392. <a href="../../api/spec/" class="md-nav__link">
  393. <span class="md-ellipsis">
  394. API specification
  395. </span>
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="../../api/controller-options/" class="md-nav__link">
  400. <span class="md-ellipsis">
  401. Controller Options
  402. </span>
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../api/metrics/" class="md-nav__link">
  407. <span class="md-ellipsis">
  408. Metrics
  409. </span>
  410. </a>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. </ul>
  416. </nav>
  417. </li>
  418. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  419. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  420. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  421. <span class="md-ellipsis">
  422. Guides
  423. </span>
  424. <span class="md-nav__icon md-icon"></span>
  425. </label>
  426. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
  427. <label class="md-nav__title" for="__nav_3">
  428. <span class="md-nav__icon md-icon"></span>
  429. Guides
  430. </label>
  431. <ul class="md-nav__list" data-md-scrollfix>
  432. <li class="md-nav__item">
  433. <a href="../introduction/" class="md-nav__link">
  434. <span class="md-ellipsis">
  435. Introduction
  436. </span>
  437. </a>
  438. </li>
  439. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  440. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" checked>
  441. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  442. <span class="md-ellipsis">
  443. External Secrets
  444. </span>
  445. <span class="md-nav__icon md-icon"></span>
  446. </label>
  447. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true">
  448. <label class="md-nav__title" for="__nav_3_2">
  449. <span class="md-nav__icon md-icon"></span>
  450. External Secrets
  451. </label>
  452. <ul class="md-nav__list" data-md-scrollfix>
  453. <li class="md-nav__item">
  454. <a href="../all-keys-one-secret/" class="md-nav__link">
  455. <span class="md-ellipsis">
  456. Extract structured data
  457. </span>
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../getallsecrets/" class="md-nav__link">
  462. <span class="md-ellipsis">
  463. Find Secrets by Name or Metadata
  464. </span>
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../datafrom-rewrite/" class="md-nav__link">
  469. <span class="md-ellipsis">
  470. Rewriting Keys
  471. </span>
  472. </a>
  473. </li>
  474. <li class="md-nav__item md-nav__item--nested">
  475. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  476. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  477. <span class="md-ellipsis">
  478. Advanced Templating
  479. </span>
  480. <span class="md-nav__icon md-icon"></span>
  481. </label>
  482. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  483. <label class="md-nav__title" for="__nav_3_2_4">
  484. <span class="md-nav__icon md-icon"></span>
  485. Advanced Templating
  486. </label>
  487. <ul class="md-nav__list" data-md-scrollfix>
  488. <li class="md-nav__item">
  489. <a href="../templating/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. v2
  492. </span>
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../templating-v1/" class="md-nav__link">
  497. <span class="md-ellipsis">
  498. v1
  499. </span>
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../common-k8s-secret-types/" class="md-nav__link">
  507. <span class="md-ellipsis">
  508. Kubernetes Secret Types
  509. </span>
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../ownership-deletion-policy/" class="md-nav__link">
  514. <span class="md-ellipsis">
  515. Lifecycle: ownership & deletion
  516. </span>
  517. </a>
  518. </li>
  519. <li class="md-nav__item">
  520. <a href="../decoding-strategy/" class="md-nav__link">
  521. <span class="md-ellipsis">
  522. Decoding Strategies
  523. </span>
  524. </a>
  525. </li>
  526. <li class="md-nav__item md-nav__item--active">
  527. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  528. <label class="md-nav__link md-nav__link--active" for="__toc">
  529. <span class="md-ellipsis">
  530. Controller Classes
  531. </span>
  532. <span class="md-nav__icon md-icon"></span>
  533. </label>
  534. <a href="./" class="md-nav__link md-nav__link--active">
  535. <span class="md-ellipsis">
  536. Controller Classes
  537. </span>
  538. </a>
  539. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  540. <label class="md-nav__title" for="__toc">
  541. <span class="md-nav__icon md-icon"></span>
  542. Table of contents
  543. </label>
  544. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  545. <li class="md-nav__item">
  546. <a href="#setting-up-controller-class" class="md-nav__link">
  547. <span class="md-ellipsis">
  548. Setting up Controller Class
  549. </span>
  550. </a>
  551. </li>
  552. </ul>
  553. </nav>
  554. </li>
  555. </ul>
  556. </nav>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../generator/" class="md-nav__link">
  560. <span class="md-ellipsis">
  561. Generators
  562. </span>
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="../pushsecrets/" class="md-nav__link">
  567. <span class="md-ellipsis">
  568. Push Secrets
  569. </span>
  570. </a>
  571. </li>
  572. <li class="md-nav__item md-nav__item--nested">
  573. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  574. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  575. <span class="md-ellipsis">
  576. Operations
  577. </span>
  578. <span class="md-nav__icon md-icon"></span>
  579. </label>
  580. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  581. <label class="md-nav__title" for="__nav_3_5">
  582. <span class="md-nav__icon md-icon"></span>
  583. Operations
  584. </label>
  585. <ul class="md-nav__list" data-md-scrollfix>
  586. <li class="md-nav__item">
  587. <a href="../multi-tenancy/" class="md-nav__link">
  588. <span class="md-ellipsis">
  589. Multi Tenancy
  590. </span>
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../security-best-practices/" class="md-nav__link">
  595. <span class="md-ellipsis">
  596. Security Best Practices
  597. </span>
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../threat-model/" class="md-nav__link">
  602. <span class="md-ellipsis">
  603. Threat Model
  604. </span>
  605. </a>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="../v1beta1/" class="md-nav__link">
  609. <span class="md-ellipsis">
  610. Upgrading to v1beta1
  611. </span>
  612. </a>
  613. </li>
  614. <li class="md-nav__item">
  615. <a href="../using-latest-image/" class="md-nav__link">
  616. <span class="md-ellipsis">
  617. Using Latest Image
  618. </span>
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../disable-cluster-features/" class="md-nav__link">
  623. <span class="md-ellipsis">
  624. Disable Cluster Features
  625. </span>
  626. </a>
  627. </li>
  628. </ul>
  629. </nav>
  630. </li>
  631. </ul>
  632. </nav>
  633. </li>
  634. <li class="md-nav__item md-nav__item--nested">
  635. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  636. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  637. <span class="md-ellipsis">
  638. Provider
  639. </span>
  640. <span class="md-nav__icon md-icon"></span>
  641. </label>
  642. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  643. <label class="md-nav__title" for="__nav_4">
  644. <span class="md-nav__icon md-icon"></span>
  645. Provider
  646. </label>
  647. <ul class="md-nav__list" data-md-scrollfix>
  648. <li class="md-nav__item">
  649. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  650. <span class="md-ellipsis">
  651. AWS Secrets Manager
  652. </span>
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  657. <span class="md-ellipsis">
  658. AWS Parameter Store
  659. </span>
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  664. <span class="md-ellipsis">
  665. Azure Key Vault
  666. </span>
  667. </a>
  668. </li>
  669. <li class="md-nav__item">
  670. <a href="../../provider/chef/" class="md-nav__link">
  671. <span class="md-ellipsis">
  672. Chef
  673. </span>
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../../provider/conjur/" class="md-nav__link">
  678. <span class="md-ellipsis">
  679. CyberArk Conjur
  680. </span>
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  685. <span class="md-ellipsis">
  686. Google Cloud Secret Manager
  687. </span>
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  692. <span class="md-ellipsis">
  693. HashiCorp Vault
  694. </span>
  695. </a>
  696. </li>
  697. <li class="md-nav__item">
  698. <a href="../../provider/kubernetes/" class="md-nav__link">
  699. <span class="md-ellipsis">
  700. Kubernetes
  701. </span>
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  706. <span class="md-ellipsis">
  707. IBM Secrets Manager
  708. </span>
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../../provider/akeyless/" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. Akeyless
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. Yandex Certificate Manager
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. Yandex Lockbox
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="../../provider/alibaba/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. Alibaba Cloud
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. GitLab Variables
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../../provider/oracle-vault/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. Oracle Vault
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="../../provider/1password-automation/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. 1Password Secrets Automation
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../provider/webhook/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. Webhook
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="../../provider/fake/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Fake
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. senhasegura DevOps Secrets Management (DSM)
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../../provider/doppler/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. Doppler
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="../../provider/keeper-security/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. Keeper Security
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../../provider/cloak/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. Cloak End 2 End Encrypted Secrets
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="../../provider/scaleway/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. Scaleway
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="../../provider/delinea/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. Delinea
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="../../provider/passbolt/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. Passbolt
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="../../provider/pulumi/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Pulumi ESC
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="../../provider/onboardbase/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. Onboardbase
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="../../provider-passworddepot/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. Password Depot
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="../../provider/fortanix/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Fortanix
  848. </span>
  849. </a>
  850. </li>
  851. </ul>
  852. </nav>
  853. </li>
  854. <li class="md-nav__item md-nav__item--nested">
  855. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  856. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  857. <span class="md-ellipsis">
  858. Examples
  859. </span>
  860. <span class="md-nav__icon md-icon"></span>
  861. </label>
  862. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  863. <label class="md-nav__title" for="__nav_5">
  864. <span class="md-nav__icon md-icon"></span>
  865. Examples
  866. </label>
  867. <ul class="md-nav__list" data-md-scrollfix>
  868. <li class="md-nav__item">
  869. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  870. <span class="md-ellipsis">
  871. FluxCD
  872. </span>
  873. </a>
  874. </li>
  875. <li class="md-nav__item">
  876. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  877. <span class="md-ellipsis">
  878. Anchore Engine
  879. </span>
  880. </a>
  881. </li>
  882. <li class="md-nav__item">
  883. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  884. <span class="md-ellipsis">
  885. Jenkins
  886. </span>
  887. </a>
  888. </li>
  889. <li class="md-nav__item">
  890. <a href="../../examples/bitwarden/" class="md-nav__link">
  891. <span class="md-ellipsis">
  892. BitWarden
  893. </span>
  894. </a>
  895. </li>
  896. </ul>
  897. </nav>
  898. </li>
  899. <li class="md-nav__item md-nav__item--nested">
  900. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  901. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  902. <span class="md-ellipsis">
  903. Community
  904. </span>
  905. <span class="md-nav__icon md-icon"></span>
  906. </label>
  907. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  908. <label class="md-nav__title" for="__nav_6">
  909. <span class="md-nav__icon md-icon"></span>
  910. Community
  911. </label>
  912. <ul class="md-nav__list" data-md-scrollfix>
  913. <li class="md-nav__item md-nav__item--nested">
  914. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  915. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  916. <span class="md-ellipsis">
  917. Contributing
  918. </span>
  919. <span class="md-nav__icon md-icon"></span>
  920. </label>
  921. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  922. <label class="md-nav__title" for="__nav_6_1">
  923. <span class="md-nav__icon md-icon"></span>
  924. Contributing
  925. </label>
  926. <ul class="md-nav__list" data-md-scrollfix>
  927. <li class="md-nav__item">
  928. <a href="../../contributing/devguide/" class="md-nav__link">
  929. <span class="md-ellipsis">
  930. Developer guide
  931. </span>
  932. </a>
  933. </li>
  934. <li class="md-nav__item">
  935. <a href="../../contributing/process/" class="md-nav__link">
  936. <span class="md-ellipsis">
  937. Contributing Process
  938. </span>
  939. </a>
  940. </li>
  941. <li class="md-nav__item">
  942. <a href="../../contributing/release/" class="md-nav__link">
  943. <span class="md-ellipsis">
  944. Release Process
  945. </span>
  946. </a>
  947. </li>
  948. <li class="md-nav__item">
  949. <a href="../../contributing/coc/" class="md-nav__link">
  950. <span class="md-ellipsis">
  951. Code of Conduct
  952. </span>
  953. </a>
  954. </li>
  955. <li class="md-nav__item">
  956. <a href="../../contributing/roadmap/" class="md-nav__link">
  957. <span class="md-ellipsis">
  958. Roadmap
  959. </span>
  960. </a>
  961. </li>
  962. </ul>
  963. </nav>
  964. </li>
  965. <li class="md-nav__item md-nav__item--nested">
  966. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  967. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  968. <span class="md-ellipsis">
  969. External Resources
  970. </span>
  971. <span class="md-nav__icon md-icon"></span>
  972. </label>
  973. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  974. <label class="md-nav__title" for="__nav_6_2">
  975. <span class="md-nav__icon md-icon"></span>
  976. External Resources
  977. </label>
  978. <ul class="md-nav__list" data-md-scrollfix>
  979. <li class="md-nav__item">
  980. <a href="../../eso-talks/" class="md-nav__link">
  981. <span class="md-ellipsis">
  982. Talks
  983. </span>
  984. </a>
  985. </li>
  986. <li class="md-nav__item">
  987. <a href="../../eso-demos/" class="md-nav__link">
  988. <span class="md-ellipsis">
  989. Demos
  990. </span>
  991. </a>
  992. </li>
  993. <li class="md-nav__item">
  994. <a href="../../eso-blogs/" class="md-nav__link">
  995. <span class="md-ellipsis">
  996. Blogs
  997. </span>
  998. </a>
  999. </li>
  1000. </ul>
  1001. </nav>
  1002. </li>
  1003. </ul>
  1004. </nav>
  1005. </li>
  1006. <li class="md-nav__item md-nav__item--nested">
  1007. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1008. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1009. <span class="md-ellipsis">
  1010. References
  1011. </span>
  1012. <span class="md-nav__icon md-icon"></span>
  1013. </label>
  1014. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1015. <label class="md-nav__title" for="__nav_7">
  1016. <span class="md-nav__icon md-icon"></span>
  1017. References
  1018. </label>
  1019. <ul class="md-nav__list" data-md-scrollfix>
  1020. <li class="md-nav__item">
  1021. <a href="../../spec/" class="md-nav__link">
  1022. <span class="md-ellipsis">
  1023. API specification
  1024. </span>
  1025. </a>
  1026. </li>
  1027. </ul>
  1028. </nav>
  1029. </li>
  1030. </ul>
  1031. </nav>
  1032. </div>
  1033. </div>
  1034. </div>
  1035. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1036. <div class="md-sidebar__scrollwrap">
  1037. <div class="md-sidebar__inner">
  1038. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1039. <label class="md-nav__title" for="__toc">
  1040. <span class="md-nav__icon md-icon"></span>
  1041. Table of contents
  1042. </label>
  1043. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1044. <li class="md-nav__item">
  1045. <a href="#setting-up-controller-class" class="md-nav__link">
  1046. <span class="md-ellipsis">
  1047. Setting up Controller Class
  1048. </span>
  1049. </a>
  1050. </li>
  1051. </ul>
  1052. </nav>
  1053. </div>
  1054. </div>
  1055. </div>
  1056. <div class="md-content" data-md-component="content">
  1057. <article class="md-content__inner md-typeset">
  1058. <h1 id="controller-classes">Controller Classes</h1>
  1059. <blockquote>
  1060. <p>NOTE: this feature is experimental and not highly tested</p>
  1061. </blockquote>
  1062. <p>Controller classes are a property set during the deployment that allows multiple controllers to work in a group of workload. It works by separating which secretStores are going to be attributed to which controller. For the behavior of a single controller, no extra configuration is needed.</p>
  1063. <h2 id="setting-up-controller-class">Setting up Controller Class</h2>
  1064. <p>In order to deploy the controller with a specific class, install the helm charts specifying the controller class, and create a <code>SecretStore</code> with the appropriate <code>spec.controller</code> values:
  1065. <div class="highlight"><pre><span></span><code>helm install custom-external-secrets external-secrets/external-secrets --set controllerClass=custom
  1066. </code></pre></div>
  1067. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1068. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1069. <span class="nt">metadata</span><span class="p">:</span>
  1070. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">controller-custom-example</span>
  1071. <span class="nt">spec</span><span class="p">:</span>
  1072. <span class="w"> </span><span class="c1">#define the controller label to the matching value of the deployment</span>
  1073. <span class="w"> </span><span class="nt">controller</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">custom</span>
  1074. <span class="w"> </span><span class="c1">#configure provider the same way</span>
  1075. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1076. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1077. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://vault.default:8200&quot;</span>
  1078. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1079. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1080. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1081. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1082. <span class="w"> </span><span class="nt">mountPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;kubernetes&quot;</span>
  1083. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;demo-role&quot;</span>
  1084. </code></pre></div></p>
  1085. <p>Now, any <code>ExternalSecret</code> bound to this secret store will be evaluated by the operator with the controllerClass custom.</p>
  1086. <blockquote>
  1087. <p>Note: Any SecretStore without <code>spec.controller</code> set will be considered as valid by any operator, regardless of their respective controllerClasses.</p>
  1088. </blockquote>
  1089. </article>
  1090. </div>
  1091. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1092. </div>
  1093. </main>
  1094. <footer class="md-footer">
  1095. <div class="md-footer-meta md-typeset">
  1096. <div class="md-footer-meta__inner md-grid">
  1097. <div class="md-copyright">
  1098. <div class="md-copyright__highlight">
  1099. &copy; 2024 The external-secrets Authors.<br/>
  1100. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1101. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1102. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1103. </div>
  1104. Made with
  1105. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1106. Material for MkDocs
  1107. </a>
  1108. </div>
  1109. </div>
  1110. </div>
  1111. </footer>
  1112. </div>
  1113. <div class="md-dialog" data-md-component="dialog">
  1114. <div class="md-dialog__inner md-typeset"></div>
  1115. </div>
  1116. <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>
  1117. <script src="../../assets/javascripts/bundle.081f42fc.min.js"></script>
  1118. </body>
  1119. </html>