index.html 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648
  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="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>Controller Classes - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("..",location),__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>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#controller-classes" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <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>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Controller Classes
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <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>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <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>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <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>
  72. <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>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <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>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. <li class="md-nav__item">
  166. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../guides-introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item md-nav__item--active">
  231. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  232. <label class="md-nav__link md-nav__link--active" for="__toc">
  233. Controller Classes
  234. <span class="md-nav__icon md-icon"></span>
  235. </label>
  236. <a href="./" class="md-nav__link md-nav__link--active">
  237. Controller Classes
  238. </a>
  239. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  240. <label class="md-nav__title" for="__toc">
  241. <span class="md-nav__icon md-icon"></span>
  242. Table of contents
  243. </label>
  244. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  245. <li class="md-nav__item">
  246. <a href="#setting-up-controller-class" class="md-nav__link">
  247. Setting up Controller Class
  248. </a>
  249. </li>
  250. </ul>
  251. </nav>
  252. </li>
  253. <li class="md-nav__item">
  254. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  255. Lifecycle: ownership & deletion
  256. </a>
  257. </li>
  258. <li class="md-nav__item">
  259. <a href="../guides-getallsecrets/" class="md-nav__link">
  260. Getting Multiple Secrets
  261. </a>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="../guides-multi-tenancy/" class="md-nav__link">
  265. Multi Tenancy
  266. </a>
  267. </li>
  268. <li class="md-nav__item">
  269. <a href="../guides-metrics/" class="md-nav__link">
  270. Metrics
  271. </a>
  272. </li>
  273. <li class="md-nav__item">
  274. <a href="../guides-v1beta1/" class="md-nav__link">
  275. Upgrading to v1beta1
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="../guides-using-latest-image/" class="md-nav__link">
  280. Using Latest Image
  281. </a>
  282. </li>
  283. </ul>
  284. </nav>
  285. </li>
  286. <li class="md-nav__item md-nav__item--nested">
  287. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  288. <label class="md-nav__link" for="__nav_5">
  289. Provider
  290. <span class="md-nav__icon md-icon"></span>
  291. </label>
  292. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  293. <label class="md-nav__title" for="__nav_5">
  294. <span class="md-nav__icon md-icon"></span>
  295. Provider
  296. </label>
  297. <ul class="md-nav__list" data-md-scrollfix>
  298. <li class="md-nav__item md-nav__item--nested">
  299. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  300. <label class="md-nav__link" for="__nav_5_1">
  301. AWS
  302. <span class="md-nav__icon md-icon"></span>
  303. </label>
  304. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  305. <label class="md-nav__title" for="__nav_5_1">
  306. <span class="md-nav__icon md-icon"></span>
  307. AWS
  308. </label>
  309. <ul class="md-nav__list" data-md-scrollfix>
  310. <li class="md-nav__item">
  311. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  312. Secrets Manager
  313. </a>
  314. </li>
  315. <li class="md-nav__item">
  316. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  317. Parameter Store
  318. </a>
  319. </li>
  320. </ul>
  321. </nav>
  322. </li>
  323. <li class="md-nav__item md-nav__item--nested">
  324. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  325. <label class="md-nav__link" for="__nav_5_2">
  326. Azure
  327. <span class="md-nav__icon md-icon"></span>
  328. </label>
  329. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  330. <label class="md-nav__title" for="__nav_5_2">
  331. <span class="md-nav__icon md-icon"></span>
  332. Azure
  333. </label>
  334. <ul class="md-nav__list" data-md-scrollfix>
  335. <li class="md-nav__item">
  336. <a href="../provider-azure-key-vault/" class="md-nav__link">
  337. Key Vault
  338. </a>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  345. <label class="md-nav__link" for="__nav_5_3">
  346. Google
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="Google" data-md-level="2">
  350. <label class="md-nav__title" for="__nav_5_3">
  351. <span class="md-nav__icon md-icon"></span>
  352. Google
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  357. Secret Manager
  358. </a>
  359. </li>
  360. </ul>
  361. </nav>
  362. </li>
  363. <li class="md-nav__item md-nav__item--nested">
  364. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  365. <label class="md-nav__link" for="__nav_5_4">
  366. IBM
  367. <span class="md-nav__icon md-icon"></span>
  368. </label>
  369. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  370. <label class="md-nav__title" for="__nav_5_4">
  371. <span class="md-nav__icon md-icon"></span>
  372. IBM
  373. </label>
  374. <ul class="md-nav__list" data-md-scrollfix>
  375. <li class="md-nav__item">
  376. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  377. Secrets Manager
  378. </a>
  379. </li>
  380. </ul>
  381. </nav>
  382. </li>
  383. <li class="md-nav__item">
  384. <a href="../provider-akeyless/" class="md-nav__link">
  385. Akeyless
  386. </a>
  387. </li>
  388. <li class="md-nav__item">
  389. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  390. HashiCorp Vault
  391. </a>
  392. </li>
  393. <li class="md-nav__item md-nav__item--nested">
  394. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  395. <label class="md-nav__link" for="__nav_5_7">
  396. Yandex
  397. <span class="md-nav__icon md-icon"></span>
  398. </label>
  399. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  400. <label class="md-nav__title" for="__nav_5_7">
  401. <span class="md-nav__icon md-icon"></span>
  402. Yandex
  403. </label>
  404. <ul class="md-nav__list" data-md-scrollfix>
  405. <li class="md-nav__item">
  406. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  407. Lockbox
  408. </a>
  409. </li>
  410. </ul>
  411. </nav>
  412. </li>
  413. <li class="md-nav__item md-nav__item--nested">
  414. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  415. <label class="md-nav__link" for="__nav_5_8">
  416. Gitlab
  417. <span class="md-nav__icon md-icon"></span>
  418. </label>
  419. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  420. <label class="md-nav__title" for="__nav_5_8">
  421. <span class="md-nav__icon md-icon"></span>
  422. Gitlab
  423. </label>
  424. <ul class="md-nav__list" data-md-scrollfix>
  425. <li class="md-nav__item">
  426. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  427. Gitlab Project Variables
  428. </a>
  429. </li>
  430. </ul>
  431. </nav>
  432. </li>
  433. <li class="md-nav__item md-nav__item--nested">
  434. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  435. <label class="md-nav__link" for="__nav_5_9">
  436. Oracle
  437. <span class="md-nav__icon md-icon"></span>
  438. </label>
  439. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  440. <label class="md-nav__title" for="__nav_5_9">
  441. <span class="md-nav__icon md-icon"></span>
  442. Oracle
  443. </label>
  444. <ul class="md-nav__list" data-md-scrollfix>
  445. <li class="md-nav__item">
  446. <a href="../provider-oracle-vault/" class="md-nav__link">
  447. Oracle Vault
  448. </a>
  449. </li>
  450. </ul>
  451. </nav>
  452. </li>
  453. <li class="md-nav__item md-nav__item--nested">
  454. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  455. <label class="md-nav__link" for="__nav_5_10">
  456. 1Password
  457. <span class="md-nav__icon md-icon"></span>
  458. </label>
  459. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  460. <label class="md-nav__title" for="__nav_5_10">
  461. <span class="md-nav__icon md-icon"></span>
  462. 1Password
  463. </label>
  464. <ul class="md-nav__list" data-md-scrollfix>
  465. <li class="md-nav__item">
  466. <a href="../provider-1password-automation/" class="md-nav__link">
  467. Secrets Automation
  468. </a>
  469. </li>
  470. </ul>
  471. </nav>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../provider-webhook/" class="md-nav__link">
  475. Webhook
  476. </a>
  477. </li>
  478. <li class="md-nav__item">
  479. <a href="../provider-fake/" class="md-nav__link">
  480. Fake
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="../provider-kubernetes/" class="md-nav__link">
  485. Kubernetes
  486. </a>
  487. </li>
  488. <li class="md-nav__item md-nav__item--nested">
  489. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  490. <label class="md-nav__link" for="__nav_5_14">
  491. senhasegura
  492. <span class="md-nav__icon md-icon"></span>
  493. </label>
  494. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  495. <label class="md-nav__title" for="__nav_5_14">
  496. <span class="md-nav__icon md-icon"></span>
  497. senhasegura
  498. </label>
  499. <ul class="md-nav__list" data-md-scrollfix>
  500. <li class="md-nav__item">
  501. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  502. DevOps Secrets Management (DSM)
  503. </a>
  504. </li>
  505. </ul>
  506. </nav>
  507. </li>
  508. </ul>
  509. </nav>
  510. </li>
  511. <li class="md-nav__item md-nav__item--nested">
  512. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  513. <label class="md-nav__link" for="__nav_6">
  514. Examples
  515. <span class="md-nav__icon md-icon"></span>
  516. </label>
  517. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  518. <label class="md-nav__title" for="__nav_6">
  519. <span class="md-nav__icon md-icon"></span>
  520. Examples
  521. </label>
  522. <ul class="md-nav__list" data-md-scrollfix>
  523. <li class="md-nav__item">
  524. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  525. FluxCD
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  530. Anchore Engine
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  535. Jenkins
  536. </a>
  537. </li>
  538. </ul>
  539. </nav>
  540. </li>
  541. <li class="md-nav__item md-nav__item--nested">
  542. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  543. <label class="md-nav__link" for="__nav_7">
  544. External Resources
  545. <span class="md-nav__icon md-icon"></span>
  546. </label>
  547. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  548. <label class="md-nav__title" for="__nav_7">
  549. <span class="md-nav__icon md-icon"></span>
  550. External Resources
  551. </label>
  552. <ul class="md-nav__list" data-md-scrollfix>
  553. <li class="md-nav__item">
  554. <a href="../eso-talks/" class="md-nav__link">
  555. Talks
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../eso-demos/" class="md-nav__link">
  560. Demos
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="../eso-blogs/" class="md-nav__link">
  565. Blogs
  566. </a>
  567. </li>
  568. </ul>
  569. </nav>
  570. </li>
  571. <li class="md-nav__item md-nav__item--nested">
  572. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  573. <label class="md-nav__link" for="__nav_8">
  574. References
  575. <span class="md-nav__icon md-icon"></span>
  576. </label>
  577. <nav class="md-nav" aria-label="References" data-md-level="1">
  578. <label class="md-nav__title" for="__nav_8">
  579. <span class="md-nav__icon md-icon"></span>
  580. References
  581. </label>
  582. <ul class="md-nav__list" data-md-scrollfix>
  583. <li class="md-nav__item">
  584. <a href="../spec/" class="md-nav__link">
  585. API specification
  586. </a>
  587. </li>
  588. </ul>
  589. </nav>
  590. </li>
  591. <li class="md-nav__item md-nav__item--nested">
  592. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  593. <label class="md-nav__link" for="__nav_9">
  594. Contributing
  595. <span class="md-nav__icon md-icon"></span>
  596. </label>
  597. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  598. <label class="md-nav__title" for="__nav_9">
  599. <span class="md-nav__icon md-icon"></span>
  600. Contributing
  601. </label>
  602. <ul class="md-nav__list" data-md-scrollfix>
  603. <li class="md-nav__item">
  604. <a href="../contributing-devguide/" class="md-nav__link">
  605. Developer guide
  606. </a>
  607. </li>
  608. <li class="md-nav__item">
  609. <a href="../contributing-process/" class="md-nav__link">
  610. Contributing Process
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../contributing-release/" class="md-nav__link">
  615. Release Process
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="../contributing-coc/" class="md-nav__link">
  620. Code of Conduct
  621. </a>
  622. </li>
  623. </ul>
  624. </nav>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../stability-support/" class="md-nav__link">
  628. Stability and Support
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../deprecation-policy/" class="md-nav__link">
  633. Deprecation Policy
  634. </a>
  635. </li>
  636. </ul>
  637. </nav>
  638. </div>
  639. </div>
  640. </div>
  641. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  642. <div class="md-sidebar__scrollwrap">
  643. <div class="md-sidebar__inner">
  644. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  645. <label class="md-nav__title" for="__toc">
  646. <span class="md-nav__icon md-icon"></span>
  647. Table of contents
  648. </label>
  649. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  650. <li class="md-nav__item">
  651. <a href="#setting-up-controller-class" class="md-nav__link">
  652. Setting up Controller Class
  653. </a>
  654. </li>
  655. </ul>
  656. </nav>
  657. </div>
  658. </div>
  659. </div>
  660. <div class="md-content" data-md-component="content">
  661. <article class="md-content__inner md-typeset">
  662. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/guides-controller-class.md" title="Edit this page" class="md-content__button md-icon">
  663. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  664. </a>
  665. <h1 id="controller-classes">Controller Classes</h1>
  666. <blockquote>
  667. <p>NOTE: this feature is experimental and not highly tested</p>
  668. </blockquote>
  669. <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>
  670. <h2 id="setting-up-controller-class">Setting up Controller Class</h2>
  671. <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:
  672. <div class="highlight"><pre><span></span><code>helm install custom-external-secrets external-secrets/external-secrets --set controllerClass=custom
  673. </code></pre></div>
  674. <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><span class="w"></span>
  675. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  676. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  677. <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><span class="w"></span>
  678. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  679. <span class="w"> </span><span class="c1">#define the controller label to the matching value of the deployment</span><span class="w"></span>
  680. <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><span class="w"></span>
  681. <span class="w"> </span><span class="c1">#configure provider the same way</span><span class="w"></span>
  682. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  683. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"></span>
  684. <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><span class="w"></span>
  685. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span><span class="w"></span>
  686. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span><span class="w"></span>
  687. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  688. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  689. <span class="w"> </span><span class="nt">mountPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;kubernetes&quot;</span><span class="w"></span>
  690. <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><span class="w"></span>
  691. </code></pre></div></p>
  692. <p>Now, any <code>ExternalSecret</code> bound to this secret store will be evaluated by the operator with the controllerClass custom.</p>
  693. <blockquote>
  694. <p>Note: Any SecretStore without <code>spec.controller</code> set will be considered as valid by any operator, regardless of their respective controllerClasses.</p>
  695. </blockquote>
  696. </article>
  697. </div>
  698. </div>
  699. </main>
  700. <footer class="md-footer">
  701. <nav class="md-footer__inner md-grid" aria-label="Footer">
  702. <a href="../guides-common-k8s-secret-types/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Common K8S Secret Types" rel="prev">
  703. <div class="md-footer__button md-icon">
  704. <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>
  705. </div>
  706. <div class="md-footer__title">
  707. <div class="md-ellipsis">
  708. <span class="md-footer__direction">
  709. Previous
  710. </span>
  711. Common K8S Secret Types
  712. </div>
  713. </div>
  714. </a>
  715. <a href="../guides-ownership-deletion-policy/" class="md-footer__link md-footer__link--next" aria-label="Next: Lifecycle: ownership &amp; deletion" rel="next">
  716. <div class="md-footer__title">
  717. <div class="md-ellipsis">
  718. <span class="md-footer__direction">
  719. Next
  720. </span>
  721. Lifecycle: ownership & deletion
  722. </div>
  723. </div>
  724. <div class="md-footer__button md-icon">
  725. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  726. </div>
  727. </a>
  728. </nav>
  729. <div class="md-footer-meta md-typeset">
  730. <div class="md-footer-meta__inner md-grid">
  731. <div class="md-copyright">
  732. Made with
  733. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  734. Material for MkDocs
  735. </a>
  736. </div>
  737. </div>
  738. </div>
  739. </footer>
  740. </div>
  741. <div class="md-dialog" data-md-component="dialog">
  742. <div class="md-dialog__inner md-typeset"></div>
  743. </div>
  744. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  745. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  746. </body>
  747. </html>