index.html 34 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379
  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. </ul>
  166. </nav>
  167. </li>
  168. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  169. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  170. <label class="md-nav__link" for="__nav_4">
  171. Guides
  172. <span class="md-nav__icon md-icon"></span>
  173. </label>
  174. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  175. <label class="md-nav__title" for="__nav_4">
  176. <span class="md-nav__icon md-icon"></span>
  177. Guides
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../guides-introduction/" class="md-nav__link">
  182. Introduction
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item md-nav__item--nested">
  191. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  192. <label class="md-nav__link" for="__nav_4_3">
  193. Advanced Templating
  194. <span class="md-nav__icon md-icon"></span>
  195. </label>
  196. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  197. <label class="md-nav__title" for="__nav_4_3">
  198. <span class="md-nav__icon md-icon"></span>
  199. Advanced Templating
  200. </label>
  201. <ul class="md-nav__list" data-md-scrollfix>
  202. <li class="md-nav__item">
  203. <a href="../guides-templating/" class="md-nav__link">
  204. v2
  205. </a>
  206. </li>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating-v1/" class="md-nav__link">
  209. v1
  210. </a>
  211. </li>
  212. </ul>
  213. </nav>
  214. </li>
  215. <li class="md-nav__item md-nav__item--active">
  216. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  217. <label class="md-nav__link md-nav__link--active" for="__toc">
  218. Controller Classes
  219. <span class="md-nav__icon md-icon"></span>
  220. </label>
  221. <a href="./" class="md-nav__link md-nav__link--active">
  222. Controller Classes
  223. </a>
  224. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  225. <label class="md-nav__title" for="__toc">
  226. <span class="md-nav__icon md-icon"></span>
  227. Table of contents
  228. </label>
  229. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  230. <li class="md-nav__item">
  231. <a href="#setting-up-controller-class" class="md-nav__link">
  232. Setting up Controller Class
  233. </a>
  234. </li>
  235. </ul>
  236. </nav>
  237. </li>
  238. <li class="md-nav__item">
  239. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  240. All keys, One secret
  241. </a>
  242. </li>
  243. <li class="md-nav__item">
  244. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  245. Common K8S Secret Types
  246. </a>
  247. </li>
  248. <li class="md-nav__item">
  249. <a href="../guides-multi-tenancy/" class="md-nav__link">
  250. Multi Tenancy
  251. </a>
  252. </li>
  253. <li class="md-nav__item">
  254. <a href="../guides-metrics/" class="md-nav__link">
  255. Metrics
  256. </a>
  257. </li>
  258. <li class="md-nav__item">
  259. <a href="../guides-using-latest-image/" class="md-nav__link">
  260. Using Latest Image
  261. </a>
  262. </li>
  263. </ul>
  264. </nav>
  265. </li>
  266. <li class="md-nav__item md-nav__item--nested">
  267. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  268. <label class="md-nav__link" for="__nav_5">
  269. Provider
  270. <span class="md-nav__icon md-icon"></span>
  271. </label>
  272. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  273. <label class="md-nav__title" for="__nav_5">
  274. <span class="md-nav__icon md-icon"></span>
  275. Provider
  276. </label>
  277. <ul class="md-nav__list" data-md-scrollfix>
  278. <li class="md-nav__item md-nav__item--nested">
  279. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  280. <label class="md-nav__link" for="__nav_5_1">
  281. AWS
  282. <span class="md-nav__icon md-icon"></span>
  283. </label>
  284. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  285. <label class="md-nav__title" for="__nav_5_1">
  286. <span class="md-nav__icon md-icon"></span>
  287. AWS
  288. </label>
  289. <ul class="md-nav__list" data-md-scrollfix>
  290. <li class="md-nav__item">
  291. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  292. Secrets Manager
  293. </a>
  294. </li>
  295. <li class="md-nav__item">
  296. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  297. Parameter Store
  298. </a>
  299. </li>
  300. </ul>
  301. </nav>
  302. </li>
  303. <li class="md-nav__item md-nav__item--nested">
  304. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  305. <label class="md-nav__link" for="__nav_5_2">
  306. Azure
  307. <span class="md-nav__icon md-icon"></span>
  308. </label>
  309. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  310. <label class="md-nav__title" for="__nav_5_2">
  311. <span class="md-nav__icon md-icon"></span>
  312. Azure
  313. </label>
  314. <ul class="md-nav__list" data-md-scrollfix>
  315. <li class="md-nav__item">
  316. <a href="../provider-azure-key-vault/" class="md-nav__link">
  317. Key Vault
  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_3" type="checkbox" id="__nav_5_3" >
  325. <label class="md-nav__link" for="__nav_5_3">
  326. Google
  327. <span class="md-nav__icon md-icon"></span>
  328. </label>
  329. <nav class="md-nav" aria-label="Google" data-md-level="2">
  330. <label class="md-nav__title" for="__nav_5_3">
  331. <span class="md-nav__icon md-icon"></span>
  332. Google
  333. </label>
  334. <ul class="md-nav__list" data-md-scrollfix>
  335. <li class="md-nav__item">
  336. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  337. Secret Manager
  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_4" type="checkbox" id="__nav_5_4" >
  345. <label class="md-nav__link" for="__nav_5_4">
  346. IBM
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  350. <label class="md-nav__title" for="__nav_5_4">
  351. <span class="md-nav__icon md-icon"></span>
  352. IBM
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  357. Secrets Manager
  358. </a>
  359. </li>
  360. </ul>
  361. </nav>
  362. </li>
  363. <li class="md-nav__item">
  364. <a href="../provider-akeyless/" class="md-nav__link">
  365. Akeyless
  366. </a>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  370. HashiCorp Vault
  371. </a>
  372. </li>
  373. <li class="md-nav__item md-nav__item--nested">
  374. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  375. <label class="md-nav__link" for="__nav_5_7">
  376. Yandex
  377. <span class="md-nav__icon md-icon"></span>
  378. </label>
  379. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  380. <label class="md-nav__title" for="__nav_5_7">
  381. <span class="md-nav__icon md-icon"></span>
  382. Yandex
  383. </label>
  384. <ul class="md-nav__list" data-md-scrollfix>
  385. <li class="md-nav__item">
  386. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  387. Lockbox
  388. </a>
  389. </li>
  390. </ul>
  391. </nav>
  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_8" type="checkbox" id="__nav_5_8" >
  395. <label class="md-nav__link" for="__nav_5_8">
  396. Gitlab
  397. <span class="md-nav__icon md-icon"></span>
  398. </label>
  399. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  400. <label class="md-nav__title" for="__nav_5_8">
  401. <span class="md-nav__icon md-icon"></span>
  402. Gitlab
  403. </label>
  404. <ul class="md-nav__list" data-md-scrollfix>
  405. <li class="md-nav__item">
  406. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  407. Gitlab Project Variables
  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_9" type="checkbox" id="__nav_5_9" >
  415. <label class="md-nav__link" for="__nav_5_9">
  416. Oracle
  417. <span class="md-nav__icon md-icon"></span>
  418. </label>
  419. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  420. <label class="md-nav__title" for="__nav_5_9">
  421. <span class="md-nav__icon md-icon"></span>
  422. Oracle
  423. </label>
  424. <ul class="md-nav__list" data-md-scrollfix>
  425. <li class="md-nav__item">
  426. <a href="../provider-oracle-vault/" class="md-nav__link">
  427. Oracle Vault
  428. </a>
  429. </li>
  430. </ul>
  431. </nav>
  432. </li>
  433. <li class="md-nav__item">
  434. <a href="../provider-webhook/" class="md-nav__link">
  435. Webhook
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../provider-fake/" class="md-nav__link">
  440. Fake
  441. </a>
  442. </li>
  443. </ul>
  444. </nav>
  445. </li>
  446. <li class="md-nav__item md-nav__item--nested">
  447. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  448. <label class="md-nav__link" for="__nav_6">
  449. Examples
  450. <span class="md-nav__icon md-icon"></span>
  451. </label>
  452. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  453. <label class="md-nav__title" for="__nav_6">
  454. <span class="md-nav__icon md-icon"></span>
  455. Examples
  456. </label>
  457. <ul class="md-nav__list" data-md-scrollfix>
  458. <li class="md-nav__item">
  459. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  460. FluxCD
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  465. Anchore Engine
  466. </a>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  470. Jenkins
  471. </a>
  472. </li>
  473. </ul>
  474. </nav>
  475. </li>
  476. <li class="md-nav__item md-nav__item--nested">
  477. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  478. <label class="md-nav__link" for="__nav_7">
  479. References
  480. <span class="md-nav__icon md-icon"></span>
  481. </label>
  482. <nav class="md-nav" aria-label="References" data-md-level="1">
  483. <label class="md-nav__title" for="__nav_7">
  484. <span class="md-nav__icon md-icon"></span>
  485. References
  486. </label>
  487. <ul class="md-nav__list" data-md-scrollfix>
  488. <li class="md-nav__item">
  489. <a href="../spec/" class="md-nav__link">
  490. API specification
  491. </a>
  492. </li>
  493. </ul>
  494. </nav>
  495. </li>
  496. <li class="md-nav__item md-nav__item--nested">
  497. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  498. <label class="md-nav__link" for="__nav_8">
  499. Contributing
  500. <span class="md-nav__icon md-icon"></span>
  501. </label>
  502. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  503. <label class="md-nav__title" for="__nav_8">
  504. <span class="md-nav__icon md-icon"></span>
  505. Contributing
  506. </label>
  507. <ul class="md-nav__list" data-md-scrollfix>
  508. <li class="md-nav__item">
  509. <a href="../contributing-devguide/" class="md-nav__link">
  510. Developer guide
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="../contributing-process/" class="md-nav__link">
  515. Contributing Process
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../contributing-coc/" class="md-nav__link">
  520. Code of Conduct
  521. </a>
  522. </li>
  523. </ul>
  524. </nav>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../deprecation-policy/" class="md-nav__link">
  528. Deprecation Policy
  529. </a>
  530. </li>
  531. </ul>
  532. </nav>
  533. </div>
  534. </div>
  535. </div>
  536. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  537. <div class="md-sidebar__scrollwrap">
  538. <div class="md-sidebar__inner">
  539. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  540. <label class="md-nav__title" for="__toc">
  541. <span class="md-nav__icon md-icon"></span>
  542. Table of contents
  543. </label>
  544. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  545. <li class="md-nav__item">
  546. <a href="#setting-up-controller-class" class="md-nav__link">
  547. Setting up Controller Class
  548. </a>
  549. </li>
  550. </ul>
  551. </nav>
  552. </div>
  553. </div>
  554. </div>
  555. <div class="md-content" data-md-component="content">
  556. <article class="md-content__inner md-typeset">
  557. <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">
  558. <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>
  559. </a>
  560. <h1 id="controller-classes">Controller Classes</h1>
  561. <blockquote>
  562. <p>NOTE: this feature is experimental and not highly tested</p>
  563. </blockquote>
  564. <p>Controller classes are a proprierty set during the deployment that allows multiple controllers to work in a group of workloard. 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>
  565. <h2 id="setting-up-controller-class">Setting up Controller Class</h2>
  566. <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:
  567. <div class="highlight"><pre><span></span><code>helm install custom-external-secrets external-secrets/external-secrets --set controllerClass=custom
  568. </code></pre></div>
  569. <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/v1alpha1</span><span class="w"></span>
  570. <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>
  571. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  572. <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>
  573. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  574. <span class="w"> </span><span class="c1">#define the controller label to the matching value of the deployment</span><span class="w"></span>
  575. <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>
  576. <span class="w"> </span><span class="c1">#configure provider the same way</span><span class="w"></span>
  577. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  578. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"></span>
  579. <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>
  580. <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>
  581. <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>
  582. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  583. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  584. <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>
  585. <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>
  586. </code></pre></div></p>
  587. <p>Now, any <code>ExternalSecret</code> bound to this secret store will be evaluated by the operator with the controllerClass custom.</p>
  588. <blockquote>
  589. <p>Note: Any SecretStore without <code>spec.controller</code> set will be considered as valid by any operator, regardless of their respective controllerClasses.</p>
  590. </blockquote>
  591. </article>
  592. </div>
  593. </div>
  594. </main>
  595. <footer class="md-footer">
  596. <nav class="md-footer__inner md-grid" aria-label="Footer">
  597. <a href="../guides-templating-v1/" class="md-footer__link md-footer__link--prev" aria-label="Previous: v1" rel="prev">
  598. <div class="md-footer__button md-icon">
  599. <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>
  600. </div>
  601. <div class="md-footer__title">
  602. <div class="md-ellipsis">
  603. <span class="md-footer__direction">
  604. Previous
  605. </span>
  606. v1
  607. </div>
  608. </div>
  609. </a>
  610. <a href="../guides-all-keys-one-secret/" class="md-footer__link md-footer__link--next" aria-label="Next: All keys, One secret" rel="next">
  611. <div class="md-footer__title">
  612. <div class="md-ellipsis">
  613. <span class="md-footer__direction">
  614. Next
  615. </span>
  616. All keys, One secret
  617. </div>
  618. </div>
  619. <div class="md-footer__button md-icon">
  620. <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>
  621. </div>
  622. </a>
  623. </nav>
  624. <div class="md-footer-meta md-typeset">
  625. <div class="md-footer-meta__inner md-grid">
  626. <div class="md-copyright">
  627. Made with
  628. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  629. Material for MkDocs
  630. </a>
  631. </div>
  632. </div>
  633. </div>
  634. </footer>
  635. </div>
  636. <div class="md-dialog" data-md-component="dialog">
  637. <div class="md-dialog__inner md-typeset"></div>
  638. </div>
  639. <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>
  640. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  641. </body>
  642. </html>