index.html 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761
  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>ClusterSecretStore - 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. </div>
  24. <div data-md-component="announce">
  25. </div>
  26. <div data-md-component="outdated" hidden>
  27. <aside class="md-banner md-banner--warning">
  28. <div class="md-banner__inner md-grid md-typeset">
  29. You're not viewing the latest version.
  30. <a href="../../..">
  31. <strong>Click here to go to latest.</strong>
  32. </a>
  33. </div>
  34. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  35. </aside>
  36. </div>
  37. <header class="md-header" data-md-component="header">
  38. <nav class="md-header__inner md-grid" aria-label="Header">
  39. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  40. <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>
  41. </a>
  42. <label class="md-header__button md-icon" for="__drawer">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  44. </label>
  45. <div class="md-header__title" data-md-component="header-title">
  46. <div class="md-header__ellipsis">
  47. <div class="md-header__topic">
  48. <span class="md-ellipsis">
  49. External Secrets Operator
  50. </span>
  51. </div>
  52. <div class="md-header__topic" data-md-component="header-topic">
  53. <span class="md-ellipsis">
  54. ClusterSecretStore
  55. </span>
  56. </div>
  57. </div>
  58. </div>
  59. <label class="md-header__button md-icon" for="__search">
  60. <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>
  61. </label>
  62. <div class="md-search" data-md-component="search" role="dialog">
  63. <label class="md-search__overlay" for="__search"></label>
  64. <div class="md-search__inner" role="search">
  65. <form class="md-search__form" name="search">
  66. <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>
  67. <label class="md-search__icon md-icon" for="__search">
  68. <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>
  69. <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>
  70. </label>
  71. <nav class="md-search__options" aria-label="Search">
  72. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  73. <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>
  74. </button>
  75. </nav>
  76. </form>
  77. <div class="md-search__output">
  78. <div class="md-search__scrollwrap" data-md-scrollfix>
  79. <div class="md-search-result" data-md-component="search-result">
  80. <div class="md-search-result__meta">
  81. Initializing search
  82. </div>
  83. <ol class="md-search-result__list"></ol>
  84. </div>
  85. </div>
  86. </div>
  87. </div>
  88. </div>
  89. <div class="md-header__source">
  90. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  91. <div class="md-source__icon md-icon">
  92. <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>
  93. </div>
  94. <div class="md-source__repository">
  95. External Secrets Operator
  96. </div>
  97. </a>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container" data-md-component="container">
  102. <main class="md-main" data-md-component="main">
  103. <div class="md-main__inner md-grid">
  104. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  105. <div class="md-sidebar__scrollwrap">
  106. <div class="md-sidebar__inner">
  107. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  108. <label class="md-nav__title" for="__drawer">
  109. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  110. <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>
  111. </a>
  112. External Secrets Operator
  113. </label>
  114. <div class="md-nav__source">
  115. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  116. <div class="md-source__icon md-icon">
  117. <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>
  118. </div>
  119. <div class="md-source__repository">
  120. External Secrets Operator
  121. </div>
  122. </a>
  123. </div>
  124. <ul class="md-nav__list" data-md-scrollfix>
  125. <li class="md-nav__item">
  126. <a href="../.." class="md-nav__link">
  127. Introduction
  128. </a>
  129. </li>
  130. <li class="md-nav__item">
  131. <a href="../../overview/" class="md-nav__link">
  132. Overview
  133. </a>
  134. </li>
  135. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  136. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
  137. <label class="md-nav__link" for="__nav_3">
  138. API Types
  139. <span class="md-nav__icon md-icon"></span>
  140. </label>
  141. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  142. <label class="md-nav__title" for="__nav_3">
  143. <span class="md-nav__icon md-icon"></span>
  144. API Types
  145. </label>
  146. <ul class="md-nav__list" data-md-scrollfix>
  147. <li class="md-nav__item">
  148. <a href="../externalsecret/" class="md-nav__link">
  149. ExternalSecret
  150. </a>
  151. </li>
  152. <li class="md-nav__item">
  153. <a href="../secretstore/" class="md-nav__link">
  154. SecretStore
  155. </a>
  156. </li>
  157. <li class="md-nav__item md-nav__item--active">
  158. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  159. <a href="./" class="md-nav__link md-nav__link--active">
  160. ClusterSecretStore
  161. </a>
  162. </li>
  163. <li class="md-nav__item">
  164. <a href="../clusterexternalsecret/" class="md-nav__link">
  165. ClusterExternalSecret
  166. </a>
  167. </li>
  168. </ul>
  169. </nav>
  170. </li>
  171. <li class="md-nav__item md-nav__item--nested">
  172. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  173. <label class="md-nav__link" for="__nav_4">
  174. Guides
  175. <span class="md-nav__icon md-icon"></span>
  176. </label>
  177. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  178. <label class="md-nav__title" for="__nav_4">
  179. <span class="md-nav__icon md-icon"></span>
  180. Guides
  181. </label>
  182. <ul class="md-nav__list" data-md-scrollfix>
  183. <li class="md-nav__item">
  184. <a href="../../guides/introduction/" class="md-nav__link">
  185. Introduction
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../guides/getting-started/" class="md-nav__link">
  190. Getting started
  191. </a>
  192. </li>
  193. <li class="md-nav__item md-nav__item--nested">
  194. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  195. <label class="md-nav__link" for="__nav_4_3">
  196. Advanced Templating
  197. <span class="md-nav__icon md-icon"></span>
  198. </label>
  199. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  200. <label class="md-nav__title" for="__nav_4_3">
  201. <span class="md-nav__icon md-icon"></span>
  202. Advanced Templating
  203. </label>
  204. <ul class="md-nav__list" data-md-scrollfix>
  205. <li class="md-nav__item">
  206. <a href="../../guides/templating/" class="md-nav__link">
  207. v2
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../../guides/templating-v1/" class="md-nav__link">
  212. v1
  213. </a>
  214. </li>
  215. </ul>
  216. </nav>
  217. </li>
  218. <li class="md-nav__item">
  219. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  220. All keys, One secret
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  225. Common K8S Secret Types
  226. </a>
  227. </li>
  228. <li class="md-nav__item">
  229. <a href="../../guides/controller-class/" class="md-nav__link">
  230. Controller Classes
  231. </a>
  232. </li>
  233. <li class="md-nav__item">
  234. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  235. Lifecycle: ownership & deletion
  236. </a>
  237. </li>
  238. <li class="md-nav__item">
  239. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  240. Decoding Strategies
  241. </a>
  242. </li>
  243. <li class="md-nav__item">
  244. <a href="../../guides/getallsecrets/" class="md-nav__link">
  245. Getting Multiple Secrets
  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/datafrom-rewrite/" class="md-nav__link">
  260. Rewriting Keys
  261. </a>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="../../guides/v1beta1/" class="md-nav__link">
  265. Upgrading to v1beta1
  266. </a>
  267. </li>
  268. <li class="md-nav__item">
  269. <a href="../../guides/using-latest-image/" class="md-nav__link">
  270. Using Latest Image
  271. </a>
  272. </li>
  273. </ul>
  274. </nav>
  275. </li>
  276. <li class="md-nav__item md-nav__item--nested">
  277. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  278. <label class="md-nav__link" for="__nav_5">
  279. Provider
  280. <span class="md-nav__icon md-icon"></span>
  281. </label>
  282. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  283. <label class="md-nav__title" for="__nav_5">
  284. <span class="md-nav__icon md-icon"></span>
  285. Provider
  286. </label>
  287. <ul class="md-nav__list" data-md-scrollfix>
  288. <li class="md-nav__item md-nav__item--nested">
  289. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  290. <label class="md-nav__link" for="__nav_5_1">
  291. AWS
  292. <span class="md-nav__icon md-icon"></span>
  293. </label>
  294. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  295. <label class="md-nav__title" for="__nav_5_1">
  296. <span class="md-nav__icon md-icon"></span>
  297. AWS
  298. </label>
  299. <ul class="md-nav__list" data-md-scrollfix>
  300. <li class="md-nav__item">
  301. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  302. Secrets Manager
  303. </a>
  304. </li>
  305. <li class="md-nav__item">
  306. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  307. Parameter Store
  308. </a>
  309. </li>
  310. </ul>
  311. </nav>
  312. </li>
  313. <li class="md-nav__item md-nav__item--nested">
  314. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  315. <label class="md-nav__link" for="__nav_5_2">
  316. Azure
  317. <span class="md-nav__icon md-icon"></span>
  318. </label>
  319. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  320. <label class="md-nav__title" for="__nav_5_2">
  321. <span class="md-nav__icon md-icon"></span>
  322. Azure
  323. </label>
  324. <ul class="md-nav__list" data-md-scrollfix>
  325. <li class="md-nav__item">
  326. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  327. Key Vault
  328. </a>
  329. </li>
  330. </ul>
  331. </nav>
  332. </li>
  333. <li class="md-nav__item md-nav__item--nested">
  334. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  335. <label class="md-nav__link" for="__nav_5_3">
  336. Google
  337. <span class="md-nav__icon md-icon"></span>
  338. </label>
  339. <nav class="md-nav" aria-label="Google" data-md-level="2">
  340. <label class="md-nav__title" for="__nav_5_3">
  341. <span class="md-nav__icon md-icon"></span>
  342. Google
  343. </label>
  344. <ul class="md-nav__list" data-md-scrollfix>
  345. <li class="md-nav__item">
  346. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  347. Secret Manager
  348. </a>
  349. </li>
  350. </ul>
  351. </nav>
  352. </li>
  353. <li class="md-nav__item md-nav__item--nested">
  354. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  355. <label class="md-nav__link" for="__nav_5_4">
  356. IBM
  357. <span class="md-nav__icon md-icon"></span>
  358. </label>
  359. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  360. <label class="md-nav__title" for="__nav_5_4">
  361. <span class="md-nav__icon md-icon"></span>
  362. IBM
  363. </label>
  364. <ul class="md-nav__list" data-md-scrollfix>
  365. <li class="md-nav__item">
  366. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  367. Secrets Manager
  368. </a>
  369. </li>
  370. </ul>
  371. </nav>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../provider/akeyless/" class="md-nav__link">
  375. Akeyless
  376. </a>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  380. HashiCorp Vault
  381. </a>
  382. </li>
  383. <li class="md-nav__item md-nav__item--nested">
  384. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  385. <label class="md-nav__link" for="__nav_5_7">
  386. Yandex
  387. <span class="md-nav__icon md-icon"></span>
  388. </label>
  389. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  390. <label class="md-nav__title" for="__nav_5_7">
  391. <span class="md-nav__icon md-icon"></span>
  392. Yandex
  393. </label>
  394. <ul class="md-nav__list" data-md-scrollfix>
  395. <li class="md-nav__item">
  396. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  397. Certificate Manager
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  402. Lockbox
  403. </a>
  404. </li>
  405. </ul>
  406. </nav>
  407. </li>
  408. <li class="md-nav__item md-nav__item--nested">
  409. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  410. <label class="md-nav__link" for="__nav_5_8">
  411. Gitlab
  412. <span class="md-nav__icon md-icon"></span>
  413. </label>
  414. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  415. <label class="md-nav__title" for="__nav_5_8">
  416. <span class="md-nav__icon md-icon"></span>
  417. Gitlab
  418. </label>
  419. <ul class="md-nav__list" data-md-scrollfix>
  420. <li class="md-nav__item">
  421. <a href="../../provider/gitlab-project-variables/" class="md-nav__link">
  422. Gitlab Project Variables
  423. </a>
  424. </li>
  425. </ul>
  426. </nav>
  427. </li>
  428. <li class="md-nav__item md-nav__item--nested">
  429. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  430. <label class="md-nav__link" for="__nav_5_9">
  431. Oracle
  432. <span class="md-nav__icon md-icon"></span>
  433. </label>
  434. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  435. <label class="md-nav__title" for="__nav_5_9">
  436. <span class="md-nav__icon md-icon"></span>
  437. Oracle
  438. </label>
  439. <ul class="md-nav__list" data-md-scrollfix>
  440. <li class="md-nav__item">
  441. <a href="../../provider/oracle-vault/" class="md-nav__link">
  442. Oracle Vault
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. <li class="md-nav__item md-nav__item--nested">
  449. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  450. <label class="md-nav__link" for="__nav_5_10">
  451. 1Password
  452. <span class="md-nav__icon md-icon"></span>
  453. </label>
  454. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  455. <label class="md-nav__title" for="__nav_5_10">
  456. <span class="md-nav__icon md-icon"></span>
  457. 1Password
  458. </label>
  459. <ul class="md-nav__list" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="../../provider/1password-automation/" class="md-nav__link">
  462. Secrets Automation
  463. </a>
  464. </li>
  465. </ul>
  466. </nav>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="../../provider/webhook/" class="md-nav__link">
  470. Webhook
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../../provider/fake/" class="md-nav__link">
  475. Fake
  476. </a>
  477. </li>
  478. <li class="md-nav__item">
  479. <a href="../../provider/kubernetes/" class="md-nav__link">
  480. Kubernetes
  481. </a>
  482. </li>
  483. <li class="md-nav__item md-nav__item--nested">
  484. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  485. <label class="md-nav__link" for="__nav_5_14">
  486. senhasegura
  487. <span class="md-nav__icon md-icon"></span>
  488. </label>
  489. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  490. <label class="md-nav__title" for="__nav_5_14">
  491. <span class="md-nav__icon md-icon"></span>
  492. senhasegura
  493. </label>
  494. <ul class="md-nav__list" data-md-scrollfix>
  495. <li class="md-nav__item">
  496. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  497. DevOps Secrets Management (DSM)
  498. </a>
  499. </li>
  500. </ul>
  501. </nav>
  502. </li>
  503. </ul>
  504. </nav>
  505. </li>
  506. <li class="md-nav__item md-nav__item--nested">
  507. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  508. <label class="md-nav__link" for="__nav_6">
  509. Examples
  510. <span class="md-nav__icon md-icon"></span>
  511. </label>
  512. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  513. <label class="md-nav__title" for="__nav_6">
  514. <span class="md-nav__icon md-icon"></span>
  515. Examples
  516. </label>
  517. <ul class="md-nav__list" data-md-scrollfix>
  518. <li class="md-nav__item">
  519. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  520. FluxCD
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  525. Anchore Engine
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  530. Jenkins
  531. </a>
  532. </li>
  533. </ul>
  534. </nav>
  535. </li>
  536. <li class="md-nav__item md-nav__item--nested">
  537. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  538. <label class="md-nav__link" for="__nav_7">
  539. External Resources
  540. <span class="md-nav__icon md-icon"></span>
  541. </label>
  542. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  543. <label class="md-nav__title" for="__nav_7">
  544. <span class="md-nav__icon md-icon"></span>
  545. External Resources
  546. </label>
  547. <ul class="md-nav__list" data-md-scrollfix>
  548. <li class="md-nav__item">
  549. <a href="../../eso-talks/" class="md-nav__link">
  550. Talks
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../eso-demos/" class="md-nav__link">
  555. Demos
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../eso-blogs/" class="md-nav__link">
  560. Blogs
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item md-nav__item--nested">
  567. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  568. <label class="md-nav__link" for="__nav_8">
  569. References
  570. <span class="md-nav__icon md-icon"></span>
  571. </label>
  572. <nav class="md-nav" aria-label="References" data-md-level="1">
  573. <label class="md-nav__title" for="__nav_8">
  574. <span class="md-nav__icon md-icon"></span>
  575. References
  576. </label>
  577. <ul class="md-nav__list" data-md-scrollfix>
  578. <li class="md-nav__item">
  579. <a href="../../spec/" class="md-nav__link">
  580. API specification
  581. </a>
  582. </li>
  583. </ul>
  584. </nav>
  585. </li>
  586. <li class="md-nav__item md-nav__item--nested">
  587. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  588. <label class="md-nav__link" for="__nav_9">
  589. Contributing
  590. <span class="md-nav__icon md-icon"></span>
  591. </label>
  592. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  593. <label class="md-nav__title" for="__nav_9">
  594. <span class="md-nav__icon md-icon"></span>
  595. Contributing
  596. </label>
  597. <ul class="md-nav__list" data-md-scrollfix>
  598. <li class="md-nav__item">
  599. <a href="../../contributing/devguide/" class="md-nav__link">
  600. Developer guide
  601. </a>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="../../contributing/process/" class="md-nav__link">
  605. Contributing Process
  606. </a>
  607. </li>
  608. <li class="md-nav__item">
  609. <a href="../../contributing/release/" class="md-nav__link">
  610. Release Process
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../../contributing/coc/" class="md-nav__link">
  615. Code of Conduct
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="../../contributing/roadmap/" class="md-nav__link">
  620. Roadmap
  621. </a>
  622. </li>
  623. </ul>
  624. </nav>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../faq/" class="md-nav__link">
  628. FAQ
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../../stability-support/" class="md-nav__link">
  633. Stability and Support
  634. </a>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="../../deprecation-policy/" class="md-nav__link">
  638. Deprecation Policy
  639. </a>
  640. </li>
  641. </ul>
  642. </nav>
  643. </div>
  644. </div>
  645. </div>
  646. <div class="md-content" data-md-component="content">
  647. <article class="md-content__inner md-typeset">
  648. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/api/clustersecretstore.md" title="Edit this page" class="md-content__button md-icon">
  649. <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>
  650. </a>
  651. <h1>ClusterSecretStore</h1>
  652. <p><img alt="ClusterSecretStore" src="../../pictures/diagrams-high-level-cluster-detail.png" /></p>
  653. <p>The <code>ClusterSecretStore</code> is a cluster scoped SecretStore that can be referenced by all
  654. <code>ExternalSecrets</code> from all namespaces. Use it to offer a central gateway to your secret backend.</p>
  655. <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>
  656. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span><span class="w"></span>
  657. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  658. <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">example</span><span class="w"></span>
  659. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  660. <span class="w"> </span><span class="c1"># Used to select the correct ESO controller (think: ingress.ingressClassName)</span><span class="w"></span>
  661. <span class="w"> </span><span class="c1"># The ESO controller is instantiated with a specific controller name</span><span class="w"></span>
  662. <span class="w"> </span><span class="c1"># and filters ES based on this property</span><span class="w"></span>
  663. <span class="w"> </span><span class="c1"># Optional</span><span class="w"></span>
  664. <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">dev</span><span class="w"></span>
  665. <span class="w"> </span><span class="c1"># provider field contains the configuration to access the provider</span><span class="w"></span>
  666. <span class="w"> </span><span class="c1"># which contains the secret exactly one provider must be configured.</span><span class="w"></span>
  667. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  668. <span class="w"> </span><span class="c1"># (1): AWS Secrets Manager</span><span class="w"></span>
  669. <span class="w"> </span><span class="c1"># aws configures this store to sync secrets using AWS Secret Manager provider</span><span class="w"></span>
  670. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  671. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span><span class="w"></span>
  672. <span class="w"> </span><span class="c1"># Role is a Role ARN which the SecretManager provider will assume</span><span class="w"></span>
  673. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">iam-role</span><span class="w"></span>
  674. <span class="w"> </span><span class="c1"># AWS Region to be used for the provider</span><span class="w"></span>
  675. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span><span class="w"></span>
  676. <span class="w"> </span><span class="c1"># Auth defines the information necessary to authenticate against AWS</span><span class="w"></span>
  677. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  678. <span class="w"> </span><span class="c1"># Getting the accessKeyID and secretAccessKey from an already created Kubernetes Secret</span><span class="w"></span>
  679. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  680. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  681. <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">awssm-secret</span><span class="w"></span>
  682. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access-key</span><span class="w"></span>
  683. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  684. <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">awssm-secret</span><span class="w"></span>
  685. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span><span class="w"></span>
  686. <span class="w"> </span><span class="c1"># IAM roles for service accounts</span><span class="w"></span>
  687. <span class="w"> </span><span class="c1"># https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-technical-overview.html</span><span class="w"></span>
  688. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span><span class="w"></span>
  689. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  690. <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">my-serviceaccount</span><span class="w"></span>
  691. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sa-namespace</span><span class="w"></span>
  692. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"></span>
  693. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span><span class="w"></span>
  694. <span class="w"> </span><span class="c1"># Path is the mount path of the Vault KV backend endpoint</span><span class="w"></span>
  695. <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>
  696. <span class="w"> </span><span class="c1"># Version is the Vault KV secret engine version.</span><span class="w"></span>
  697. <span class="w"> </span><span class="c1"># This can be either &quot;v1&quot; or &quot;v2&quot;, defaults to &quot;v2&quot;</span><span class="w"></span>
  698. <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>
  699. <span class="w"> </span><span class="c1"># vault enterprise namespace: https://www.vaultproject.io/docs/enterprise/namespaces</span><span class="w"></span>
  700. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;a-team&quot;</span><span class="w"></span>
  701. <span class="w"> </span><span class="c1"># base64 encoded string of certificate</span><span class="w"></span>
  702. <span class="w"> </span><span class="nt">caBundle</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;...&quot;</span><span class="w"></span>
  703. <span class="w"> </span><span class="c1"># Instead of caBundle you can also specify a caProvider</span><span class="w"></span>
  704. <span class="w"> </span><span class="c1"># this will retrieve the cert from a Secret or ConfigMap</span><span class="w"></span>
  705. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span><span class="w"></span>
  706. <span class="w"> </span><span class="c1"># Can be Secret or ConfigMap</span><span class="w"></span>
  707. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Secret&quot;</span><span class="w"></span>
  708. <span class="w"> </span><span class="c1"># This is mandatory for ClusterSecretStore and not relevant for SecretStore</span><span class="w"></span>
  709. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-cert-secret-namespace&quot;</span><span class="w"></span>
  710. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-cert-secret&quot;</span><span class="w"></span>
  711. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;cert-key&quot;</span><span class="w"></span>
  712. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  713. <span class="w"> </span><span class="c1"># static token: https://www.vaultproject.io/docs/auth/token</span><span class="w"></span>
  714. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span><span class="w"></span>
  715. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span><span class="w"></span>
  716. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span><span class="w"></span>
  717. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token&quot;</span><span class="w"></span>
  718. <span class="w"> </span><span class="c1"># AppRole auth: https://www.vaultproject.io/docs/auth/approle</span><span class="w"></span>
  719. <span class="w"> </span><span class="nt">appRole</span><span class="p">:</span><span class="w"></span>
  720. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;approle&quot;</span><span class="w"></span>
  721. <span class="w"> </span><span class="nt">roleId</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;db02de05-fa39-4855-059b-67221c5c2f63&quot;</span><span class="w"></span>
  722. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  723. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span><span class="w"></span>
  724. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span><span class="w"></span>
  725. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token&quot;</span><span class="w"></span>
  726. <span class="w"> </span><span class="c1"># Kubernetes auth: https://www.vaultproject.io/docs/auth/kubernetes</span><span class="w"></span>
  727. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  728. <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>
  729. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;demo&quot;</span><span class="w"></span>
  730. <span class="w"> </span><span class="c1"># Optional service account reference</span><span class="w"></span>
  731. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  732. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-sa&quot;</span><span class="w"></span>
  733. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span><span class="w"></span>
  734. <span class="w"> </span><span class="c1"># Optional secret field containing a Kubernetes ServiceAccount JWT</span><span class="w"></span>
  735. <span class="w"> </span><span class="c1"># used for authenticating with Vault</span><span class="w"></span>
  736. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  737. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span><span class="w"></span>
  738. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span><span class="w"></span>
  739. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault&quot;</span><span class="w"></span>
  740. <span class="w"> </span><span class="c1"># (2): GCP Secret Manager</span><span class="w"></span>
  741. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span><span class="w"></span>
  742. <span class="w"> </span><span class="c1"># Auth defines the information necessary to authenticate against GCP by getting</span><span class="w"></span>
  743. <span class="w"> </span><span class="c1"># the credentials from an already created Kubernetes Secret.</span><span class="w"></span>
  744. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  745. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  746. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  747. <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">gcpsm-secret</span><span class="w"></span>
  748. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-credentials</span><span class="w"></span>
  749. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"></span>
  750. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myproject</span><span class="w"></span>
  751. <span class="w"> </span><span class="c1"># (3): Kubernetes provider</span><span class="w"></span>
  752. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  753. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
  754. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://myapiserver.tld&quot;</span><span class="w"></span>
  755. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span><span class="w"> </span>
  756. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  757. <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">my-cluster-secrets</span><span class="w"></span>
  758. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"></span>
  759. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ca.crt</span><span class="w"></span>
  760. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  761. <span class="w"> </span><span class="nt">serviceAccount</span><span class="p">:</span><span class="w"></span>
  762. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;example-sa&quot;</span><span class="w"></span>
  763. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;example&quot;</span><span class="w"></span>
  764. <span class="w"> </span><span class="c1"># (TODO): add more provider examples here</span><span class="w"></span>
  765. <span class="nt">status</span><span class="p">:</span><span class="w"></span>
  766. <span class="w"> </span><span class="c1"># Standard condition schema</span><span class="w"></span>
  767. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span><span class="w"></span>
  768. <span class="w"> </span><span class="c1"># SecretStore ready condition indicates the given store is in ready</span><span class="w"></span>
  769. <span class="w"> </span><span class="c1"># state and able to referenced by ExternalSecrets</span><span class="w"></span>
  770. <span class="w"> </span><span class="c1"># If the `status` of this condition is `False`, ExternalSecret controllers</span><span class="w"></span>
  771. <span class="w"> </span><span class="c1"># should prevent attempts to fetch secrets</span><span class="w"></span>
  772. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Ready</span><span class="w"></span>
  773. <span class="w"> </span><span class="nt">status</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;False&quot;</span><span class="w"></span>
  774. <span class="w"> </span><span class="nt">reason</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ConfigError&quot;</span><span class="w"></span>
  775. <span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </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><span class="w"></span>
  776. <span class="w"> </span><span class="nt">lastTransitionTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span><span class="w"></span>
  777. </code></pre></div>
  778. </article>
  779. </div>
  780. </div>
  781. </main>
  782. <footer class="md-footer">
  783. <nav class="md-footer__inner md-grid" aria-label="Footer">
  784. <a href="../secretstore/" class="md-footer__link md-footer__link--prev" aria-label="Previous: SecretStore" rel="prev">
  785. <div class="md-footer__button md-icon">
  786. <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>
  787. </div>
  788. <div class="md-footer__title">
  789. <div class="md-ellipsis">
  790. <span class="md-footer__direction">
  791. Previous
  792. </span>
  793. SecretStore
  794. </div>
  795. </div>
  796. </a>
  797. <a href="../clusterexternalsecret/" class="md-footer__link md-footer__link--next" aria-label="Next: ClusterExternalSecret" rel="next">
  798. <div class="md-footer__title">
  799. <div class="md-ellipsis">
  800. <span class="md-footer__direction">
  801. Next
  802. </span>
  803. ClusterExternalSecret
  804. </div>
  805. </div>
  806. <div class="md-footer__button md-icon">
  807. <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>
  808. </div>
  809. </a>
  810. </nav>
  811. <div class="md-footer-meta md-typeset">
  812. <div class="md-footer-meta__inner md-grid">
  813. <div class="md-copyright">
  814. <div class="md-copyright__highlight">
  815. &copy; 2022 The external-secrets Authors.<br/>
  816. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  817. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  818. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  819. </div>
  820. Made with
  821. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  822. Material for MkDocs
  823. </a>
  824. </div>
  825. </div>
  826. </div>
  827. </footer>
  828. </div>
  829. <div class="md-dialog" data-md-component="dialog">
  830. <div class="md-dialog__inner md-typeset"></div>
  831. </div>
  832. <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>
  833. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  834. </body>
  835. </html>