index.html 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697
  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>Kubernetes - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#authentication" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Kubernetes
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. <li class="md-nav__item">
  166. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../guides-introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  237. Lifecycle: ownership & deletion
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../guides-getallsecrets/" class="md-nav__link">
  242. Getting Multiple Secrets
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../guides-multi-tenancy/" class="md-nav__link">
  247. Multi Tenancy
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../guides-metrics/" class="md-nav__link">
  252. Metrics
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../guides-v1beta1/" class="md-nav__link">
  257. Upgrading to v1beta1
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../guides-using-latest-image/" class="md-nav__link">
  262. Using Latest Image
  263. </a>
  264. </li>
  265. </ul>
  266. </nav>
  267. </li>
  268. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  270. <label class="md-nav__link" for="__nav_5">
  271. Provider
  272. <span class="md-nav__icon md-icon"></span>
  273. </label>
  274. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  275. <label class="md-nav__title" for="__nav_5">
  276. <span class="md-nav__icon md-icon"></span>
  277. Provider
  278. </label>
  279. <ul class="md-nav__list" data-md-scrollfix>
  280. <li class="md-nav__item md-nav__item--nested">
  281. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  282. <label class="md-nav__link" for="__nav_5_1">
  283. AWS
  284. <span class="md-nav__icon md-icon"></span>
  285. </label>
  286. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  287. <label class="md-nav__title" for="__nav_5_1">
  288. <span class="md-nav__icon md-icon"></span>
  289. AWS
  290. </label>
  291. <ul class="md-nav__list" data-md-scrollfix>
  292. <li class="md-nav__item">
  293. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  294. Secrets Manager
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  299. Parameter Store
  300. </a>
  301. </li>
  302. </ul>
  303. </nav>
  304. </li>
  305. <li class="md-nav__item md-nav__item--nested">
  306. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  307. <label class="md-nav__link" for="__nav_5_2">
  308. Azure
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_5_2">
  313. <span class="md-nav__icon md-icon"></span>
  314. Azure
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../provider-azure-key-vault/" class="md-nav__link">
  319. Key Vault
  320. </a>
  321. </li>
  322. </ul>
  323. </nav>
  324. </li>
  325. <li class="md-nav__item md-nav__item--nested">
  326. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  327. <label class="md-nav__link" for="__nav_5_3">
  328. Google
  329. <span class="md-nav__icon md-icon"></span>
  330. </label>
  331. <nav class="md-nav" aria-label="Google" data-md-level="2">
  332. <label class="md-nav__title" for="__nav_5_3">
  333. <span class="md-nav__icon md-icon"></span>
  334. Google
  335. </label>
  336. <ul class="md-nav__list" data-md-scrollfix>
  337. <li class="md-nav__item">
  338. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  339. Secret Manager
  340. </a>
  341. </li>
  342. </ul>
  343. </nav>
  344. </li>
  345. <li class="md-nav__item md-nav__item--nested">
  346. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  347. <label class="md-nav__link" for="__nav_5_4">
  348. IBM
  349. <span class="md-nav__icon md-icon"></span>
  350. </label>
  351. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  352. <label class="md-nav__title" for="__nav_5_4">
  353. <span class="md-nav__icon md-icon"></span>
  354. IBM
  355. </label>
  356. <ul class="md-nav__list" data-md-scrollfix>
  357. <li class="md-nav__item">
  358. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  359. Secrets Manager
  360. </a>
  361. </li>
  362. </ul>
  363. </nav>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="../provider-akeyless/" class="md-nav__link">
  367. Akeyless
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  372. HashiCorp Vault
  373. </a>
  374. </li>
  375. <li class="md-nav__item md-nav__item--nested">
  376. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  377. <label class="md-nav__link" for="__nav_5_7">
  378. Yandex
  379. <span class="md-nav__icon md-icon"></span>
  380. </label>
  381. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  382. <label class="md-nav__title" for="__nav_5_7">
  383. <span class="md-nav__icon md-icon"></span>
  384. Yandex
  385. </label>
  386. <ul class="md-nav__list" data-md-scrollfix>
  387. <li class="md-nav__item">
  388. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  389. Lockbox
  390. </a>
  391. </li>
  392. </ul>
  393. </nav>
  394. </li>
  395. <li class="md-nav__item md-nav__item--nested">
  396. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  397. <label class="md-nav__link" for="__nav_5_8">
  398. Gitlab
  399. <span class="md-nav__icon md-icon"></span>
  400. </label>
  401. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  402. <label class="md-nav__title" for="__nav_5_8">
  403. <span class="md-nav__icon md-icon"></span>
  404. Gitlab
  405. </label>
  406. <ul class="md-nav__list" data-md-scrollfix>
  407. <li class="md-nav__item">
  408. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  409. Gitlab Project Variables
  410. </a>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. <li class="md-nav__item md-nav__item--nested">
  416. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  417. <label class="md-nav__link" for="__nav_5_9">
  418. Oracle
  419. <span class="md-nav__icon md-icon"></span>
  420. </label>
  421. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  422. <label class="md-nav__title" for="__nav_5_9">
  423. <span class="md-nav__icon md-icon"></span>
  424. Oracle
  425. </label>
  426. <ul class="md-nav__list" data-md-scrollfix>
  427. <li class="md-nav__item">
  428. <a href="../provider-oracle-vault/" class="md-nav__link">
  429. Oracle Vault
  430. </a>
  431. </li>
  432. </ul>
  433. </nav>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="../provider-webhook/" class="md-nav__link">
  437. Webhook
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="../provider-fake/" class="md-nav__link">
  442. Fake
  443. </a>
  444. </li>
  445. <li class="md-nav__item md-nav__item--active">
  446. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  447. <label class="md-nav__link md-nav__link--active" for="__toc">
  448. Kubernetes
  449. <span class="md-nav__icon md-icon"></span>
  450. </label>
  451. <a href="./" class="md-nav__link md-nav__link--active">
  452. Kubernetes
  453. </a>
  454. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  455. <label class="md-nav__title" for="__toc">
  456. <span class="md-nav__icon md-icon"></span>
  457. Table of contents
  458. </label>
  459. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="#authentication" class="md-nav__link">
  462. Authentication
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="#example" class="md-nav__link">
  467. Example
  468. </a>
  469. <nav class="md-nav" aria-label="Example">
  470. <ul class="md-nav__list">
  471. <li class="md-nav__item">
  472. <a href="#in-cluster-secrets-using-a-token" class="md-nav__link">
  473. In-cluster secrets using a Token
  474. </a>
  475. </li>
  476. <li class="md-nav__item">
  477. <a href="#remote-secret-using-a-token" class="md-nav__link">
  478. Remote Secret using a Token
  479. </a>
  480. </li>
  481. </ul>
  482. </nav>
  483. </li>
  484. </ul>
  485. </nav>
  486. </li>
  487. </ul>
  488. </nav>
  489. </li>
  490. <li class="md-nav__item md-nav__item--nested">
  491. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  492. <label class="md-nav__link" for="__nav_6">
  493. Examples
  494. <span class="md-nav__icon md-icon"></span>
  495. </label>
  496. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  497. <label class="md-nav__title" for="__nav_6">
  498. <span class="md-nav__icon md-icon"></span>
  499. Examples
  500. </label>
  501. <ul class="md-nav__list" data-md-scrollfix>
  502. <li class="md-nav__item">
  503. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  504. FluxCD
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  509. Anchore Engine
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  514. Jenkins
  515. </a>
  516. </li>
  517. </ul>
  518. </nav>
  519. </li>
  520. <li class="md-nav__item md-nav__item--nested">
  521. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  522. <label class="md-nav__link" for="__nav_7">
  523. External Resources
  524. <span class="md-nav__icon md-icon"></span>
  525. </label>
  526. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  527. <label class="md-nav__title" for="__nav_7">
  528. <span class="md-nav__icon md-icon"></span>
  529. External Resources
  530. </label>
  531. <ul class="md-nav__list" data-md-scrollfix>
  532. <li class="md-nav__item">
  533. <a href="../eso-talks/" class="md-nav__link">
  534. Talks
  535. </a>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="../eso-demos/" class="md-nav__link">
  539. Demos
  540. </a>
  541. </li>
  542. <li class="md-nav__item">
  543. <a href="../eso-blogs/" class="md-nav__link">
  544. Blogs
  545. </a>
  546. </li>
  547. </ul>
  548. </nav>
  549. </li>
  550. <li class="md-nav__item md-nav__item--nested">
  551. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  552. <label class="md-nav__link" for="__nav_8">
  553. References
  554. <span class="md-nav__icon md-icon"></span>
  555. </label>
  556. <nav class="md-nav" aria-label="References" data-md-level="1">
  557. <label class="md-nav__title" for="__nav_8">
  558. <span class="md-nav__icon md-icon"></span>
  559. References
  560. </label>
  561. <ul class="md-nav__list" data-md-scrollfix>
  562. <li class="md-nav__item">
  563. <a href="../spec/" class="md-nav__link">
  564. API specification
  565. </a>
  566. </li>
  567. </ul>
  568. </nav>
  569. </li>
  570. <li class="md-nav__item md-nav__item--nested">
  571. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  572. <label class="md-nav__link" for="__nav_9">
  573. Contributing
  574. <span class="md-nav__icon md-icon"></span>
  575. </label>
  576. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  577. <label class="md-nav__title" for="__nav_9">
  578. <span class="md-nav__icon md-icon"></span>
  579. Contributing
  580. </label>
  581. <ul class="md-nav__list" data-md-scrollfix>
  582. <li class="md-nav__item">
  583. <a href="../contributing-devguide/" class="md-nav__link">
  584. Developer guide
  585. </a>
  586. </li>
  587. <li class="md-nav__item">
  588. <a href="../contributing-process/" class="md-nav__link">
  589. Contributing Process
  590. </a>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../contributing-release/" class="md-nav__link">
  594. Release Process
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../contributing-coc/" class="md-nav__link">
  599. Code of Conduct
  600. </a>
  601. </li>
  602. </ul>
  603. </nav>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../stability-support/" class="md-nav__link">
  607. Stability and Support
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../deprecation-policy/" class="md-nav__link">
  612. Deprecation Policy
  613. </a>
  614. </li>
  615. </ul>
  616. </nav>
  617. </div>
  618. </div>
  619. </div>
  620. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  621. <div class="md-sidebar__scrollwrap">
  622. <div class="md-sidebar__inner">
  623. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  624. <label class="md-nav__title" for="__toc">
  625. <span class="md-nav__icon md-icon"></span>
  626. Table of contents
  627. </label>
  628. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  629. <li class="md-nav__item">
  630. <a href="#authentication" class="md-nav__link">
  631. Authentication
  632. </a>
  633. </li>
  634. <li class="md-nav__item">
  635. <a href="#example" class="md-nav__link">
  636. Example
  637. </a>
  638. <nav class="md-nav" aria-label="Example">
  639. <ul class="md-nav__list">
  640. <li class="md-nav__item">
  641. <a href="#in-cluster-secrets-using-a-token" class="md-nav__link">
  642. In-cluster secrets using a Token
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="#remote-secret-using-a-token" class="md-nav__link">
  647. Remote Secret using a Token
  648. </a>
  649. </li>
  650. </ul>
  651. </nav>
  652. </li>
  653. </ul>
  654. </nav>
  655. </div>
  656. </div>
  657. </div>
  658. <div class="md-content" data-md-component="content">
  659. <article class="md-content__inner md-typeset">
  660. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-kubernetes.md" title="Edit this page" class="md-content__button md-icon">
  661. <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>
  662. </a>
  663. <h1>Kubernetes</h1>
  664. <p>External Secrets Operator allows to retrieve in-cluster secrets or from a remote Kubernetes Cluster.</p>
  665. <h3 id="authentication">Authentication</h3>
  666. <p>It's possible to authenticate against the Kubernetes API using client certificates or a bearer token. Authentication using a service account has not yet been implemented. The operator enforces that exactly one authentication method is used.</p>
  667. <p><strong>NOTE:</strong> <code>SelfSubjectAccessReview</code> permission is required for the service account in order to validation work properly.</p>
  668. <h2 id="example">Example</h2>
  669. <h3 id="in-cluster-secrets-using-a-token">In-cluster secrets using a Token</h3>
  670. <ol>
  671. <li>Create a K8s Secret with a client token for the default service account</li>
  672. </ol>
  673. <p><div class="highlight"><pre><span></span><code>apiVersion: v1
  674. kind: Secret
  675. metadata:
  676. name: mydefaulttoken
  677. annotations:
  678. kubernetes.io/service-account.name: default
  679. type: kubernetes.io/service-account-token
  680. </code></pre></div>
  681. 2. Create a SecretStore</p>
  682. <p>The Servers <code>url</code> won't be present as it will default to <code>kubernetes.default</code>, add a proper value if needed. In this example the Certificate Authority is fetched using the referenced <code>caProvider</code>.</p>
  683. <p>The <code>auth</code> section indicates that the type <code>token</code> will be used for authentication, it includes the path to fetch the token. Set <code>remoteNamespace</code> to the name of the namespace where your target secrets reside.</p>
  684. <p><div class="highlight"><pre><span></span><code>apiVersion: external-secrets.io/v1beta1
  685. kind: SecretStore
  686. metadata:
  687. name: example
  688. spec:
  689. provider:
  690. kubernetes:
  691. server:
  692. caProvider:
  693. type: Secret
  694. name: mydefaulttoken
  695. key: ca.crt
  696. auth:
  697. token:
  698. bearerToken:
  699. name: mydefaulttoken
  700. key: token
  701. remoteNamespace: default
  702. </code></pre></div>
  703. 3. Create the local secret that will be synced </p>
  704. <p><div class="highlight"><pre><span></span><code>---
  705. apiVersion: v1
  706. kind: Secret
  707. metadata:
  708. name: secret-example
  709. data:
  710. extra: YmFyCg==
  711. </code></pre></div>
  712. 4. Finally create the ExternalSecret resource</p>
  713. <div class="highlight"><pre><span></span><code>apiVersion: external-secrets.io/v1beta1
  714. kind: ExternalSecret
  715. metadata:
  716. name: example
  717. spec:
  718. refreshInterval: 1h
  719. secretStoreRef:
  720. kind: SecretStore
  721. name: example # name of the SecretStore (or kind specified)
  722. target:
  723. name: secret-to-be-created # name of the k8s Secret to be created
  724. creationPolicy: Owner
  725. data:
  726. - secretKey: extra
  727. remoteRef:
  728. key: secret-example
  729. property: extra
  730. </code></pre></div>
  731. <h3 id="remote-secret-using-a-token">Remote Secret using a Token</h3>
  732. <ol>
  733. <li>Create a K8s Secret with the encoded base64 ca and client token.</li>
  734. </ol>
  735. <p><div class="highlight"><pre><span></span><code>apiVersion: v1
  736. kind: Secret
  737. metadata:
  738. name: cluster-secrets
  739. data:
  740. # Fill with your encoded base64 CA
  741. certificate-authority-data: Cg==
  742. stringData:
  743. # Fill with your string Token
  744. bearerToken: &quot;my-token&quot;
  745. </code></pre></div>
  746. 2. Create a SecretStore</p>
  747. <p>The Server section specifies the <code>url</code> of the remote Kubernetes API. In this example the Certificate Authority is fetch using the encoded base64 <code>caBundle</code>. </p>
  748. <p>The <code>auth</code> section indicates that the <code>token</code> type will be used for authentication, it includes the path to fetch the token.</p>
  749. <p><div class="highlight"><pre><span></span><code>apiVersion: external-secrets.io/v1beta1
  750. kind: SecretStore
  751. metadata:
  752. name: example
  753. spec:
  754. provider:
  755. kubernetes:
  756. # If not remoteNamesapce is provided, default namespace is used
  757. remoteNamespace: remote-namespace
  758. server:
  759. url: https://remote.kubernetes.api-server.address
  760. # Add your encoded base64 to caBundle
  761. caBundle: Cg==
  762. auth:
  763. # Adds referenced bearerToken
  764. token:
  765. bearerToken:
  766. name: cluster-secrets
  767. key: bearerToken
  768. </code></pre></div>
  769. 4. Finally create the ExternalSecret resource</p>
  770. <div class="highlight"><pre><span></span><code>apiVersion: external-secrets.io/v1beta1
  771. kind: ExternalSecret
  772. metadata:
  773. name: example
  774. spec:
  775. refreshInterval: 1h
  776. secretStoreRef:
  777. kind: SecretStore
  778. name: example # name of the SecretStore (or kind specified)
  779. target:
  780. name: secret-to-be-created # name of the k8s Secret to be created
  781. creationPolicy: Owner
  782. data:
  783. - secretKey: extra
  784. remoteRef:
  785. key: secret-remote-example
  786. property: extra
  787. </code></pre></div>
  788. </article>
  789. </div>
  790. </div>
  791. </main>
  792. <footer class="md-footer">
  793. <nav class="md-footer__inner md-grid" aria-label="Footer">
  794. <a href="../provider-fake/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Fake" rel="prev">
  795. <div class="md-footer__button md-icon">
  796. <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>
  797. </div>
  798. <div class="md-footer__title">
  799. <div class="md-ellipsis">
  800. <span class="md-footer__direction">
  801. Previous
  802. </span>
  803. Fake
  804. </div>
  805. </div>
  806. </a>
  807. <a href="../examples-gitops-using-fluxcd/" class="md-footer__link md-footer__link--next" aria-label="Next: FluxCD" rel="next">
  808. <div class="md-footer__title">
  809. <div class="md-ellipsis">
  810. <span class="md-footer__direction">
  811. Next
  812. </span>
  813. FluxCD
  814. </div>
  815. </div>
  816. <div class="md-footer__button md-icon">
  817. <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>
  818. </div>
  819. </a>
  820. </nav>
  821. <div class="md-footer-meta md-typeset">
  822. <div class="md-footer-meta__inner md-grid">
  823. <div class="md-copyright">
  824. Made with
  825. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  826. Material for MkDocs
  827. </a>
  828. </div>
  829. </div>
  830. </div>
  831. </footer>
  832. </div>
  833. <div class="md-dialog" data-md-component="dialog">
  834. <div class="md-dialog__inner md-typeset"></div>
  835. </div>
  836. <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>
  837. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  838. </body>
  839. </html>