index.html 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994
  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="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.4">
  10. <title>Controller Classes - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.50c56a3b.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. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. 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.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  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. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--section 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="">
  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--section md-nav__item--nested">
  223. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  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="false">
  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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/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="../../api/generator/fake/" class="md-nav__link">
  350. <span class="md-ellipsis">
  351. Fake
  352. </span>
  353. </a>
  354. </li>
  355. </ul>
  356. </nav>
  357. </li>
  358. <li class="md-nav__item md-nav__item--nested">
  359. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  360. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  361. <span class="md-ellipsis">
  362. Reference Docs
  363. </span>
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  367. <label class="md-nav__title" for="__nav_2_4">
  368. <span class="md-nav__icon md-icon"></span>
  369. Reference Docs
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../../api/spec/" class="md-nav__link">
  374. <span class="md-ellipsis">
  375. API specification
  376. </span>
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="../../api/controller-options/" class="md-nav__link">
  381. <span class="md-ellipsis">
  382. Controller Options
  383. </span>
  384. </a>
  385. </li>
  386. <li class="md-nav__item">
  387. <a href="../../api/metrics/" class="md-nav__link">
  388. <span class="md-ellipsis">
  389. Metrics
  390. </span>
  391. </a>
  392. </li>
  393. </ul>
  394. </nav>
  395. </li>
  396. </ul>
  397. </nav>
  398. </li>
  399. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  400. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  401. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  402. <span class="md-ellipsis">
  403. Guides
  404. </span>
  405. <span class="md-nav__icon md-icon"></span>
  406. </label>
  407. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
  408. <label class="md-nav__title" for="__nav_3">
  409. <span class="md-nav__icon md-icon"></span>
  410. Guides
  411. </label>
  412. <ul class="md-nav__list" data-md-scrollfix>
  413. <li class="md-nav__item">
  414. <a href="../introduction/" class="md-nav__link">
  415. <span class="md-ellipsis">
  416. Introduction
  417. </span>
  418. </a>
  419. </li>
  420. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  421. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" checked>
  422. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  423. <span class="md-ellipsis">
  424. External Secrets
  425. </span>
  426. <span class="md-nav__icon md-icon"></span>
  427. </label>
  428. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true">
  429. <label class="md-nav__title" for="__nav_3_2">
  430. <span class="md-nav__icon md-icon"></span>
  431. External Secrets
  432. </label>
  433. <ul class="md-nav__list" data-md-scrollfix>
  434. <li class="md-nav__item">
  435. <a href="../all-keys-one-secret/" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. Extract structured data
  438. </span>
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../getallsecrets/" class="md-nav__link">
  443. <span class="md-ellipsis">
  444. Find Secrets by Name or Metadata
  445. </span>
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../datafrom-rewrite/" class="md-nav__link">
  450. <span class="md-ellipsis">
  451. Rewriting Keys
  452. </span>
  453. </a>
  454. </li>
  455. <li class="md-nav__item md-nav__item--nested">
  456. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  457. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  458. <span class="md-ellipsis">
  459. Advanced Templating
  460. </span>
  461. <span class="md-nav__icon md-icon"></span>
  462. </label>
  463. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  464. <label class="md-nav__title" for="__nav_3_2_4">
  465. <span class="md-nav__icon md-icon"></span>
  466. Advanced Templating
  467. </label>
  468. <ul class="md-nav__list" data-md-scrollfix>
  469. <li class="md-nav__item">
  470. <a href="../templating/" class="md-nav__link">
  471. <span class="md-ellipsis">
  472. v2
  473. </span>
  474. </a>
  475. </li>
  476. <li class="md-nav__item">
  477. <a href="../templating-v1/" class="md-nav__link">
  478. <span class="md-ellipsis">
  479. v1
  480. </span>
  481. </a>
  482. </li>
  483. </ul>
  484. </nav>
  485. </li>
  486. <li class="md-nav__item">
  487. <a href="../common-k8s-secret-types/" class="md-nav__link">
  488. <span class="md-ellipsis">
  489. Kubernetes Secret Types
  490. </span>
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../ownership-deletion-policy/" class="md-nav__link">
  495. <span class="md-ellipsis">
  496. Lifecycle: ownership & deletion
  497. </span>
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../decoding-strategy/" class="md-nav__link">
  502. <span class="md-ellipsis">
  503. Decoding Strategies
  504. </span>
  505. </a>
  506. </li>
  507. <li class="md-nav__item md-nav__item--active">
  508. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  509. <label class="md-nav__link md-nav__link--active" for="__toc">
  510. <span class="md-ellipsis">
  511. Controller Classes
  512. </span>
  513. <span class="md-nav__icon md-icon"></span>
  514. </label>
  515. <a href="./" class="md-nav__link md-nav__link--active">
  516. <span class="md-ellipsis">
  517. Controller Classes
  518. </span>
  519. </a>
  520. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  521. <label class="md-nav__title" for="__toc">
  522. <span class="md-nav__icon md-icon"></span>
  523. Table of contents
  524. </label>
  525. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  526. <li class="md-nav__item">
  527. <a href="#setting-up-controller-class" class="md-nav__link">
  528. <span class="md-ellipsis">
  529. Setting up Controller Class
  530. </span>
  531. </a>
  532. </li>
  533. </ul>
  534. </nav>
  535. </li>
  536. </ul>
  537. </nav>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../generator/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Generators
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../pushsecrets/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Push Secrets
  550. </span>
  551. </a>
  552. </li>
  553. <li class="md-nav__item md-nav__item--nested">
  554. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  555. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  556. <span class="md-ellipsis">
  557. Operations
  558. </span>
  559. <span class="md-nav__icon md-icon"></span>
  560. </label>
  561. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  562. <label class="md-nav__title" for="__nav_3_5">
  563. <span class="md-nav__icon md-icon"></span>
  564. Operations
  565. </label>
  566. <ul class="md-nav__list" data-md-scrollfix>
  567. <li class="md-nav__item">
  568. <a href="../multi-tenancy/" class="md-nav__link">
  569. <span class="md-ellipsis">
  570. Multi Tenancy
  571. </span>
  572. </a>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="../security-best-practices/" class="md-nav__link">
  576. <span class="md-ellipsis">
  577. Security Best Practices
  578. </span>
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../threat-model/" class="md-nav__link">
  583. <span class="md-ellipsis">
  584. Threat Model
  585. </span>
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../v1beta1/" class="md-nav__link">
  590. <span class="md-ellipsis">
  591. Upgrading to v1beta1
  592. </span>
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../using-latest-image/" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. Using Latest Image
  599. </span>
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../disable-cluster-features/" class="md-nav__link">
  604. <span class="md-ellipsis">
  605. Disable Cluster Features
  606. </span>
  607. </a>
  608. </li>
  609. </ul>
  610. </nav>
  611. </li>
  612. </ul>
  613. </nav>
  614. </li>
  615. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  616. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  617. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  618. <span class="md-ellipsis">
  619. Provider
  620. </span>
  621. <span class="md-nav__icon md-icon"></span>
  622. </label>
  623. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  624. <label class="md-nav__title" for="__nav_4">
  625. <span class="md-nav__icon md-icon"></span>
  626. Provider
  627. </label>
  628. <ul class="md-nav__list" data-md-scrollfix>
  629. <li class="md-nav__item">
  630. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  631. <span class="md-ellipsis">
  632. AWS Secrets Manager
  633. </span>
  634. </a>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  638. <span class="md-ellipsis">
  639. AWS Parameter Store
  640. </span>
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  645. <span class="md-ellipsis">
  646. Azure Key Vault
  647. </span>
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="../../provider/conjur/" class="md-nav__link">
  652. <span class="md-ellipsis">
  653. CyberArk Conjur
  654. </span>
  655. </a>
  656. </li>
  657. <li class="md-nav__item">
  658. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  659. <span class="md-ellipsis">
  660. Google Cloud Secret Manager
  661. </span>
  662. </a>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  666. <span class="md-ellipsis">
  667. HashiCorp Vault
  668. </span>
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../../provider/kubernetes/" class="md-nav__link">
  673. <span class="md-ellipsis">
  674. Kubernetes
  675. </span>
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  680. <span class="md-ellipsis">
  681. IBM Secrets Manager
  682. </span>
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../../provider/akeyless/" class="md-nav__link">
  687. <span class="md-ellipsis">
  688. Akeyless
  689. </span>
  690. </a>
  691. </li>
  692. <li class="md-nav__item">
  693. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  694. <span class="md-ellipsis">
  695. Yandex Certificate Manager
  696. </span>
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  701. <span class="md-ellipsis">
  702. Yandex Lockbox
  703. </span>
  704. </a>
  705. </li>
  706. <li class="md-nav__item">
  707. <a href="../../provider/alibaba/" class="md-nav__link">
  708. <span class="md-ellipsis">
  709. Alibaba Cloud
  710. </span>
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  715. <span class="md-ellipsis">
  716. GitLab Variables
  717. </span>
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="../../provider/oracle-vault/" class="md-nav__link">
  722. <span class="md-ellipsis">
  723. Oracle Vault
  724. </span>
  725. </a>
  726. </li>
  727. <li class="md-nav__item">
  728. <a href="../../provider/1password-automation/" class="md-nav__link">
  729. <span class="md-ellipsis">
  730. 1Password Secrets Automation
  731. </span>
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="../../provider/webhook/" class="md-nav__link">
  736. <span class="md-ellipsis">
  737. Webhook
  738. </span>
  739. </a>
  740. </li>
  741. <li class="md-nav__item">
  742. <a href="../../provider/fake/" class="md-nav__link">
  743. <span class="md-ellipsis">
  744. Fake
  745. </span>
  746. </a>
  747. </li>
  748. <li class="md-nav__item">
  749. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  750. <span class="md-ellipsis">
  751. senhasegura DevOps Secrets Management (DSM)
  752. </span>
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="../../provider/doppler/" class="md-nav__link">
  757. <span class="md-ellipsis">
  758. Doppler
  759. </span>
  760. </a>
  761. </li>
  762. <li class="md-nav__item">
  763. <a href="../../provider/keeper-security/" class="md-nav__link">
  764. <span class="md-ellipsis">
  765. Keeper Security
  766. </span>
  767. </a>
  768. </li>
  769. <li class="md-nav__item">
  770. <a href="../../provider/cloak/" class="md-nav__link">
  771. <span class="md-ellipsis">
  772. Cloak End 2 End Encrypted Secrets
  773. </span>
  774. </a>
  775. </li>
  776. <li class="md-nav__item">
  777. <a href="../../provider/scaleway/" class="md-nav__link">
  778. <span class="md-ellipsis">
  779. Scaleway
  780. </span>
  781. </a>
  782. </li>
  783. <li class="md-nav__item">
  784. <a href="../../provider/delinea/" class="md-nav__link">
  785. <span class="md-ellipsis">
  786. Delinea
  787. </span>
  788. </a>
  789. </li>
  790. </ul>
  791. </nav>
  792. </li>
  793. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  794. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  795. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
  796. <span class="md-ellipsis">
  797. Examples
  798. </span>
  799. <span class="md-nav__icon md-icon"></span>
  800. </label>
  801. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  802. <label class="md-nav__title" for="__nav_5">
  803. <span class="md-nav__icon md-icon"></span>
  804. Examples
  805. </label>
  806. <ul class="md-nav__list" data-md-scrollfix>
  807. <li class="md-nav__item">
  808. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  809. <span class="md-ellipsis">
  810. FluxCD
  811. </span>
  812. </a>
  813. </li>
  814. <li class="md-nav__item">
  815. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  816. <span class="md-ellipsis">
  817. Anchore Engine
  818. </span>
  819. </a>
  820. </li>
  821. <li class="md-nav__item">
  822. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  823. <span class="md-ellipsis">
  824. Jenkins
  825. </span>
  826. </a>
  827. </li>
  828. <li class="md-nav__item">
  829. <a href="../../examples/bitwarden/" class="md-nav__link">
  830. <span class="md-ellipsis">
  831. BitWarden
  832. </span>
  833. </a>
  834. </li>
  835. </ul>
  836. </nav>
  837. </li>
  838. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  839. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  840. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  841. <span class="md-ellipsis">
  842. Community
  843. </span>
  844. <span class="md-nav__icon md-icon"></span>
  845. </label>
  846. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  847. <label class="md-nav__title" for="__nav_6">
  848. <span class="md-nav__icon md-icon"></span>
  849. Community
  850. </label>
  851. <ul class="md-nav__list" data-md-scrollfix>
  852. <li class="md-nav__item md-nav__item--nested">
  853. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  854. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  855. <span class="md-ellipsis">
  856. Contributing
  857. </span>
  858. <span class="md-nav__icon md-icon"></span>
  859. </label>
  860. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  861. <label class="md-nav__title" for="__nav_6_1">
  862. <span class="md-nav__icon md-icon"></span>
  863. Contributing
  864. </label>
  865. <ul class="md-nav__list" data-md-scrollfix>
  866. <li class="md-nav__item">
  867. <a href="../../contributing/devguide/" class="md-nav__link">
  868. <span class="md-ellipsis">
  869. Developer guide
  870. </span>
  871. </a>
  872. </li>
  873. <li class="md-nav__item">
  874. <a href="../../contributing/process/" class="md-nav__link">
  875. <span class="md-ellipsis">
  876. Contributing Process
  877. </span>
  878. </a>
  879. </li>
  880. <li class="md-nav__item">
  881. <a href="../../contributing/release/" class="md-nav__link">
  882. <span class="md-ellipsis">
  883. Release Process
  884. </span>
  885. </a>
  886. </li>
  887. <li class="md-nav__item">
  888. <a href="../../contributing/coc/" class="md-nav__link">
  889. <span class="md-ellipsis">
  890. Code of Conduct
  891. </span>
  892. </a>
  893. </li>
  894. <li class="md-nav__item">
  895. <a href="../../contributing/roadmap/" class="md-nav__link">
  896. <span class="md-ellipsis">
  897. Roadmap
  898. </span>
  899. </a>
  900. </li>
  901. </ul>
  902. </nav>
  903. </li>
  904. <li class="md-nav__item md-nav__item--nested">
  905. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  906. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  907. <span class="md-ellipsis">
  908. External Resources
  909. </span>
  910. <span class="md-nav__icon md-icon"></span>
  911. </label>
  912. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  913. <label class="md-nav__title" for="__nav_6_2">
  914. <span class="md-nav__icon md-icon"></span>
  915. External Resources
  916. </label>
  917. <ul class="md-nav__list" data-md-scrollfix>
  918. <li class="md-nav__item">
  919. <a href="../../eso-talks/" class="md-nav__link">
  920. <span class="md-ellipsis">
  921. Talks
  922. </span>
  923. </a>
  924. </li>
  925. <li class="md-nav__item">
  926. <a href="../../eso-demos/" class="md-nav__link">
  927. <span class="md-ellipsis">
  928. Demos
  929. </span>
  930. </a>
  931. </li>
  932. <li class="md-nav__item">
  933. <a href="../../eso-blogs/" class="md-nav__link">
  934. <span class="md-ellipsis">
  935. Blogs
  936. </span>
  937. </a>
  938. </li>
  939. </ul>
  940. </nav>
  941. </li>
  942. </ul>
  943. </nav>
  944. </li>
  945. </ul>
  946. </nav>
  947. </div>
  948. </div>
  949. </div>
  950. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  951. <div class="md-sidebar__scrollwrap">
  952. <div class="md-sidebar__inner">
  953. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  954. <label class="md-nav__title" for="__toc">
  955. <span class="md-nav__icon md-icon"></span>
  956. Table of contents
  957. </label>
  958. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  959. <li class="md-nav__item">
  960. <a href="#setting-up-controller-class" class="md-nav__link">
  961. <span class="md-ellipsis">
  962. Setting up Controller Class
  963. </span>
  964. </a>
  965. </li>
  966. </ul>
  967. </nav>
  968. </div>
  969. </div>
  970. </div>
  971. <div class="md-content" data-md-component="content">
  972. <article class="md-content__inner md-typeset">
  973. <h1 id="controller-classes">Controller Classes</h1>
  974. <blockquote>
  975. <p>NOTE: this feature is experimental and not highly tested</p>
  976. </blockquote>
  977. <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>
  978. <h2 id="setting-up-controller-class">Setting up Controller Class</h2>
  979. <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:
  980. <div class="highlight"><pre><span></span><code>helm install custom-external-secrets external-secrets/external-secrets --set controllerClass=custom
  981. </code></pre></div>
  982. <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>
  983. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  984. <span class="nt">metadata</span><span class="p">:</span>
  985. <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>
  986. <span class="nt">spec</span><span class="p">:</span>
  987. <span class="w"> </span><span class="c1">#define the controller label to the matching value of the deployment</span>
  988. <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>
  989. <span class="w"> </span><span class="c1">#configure provider the same way</span>
  990. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  991. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  992. <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>
  993. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  994. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  995. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  996. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  997. <span class="w"> </span><span class="nt">mountPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;kubernetes&quot;</span>
  998. <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>
  999. </code></pre></div></p>
  1000. <p>Now, any <code>ExternalSecret</code> bound to this secret store will be evaluated by the operator with the controllerClass custom.</p>
  1001. <blockquote>
  1002. <p>Note: Any SecretStore without <code>spec.controller</code> set will be considered as valid by any operator, regardless of their respective controllerClasses.</p>
  1003. </blockquote>
  1004. </article>
  1005. </div>
  1006. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1007. </div>
  1008. </main>
  1009. <footer class="md-footer">
  1010. <div class="md-footer-meta md-typeset">
  1011. <div class="md-footer-meta__inner md-grid">
  1012. <div class="md-copyright">
  1013. <div class="md-copyright__highlight">
  1014. &copy; 2023 The external-secrets Authors.<br/>
  1015. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1016. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1017. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1018. </div>
  1019. Made with
  1020. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1021. Material for MkDocs
  1022. </a>
  1023. </div>
  1024. </div>
  1025. </div>
  1026. </footer>
  1027. </div>
  1028. <div class="md-dialog" data-md-component="dialog">
  1029. <div class="md-dialog__inner md-typeset"></div>
  1030. </div>
  1031. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.c011b7c0.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>
  1032. <script src="../../assets/javascripts/bundle.7389ff0e.min.js"></script>
  1033. </body>
  1034. </html>