index.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554
  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">
  454. <a href="../provider-webhook/" class="md-nav__link">
  455. Webhook
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../provider-fake/" class="md-nav__link">
  460. Fake
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../provider-kubernetes/" class="md-nav__link">
  465. Kubernetes
  466. </a>
  467. </li>
  468. </ul>
  469. </nav>
  470. </li>
  471. <li class="md-nav__item md-nav__item--nested">
  472. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  473. <label class="md-nav__link" for="__nav_6">
  474. Examples
  475. <span class="md-nav__icon md-icon"></span>
  476. </label>
  477. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  478. <label class="md-nav__title" for="__nav_6">
  479. <span class="md-nav__icon md-icon"></span>
  480. Examples
  481. </label>
  482. <ul class="md-nav__list" data-md-scrollfix>
  483. <li class="md-nav__item">
  484. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  485. FluxCD
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  490. Anchore Engine
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  495. Jenkins
  496. </a>
  497. </li>
  498. </ul>
  499. </nav>
  500. </li>
  501. <li class="md-nav__item md-nav__item--nested">
  502. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  503. <label class="md-nav__link" for="__nav_7">
  504. External Resources
  505. <span class="md-nav__icon md-icon"></span>
  506. </label>
  507. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  508. <label class="md-nav__title" for="__nav_7">
  509. <span class="md-nav__icon md-icon"></span>
  510. External Resources
  511. </label>
  512. <ul class="md-nav__list" data-md-scrollfix>
  513. <li class="md-nav__item">
  514. <a href="../eso-talks/" class="md-nav__link">
  515. Talks
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../eso-demos/" class="md-nav__link">
  520. Demos
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../eso-blogs/" class="md-nav__link">
  525. Blogs
  526. </a>
  527. </li>
  528. </ul>
  529. </nav>
  530. </li>
  531. <li class="md-nav__item md-nav__item--nested">
  532. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  533. <label class="md-nav__link" for="__nav_8">
  534. References
  535. <span class="md-nav__icon md-icon"></span>
  536. </label>
  537. <nav class="md-nav" aria-label="References" data-md-level="1">
  538. <label class="md-nav__title" for="__nav_8">
  539. <span class="md-nav__icon md-icon"></span>
  540. References
  541. </label>
  542. <ul class="md-nav__list" data-md-scrollfix>
  543. <li class="md-nav__item">
  544. <a href="../spec/" class="md-nav__link">
  545. API specification
  546. </a>
  547. </li>
  548. </ul>
  549. </nav>
  550. </li>
  551. <li class="md-nav__item md-nav__item--nested">
  552. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  553. <label class="md-nav__link" for="__nav_9">
  554. Contributing
  555. <span class="md-nav__icon md-icon"></span>
  556. </label>
  557. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  558. <label class="md-nav__title" for="__nav_9">
  559. <span class="md-nav__icon md-icon"></span>
  560. Contributing
  561. </label>
  562. <ul class="md-nav__list" data-md-scrollfix>
  563. <li class="md-nav__item">
  564. <a href="../contributing-devguide/" class="md-nav__link">
  565. Developer guide
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="../contributing-process/" class="md-nav__link">
  570. Contributing Process
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="../contributing-release/" class="md-nav__link">
  575. Release Process
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../contributing-coc/" class="md-nav__link">
  580. Code of Conduct
  581. </a>
  582. </li>
  583. </ul>
  584. </nav>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../stability-support/" class="md-nav__link">
  588. Stability and Support
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../deprecation-policy/" class="md-nav__link">
  593. Deprecation Policy
  594. </a>
  595. </li>
  596. </ul>
  597. </nav>
  598. </div>
  599. </div>
  600. </div>
  601. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  602. <div class="md-sidebar__scrollwrap">
  603. <div class="md-sidebar__inner">
  604. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  605. <label class="md-nav__title" for="__toc">
  606. <span class="md-nav__icon md-icon"></span>
  607. Table of contents
  608. </label>
  609. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  610. <li class="md-nav__item">
  611. <a href="#setting-up-controller-class" class="md-nav__link">
  612. Setting up Controller Class
  613. </a>
  614. </li>
  615. </ul>
  616. </nav>
  617. </div>
  618. </div>
  619. </div>
  620. <div class="md-content" data-md-component="content">
  621. <article class="md-content__inner md-typeset">
  622. <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">
  623. <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>
  624. </a>
  625. <h1 id="controller-classes">Controller Classes</h1>
  626. <blockquote>
  627. <p>NOTE: this feature is experimental and not highly tested</p>
  628. </blockquote>
  629. <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>
  630. <h2 id="setting-up-controller-class">Setting up Controller Class</h2>
  631. <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:
  632. <div class="highlight"><pre><span></span><code>helm install custom-external-secrets external-secrets/external-secrets --set controllerClass=custom
  633. </code></pre></div>
  634. <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>
  635. <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>
  636. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  637. <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>
  638. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  639. <span class="w"> </span><span class="c1">#define the controller label to the matching value of the deployment</span><span class="w"></span>
  640. <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>
  641. <span class="w"> </span><span class="c1">#configure provider the same way</span><span class="w"></span>
  642. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  643. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"></span>
  644. <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>
  645. <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>
  646. <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>
  647. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  648. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  649. <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>
  650. <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>
  651. </code></pre></div></p>
  652. <p>Now, any <code>ExternalSecret</code> bound to this secret store will be evaluated by the operator with the controllerClass custom.</p>
  653. <blockquote>
  654. <p>Note: Any SecretStore without <code>spec.controller</code> set will be considered as valid by any operator, regardless of their respective controllerClasses.</p>
  655. </blockquote>
  656. </article>
  657. </div>
  658. </div>
  659. </main>
  660. <footer class="md-footer">
  661. <nav class="md-footer__inner md-grid" aria-label="Footer">
  662. <a href="../guides-common-k8s-secret-types/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Common K8S Secret Types" rel="prev">
  663. <div class="md-footer__button md-icon">
  664. <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>
  665. </div>
  666. <div class="md-footer__title">
  667. <div class="md-ellipsis">
  668. <span class="md-footer__direction">
  669. Previous
  670. </span>
  671. Common K8S Secret Types
  672. </div>
  673. </div>
  674. </a>
  675. <a href="../guides-ownership-deletion-policy/" class="md-footer__link md-footer__link--next" aria-label="Next: Lifecycle: ownership &amp; deletion" rel="next">
  676. <div class="md-footer__title">
  677. <div class="md-ellipsis">
  678. <span class="md-footer__direction">
  679. Next
  680. </span>
  681. Lifecycle: ownership & deletion
  682. </div>
  683. </div>
  684. <div class="md-footer__button md-icon">
  685. <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>
  686. </div>
  687. </a>
  688. </nav>
  689. <div class="md-footer-meta md-typeset">
  690. <div class="md-footer-meta__inner md-grid">
  691. <div class="md-copyright">
  692. Made with
  693. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  694. Material for MkDocs
  695. </a>
  696. </div>
  697. </div>
  698. </div>
  699. </footer>
  700. </div>
  701. <div class="md-dialog" data-md-component="dialog">
  702. <div class="md-dialog__inner md-typeset"></div>
  703. </div>
  704. <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>
  705. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  706. </body>
  707. </html>