index.html 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081
  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.1, mkdocs-material-7.1.8">
  8. <title>ClusterSecretStore - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.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-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
  14. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  16. </head>
  17. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  18. <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  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. </div>
  24. <div data-md-component="announce">
  25. </div>
  26. <header class="md-header" data-md-component="header">
  27. <nav class="md-header__inner md-grid" aria-label="Header">
  28. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  29. <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>
  30. </a>
  31. <label class="md-header__button md-icon" for="__drawer">
  32. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  33. </label>
  34. <div class="md-header__title" data-md-component="header-title">
  35. <div class="md-header__ellipsis">
  36. <div class="md-header__topic">
  37. <span class="md-ellipsis">
  38. External Secrets Operator
  39. </span>
  40. </div>
  41. <div class="md-header__topic" data-md-component="header-topic">
  42. <span class="md-ellipsis">
  43. ClusterSecretStore
  44. </span>
  45. </div>
  46. </div>
  47. </div>
  48. <label class="md-header__button md-icon" for="__search">
  49. <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>
  50. </label>
  51. <div class="md-search" data-md-component="search" role="dialog">
  52. <label class="md-search__overlay" for="__search"></label>
  53. <div class="md-search__inner" role="search">
  54. <form class="md-search__form" name="search">
  55. <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" data-md-state="active" required>
  56. <label class="md-search__icon md-icon" for="__search">
  57. <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>
  58. <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>
  59. </label>
  60. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  61. <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>
  62. </button>
  63. </form>
  64. <div class="md-search__output">
  65. <div class="md-search__scrollwrap" data-md-scrollfix>
  66. <div class="md-search-result" data-md-component="search-result">
  67. <div class="md-search-result__meta">
  68. Initializing search
  69. </div>
  70. <ol class="md-search-result__list"></ol>
  71. </div>
  72. </div>
  73. </div>
  74. </div>
  75. </div>
  76. <div class="md-header__source">
  77. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  78. <div class="md-source__icon md-icon">
  79. <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>
  80. </div>
  81. <div class="md-source__repository">
  82. External Secrets Operator
  83. </div>
  84. </a>
  85. </div>
  86. </nav>
  87. </header>
  88. <div class="md-container" data-md-component="container">
  89. <main class="md-main" data-md-component="main">
  90. <div class="md-main__inner md-grid">
  91. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  92. <div class="md-sidebar__scrollwrap">
  93. <div class="md-sidebar__inner">
  94. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  95. <label class="md-nav__title" for="__drawer">
  96. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  97. <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>
  98. </a>
  99. External Secrets Operator
  100. </label>
  101. <div class="md-nav__source">
  102. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  103. <div class="md-source__icon md-icon">
  104. <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>
  105. </div>
  106. <div class="md-source__repository">
  107. External Secrets Operator
  108. </div>
  109. </a>
  110. </div>
  111. <ul class="md-nav__list" data-md-scrollfix>
  112. <li class="md-nav__item">
  113. <a href=".." class="md-nav__link">
  114. Introduction
  115. </a>
  116. </li>
  117. <li class="md-nav__item">
  118. <a href="../api-overview/" class="md-nav__link">
  119. Overview
  120. </a>
  121. </li>
  122. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  123. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
  124. <label class="md-nav__link" for="__nav_3">
  125. API Types
  126. <span class="md-nav__icon md-icon"></span>
  127. </label>
  128. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  129. <label class="md-nav__title" for="__nav_3">
  130. <span class="md-nav__icon md-icon"></span>
  131. API Types
  132. </label>
  133. <ul class="md-nav__list" data-md-scrollfix>
  134. <li class="md-nav__item">
  135. <a href="../api-externalsecret/" class="md-nav__link">
  136. ExternalSecret
  137. </a>
  138. </li>
  139. <li class="md-nav__item">
  140. <a href="../api-secretstore/" class="md-nav__link">
  141. SecretStore
  142. </a>
  143. </li>
  144. <li class="md-nav__item md-nav__item--active">
  145. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  146. <a href="./" class="md-nav__link md-nav__link--active">
  147. ClusterSecretStore
  148. </a>
  149. </li>
  150. </ul>
  151. </nav>
  152. </li>
  153. <li class="md-nav__item md-nav__item--nested">
  154. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  155. <label class="md-nav__link" for="__nav_4">
  156. Guides
  157. <span class="md-nav__icon md-icon"></span>
  158. </label>
  159. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  160. <label class="md-nav__title" for="__nav_4">
  161. <span class="md-nav__icon md-icon"></span>
  162. Guides
  163. </label>
  164. <ul class="md-nav__list" data-md-scrollfix>
  165. <li class="md-nav__item">
  166. <a href="../guides-introduction/" class="md-nav__link">
  167. Introduction
  168. </a>
  169. </li>
  170. <li class="md-nav__item">
  171. <a href="../guides-getting-started/" class="md-nav__link">
  172. Getting started
  173. </a>
  174. </li>
  175. <li class="md-nav__item">
  176. <a href="../guides-templating/" class="md-nav__link">
  177. Advanced Templating
  178. </a>
  179. </li>
  180. <li class="md-nav__item">
  181. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  182. All keys, One secret
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  187. Common K8S Secret Types
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-multi-tenancy/" class="md-nav__link">
  192. Multi Tenancy
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../guides-metrics/" class="md-nav__link">
  197. Metrics
  198. </a>
  199. </li>
  200. </ul>
  201. </nav>
  202. </li>
  203. <li class="md-nav__item md-nav__item--nested">
  204. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  205. <label class="md-nav__link" for="__nav_5">
  206. Provider
  207. <span class="md-nav__icon md-icon"></span>
  208. </label>
  209. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  210. <label class="md-nav__title" for="__nav_5">
  211. <span class="md-nav__icon md-icon"></span>
  212. Provider
  213. </label>
  214. <ul class="md-nav__list" data-md-scrollfix>
  215. <li class="md-nav__item md-nav__item--nested">
  216. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  217. <label class="md-nav__link" for="__nav_5_1">
  218. AWS
  219. <span class="md-nav__icon md-icon"></span>
  220. </label>
  221. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  222. <label class="md-nav__title" for="__nav_5_1">
  223. <span class="md-nav__icon md-icon"></span>
  224. AWS
  225. </label>
  226. <ul class="md-nav__list" data-md-scrollfix>
  227. <li class="md-nav__item">
  228. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  229. Secrets Manager
  230. </a>
  231. </li>
  232. <li class="md-nav__item">
  233. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  234. Parameter Store
  235. </a>
  236. </li>
  237. </ul>
  238. </nav>
  239. </li>
  240. <li class="md-nav__item md-nav__item--nested">
  241. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  242. <label class="md-nav__link" for="__nav_5_2">
  243. Azure
  244. <span class="md-nav__icon md-icon"></span>
  245. </label>
  246. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  247. <label class="md-nav__title" for="__nav_5_2">
  248. <span class="md-nav__icon md-icon"></span>
  249. Azure
  250. </label>
  251. <ul class="md-nav__list" data-md-scrollfix>
  252. <li class="md-nav__item">
  253. <a href="../provider-azure-key-vault/" class="md-nav__link">
  254. Key Vault
  255. </a>
  256. </li>
  257. </ul>
  258. </nav>
  259. </li>
  260. <li class="md-nav__item md-nav__item--nested">
  261. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  262. <label class="md-nav__link" for="__nav_5_3">
  263. Google
  264. <span class="md-nav__icon md-icon"></span>
  265. </label>
  266. <nav class="md-nav" aria-label="Google" data-md-level="2">
  267. <label class="md-nav__title" for="__nav_5_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. Google
  270. </label>
  271. <ul class="md-nav__list" data-md-scrollfix>
  272. <li class="md-nav__item">
  273. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  274. Secrets Manager
  275. </a>
  276. </li>
  277. </ul>
  278. </nav>
  279. </li>
  280. <li class="md-nav__item md-nav__item--nested">
  281. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  282. <label class="md-nav__link" for="__nav_5_4">
  283. IBM
  284. <span class="md-nav__icon md-icon"></span>
  285. </label>
  286. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  287. <label class="md-nav__title" for="__nav_5_4">
  288. <span class="md-nav__icon md-icon"></span>
  289. IBM
  290. </label>
  291. <ul class="md-nav__list" data-md-scrollfix>
  292. <li class="md-nav__item">
  293. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  294. Secrets Manager
  295. </a>
  296. </li>
  297. </ul>
  298. </nav>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="../provider-akeyless/" class="md-nav__link">
  302. Akeyless
  303. </a>
  304. </li>
  305. <li class="md-nav__item">
  306. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  307. HashiCorp Vault
  308. </a>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  312. <label class="md-nav__link" for="__nav_5_7">
  313. Yandex
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_5_7">
  318. <span class="md-nav__icon md-icon"></span>
  319. Yandex
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  324. Lockbox
  325. </a>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. <li class="md-nav__item md-nav__item--nested">
  331. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  332. <label class="md-nav__link" for="__nav_5_8">
  333. Gitlab
  334. <span class="md-nav__icon md-icon"></span>
  335. </label>
  336. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  337. <label class="md-nav__title" for="__nav_5_8">
  338. <span class="md-nav__icon md-icon"></span>
  339. Gitlab
  340. </label>
  341. <ul class="md-nav__list" data-md-scrollfix>
  342. <li class="md-nav__item">
  343. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  344. Gitlab Project Variables
  345. </a>
  346. </li>
  347. </ul>
  348. </nav>
  349. </li>
  350. <li class="md-nav__item md-nav__item--nested">
  351. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  352. <label class="md-nav__link" for="__nav_5_9">
  353. Oracle
  354. <span class="md-nav__icon md-icon"></span>
  355. </label>
  356. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  357. <label class="md-nav__title" for="__nav_5_9">
  358. <span class="md-nav__icon md-icon"></span>
  359. Oracle
  360. </label>
  361. <ul class="md-nav__list" data-md-scrollfix>
  362. <li class="md-nav__item">
  363. <a href="../provider-oracle-vault/" class="md-nav__link">
  364. Oracle Vault
  365. </a>
  366. </li>
  367. </ul>
  368. </nav>
  369. </li>
  370. </ul>
  371. </nav>
  372. </li>
  373. <li class="md-nav__item md-nav__item--nested">
  374. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  375. <label class="md-nav__link" for="__nav_6">
  376. References
  377. <span class="md-nav__icon md-icon"></span>
  378. </label>
  379. <nav class="md-nav" aria-label="References" data-md-level="1">
  380. <label class="md-nav__title" for="__nav_6">
  381. <span class="md-nav__icon md-icon"></span>
  382. References
  383. </label>
  384. <ul class="md-nav__list" data-md-scrollfix>
  385. <li class="md-nav__item">
  386. <a href="../spec/" class="md-nav__link">
  387. API specification
  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_7" type="checkbox" id="__nav_7" >
  395. <label class="md-nav__link" for="__nav_7">
  396. Contributing
  397. <span class="md-nav__icon md-icon"></span>
  398. </label>
  399. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  400. <label class="md-nav__title" for="__nav_7">
  401. <span class="md-nav__icon md-icon"></span>
  402. Contributing
  403. </label>
  404. <ul class="md-nav__list" data-md-scrollfix>
  405. <li class="md-nav__item">
  406. <a href="../contributing-devguide/" class="md-nav__link">
  407. Developer guide
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../contributing-process/" class="md-nav__link">
  412. Contributing Process
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../contributing-coc/" class="md-nav__link">
  417. Code of Conduct
  418. </a>
  419. </li>
  420. </ul>
  421. </nav>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../deprecation-policy/" class="md-nav__link">
  425. Deprecation Policy
  426. </a>
  427. </li>
  428. </ul>
  429. </nav>
  430. </div>
  431. </div>
  432. </div>
  433. <div class="md-content" data-md-component="content">
  434. <article class="md-content__inner md-typeset">
  435. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/api-clustersecretstore.md" title="Edit this page" class="md-content__button md-icon">
  436. <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>
  437. </a>
  438. <h1>ClusterSecretStore</h1>
  439. <p><img alt="ClusterSecretStore" src="../pictures/diagrams-high-level-cluster-detail.png" /></p>
  440. <p>The <code>ClusterSecretStore</code> is a cluster scoped SecretStore that can be referenced by all
  441. <code>ExternalSecrets</code> from all namespaces. Use it to offer a central gateway to your secret backend.</p>
  442. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  443. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  444. <span class="nt">metadata</span><span class="p">:</span>
  445. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  446. <span class="nt">spec</span><span class="p">:</span>
  447. <span class="c1"># Used to select the correct ESO controller (think: ingress.ingressClassName)</span>
  448. <span class="c1"># The ESO controller is instantiated with a specific controller name</span>
  449. <span class="c1"># and filters ES based on this property</span>
  450. <span class="c1"># Optional</span>
  451. <span class="nt">controller</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev</span>
  452. <span class="c1"># provider field contains the configuration to access the provider</span>
  453. <span class="c1"># which contains the secret exactly one provider must be configured.</span>
  454. <span class="nt">provider</span><span class="p">:</span>
  455. <span class="c1"># (1): AWS Secrets Manager</span>
  456. <span class="c1"># aws configures this store to sync secrets using AWS Secret Manager provider</span>
  457. <span class="nt">aws</span><span class="p">:</span>
  458. <span class="nt">service</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  459. <span class="c1"># Role is a Role ARN which the SecretManager provider will assume</span>
  460. <span class="nt">role</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">iam-role</span>
  461. <span class="c1"># AWS Region to be used for the provider</span>
  462. <span class="nt">region</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  463. <span class="c1"># Auth defines the information necessary to authenticate against AWS by</span>
  464. <span class="c1"># getting the accessKeyID and secretAccessKey from an already created Kubernetes Secret</span>
  465. <span class="nt">auth</span><span class="p">:</span>
  466. <span class="nt">secretRef</span><span class="p">:</span>
  467. <span class="nt">accessKeyID</span><span class="p">:</span>
  468. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  469. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">access-key</span>
  470. <span class="nt">secretAccessKey</span><span class="p">:</span>
  471. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  472. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  473. <span class="nt">vault</span><span class="p">:</span>
  474. <span class="nt">server</span><span class="p">:</span> <span class="s">&quot;https://vault.acme.org&quot;</span>
  475. <span class="c1"># Path is the mount path of the Vault KV backend endpoint</span>
  476. <span class="nt">path</span><span class="p">:</span> <span class="s">&quot;secret&quot;</span>
  477. <span class="c1"># Version is the Vault KV secret engine version.</span>
  478. <span class="c1"># This can be either &quot;v1&quot; or &quot;v2&quot;, defaults to &quot;v2&quot;</span>
  479. <span class="nt">version</span><span class="p">:</span> <span class="s">&quot;v2&quot;</span>
  480. <span class="c1"># vault enterprise namespace: https://www.vaultproject.io/docs/enterprise/namespaces</span>
  481. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;a-team&quot;</span>
  482. <span class="nt">caBundle</span><span class="p">:</span> <span class="s">&quot;...&quot;</span>
  483. <span class="nt">auth</span><span class="p">:</span>
  484. <span class="c1"># static token: https://www.vaultproject.io/docs/auth/token</span>
  485. <span class="nt">tokenSecretRef</span><span class="p">:</span>
  486. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-secret&quot;</span>
  487. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  488. <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;vault-token&quot;</span>
  489. <span class="c1"># AppRole auth: https://www.vaultproject.io/docs/auth/approle</span>
  490. <span class="nt">appRole</span><span class="p">:</span>
  491. <span class="nt">path</span><span class="p">:</span> <span class="s">&quot;approle&quot;</span>
  492. <span class="nt">roleId</span><span class="p">:</span> <span class="s">&quot;db02de05-fa39-4855-059b-67221c5c2f63&quot;</span>
  493. <span class="nt">secretRef</span><span class="p">:</span>
  494. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-secret&quot;</span>
  495. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  496. <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;vault-token&quot;</span>
  497. <span class="c1"># Kubernetes auth: https://www.vaultproject.io/docs/auth/kubernetes</span>
  498. <span class="nt">kubernetes</span><span class="p">:</span>
  499. <span class="nt">mountPath</span><span class="p">:</span> <span class="s">&quot;kubernetes&quot;</span>
  500. <span class="nt">role</span><span class="p">:</span> <span class="s">&quot;demo&quot;</span>
  501. <span class="c1"># Optional service account reference</span>
  502. <span class="nt">serviceAccountRef</span><span class="p">:</span>
  503. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-sa&quot;</span>
  504. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  505. <span class="c1"># Optional secret field containing a Kubernetes ServiceAccount JWT</span>
  506. <span class="c1"># used for authenticating with Vault</span>
  507. <span class="nt">secretRef</span><span class="p">:</span>
  508. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-secret&quot;</span>
  509. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  510. <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;vault&quot;</span>
  511. <span class="c1"># (2): GCP Secret Manager</span>
  512. <span class="nt">gcpsm</span><span class="p">:</span>
  513. <span class="c1"># Auth defines the information necessary to authenticate against GCP by getting</span>
  514. <span class="c1"># the credentials from an already created Kubernetes Secret.</span>
  515. <span class="nt">auth</span><span class="p">:</span>
  516. <span class="nt">secretRef</span><span class="p">:</span>
  517. <span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  518. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gcpsm-secret</span>
  519. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-access-credentials</span>
  520. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  521. <span class="nt">projectID</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">myproject</span>
  522. <span class="c1"># (TODO): add more provider examples here</span>
  523. <span class="nt">status</span><span class="p">:</span>
  524. <span class="c1"># Standard condition schema</span>
  525. <span class="nt">conditions</span><span class="p">:</span>
  526. <span class="c1"># SecretStore ready condition indicates the given store is in ready</span>
  527. <span class="c1"># state and able to referenced by ExternalSecrets</span>
  528. <span class="c1"># If the `status` of this condition is `False`, ExternalSecret controllers</span>
  529. <span class="c1"># should prevent attempts to fetch secrets</span>
  530. <span class="p p-Indicator">-</span> <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Ready</span>
  531. <span class="nt">status</span><span class="p">:</span> <span class="s">&quot;False&quot;</span>
  532. <span class="nt">reason</span><span class="p">:</span> <span class="s">&quot;ConfigError&quot;</span>
  533. <span class="nt">message</span><span class="p">:</span> <span class="s">&quot;SecretStore</span><span class="nv"> </span><span class="s">validation</span><span class="nv"> </span><span class="s">failed&quot;</span>
  534. <span class="nt">lastTransitionTime</span><span class="p">:</span> <span class="s">&quot;2019-08-12T12:33:02Z&quot;</span>
  535. </code></pre></div>
  536. </article>
  537. </div>
  538. </div>
  539. </main>
  540. <footer class="md-footer">
  541. <nav class="md-footer__inner md-grid" aria-label="Footer">
  542. <a href="../api-secretstore/" class="md-footer__link md-footer__link--prev" aria-label="Previous: SecretStore" rel="prev">
  543. <div class="md-footer__button md-icon">
  544. <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>
  545. </div>
  546. <div class="md-footer__title">
  547. <div class="md-ellipsis">
  548. <span class="md-footer__direction">
  549. Previous
  550. </span>
  551. SecretStore
  552. </div>
  553. </div>
  554. </a>
  555. <a href="../guides-introduction/" class="md-footer__link md-footer__link--next" aria-label="Next: Introduction" rel="next">
  556. <div class="md-footer__title">
  557. <div class="md-ellipsis">
  558. <span class="md-footer__direction">
  559. Next
  560. </span>
  561. Introduction
  562. </div>
  563. </div>
  564. <div class="md-footer__button md-icon">
  565. <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>
  566. </div>
  567. </a>
  568. </nav>
  569. <div class="md-footer-meta md-typeset">
  570. <div class="md-footer-meta__inner md-grid">
  571. <div class="md-footer-copyright">
  572. Made with
  573. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  574. Material for MkDocs
  575. </a>
  576. </div>
  577. </div>
  578. </div>
  579. </footer>
  580. </div>
  581. <div class="md-dialog" data-md-component="dialog">
  582. <div class="md-dialog__inner md-typeset"></div>
  583. </div>
  584. <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.b0710199.min.js", "version": null}</script>
  585. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  586. </body>
  587. </html>