index.html 51 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727
  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="../api-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="../api-externalsecret/" class="md-nav__link">
  149. ExternalSecret
  150. </a>
  151. </li>
  152. <li class="md-nav__item">
  153. <a href="../api-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="../api-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-v1beta1/" class="md-nav__link">
  260. Upgrading to v1beta1
  261. </a>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="../guides-using-latest-image/" class="md-nav__link">
  265. Using Latest Image
  266. </a>
  267. </li>
  268. </ul>
  269. </nav>
  270. </li>
  271. <li class="md-nav__item md-nav__item--nested">
  272. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  273. <label class="md-nav__link" for="__nav_5">
  274. Provider
  275. <span class="md-nav__icon md-icon"></span>
  276. </label>
  277. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  278. <label class="md-nav__title" for="__nav_5">
  279. <span class="md-nav__icon md-icon"></span>
  280. Provider
  281. </label>
  282. <ul class="md-nav__list" data-md-scrollfix>
  283. <li class="md-nav__item md-nav__item--nested">
  284. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  285. <label class="md-nav__link" for="__nav_5_1">
  286. AWS
  287. <span class="md-nav__icon md-icon"></span>
  288. </label>
  289. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  290. <label class="md-nav__title" for="__nav_5_1">
  291. <span class="md-nav__icon md-icon"></span>
  292. AWS
  293. </label>
  294. <ul class="md-nav__list" data-md-scrollfix>
  295. <li class="md-nav__item">
  296. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  297. Secrets Manager
  298. </a>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  302. Parameter Store
  303. </a>
  304. </li>
  305. </ul>
  306. </nav>
  307. </li>
  308. <li class="md-nav__item md-nav__item--nested">
  309. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  310. <label class="md-nav__link" for="__nav_5_2">
  311. Azure
  312. <span class="md-nav__icon md-icon"></span>
  313. </label>
  314. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  315. <label class="md-nav__title" for="__nav_5_2">
  316. <span class="md-nav__icon md-icon"></span>
  317. Azure
  318. </label>
  319. <ul class="md-nav__list" data-md-scrollfix>
  320. <li class="md-nav__item">
  321. <a href="../provider-azure-key-vault/" class="md-nav__link">
  322. Key Vault
  323. </a>
  324. </li>
  325. </ul>
  326. </nav>
  327. </li>
  328. <li class="md-nav__item md-nav__item--nested">
  329. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  330. <label class="md-nav__link" for="__nav_5_3">
  331. Google
  332. <span class="md-nav__icon md-icon"></span>
  333. </label>
  334. <nav class="md-nav" aria-label="Google" data-md-level="2">
  335. <label class="md-nav__title" for="__nav_5_3">
  336. <span class="md-nav__icon md-icon"></span>
  337. Google
  338. </label>
  339. <ul class="md-nav__list" data-md-scrollfix>
  340. <li class="md-nav__item">
  341. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  342. Secret Manager
  343. </a>
  344. </li>
  345. </ul>
  346. </nav>
  347. </li>
  348. <li class="md-nav__item md-nav__item--nested">
  349. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  350. <label class="md-nav__link" for="__nav_5_4">
  351. IBM
  352. <span class="md-nav__icon md-icon"></span>
  353. </label>
  354. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  355. <label class="md-nav__title" for="__nav_5_4">
  356. <span class="md-nav__icon md-icon"></span>
  357. IBM
  358. </label>
  359. <ul class="md-nav__list" data-md-scrollfix>
  360. <li class="md-nav__item">
  361. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  362. Secrets Manager
  363. </a>
  364. </li>
  365. </ul>
  366. </nav>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="../provider-akeyless/" class="md-nav__link">
  370. Akeyless
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  375. HashiCorp Vault
  376. </a>
  377. </li>
  378. <li class="md-nav__item md-nav__item--nested">
  379. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  380. <label class="md-nav__link" for="__nav_5_7">
  381. Yandex
  382. <span class="md-nav__icon md-icon"></span>
  383. </label>
  384. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  385. <label class="md-nav__title" for="__nav_5_7">
  386. <span class="md-nav__icon md-icon"></span>
  387. Yandex
  388. </label>
  389. <ul class="md-nav__list" data-md-scrollfix>
  390. <li class="md-nav__item">
  391. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  392. Certificate Manager
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  397. Lockbox
  398. </a>
  399. </li>
  400. </ul>
  401. </nav>
  402. </li>
  403. <li class="md-nav__item md-nav__item--nested">
  404. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  405. <label class="md-nav__link" for="__nav_5_8">
  406. Gitlab
  407. <span class="md-nav__icon md-icon"></span>
  408. </label>
  409. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  410. <label class="md-nav__title" for="__nav_5_8">
  411. <span class="md-nav__icon md-icon"></span>
  412. Gitlab
  413. </label>
  414. <ul class="md-nav__list" data-md-scrollfix>
  415. <li class="md-nav__item">
  416. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  417. Gitlab Project Variables
  418. </a>
  419. </li>
  420. </ul>
  421. </nav>
  422. </li>
  423. <li class="md-nav__item md-nav__item--nested">
  424. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  425. <label class="md-nav__link" for="__nav_5_9">
  426. Oracle
  427. <span class="md-nav__icon md-icon"></span>
  428. </label>
  429. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  430. <label class="md-nav__title" for="__nav_5_9">
  431. <span class="md-nav__icon md-icon"></span>
  432. Oracle
  433. </label>
  434. <ul class="md-nav__list" data-md-scrollfix>
  435. <li class="md-nav__item">
  436. <a href="../provider-oracle-vault/" class="md-nav__link">
  437. Oracle Vault
  438. </a>
  439. </li>
  440. </ul>
  441. </nav>
  442. </li>
  443. <li class="md-nav__item md-nav__item--nested">
  444. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  445. <label class="md-nav__link" for="__nav_5_10">
  446. 1Password
  447. <span class="md-nav__icon md-icon"></span>
  448. </label>
  449. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  450. <label class="md-nav__title" for="__nav_5_10">
  451. <span class="md-nav__icon md-icon"></span>
  452. 1Password
  453. </label>
  454. <ul class="md-nav__list" data-md-scrollfix>
  455. <li class="md-nav__item">
  456. <a href="../provider-1password-automation/" class="md-nav__link">
  457. Secrets Automation
  458. </a>
  459. </li>
  460. </ul>
  461. </nav>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../provider-webhook/" class="md-nav__link">
  465. Webhook
  466. </a>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="../provider-fake/" class="md-nav__link">
  470. Fake
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../provider-kubernetes/" class="md-nav__link">
  475. Kubernetes
  476. </a>
  477. </li>
  478. <li class="md-nav__item md-nav__item--nested">
  479. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  480. <label class="md-nav__link" for="__nav_5_14">
  481. senhasegura
  482. <span class="md-nav__icon md-icon"></span>
  483. </label>
  484. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  485. <label class="md-nav__title" for="__nav_5_14">
  486. <span class="md-nav__icon md-icon"></span>
  487. senhasegura
  488. </label>
  489. <ul class="md-nav__list" data-md-scrollfix>
  490. <li class="md-nav__item">
  491. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  492. DevOps Secrets Management (DSM)
  493. </a>
  494. </li>
  495. </ul>
  496. </nav>
  497. </li>
  498. </ul>
  499. </nav>
  500. </li>
  501. <li class="md-nav__item md-nav__item--nested">
  502. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  503. <label class="md-nav__link" for="__nav_6">
  504. Examples
  505. <span class="md-nav__icon md-icon"></span>
  506. </label>
  507. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  508. <label class="md-nav__title" for="__nav_6">
  509. <span class="md-nav__icon md-icon"></span>
  510. Examples
  511. </label>
  512. <ul class="md-nav__list" data-md-scrollfix>
  513. <li class="md-nav__item">
  514. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  515. FluxCD
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  520. Anchore Engine
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  525. Jenkins
  526. </a>
  527. </li>
  528. </ul>
  529. </nav>
  530. </li>
  531. <li class="md-nav__item md-nav__item--nested">
  532. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  533. <label class="md-nav__link" for="__nav_7">
  534. External Resources
  535. <span class="md-nav__icon md-icon"></span>
  536. </label>
  537. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  538. <label class="md-nav__title" for="__nav_7">
  539. <span class="md-nav__icon md-icon"></span>
  540. External Resources
  541. </label>
  542. <ul class="md-nav__list" data-md-scrollfix>
  543. <li class="md-nav__item">
  544. <a href="../eso-talks/" class="md-nav__link">
  545. Talks
  546. </a>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../eso-demos/" class="md-nav__link">
  550. Demos
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../eso-blogs/" class="md-nav__link">
  555. Blogs
  556. </a>
  557. </li>
  558. </ul>
  559. </nav>
  560. </li>
  561. <li class="md-nav__item md-nav__item--nested">
  562. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  563. <label class="md-nav__link" for="__nav_8">
  564. References
  565. <span class="md-nav__icon md-icon"></span>
  566. </label>
  567. <nav class="md-nav" aria-label="References" data-md-level="1">
  568. <label class="md-nav__title" for="__nav_8">
  569. <span class="md-nav__icon md-icon"></span>
  570. References
  571. </label>
  572. <ul class="md-nav__list" data-md-scrollfix>
  573. <li class="md-nav__item">
  574. <a href="../spec/" class="md-nav__link">
  575. API specification
  576. </a>
  577. </li>
  578. </ul>
  579. </nav>
  580. </li>
  581. <li class="md-nav__item md-nav__item--nested">
  582. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  583. <label class="md-nav__link" for="__nav_9">
  584. Contributing
  585. <span class="md-nav__icon md-icon"></span>
  586. </label>
  587. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  588. <label class="md-nav__title" for="__nav_9">
  589. <span class="md-nav__icon md-icon"></span>
  590. Contributing
  591. </label>
  592. <ul class="md-nav__list" data-md-scrollfix>
  593. <li class="md-nav__item">
  594. <a href="../contributing-devguide/" class="md-nav__link">
  595. Developer guide
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../contributing-process/" class="md-nav__link">
  600. Contributing Process
  601. </a>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="../contributing-release/" class="md-nav__link">
  605. Release Process
  606. </a>
  607. </li>
  608. <li class="md-nav__item">
  609. <a href="../contributing-coc/" class="md-nav__link">
  610. Code of Conduct
  611. </a>
  612. </li>
  613. </ul>
  614. </nav>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../roadmap/" class="md-nav__link">
  618. Roadmap
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../faq/" class="md-nav__link">
  623. FAQ
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../stability-support/" class="md-nav__link">
  628. Stability and Support
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../deprecation-policy/" class="md-nav__link">
  633. Deprecation Policy
  634. </a>
  635. </li>
  636. </ul>
  637. </nav>
  638. </div>
  639. </div>
  640. </div>
  641. <div class="md-content" data-md-component="content">
  642. <article class="md-content__inner md-typeset">
  643. <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">
  644. <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>
  645. </a>
  646. <h1>ClusterSecretStore</h1>
  647. <p><img alt="ClusterSecretStore" src="../pictures/diagrams-high-level-cluster-detail.png" /></p>
  648. <p>The <code>ClusterSecretStore</code> is a cluster scoped SecretStore that can be referenced by all
  649. <code>ExternalSecrets</code> from all namespaces. Use it to offer a central gateway to your secret backend.</p>
  650. <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>
  651. <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>
  652. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  653. <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>
  654. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  655. <span class="w"> </span><span class="c1"># Used to select the correct ESO controller (think: ingress.ingressClassName)</span><span class="w"></span>
  656. <span class="w"> </span><span class="c1"># The ESO controller is instantiated with a specific controller name</span><span class="w"></span>
  657. <span class="w"> </span><span class="c1"># and filters ES based on this property</span><span class="w"></span>
  658. <span class="w"> </span><span class="c1"># Optional</span><span class="w"></span>
  659. <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>
  660. <span class="w"> </span><span class="c1"># provider field contains the configuration to access the provider</span><span class="w"></span>
  661. <span class="w"> </span><span class="c1"># which contains the secret exactly one provider must be configured.</span><span class="w"></span>
  662. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  663. <span class="w"> </span><span class="c1"># (1): AWS Secrets Manager</span><span class="w"></span>
  664. <span class="w"> </span><span class="c1"># aws configures this store to sync secrets using AWS Secret Manager provider</span><span class="w"></span>
  665. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  666. <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>
  667. <span class="w"> </span><span class="c1"># Role is a Role ARN which the SecretManager provider will assume</span><span class="w"></span>
  668. <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>
  669. <span class="w"> </span><span class="c1"># AWS Region to be used for the provider</span><span class="w"></span>
  670. <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>
  671. <span class="w"> </span><span class="c1"># Auth defines the information necessary to authenticate against AWS</span><span class="w"></span>
  672. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  673. <span class="w"> </span><span class="c1"># Getting the accessKeyID and secretAccessKey from an already created Kubernetes Secret</span><span class="w"></span>
  674. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  675. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  676. <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>
  677. <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>
  678. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  679. <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>
  680. <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>
  681. <span class="w"> </span><span class="c1"># IAM roles for service accounts</span><span class="w"></span>
  682. <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>
  683. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span><span class="w"></span>
  684. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  685. <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>
  686. <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>
  687. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"></span>
  688. <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>
  689. <span class="w"> </span><span class="c1"># Path is the mount path of the Vault KV backend endpoint</span><span class="w"></span>
  690. <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>
  691. <span class="w"> </span><span class="c1"># Version is the Vault KV secret engine version.</span><span class="w"></span>
  692. <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>
  693. <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>
  694. <span class="w"> </span><span class="c1"># vault enterprise namespace: https://www.vaultproject.io/docs/enterprise/namespaces</span><span class="w"></span>
  695. <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>
  696. <span class="w"> </span><span class="c1"># base64 encoded string of certificate</span><span class="w"></span>
  697. <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>
  698. <span class="w"> </span><span class="c1"># Instead of caBundle you can also specify a caProvider</span><span class="w"></span>
  699. <span class="w"> </span><span class="c1"># this will retrieve the cert from a Secret or ConfigMap</span><span class="w"></span>
  700. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span><span class="w"></span>
  701. <span class="w"> </span><span class="c1"># Can be Secret or ConfigMap</span><span class="w"></span>
  702. <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>
  703. <span class="w"> </span><span class="c1"># This is mandatory for ClusterSecretStore and not relevant for SecretStore</span><span class="w"></span>
  704. <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>
  705. <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>
  706. <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>
  707. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  708. <span class="w"> </span><span class="c1"># static token: https://www.vaultproject.io/docs/auth/token</span><span class="w"></span>
  709. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</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-secret&quot;</span><span class="w"></span>
  711. <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>
  712. <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>
  713. <span class="w"> </span><span class="c1"># AppRole auth: https://www.vaultproject.io/docs/auth/approle</span><span class="w"></span>
  714. <span class="w"> </span><span class="nt">appRole</span><span class="p">:</span><span class="w"></span>
  715. <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>
  716. <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>
  717. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  718. <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>
  719. <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>
  720. <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>
  721. <span class="w"> </span><span class="c1"># Kubernetes auth: https://www.vaultproject.io/docs/auth/kubernetes</span><span class="w"></span>
  722. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  723. <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>
  724. <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>
  725. <span class="w"> </span><span class="c1"># Optional service account reference</span><span class="w"></span>
  726. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  727. <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>
  728. <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>
  729. <span class="w"> </span><span class="c1"># Optional secret field containing a Kubernetes ServiceAccount JWT</span><span class="w"></span>
  730. <span class="w"> </span><span class="c1"># used for authenticating with Vault</span><span class="w"></span>
  731. <span class="w"> </span><span class="nt">secretRef</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-secret&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="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault&quot;</span><span class="w"></span>
  735. <span class="w"> </span><span class="c1"># (2): GCP Secret Manager</span><span class="w"></span>
  736. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span><span class="w"></span>
  737. <span class="w"> </span><span class="c1"># Auth defines the information necessary to authenticate against GCP by getting</span><span class="w"></span>
  738. <span class="w"> </span><span class="c1"># the credentials from an already created Kubernetes Secret.</span><span class="w"></span>
  739. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  740. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  741. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  742. <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>
  743. <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>
  744. <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>
  745. <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>
  746. <span class="w"> </span><span class="c1"># (TODO): add more provider examples here</span><span class="w"></span>
  747. <span class="nt">status</span><span class="p">:</span><span class="w"></span>
  748. <span class="w"> </span><span class="c1"># Standard condition schema</span><span class="w"></span>
  749. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span><span class="w"></span>
  750. <span class="w"> </span><span class="c1"># SecretStore ready condition indicates the given store is in ready</span><span class="w"></span>
  751. <span class="w"> </span><span class="c1"># state and able to referenced by ExternalSecrets</span><span class="w"></span>
  752. <span class="w"> </span><span class="c1"># If the `status` of this condition is `False`, ExternalSecret controllers</span><span class="w"></span>
  753. <span class="w"> </span><span class="c1"># should prevent attempts to fetch secrets</span><span class="w"></span>
  754. <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>
  755. <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>
  756. <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>
  757. <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>
  758. <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>
  759. </code></pre></div>
  760. </article>
  761. </div>
  762. </div>
  763. </main>
  764. <footer class="md-footer">
  765. <nav class="md-footer__inner md-grid" aria-label="Footer">
  766. <a href="../api-secretstore/" class="md-footer__link md-footer__link--prev" aria-label="Previous: SecretStore" rel="prev">
  767. <div class="md-footer__button md-icon">
  768. <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>
  769. </div>
  770. <div class="md-footer__title">
  771. <div class="md-ellipsis">
  772. <span class="md-footer__direction">
  773. Previous
  774. </span>
  775. SecretStore
  776. </div>
  777. </div>
  778. </a>
  779. <a href="../api-clusterexternalsecret/" class="md-footer__link md-footer__link--next" aria-label="Next: ClusterExternalSecret" rel="next">
  780. <div class="md-footer__title">
  781. <div class="md-ellipsis">
  782. <span class="md-footer__direction">
  783. Next
  784. </span>
  785. ClusterExternalSecret
  786. </div>
  787. </div>
  788. <div class="md-footer__button md-icon">
  789. <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>
  790. </div>
  791. </a>
  792. </nav>
  793. <div class="md-footer-meta md-typeset">
  794. <div class="md-footer-meta__inner md-grid">
  795. <div class="md-copyright">
  796. Made with
  797. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  798. Material for MkDocs
  799. </a>
  800. </div>
  801. </div>
  802. </div>
  803. </footer>
  804. </div>
  805. <div class="md-dialog" data-md-component="dialog">
  806. <div class="md-dialog__inner md-typeset"></div>
  807. </div>
  808. <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>
  809. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  810. </body>
  811. </html>