index.html 68 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339
  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="#external-secret-spec" 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. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../aws-secrets-manager/" class="md-tabs__link md-tabs__link--active">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <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>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <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>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/vault/" class="md-nav__link">
  294. Vault Dynamic Secret
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/password/" class="md-nav__link">
  299. Password
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../../api/generator/fake/" class="md-nav__link">
  304. Fake
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  312. <label class="md-nav__link" for="__nav_2_4">
  313. Reference Docs
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_2_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. Reference Docs
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../../api/spec/" class="md-nav__link">
  324. API specification
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/controller-options/" class="md-nav__link">
  329. Controller Options
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/metrics/" class="md-nav__link">
  334. Metrics
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  345. <label class="md-nav__link" for="__nav_3">
  346. Guides
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  350. <label class="md-nav__title" for="__nav_3">
  351. <span class="md-nav__icon md-icon"></span>
  352. Guides
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../../guides/introduction/" class="md-nav__link">
  357. Introduction
  358. </a>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  362. <label class="md-nav__link" for="__nav_3_2">
  363. Advanced Templating
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_3_2">
  368. <span class="md-nav__icon md-icon"></span>
  369. Advanced Templating
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../../guides/templating/" class="md-nav__link">
  374. v2
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../../guides/templating-v1/" class="md-nav__link">
  379. v1
  380. </a>
  381. </li>
  382. </ul>
  383. </nav>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../../guides/generator/" class="md-nav__link">
  387. Generators
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  392. All keys, One secret
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  397. Common K8S Secret Types
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../guides/controller-class/" class="md-nav__link">
  402. Controller Classes
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  407. Lifecycle: ownership & deletion
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  412. Decoding Strategies
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/getallsecrets/" class="md-nav__link">
  417. Getting Multiple Secrets
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  422. Multi Tenancy
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  427. Rewriting Keys
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../guides/v1beta1/" class="md-nav__link">
  432. Upgrading to v1beta1
  433. </a>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="../../guides/using-latest-image/" class="md-nav__link">
  437. Using Latest Image
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  442. Disable Cluster Features
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  449. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  450. <label class="md-nav__link" for="__nav_4">
  451. Provider
  452. <span class="md-nav__icon md-icon"></span>
  453. </label>
  454. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  455. <label class="md-nav__title" for="__nav_4">
  456. <span class="md-nav__icon md-icon"></span>
  457. Provider
  458. </label>
  459. <ul class="md-nav__list" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="../aws-secrets-manager/" class="md-nav__link">
  462. AWS Secrets Manager
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../aws-parameter-store/" class="md-nav__link">
  467. AWS Parameter Store
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../azure-key-vault/" class="md-nav__link">
  472. Azure Key Vault
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../google-secrets-manager/" class="md-nav__link">
  477. Google Cloud Secret Manager
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../ibm-secrets-manager/" class="md-nav__link">
  482. IBM Secrets Manager
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../akeyless/" class="md-nav__link">
  487. Akeyless
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../hashicorp-vault/" class="md-nav__link">
  492. HashiCorp Vault
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../yandex-certificate-manager/" class="md-nav__link">
  497. Yandex Certificate Manager
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../yandex-lockbox/" class="md-nav__link">
  502. Yandex Lockbox
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../alibaba/" class="md-nav__link">
  507. Alibaba Cloud
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../gitlab-variables/" class="md-nav__link">
  512. Gitlab Variables
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../oracle-vault/" class="md-nav__link">
  517. Oracle Vault
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../1password-automation/" class="md-nav__link">
  522. 1Password Secrets Automation
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../webhook/" class="md-nav__link">
  527. Webhook
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../fake/" class="md-nav__link">
  532. Fake
  533. </a>
  534. </li>
  535. <li class="md-nav__item md-nav__item--active">
  536. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  537. <label class="md-nav__link md-nav__link--active" for="__toc">
  538. Kubernetes
  539. <span class="md-nav__icon md-icon"></span>
  540. </label>
  541. <a href="./" class="md-nav__link md-nav__link--active">
  542. Kubernetes
  543. </a>
  544. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  545. <label class="md-nav__title" for="__toc">
  546. <span class="md-nav__icon md-icon"></span>
  547. Table of contents
  548. </label>
  549. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  550. <li class="md-nav__item">
  551. <a href="#external-secret-spec" class="md-nav__link">
  552. External Secret Spec
  553. </a>
  554. <nav class="md-nav" aria-label="External Secret Spec">
  555. <ul class="md-nav__list">
  556. <li class="md-nav__item">
  557. <a href="#find-by-tag-name" class="md-nav__link">
  558. find by tag &amp; name
  559. </a>
  560. </li>
  561. </ul>
  562. </nav>
  563. </li>
  564. <li class="md-nav__item">
  565. <a href="#target-api-server-configuration" class="md-nav__link">
  566. Target API-Server Configuration
  567. </a>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="#authentication" class="md-nav__link">
  571. Authentication
  572. </a>
  573. <nav class="md-nav" aria-label="Authentication">
  574. <ul class="md-nav__list">
  575. <li class="md-nav__item">
  576. <a href="#authenticating-with-bearertoken" class="md-nav__link">
  577. Authenticating with BearerToken
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="#authenticating-with-serviceaccount" class="md-nav__link">
  582. Authenticating with ServiceAccount
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="#authenticating-with-client-certificates" class="md-nav__link">
  587. Authenticating with Client Certificates
  588. </a>
  589. </li>
  590. </ul>
  591. </nav>
  592. </li>
  593. </ul>
  594. </nav>
  595. </li>
  596. <li class="md-nav__item">
  597. <a href="../senhasegura-dsm/" class="md-nav__link">
  598. senhasegura DevOps Secrets Management (DSM)
  599. </a>
  600. </li>
  601. <li class="md-nav__item">
  602. <a href="../doppler/" class="md-nav__link">
  603. Doppler
  604. </a>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="../keeper-security/" class="md-nav__link">
  608. Keeper Security
  609. </a>
  610. </li>
  611. <li class="md-nav__item">
  612. <a href="../scaleway/" class="md-nav__link">
  613. Scaleway
  614. </a>
  615. </li>
  616. </ul>
  617. </nav>
  618. </li>
  619. <li class="md-nav__item md-nav__item--nested">
  620. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  621. <label class="md-nav__link" for="__nav_5">
  622. Examples
  623. <span class="md-nav__icon md-icon"></span>
  624. </label>
  625. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  626. <label class="md-nav__title" for="__nav_5">
  627. <span class="md-nav__icon md-icon"></span>
  628. Examples
  629. </label>
  630. <ul class="md-nav__list" data-md-scrollfix>
  631. <li class="md-nav__item">
  632. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  633. FluxCD
  634. </a>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  638. Anchore Engine
  639. </a>
  640. </li>
  641. <li class="md-nav__item">
  642. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  643. Jenkins
  644. </a>
  645. </li>
  646. <li class="md-nav__item">
  647. <a href="../../examples/bitwarden/" class="md-nav__link">
  648. BitWarden
  649. </a>
  650. </li>
  651. </ul>
  652. </nav>
  653. </li>
  654. <li class="md-nav__item md-nav__item--nested">
  655. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  656. <label class="md-nav__link" for="__nav_6">
  657. Community
  658. <span class="md-nav__icon md-icon"></span>
  659. </label>
  660. <nav class="md-nav" aria-label="Community" data-md-level="1">
  661. <label class="md-nav__title" for="__nav_6">
  662. <span class="md-nav__icon md-icon"></span>
  663. Community
  664. </label>
  665. <ul class="md-nav__list" data-md-scrollfix>
  666. <li class="md-nav__item md-nav__item--nested">
  667. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  668. <label class="md-nav__link" for="__nav_6_1">
  669. Contributing
  670. <span class="md-nav__icon md-icon"></span>
  671. </label>
  672. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  673. <label class="md-nav__title" for="__nav_6_1">
  674. <span class="md-nav__icon md-icon"></span>
  675. Contributing
  676. </label>
  677. <ul class="md-nav__list" data-md-scrollfix>
  678. <li class="md-nav__item">
  679. <a href="../../contributing/devguide/" class="md-nav__link">
  680. Developer guide
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="../../contributing/process/" class="md-nav__link">
  685. Contributing Process
  686. </a>
  687. </li>
  688. <li class="md-nav__item">
  689. <a href="../../contributing/release/" class="md-nav__link">
  690. Release Process
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="../../contributing/coc/" class="md-nav__link">
  695. Code of Conduct
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../../contributing/roadmap/" class="md-nav__link">
  700. Roadmap
  701. </a>
  702. </li>
  703. </ul>
  704. </nav>
  705. </li>
  706. <li class="md-nav__item md-nav__item--nested">
  707. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  708. <label class="md-nav__link" for="__nav_6_2">
  709. External Resources
  710. <span class="md-nav__icon md-icon"></span>
  711. </label>
  712. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  713. <label class="md-nav__title" for="__nav_6_2">
  714. <span class="md-nav__icon md-icon"></span>
  715. External Resources
  716. </label>
  717. <ul class="md-nav__list" data-md-scrollfix>
  718. <li class="md-nav__item">
  719. <a href="../../eso-talks/" class="md-nav__link">
  720. Talks
  721. </a>
  722. </li>
  723. <li class="md-nav__item">
  724. <a href="../../eso-demos/" class="md-nav__link">
  725. Demos
  726. </a>
  727. </li>
  728. <li class="md-nav__item">
  729. <a href="../../eso-blogs/" class="md-nav__link">
  730. Blogs
  731. </a>
  732. </li>
  733. </ul>
  734. </nav>
  735. </li>
  736. </ul>
  737. </nav>
  738. </li>
  739. </ul>
  740. </nav>
  741. </div>
  742. </div>
  743. </div>
  744. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  745. <div class="md-sidebar__scrollwrap">
  746. <div class="md-sidebar__inner">
  747. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  748. <label class="md-nav__title" for="__toc">
  749. <span class="md-nav__icon md-icon"></span>
  750. Table of contents
  751. </label>
  752. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  753. <li class="md-nav__item">
  754. <a href="#external-secret-spec" class="md-nav__link">
  755. External Secret Spec
  756. </a>
  757. <nav class="md-nav" aria-label="External Secret Spec">
  758. <ul class="md-nav__list">
  759. <li class="md-nav__item">
  760. <a href="#find-by-tag-name" class="md-nav__link">
  761. find by tag &amp; name
  762. </a>
  763. </li>
  764. </ul>
  765. </nav>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="#target-api-server-configuration" class="md-nav__link">
  769. Target API-Server Configuration
  770. </a>
  771. </li>
  772. <li class="md-nav__item">
  773. <a href="#authentication" class="md-nav__link">
  774. Authentication
  775. </a>
  776. <nav class="md-nav" aria-label="Authentication">
  777. <ul class="md-nav__list">
  778. <li class="md-nav__item">
  779. <a href="#authenticating-with-bearertoken" class="md-nav__link">
  780. Authenticating with BearerToken
  781. </a>
  782. </li>
  783. <li class="md-nav__item">
  784. <a href="#authenticating-with-serviceaccount" class="md-nav__link">
  785. Authenticating with ServiceAccount
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="#authenticating-with-client-certificates" class="md-nav__link">
  790. Authenticating with Client Certificates
  791. </a>
  792. </li>
  793. </ul>
  794. </nav>
  795. </li>
  796. </ul>
  797. </nav>
  798. </div>
  799. </div>
  800. </div>
  801. <div class="md-content" data-md-component="content">
  802. <article class="md-content__inner md-typeset">
  803. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/provider/kubernetes.md" title="Edit this page" class="md-content__button md-icon">
  804. <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>
  805. </a>
  806. <h1>Kubernetes</h1>
  807. <p>External Secrets Operator allows to retrieve secrets from a Kubernetes Cluster - this can be either a remote cluster or the local one where the operator runs in.</p>
  808. <p>A <code>SecretStore</code> points to a <strong>specific namespace</strong> in the target Kubernetes Cluster. You are able to retrieve all secrets from that particular namespace given you have the correct set of RBAC permissions.</p>
  809. <p>The <code>SecretStore</code> reconciler checks if you have read access for secrets in that namespace using <code>SelfSubjectRulesReview</code>. See below on how to set that up properly.</p>
  810. <h3 id="external-secret-spec">External Secret Spec</h3>
  811. <p>This provider supports the use of the <code>Property</code> field. With it you point to the key of the remote secret. If you leave it empty it will json encode all key/value pairs.</p>
  812. <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>
  813. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  814. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  815. <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">database-credentials</span><span class="w"></span>
  816. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  817. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  818. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  819. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  820. <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">k8s-store</span><span class="w"> </span><span class="c1"># name of the SecretStore (or kind specified)</span><span class="w"></span>
  821. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  822. <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">database-credentials</span><span class="w"> </span><span class="c1"># name of the k8s Secret to be created</span><span class="w"></span>
  823. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  824. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span><span class="w"></span>
  825. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  826. <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">database-credentials</span><span class="w"></span>
  827. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span><span class="w"></span>
  828. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span><span class="w"></span>
  829. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  830. <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">database-credentials</span><span class="w"></span>
  831. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span><span class="w"></span>
  832. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the labels and annotations in JSON format</span><span class="w"></span>
  833. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tags</span><span class="w"></span>
  834. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  835. <span class="w"> </span><span class="nt">metadataPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Fetch</span><span class="w"> </span>
  836. <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">database-credentials</span><span class="w"></span>
  837. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the labels in JSON format</span><span class="w"></span>
  838. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">labels</span><span class="w"></span>
  839. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  840. <span class="w"> </span><span class="nt">metadataPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Fetch</span><span class="w"> </span>
  841. <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">database-credentials</span><span class="w"></span>
  842. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">labels</span><span class="w"></span>
  843. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific label (dev) from the source secret</span><span class="w"></span>
  844. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">developer</span><span class="w"></span>
  845. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  846. <span class="w"> </span><span class="nt">metadataPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Fetch</span><span class="w"> </span>
  847. <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">database-credentials</span><span class="w"></span>
  848. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">labels.dev</span><span class="w"></span>
  849. </code></pre></div>
  850. <h4 id="find-by-tag-name">find by tag &amp; name</h4>
  851. <p>You can fetch secrets based on labels or names matching a regexp:</p>
  852. <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>
  853. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  854. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  855. <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">fetch-tls-and-nginx</span><span class="w"></span>
  856. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  857. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  858. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  859. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  860. <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">k8s-store</span><span class="w"></span>
  861. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  862. <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">fetch-tls-and-nginx</span><span class="w"></span>
  863. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  864. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
  865. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"></span>
  866. <span class="w"> </span><span class="c1"># match secret name with regexp</span><span class="w"></span>
  867. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls-.*&quot;</span><span class="w"></span>
  868. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
  869. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"></span>
  870. <span class="w"> </span><span class="c1"># fetch secrets based on label combination</span><span class="w"></span>
  871. <span class="w"> </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;nginx&quot;</span><span class="w"></span>
  872. </code></pre></div>
  873. <h3 id="target-api-server-configuration">Target API-Server Configuration</h3>
  874. <p>The servers <code>url</code> can be omitted and defaults to <code>kubernetes.default</code>. You <strong>have to</strong> provide a CA certificate in order to connect to the API Server securely.
  875. For your convenience, each namespace has a ConfigMap <code>kube-root-ca.crt</code> that contains the CA certificate of the internal API Server (see <code>RootCAConfigMap</code> <a href="https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/">feature gate</a>).
  876. Use that if you want to connect to the same API server.
  877. If you want to connect to a remote API Server you need to fetch it and store it inside the cluster as ConfigMap or Secret.
  878. You may also define it inline as base64 encoded value using the <code>caBundle</code> property.</p>
  879. <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>
  880. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  881. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  882. <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">k8s-store-default-ns</span><span class="w"></span>
  883. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  884. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  885. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  886. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span><span class="w"></span>
  887. <span class="w"> </span><span class="nt">remoteNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"></span>
  888. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
  889. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://myapiserver.tld&quot;</span><span class="w"></span>
  890. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span><span class="w"></span>
  891. <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">ConfigMap</span><span class="w"></span>
  892. <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">kube-root-ca.crt</span><span class="w"></span>
  893. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ca.crt</span><span class="w"></span>
  894. </code></pre></div>
  895. <h3 id="authentication">Authentication</h3>
  896. <p>It's possible to authenticate against the Kubernetes API using client certificates, a bearer token or service account. The operator enforces that exactly one authentication method is used. You can not use the service account that is mounted inside the operator, this is by design to avoid reading secrets across namespaces.</p>
  897. <p><strong>NOTE:</strong> <code>SelfSubjectRulesReview</code> permission is required in order to validation work properly. Please use the following role as reference:</p>
  898. <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">rbac.authorization.k8s.io/v1</span><span class="w"></span>
  899. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Role</span><span class="w"></span>
  900. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  901. <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">default</span><span class="w"></span>
  902. <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">eso-store-role</span><span class="w"></span>
  903. <span class="nt">rules</span><span class="p">:</span><span class="w"></span>
  904. <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">apiGroups</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;&quot;</span><span class="p p-Indicator">]</span><span class="w"></span>
  905. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span><span class="w"></span>
  906. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secrets</span><span class="w"></span>
  907. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span><span class="w"></span>
  908. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">get</span><span class="w"></span>
  909. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">list</span><span class="w"></span>
  910. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watch</span><span class="w"></span>
  911. <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">apiGroups</span><span class="p">:</span><span class="w"></span>
  912. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">authorization.k8s.io</span><span class="w"></span>
  913. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span><span class="w"></span>
  914. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">selfsubjectrulesreviews</span><span class="w"></span>
  915. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span><span class="w"></span>
  916. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create</span><span class="w"></span>
  917. </code></pre></div>
  918. <h4 id="authenticating-with-bearertoken">Authenticating with BearerToken</h4>
  919. <p>Create a Kubernetes secret with a client token. There are many ways to acquire such a token, please refer to the <a href="https://kubernetes.io/docs/reference/access-authn-authz/authentication/#authentication-strategies">Kubernetes Authentication docs</a>.</p>
  920. <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">v1</span><span class="w"></span>
  921. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  922. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  923. <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-token</span><span class="w"></span>
  924. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  925. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;....&quot;</span><span class="w"></span>
  926. </code></pre></div>
  927. <p>Create a SecretStore: 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>
  928. <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>
  929. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  930. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  931. <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">k8s-store-token-auth</span><span class="w"></span>
  932. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  933. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  934. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  935. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span><span class="w"></span>
  936. <span class="w"> </span><span class="nt">remoteNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"></span>
  937. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
  938. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  939. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  940. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"></span>
  941. <span class="w"> </span><span class="nt">bearerToken</span><span class="p">:</span><span class="w"></span>
  942. <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-token</span><span class="w"></span>
  943. <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">token</span><span class="w"></span>
  944. </code></pre></div>
  945. <h4 id="authenticating-with-serviceaccount">Authenticating with ServiceAccount</h4>
  946. <p>Create a Kubernetes Service Account, please refer to the <a href="https://kubernetes.io/docs/reference/access-authn-authz/authentication/#service-account-tokens">Service Account Tokens Documentation</a> on how they work and how to create them.</p>
  947. <div class="highlight"><pre><span></span><code>$ kubectl create serviceaccount my-store
  948. </code></pre></div>
  949. <p>This Service Account needs permissions to read <code>Secret</code> and create <code>SelfSubjectRulesReview</code> resources. Please see the above role.</p>
  950. <div class="highlight"><pre><span></span><code>$ kubectl create rolebinding my-store --role=eso-store-role --serviceaccount=default:my-store
  951. </code></pre></div>
  952. <p>Create a SecretStore: the <code>auth</code> section indicates that the type <code>serviceAccount</code> will be used for authentication.</p>
  953. <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>
  954. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  955. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  956. <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">k8s-store-sa-auth</span><span class="w"></span>
  957. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  958. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  959. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  960. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span><span class="w"></span>
  961. <span class="w"> </span><span class="nt">remoteNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"></span>
  962. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
  963. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  964. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  965. <span class="w"> </span><span class="nt">serviceAccount</span><span class="p">:</span><span class="w"></span>
  966. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-store&quot;</span><span class="w"></span>
  967. </code></pre></div>
  968. <h4 id="authenticating-with-client-certificates">Authenticating with Client Certificates</h4>
  969. <p>Create a Kubernetes secret which contains the client key and certificate. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/certificates/">Generate Certificates Documentations</a> on how to create them.</p>
  970. <div class="highlight"><pre><span></span><code>$ kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
  971. </code></pre></div>
  972. <p>Reference the <code>tls-secret</code> in the SecretStore</p>
  973. <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>
  974. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  975. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  976. <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">k8s-store-cert-auth</span><span class="w"></span>
  977. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  978. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  979. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  980. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span><span class="w"></span>
  981. <span class="w"> </span><span class="nt">remoteNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"></span>
  982. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
  983. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  984. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  985. <span class="w"> </span><span class="nt">cert</span><span class="p">:</span><span class="w"></span>
  986. <span class="w"> </span><span class="nt">clientCert</span><span class="p">:</span><span class="w"></span>
  987. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls-secret&quot;</span><span class="w"></span>
  988. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls.crt&quot;</span><span class="w"></span>
  989. <span class="w"> </span><span class="nt">clientKey</span><span class="p">:</span><span class="w"></span>
  990. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls-secret&quot;</span><span class="w"></span>
  991. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls.key&quot;</span><span class="w"></span>
  992. </code></pre></div>
  993. </article>
  994. </div>
  995. </div>
  996. </main>
  997. <footer class="md-footer">
  998. <nav class="md-footer__inner md-grid" aria-label="Footer">
  999. <a href="../fake/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Fake" rel="prev">
  1000. <div class="md-footer__button md-icon">
  1001. <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>
  1002. </div>
  1003. <div class="md-footer__title">
  1004. <div class="md-ellipsis">
  1005. <span class="md-footer__direction">
  1006. Previous
  1007. </span>
  1008. Fake
  1009. </div>
  1010. </div>
  1011. </a>
  1012. <a href="../senhasegura-dsm/" class="md-footer__link md-footer__link--next" aria-label="Next: senhasegura DevOps Secrets Management (DSM)" rel="next">
  1013. <div class="md-footer__title">
  1014. <div class="md-ellipsis">
  1015. <span class="md-footer__direction">
  1016. Next
  1017. </span>
  1018. senhasegura DevOps Secrets Management (DSM)
  1019. </div>
  1020. </div>
  1021. <div class="md-footer__button md-icon">
  1022. <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>
  1023. </div>
  1024. </a>
  1025. </nav>
  1026. <div class="md-footer-meta md-typeset">
  1027. <div class="md-footer-meta__inner md-grid">
  1028. <div class="md-copyright">
  1029. <div class="md-copyright__highlight">
  1030. &copy; 2023 The external-secrets Authors.<br/>
  1031. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1032. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1033. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1034. </div>
  1035. Made with
  1036. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1037. Material for MkDocs
  1038. </a>
  1039. </div>
  1040. </div>
  1041. </div>
  1042. </footer>
  1043. </div>
  1044. <div class="md-dialog" data-md-component="dialog">
  1045. <div class="md-dialog__inner md-typeset"></div>
  1046. </div>
  1047. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "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>
  1048. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1049. </body>
  1050. </html>