index.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733
  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. <meta http-equiv="x-ua-compatible" content="ie=edge">
  7. <meta name="lang:clipboard.copy" content="Copy to clipboard">
  8. <meta name="lang:clipboard.copied" content="Copied to clipboard">
  9. <meta name="lang:search.language" content="en">
  10. <meta name="lang:search.pipeline.stopwords" content="True">
  11. <meta name="lang:search.pipeline.trimmer" content="True">
  12. <meta name="lang:search.result.none" content="No matching documents">
  13. <meta name="lang:search.result.one" content="1 matching document">
  14. <meta name="lang:search.result.other" content="# matching documents">
  15. <meta name="lang:search.tokenizer" content="[\s\-]+">
  16. <link rel="shortcut icon" href="../assets/images/favicon.png">
  17. <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">
  18. <title>ClusterSecretStore - External Secrets Operator</title>
  19. <link rel="stylesheet" href="../assets/stylesheets/application.1b62728e.css">
  20. <script src="../assets/javascripts/modernizr.268332fc.js"></script>
  21. <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
  22. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  23. <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
  24. <link rel="stylesheet" href="../assets/fonts/material-icons.css">
  25. </head>
  26. <body dir="ltr">
  27. <svg class="md-svg">
  28. <defs>
  29. <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
  30. </defs>
  31. </svg>
  32. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  33. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  34. <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
  35. <header class="md-header" data-md-component="header">
  36. <nav class="md-header-nav md-grid">
  37. <div class="md-flex">
  38. <div class="md-flex__cell md-flex__cell--shrink">
  39. <a href=".." title="External Secrets Operator" class="md-header-nav__button md-logo">
  40. <i class="md-icon"></i>
  41. </a>
  42. </div>
  43. <div class="md-flex__cell md-flex__cell--shrink">
  44. <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
  45. </div>
  46. <div class="md-flex__cell md-flex__cell--stretch">
  47. <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
  48. <span class="md-header-nav__topic">
  49. External Secrets Operator
  50. </span>
  51. <span class="md-header-nav__topic">
  52. ClusterSecretStore
  53. </span>
  54. </div>
  55. </div>
  56. <div class="md-flex__cell md-flex__cell--shrink">
  57. <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
  58. <div class="md-search" data-md-component="search" role="dialog">
  59. <label class="md-search__overlay" for="__search"></label>
  60. <div class="md-search__inner" role="search">
  61. <form class="md-search__form" name="search">
  62. <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
  63. <label class="md-icon md-search__icon" for="__search"></label>
  64. <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
  65. &#xE5CD;
  66. </button>
  67. </form>
  68. <div class="md-search__output">
  69. <div class="md-search__scrollwrap" data-md-scrollfix>
  70. <div class="md-search-result" data-md-component="result">
  71. <div class="md-search-result__meta">
  72. Type to start searching
  73. </div>
  74. <ol class="md-search-result__list"></ol>
  75. </div>
  76. </div>
  77. </div>
  78. </div>
  79. </div>
  80. </div>
  81. <div class="md-flex__cell md-flex__cell--shrink">
  82. <div class="md-header-nav__source">
  83. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  84. <div class="md-source__icon">
  85. <svg viewBox="0 0 24 24" width="24" height="24">
  86. <use xlink:href="#__github" width="24" height="24"></use>
  87. </svg>
  88. </div>
  89. <div class="md-source__repository">
  90. External Secrets Operator
  91. </div>
  92. </a>
  93. </div>
  94. </div>
  95. </div>
  96. </nav>
  97. </header>
  98. <div class="md-container">
  99. <main class="md-main" role="main">
  100. <div class="md-main__inner md-grid" data-md-component="container">
  101. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  102. <div class="md-sidebar__scrollwrap">
  103. <div class="md-sidebar__inner">
  104. <nav class="md-nav md-nav--primary" data-md-level="0">
  105. <label class="md-nav__title md-nav__title--site" for="__drawer">
  106. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo">
  107. <i class="md-icon"></i>
  108. </a>
  109. External Secrets Operator
  110. </label>
  111. <div class="md-nav__source">
  112. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  113. <div class="md-source__icon">
  114. <svg viewBox="0 0 24 24" width="24" height="24">
  115. <use xlink:href="#__github" width="24" height="24"></use>
  116. </svg>
  117. </div>
  118. <div class="md-source__repository">
  119. External Secrets Operator
  120. </div>
  121. </a>
  122. </div>
  123. <ul class="md-nav__list" data-md-scrollfix>
  124. <li class="md-nav__item">
  125. <a href=".." title="Introduction" class="md-nav__link">
  126. Introduction
  127. </a>
  128. </li>
  129. <li class="md-nav__item">
  130. <a href="../api-overview/" title="Overview" class="md-nav__link">
  131. Overview
  132. </a>
  133. </li>
  134. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  135. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
  136. <label class="md-nav__link" for="nav-3">
  137. API Types
  138. </label>
  139. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  140. <label class="md-nav__title" for="nav-3">
  141. API Types
  142. </label>
  143. <ul class="md-nav__list" data-md-scrollfix>
  144. <li class="md-nav__item">
  145. <a href="../api-externalsecret/" title="ExternalSecret" class="md-nav__link">
  146. ExternalSecret
  147. </a>
  148. </li>
  149. <li class="md-nav__item">
  150. <a href="../api-secretstore/" title="SecretStore" class="md-nav__link">
  151. SecretStore
  152. </a>
  153. </li>
  154. <li class="md-nav__item md-nav__item--active">
  155. <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  156. <a href="./" title="ClusterSecretStore" class="md-nav__link md-nav__link--active">
  157. ClusterSecretStore
  158. </a>
  159. </li>
  160. </ul>
  161. </nav>
  162. </li>
  163. <li class="md-nav__item md-nav__item--nested">
  164. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
  165. <label class="md-nav__link" for="nav-4">
  166. Guides
  167. </label>
  168. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  169. <label class="md-nav__title" for="nav-4">
  170. Guides
  171. </label>
  172. <ul class="md-nav__list" data-md-scrollfix>
  173. <li class="md-nav__item">
  174. <a href="../guides-introduction/" title="Introduction" class="md-nav__link">
  175. Introduction
  176. </a>
  177. </li>
  178. <li class="md-nav__item">
  179. <a href="../guides-getting-started/" title="Getting started" class="md-nav__link">
  180. Getting started
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../guides-templating/" title="Advanced Templating" class="md-nav__link">
  185. Advanced Templating
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../guides-multi-tenancy/" title="Multi Tenancy" class="md-nav__link">
  190. Multi Tenancy
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../guides-metrics/" title="Metrics" class="md-nav__link">
  195. Metrics
  196. </a>
  197. </li>
  198. </ul>
  199. </nav>
  200. </li>
  201. <li class="md-nav__item md-nav__item--nested">
  202. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
  203. <label class="md-nav__link" for="nav-5">
  204. Provider
  205. </label>
  206. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  207. <label class="md-nav__title" for="nav-5">
  208. Provider
  209. </label>
  210. <ul class="md-nav__list" data-md-scrollfix>
  211. <li class="md-nav__item md-nav__item--nested">
  212. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1">
  213. <label class="md-nav__link" for="nav-5-1">
  214. AWS
  215. </label>
  216. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  217. <label class="md-nav__title" for="nav-5-1">
  218. AWS
  219. </label>
  220. <ul class="md-nav__list" data-md-scrollfix>
  221. <li class="md-nav__item">
  222. <a href="../provider-aws-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  223. Secrets Manager
  224. </a>
  225. </li>
  226. <li class="md-nav__item">
  227. <a href="../provider-aws-parameter-store/" title="Parameter Store" class="md-nav__link">
  228. Parameter Store
  229. </a>
  230. </li>
  231. </ul>
  232. </nav>
  233. </li>
  234. <li class="md-nav__item md-nav__item--nested">
  235. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
  236. <label class="md-nav__link" for="nav-5-2">
  237. Azure
  238. </label>
  239. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  240. <label class="md-nav__title" for="nav-5-2">
  241. Azure
  242. </label>
  243. <ul class="md-nav__list" data-md-scrollfix>
  244. <li class="md-nav__item">
  245. <a href="../provider-azure-key-vault/" title="Key Vault" class="md-nav__link">
  246. Key Vault
  247. </a>
  248. </li>
  249. </ul>
  250. </nav>
  251. </li>
  252. <li class="md-nav__item md-nav__item--nested">
  253. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
  254. <label class="md-nav__link" for="nav-5-3">
  255. Google
  256. </label>
  257. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  258. <label class="md-nav__title" for="nav-5-3">
  259. Google
  260. </label>
  261. <ul class="md-nav__list" data-md-scrollfix>
  262. <li class="md-nav__item">
  263. <a href="../provider-google-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  264. Secrets Manager
  265. </a>
  266. </li>
  267. </ul>
  268. </nav>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="../provider-hashicorp-vault/" title="HashiCorp Vault" class="md-nav__link">
  272. HashiCorp Vault
  273. </a>
  274. </li>
  275. </ul>
  276. </nav>
  277. </li>
  278. <li class="md-nav__item md-nav__item--nested">
  279. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
  280. <label class="md-nav__link" for="nav-6">
  281. References
  282. </label>
  283. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  284. <label class="md-nav__title" for="nav-6">
  285. References
  286. </label>
  287. <ul class="md-nav__list" data-md-scrollfix>
  288. <li class="md-nav__item">
  289. <a href="../spec/" title="API specification" class="md-nav__link">
  290. API specification
  291. </a>
  292. </li>
  293. </ul>
  294. </nav>
  295. </li>
  296. <li class="md-nav__item md-nav__item--nested">
  297. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
  298. <label class="md-nav__link" for="nav-7">
  299. Contributing
  300. </label>
  301. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  302. <label class="md-nav__title" for="nav-7">
  303. Contributing
  304. </label>
  305. <ul class="md-nav__list" data-md-scrollfix>
  306. <li class="md-nav__item">
  307. <a href="../contributing-devguide/" title="Developer guide" class="md-nav__link">
  308. Developer guide
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../contributing-process/" title="Contributing Process" class="md-nav__link">
  313. Contributing Process
  314. </a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="../contributing-coc/" title="Code of Conduct" class="md-nav__link">
  318. Code of Conduct
  319. </a>
  320. </li>
  321. </ul>
  322. </nav>
  323. </li>
  324. </ul>
  325. </nav>
  326. </div>
  327. </div>
  328. </div>
  329. <div class="md-content">
  330. <article class="md-content__inner md-typeset">
  331. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/api-clustersecretstore.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
  332. <h1>ClusterSecretStore</h1>
  333. <p><img alt="ClusterSecretStore" src="../pictures/diagrams-high-level-cluster-detail.png" /></p>
  334. <p>The <code>ClusterSecretStore</code> is a cluster scoped SecretStore that can be used by all
  335. <code>ExternalSecrets</code> from all namespaces unless you pin down its usage by using
  336. RBAC or Admission Control.</p>
  337. </article>
  338. </div>
  339. </div>
  340. </main>
  341. <footer class="md-footer">
  342. <div class="md-footer-nav">
  343. <nav class="md-footer-nav__inner md-grid">
  344. <a href="../api-secretstore/" title="SecretStore" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  345. <div class="md-flex__cell md-flex__cell--shrink">
  346. <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
  347. </div>
  348. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  349. <span class="md-flex__ellipsis">
  350. <span class="md-footer-nav__direction">
  351. Previous
  352. </span>
  353. SecretStore
  354. </span>
  355. </div>
  356. </a>
  357. <a href="../guides-introduction/" title="Introduction" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
  358. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  359. <span class="md-flex__ellipsis">
  360. <span class="md-footer-nav__direction">
  361. Next
  362. </span>
  363. Introduction
  364. </span>
  365. </div>
  366. <div class="md-flex__cell md-flex__cell--shrink">
  367. <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
  368. </div>
  369. </a>
  370. </nav>
  371. </div>
  372. <div class="md-footer-meta md-typeset">
  373. <div class="md-footer-meta__inner md-grid">
  374. <div class="md-footer-copyright">
  375. powered by
  376. <a href="https://www.mkdocs.org">MkDocs</a>
  377. and
  378. <a href="https://squidfunk.github.io/mkdocs-material/">
  379. Material for MkDocs</a>
  380. </div>
  381. </div>
  382. </div>
  383. </footer>
  384. </div>
  385. <script src="../assets/javascripts/application.808e90bb.js"></script>
  386. <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
  387. </body>
  388. </html>