index.html 76 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561
  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="prev" href="../hashicorp-vault/">
  7. <link rel="next" href="../ibm-secrets-manager/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.9">
  10. <title>Kubernetes - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.85bb2934.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__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>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#external-secret-spec" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <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>
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Kubernetes
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <label class="md-header__button md-icon" for="__search">
  65. <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>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <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>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <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>
  74. <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>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <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>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../aws-secrets-manager/" class="md-tabs__link md-tabs__link--active">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <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>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--nested">
  167. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  168. <div class="md-nav__link md-nav__link--index ">
  169. <a href="../..">Introduction</a>
  170. <label for="__nav_1">
  171. <span class="md-nav__icon md-icon"></span>
  172. </label>
  173. </div>
  174. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  175. <label class="md-nav__title" for="__nav_1">
  176. <span class="md-nav__icon md-icon"></span>
  177. Introduction
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../../introduction/overview/" class="md-nav__link">
  182. Overview
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../../introduction/getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../introduction/faq/" class="md-nav__link">
  192. FAQ
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/stability-support/" class="md-nav__link">
  197. Stability and Support
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  202. Deprecation Policy
  203. </a>
  204. </li>
  205. </ul>
  206. </nav>
  207. </li>
  208. <li class="md-nav__item md-nav__item--nested">
  209. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  210. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  211. API
  212. <span class="md-nav__icon md-icon"></span>
  213. </label>
  214. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  215. <label class="md-nav__title" for="__nav_2">
  216. <span class="md-nav__icon md-icon"></span>
  217. API
  218. </label>
  219. <ul class="md-nav__list" data-md-scrollfix>
  220. <li class="md-nav__item">
  221. <a href="../../api/components/" class="md-nav__link">
  222. Components
  223. </a>
  224. </li>
  225. <li class="md-nav__item md-nav__item--nested">
  226. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  227. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  228. Core Resources
  229. <span class="md-nav__icon md-icon"></span>
  230. </label>
  231. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  232. <label class="md-nav__title" for="__nav_2_2">
  233. <span class="md-nav__icon md-icon"></span>
  234. Core Resources
  235. </label>
  236. <ul class="md-nav__list" data-md-scrollfix>
  237. <li class="md-nav__item">
  238. <a href="../../api/externalsecret/" class="md-nav__link">
  239. ExternalSecret
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../../api/secretstore/" class="md-nav__link">
  244. SecretStore
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../../api/clustersecretstore/" class="md-nav__link">
  249. ClusterSecretStore
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  254. ClusterExternalSecret
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="../../api/pushsecret/" class="md-nav__link">
  259. PushSecret
  260. </a>
  261. </li>
  262. </ul>
  263. </nav>
  264. </li>
  265. <li class="md-nav__item md-nav__item--nested">
  266. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  267. <div class="md-nav__link md-nav__link--index ">
  268. <a href="../../api/generator/">Generators</a>
  269. <label for="__nav_2_3">
  270. <span class="md-nav__icon md-icon"></span>
  271. </label>
  272. </div>
  273. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  274. <label class="md-nav__title" for="__nav_2_3">
  275. <span class="md-nav__icon md-icon"></span>
  276. Generators
  277. </label>
  278. <ul class="md-nav__list" data-md-scrollfix>
  279. <li class="md-nav__item">
  280. <a href="../../api/generator/acr/" class="md-nav__link">
  281. Azure Container Registry
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="../../api/generator/ecr/" class="md-nav__link">
  286. AWS Elastic Container Registry
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/generator/gcr/" class="md-nav__link">
  291. Google Container Registry
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="../../api/generator/vault/" class="md-nav__link">
  296. Vault Dynamic Secret
  297. </a>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="../../api/generator/password/" class="md-nav__link">
  301. Password
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="../../api/generator/fake/" class="md-nav__link">
  306. Fake
  307. </a>
  308. </li>
  309. </ul>
  310. </nav>
  311. </li>
  312. <li class="md-nav__item md-nav__item--nested">
  313. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  314. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  315. Reference Docs
  316. <span class="md-nav__icon md-icon"></span>
  317. </label>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_4">
  320. <span class="md-nav__icon md-icon"></span>
  321. Reference Docs
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../../api/spec/" class="md-nav__link">
  326. API specification
  327. </a>
  328. </li>
  329. <li class="md-nav__item">
  330. <a href="../../api/controller-options/" class="md-nav__link">
  331. Controller Options
  332. </a>
  333. </li>
  334. <li class="md-nav__item">
  335. <a href="../../api/metrics/" class="md-nav__link">
  336. Metrics
  337. </a>
  338. </li>
  339. </ul>
  340. </nav>
  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 md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  347. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  348. Guides
  349. <span class="md-nav__icon md-icon"></span>
  350. </label>
  351. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  352. <label class="md-nav__title" for="__nav_3">
  353. <span class="md-nav__icon md-icon"></span>
  354. Guides
  355. </label>
  356. <ul class="md-nav__list" data-md-scrollfix>
  357. <li class="md-nav__item">
  358. <a href="../../guides/introduction/" class="md-nav__link">
  359. Introduction
  360. </a>
  361. </li>
  362. <li class="md-nav__item md-nav__item--nested">
  363. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  364. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  365. External Secrets
  366. <span class="md-nav__icon md-icon"></span>
  367. </label>
  368. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  369. <label class="md-nav__title" for="__nav_3_2">
  370. <span class="md-nav__icon md-icon"></span>
  371. External Secrets
  372. </label>
  373. <ul class="md-nav__list" data-md-scrollfix>
  374. <li class="md-nav__item">
  375. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  376. Extract structured data
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="../../guides/getallsecrets/" class="md-nav__link">
  381. Find Secrets by Name or Metadata
  382. </a>
  383. </li>
  384. <li class="md-nav__item">
  385. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  386. Rewriting Keys
  387. </a>
  388. </li>
  389. <li class="md-nav__item md-nav__item--nested">
  390. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  391. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  392. Advanced Templating
  393. <span class="md-nav__icon md-icon"></span>
  394. </label>
  395. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  396. <label class="md-nav__title" for="__nav_3_2_4">
  397. <span class="md-nav__icon md-icon"></span>
  398. Advanced Templating
  399. </label>
  400. <ul class="md-nav__list" data-md-scrollfix>
  401. <li class="md-nav__item">
  402. <a href="../../guides/templating/" class="md-nav__link">
  403. v2
  404. </a>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="../../guides/templating-v1/" class="md-nav__link">
  408. v1
  409. </a>
  410. </li>
  411. </ul>
  412. </nav>
  413. </li>
  414. <li class="md-nav__item">
  415. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  416. Kubernetes Secret Types
  417. </a>
  418. </li>
  419. <li class="md-nav__item">
  420. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  421. Lifecycle: ownership & deletion
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  426. Decoding Strategies
  427. </a>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="../../guides/controller-class/" class="md-nav__link">
  431. Controller Classes
  432. </a>
  433. </li>
  434. </ul>
  435. </nav>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="../../guides/generator/" class="md-nav__link">
  439. Generators
  440. </a>
  441. </li>
  442. <li class="md-nav__item md-nav__item--nested">
  443. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
  444. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  445. Operations
  446. <span class="md-nav__icon md-icon"></span>
  447. </label>
  448. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
  449. <label class="md-nav__title" for="__nav_3_4">
  450. <span class="md-nav__icon md-icon"></span>
  451. Operations
  452. </label>
  453. <ul class="md-nav__list" data-md-scrollfix>
  454. <li class="md-nav__item">
  455. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  456. Multi Tenancy
  457. </a>
  458. </li>
  459. <li class="md-nav__item">
  460. <a href="../../guides/security-best-practices/" class="md-nav__link">
  461. Security Best Practices
  462. </a>
  463. </li>
  464. <li class="md-nav__item">
  465. <a href="../../guides/v1beta1/" class="md-nav__link">
  466. Upgrading to v1beta1
  467. </a>
  468. </li>
  469. <li class="md-nav__item">
  470. <a href="../../guides/using-latest-image/" class="md-nav__link">
  471. Using Latest Image
  472. </a>
  473. </li>
  474. <li class="md-nav__item">
  475. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  476. Disable Cluster Features
  477. </a>
  478. </li>
  479. </ul>
  480. </nav>
  481. </li>
  482. </ul>
  483. </nav>
  484. </li>
  485. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  486. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  487. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  488. Provider
  489. <span class="md-nav__icon md-icon"></span>
  490. </label>
  491. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  492. <label class="md-nav__title" for="__nav_4">
  493. <span class="md-nav__icon md-icon"></span>
  494. Provider
  495. </label>
  496. <ul class="md-nav__list" data-md-scrollfix>
  497. <li class="md-nav__item">
  498. <a href="../aws-secrets-manager/" class="md-nav__link">
  499. AWS Secrets Manager
  500. </a>
  501. </li>
  502. <li class="md-nav__item">
  503. <a href="../aws-parameter-store/" class="md-nav__link">
  504. AWS Parameter Store
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="../azure-key-vault/" class="md-nav__link">
  509. Azure Key Vault
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../google-secrets-manager/" class="md-nav__link">
  514. Google Cloud Secret Manager
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="../hashicorp-vault/" class="md-nav__link">
  519. HashiCorp Vault
  520. </a>
  521. </li>
  522. <li class="md-nav__item md-nav__item--active">
  523. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  524. <label class="md-nav__link md-nav__link--active" for="__toc">
  525. Kubernetes
  526. <span class="md-nav__icon md-icon"></span>
  527. </label>
  528. <a href="./" class="md-nav__link md-nav__link--active">
  529. Kubernetes
  530. </a>
  531. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  532. <label class="md-nav__title" for="__toc">
  533. <span class="md-nav__icon md-icon"></span>
  534. Table of contents
  535. </label>
  536. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  537. <li class="md-nav__item">
  538. <a href="#external-secret-spec" class="md-nav__link">
  539. External Secret Spec
  540. </a>
  541. <nav class="md-nav" aria-label="External Secret Spec">
  542. <ul class="md-nav__list">
  543. <li class="md-nav__item">
  544. <a href="#find-by-tag-name" class="md-nav__link">
  545. find by tag &amp; name
  546. </a>
  547. </li>
  548. </ul>
  549. </nav>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="#target-api-server-configuration" class="md-nav__link">
  553. Target API-Server Configuration
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="#authentication" class="md-nav__link">
  558. Authentication
  559. </a>
  560. <nav class="md-nav" aria-label="Authentication">
  561. <ul class="md-nav__list">
  562. <li class="md-nav__item">
  563. <a href="#authenticating-with-bearertoken" class="md-nav__link">
  564. Authenticating with BearerToken
  565. </a>
  566. </li>
  567. <li class="md-nav__item">
  568. <a href="#authenticating-with-serviceaccount" class="md-nav__link">
  569. Authenticating with ServiceAccount
  570. </a>
  571. </li>
  572. <li class="md-nav__item">
  573. <a href="#authenticating-with-client-certificates" class="md-nav__link">
  574. Authenticating with Client Certificates
  575. </a>
  576. </li>
  577. </ul>
  578. </nav>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="#pushsecret" class="md-nav__link">
  582. PushSecret
  583. </a>
  584. <nav class="md-nav" aria-label="PushSecret">
  585. <ul class="md-nav__list">
  586. <li class="md-nav__item">
  587. <a href="#implementation-considerations" class="md-nav__link">
  588. Implementation Considerations
  589. </a>
  590. </li>
  591. </ul>
  592. </nav>
  593. </li>
  594. </ul>
  595. </nav>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../ibm-secrets-manager/" class="md-nav__link">
  599. IBM Secrets Manager
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../akeyless/" class="md-nav__link">
  604. Akeyless
  605. </a>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="../yandex-certificate-manager/" class="md-nav__link">
  609. Yandex Certificate Manager
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../yandex-lockbox/" class="md-nav__link">
  614. Yandex Lockbox
  615. </a>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="../alibaba/" class="md-nav__link">
  619. Alibaba Cloud
  620. </a>
  621. </li>
  622. <li class="md-nav__item">
  623. <a href="../gitlab-variables/" class="md-nav__link">
  624. GitLab Variables
  625. </a>
  626. </li>
  627. <li class="md-nav__item">
  628. <a href="../oracle-vault/" class="md-nav__link">
  629. Oracle Vault
  630. </a>
  631. </li>
  632. <li class="md-nav__item">
  633. <a href="../1password-automation/" class="md-nav__link">
  634. 1Password Secrets Automation
  635. </a>
  636. </li>
  637. <li class="md-nav__item">
  638. <a href="../webhook/" class="md-nav__link">
  639. Webhook
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../fake/" class="md-nav__link">
  644. Fake
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../senhasegura-dsm/" class="md-nav__link">
  649. senhasegura DevOps Secrets Management (DSM)
  650. </a>
  651. </li>
  652. <li class="md-nav__item">
  653. <a href="../doppler/" class="md-nav__link">
  654. Doppler
  655. </a>
  656. </li>
  657. <li class="md-nav__item">
  658. <a href="../keeper-security/" class="md-nav__link">
  659. Keeper Security
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../scaleway/" class="md-nav__link">
  664. Scaleway
  665. </a>
  666. </li>
  667. </ul>
  668. </nav>
  669. </li>
  670. <li class="md-nav__item md-nav__item--nested">
  671. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  672. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  673. Examples
  674. <span class="md-nav__icon md-icon"></span>
  675. </label>
  676. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  677. <label class="md-nav__title" for="__nav_5">
  678. <span class="md-nav__icon md-icon"></span>
  679. Examples
  680. </label>
  681. <ul class="md-nav__list" data-md-scrollfix>
  682. <li class="md-nav__item">
  683. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  684. FluxCD
  685. </a>
  686. </li>
  687. <li class="md-nav__item">
  688. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  689. Anchore Engine
  690. </a>
  691. </li>
  692. <li class="md-nav__item">
  693. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  694. Jenkins
  695. </a>
  696. </li>
  697. <li class="md-nav__item">
  698. <a href="../../examples/bitwarden/" class="md-nav__link">
  699. BitWarden
  700. </a>
  701. </li>
  702. </ul>
  703. </nav>
  704. </li>
  705. <li class="md-nav__item md-nav__item--nested">
  706. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  707. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  708. Community
  709. <span class="md-nav__icon md-icon"></span>
  710. </label>
  711. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  712. <label class="md-nav__title" for="__nav_6">
  713. <span class="md-nav__icon md-icon"></span>
  714. Community
  715. </label>
  716. <ul class="md-nav__list" data-md-scrollfix>
  717. <li class="md-nav__item md-nav__item--nested">
  718. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  719. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  720. Contributing
  721. <span class="md-nav__icon md-icon"></span>
  722. </label>
  723. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  724. <label class="md-nav__title" for="__nav_6_1">
  725. <span class="md-nav__icon md-icon"></span>
  726. Contributing
  727. </label>
  728. <ul class="md-nav__list" data-md-scrollfix>
  729. <li class="md-nav__item">
  730. <a href="../../contributing/devguide/" class="md-nav__link">
  731. Developer guide
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="../../contributing/process/" class="md-nav__link">
  736. Contributing Process
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="../../contributing/release/" class="md-nav__link">
  741. Release Process
  742. </a>
  743. </li>
  744. <li class="md-nav__item">
  745. <a href="../../contributing/coc/" class="md-nav__link">
  746. Code of Conduct
  747. </a>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="../../contributing/roadmap/" class="md-nav__link">
  751. Roadmap
  752. </a>
  753. </li>
  754. </ul>
  755. </nav>
  756. </li>
  757. <li class="md-nav__item md-nav__item--nested">
  758. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  759. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  760. External Resources
  761. <span class="md-nav__icon md-icon"></span>
  762. </label>
  763. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  764. <label class="md-nav__title" for="__nav_6_2">
  765. <span class="md-nav__icon md-icon"></span>
  766. External Resources
  767. </label>
  768. <ul class="md-nav__list" data-md-scrollfix>
  769. <li class="md-nav__item">
  770. <a href="../../eso-talks/" class="md-nav__link">
  771. Talks
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../../eso-demos/" class="md-nav__link">
  776. Demos
  777. </a>
  778. </li>
  779. <li class="md-nav__item">
  780. <a href="../../eso-blogs/" class="md-nav__link">
  781. Blogs
  782. </a>
  783. </li>
  784. </ul>
  785. </nav>
  786. </li>
  787. </ul>
  788. </nav>
  789. </li>
  790. </ul>
  791. </nav>
  792. </div>
  793. </div>
  794. </div>
  795. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  796. <div class="md-sidebar__scrollwrap">
  797. <div class="md-sidebar__inner">
  798. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  799. <label class="md-nav__title" for="__toc">
  800. <span class="md-nav__icon md-icon"></span>
  801. Table of contents
  802. </label>
  803. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  804. <li class="md-nav__item">
  805. <a href="#external-secret-spec" class="md-nav__link">
  806. External Secret Spec
  807. </a>
  808. <nav class="md-nav" aria-label="External Secret Spec">
  809. <ul class="md-nav__list">
  810. <li class="md-nav__item">
  811. <a href="#find-by-tag-name" class="md-nav__link">
  812. find by tag &amp; name
  813. </a>
  814. </li>
  815. </ul>
  816. </nav>
  817. </li>
  818. <li class="md-nav__item">
  819. <a href="#target-api-server-configuration" class="md-nav__link">
  820. Target API-Server Configuration
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="#authentication" class="md-nav__link">
  825. Authentication
  826. </a>
  827. <nav class="md-nav" aria-label="Authentication">
  828. <ul class="md-nav__list">
  829. <li class="md-nav__item">
  830. <a href="#authenticating-with-bearertoken" class="md-nav__link">
  831. Authenticating with BearerToken
  832. </a>
  833. </li>
  834. <li class="md-nav__item">
  835. <a href="#authenticating-with-serviceaccount" class="md-nav__link">
  836. Authenticating with ServiceAccount
  837. </a>
  838. </li>
  839. <li class="md-nav__item">
  840. <a href="#authenticating-with-client-certificates" class="md-nav__link">
  841. Authenticating with Client Certificates
  842. </a>
  843. </li>
  844. </ul>
  845. </nav>
  846. </li>
  847. <li class="md-nav__item">
  848. <a href="#pushsecret" class="md-nav__link">
  849. PushSecret
  850. </a>
  851. <nav class="md-nav" aria-label="PushSecret">
  852. <ul class="md-nav__list">
  853. <li class="md-nav__item">
  854. <a href="#implementation-considerations" class="md-nav__link">
  855. Implementation Considerations
  856. </a>
  857. </li>
  858. </ul>
  859. </nav>
  860. </li>
  861. </ul>
  862. </nav>
  863. </div>
  864. </div>
  865. </div>
  866. <div class="md-content" data-md-component="content">
  867. <article class="md-content__inner md-typeset">
  868. <h1>Kubernetes</h1>
  869. <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>
  870. <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>
  871. <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>
  872. <h3 id="external-secret-spec">External Secret Spec</h3>
  873. <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>
  874. <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>
  875. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  876. <span class="nt">metadata</span><span class="p">:</span>
  877. <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>
  878. <span class="nt">spec</span><span class="p">:</span>
  879. <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>
  880. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  881. <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>
  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</span><span class="w"> </span><span class="c1"># name of the SecretStore (or kind specified)</span>
  883. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  884. <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>
  885. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  886. <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>
  887. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  888. <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>
  889. <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>
  890. <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>
  891. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  892. <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>
  893. <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>
  894. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the labels and annotations in JSON format</span>
  895. <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>
  896. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  897. <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>
  898. <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>
  899. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the labels in JSON format</span>
  900. <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>
  901. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  902. <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>
  903. <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>
  904. <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>
  905. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific label (dev) from the source secret</span>
  906. <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>
  907. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  908. <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>
  909. <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>
  910. <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>
  911. </code></pre></div>
  912. <h4 id="find-by-tag-name">find by tag &amp; name</h4>
  913. <p>You can fetch secrets based on labels or names matching a regexp:</p>
  914. <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>
  915. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  916. <span class="nt">metadata</span><span class="p">:</span>
  917. <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>
  918. <span class="nt">spec</span><span class="p">:</span>
  919. <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>
  920. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  921. <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>
  922. <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>
  923. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  924. <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>
  925. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  926. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span>
  927. <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
  928. <span class="w"> </span><span class="c1"># match secret name with regexp</span>
  929. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls-.*&quot;</span>
  930. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span>
  931. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
  932. <span class="w"> </span><span class="c1"># fetch secrets based on label combination</span>
  933. <span class="w"> </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;nginx&quot;</span>
  934. </code></pre></div>
  935. <h3 id="target-api-server-configuration">Target API-Server Configuration</h3>
  936. <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.
  937. 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>).
  938. Use that if you want to connect to the same API server.
  939. 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.
  940. You may also define it inline as base64 encoded value using the <code>caBundle</code> property.</p>
  941. <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>
  942. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  943. <span class="nt">metadata</span><span class="p">:</span>
  944. <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>
  945. <span class="nt">spec</span><span class="p">:</span>
  946. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  947. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  948. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span>
  949. <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>
  950. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  951. <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>
  952. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span>
  953. <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>
  954. <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>
  955. <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>
  956. </code></pre></div>
  957. <h3 id="authentication">Authentication</h3>
  958. <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>
  959. <p><strong>NOTE:</strong> <code>SelfSubjectRulesReview</code> permission is required in order to validation work properly. Please use the following role as reference:</p>
  960. <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>
  961. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Role</span>
  962. <span class="nt">metadata</span><span class="p">:</span>
  963. <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>
  964. <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>
  965. <span class="nt">rules</span><span class="p">:</span>
  966. <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>
  967. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  968. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secrets</span>
  969. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span>
  970. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">get</span>
  971. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">list</span>
  972. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watch</span>
  973. <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">apiGroups</span><span class="p">:</span>
  974. <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>
  975. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  976. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">selfsubjectrulesreviews</span>
  977. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span>
  978. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create</span>
  979. </code></pre></div>
  980. <h4 id="authenticating-with-bearertoken">Authenticating with BearerToken</h4>
  981. <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>
  982. <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>
  983. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  984. <span class="nt">metadata</span><span class="p">:</span>
  985. <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>
  986. <span class="nt">data</span><span class="p">:</span>
  987. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;....&quot;</span>
  988. </code></pre></div>
  989. <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>
  990. <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>
  991. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  992. <span class="nt">metadata</span><span class="p">:</span>
  993. <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>
  994. <span class="nt">spec</span><span class="p">:</span>
  995. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  996. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  997. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span>
  998. <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>
  999. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  1000. <span class="w"> </span><span class="c1"># ...</span>
  1001. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1002. <span class="w"> </span><span class="nt">token</span><span class="p">:</span>
  1003. <span class="w"> </span><span class="nt">bearerToken</span><span class="p">:</span>
  1004. <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>
  1005. <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>
  1006. </code></pre></div>
  1007. <h4 id="authenticating-with-serviceaccount">Authenticating with ServiceAccount</h4>
  1008. <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>
  1009. <div class="highlight"><pre><span></span><code>$ kubectl create serviceaccount my-store
  1010. </code></pre></div>
  1011. <p>This Service Account needs permissions to read <code>Secret</code> and create <code>SelfSubjectRulesReview</code> resources. Please see the above role.</p>
  1012. <div class="highlight"><pre><span></span><code>$ kubectl create rolebinding my-store --role=eso-store-role --serviceaccount=default:my-store
  1013. </code></pre></div>
  1014. <p>Create a SecretStore: the <code>auth</code> section indicates that the type <code>serviceAccount</code> will be used for authentication.</p>
  1015. <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>
  1016. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1017. <span class="nt">metadata</span><span class="p">:</span>
  1018. <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>
  1019. <span class="nt">spec</span><span class="p">:</span>
  1020. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1021. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1022. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span>
  1023. <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>
  1024. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  1025. <span class="w"> </span><span class="c1"># ...</span>
  1026. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1027. <span class="w"> </span><span class="nt">serviceAccount</span><span class="p">:</span>
  1028. <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>
  1029. </code></pre></div>
  1030. <h4 id="authenticating-with-client-certificates">Authenticating with Client Certificates</h4>
  1031. <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>
  1032. <div class="highlight"><pre><span></span><code>$ kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
  1033. </code></pre></div>
  1034. <p>Reference the <code>tls-secret</code> in the SecretStore</p>
  1035. <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>
  1036. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1037. <span class="nt">metadata</span><span class="p">:</span>
  1038. <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>
  1039. <span class="nt">spec</span><span class="p">:</span>
  1040. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1041. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1042. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span>
  1043. <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>
  1044. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  1045. <span class="w"> </span><span class="c1"># ...</span>
  1046. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1047. <span class="w"> </span><span class="nt">cert</span><span class="p">:</span>
  1048. <span class="w"> </span><span class="nt">clientCert</span><span class="p">:</span>
  1049. <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>
  1050. <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>
  1051. <span class="w"> </span><span class="nt">clientKey</span><span class="p">:</span>
  1052. <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>
  1053. <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>
  1054. </code></pre></div>
  1055. <h3 id="pushsecret">PushSecret</h3>
  1056. <p>The PushSecret functionality facilitates the replication of a Kubernetes Secret from one namespace or cluster to another. This feature proves useful in scenarios where you need to share sensitive information, such as credentials or configuration data, across different parts of your infrastructure.</p>
  1057. <p>To configure the PushSecret resource, you need to specify the following parameters:</p>
  1058. <ul>
  1059. <li>
  1060. <p><strong>Selector</strong>: Specify the selector that identifies the source Secret to be replicated. This selector allows you to target the specific Secret you want to share.</p>
  1061. </li>
  1062. <li>
  1063. <p><strong>SecretKey</strong>: Set the SecretKey parameter to indicate the key within the source Secret that you want to replicate. This ensures that only the relevant information is shared.</p>
  1064. </li>
  1065. <li>
  1066. <p><strong>RemoteRef.Property</strong>: In addition to the above parameters, the Kubernetes provider requires you to set the <code>remoteRef.property</code> field. This field specifies the key of the remote Secret resource where the replicated value should be stored.</p>
  1067. </li>
  1068. </ul>
  1069. <p>Here's an example:</p>
  1070. <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/v1alpha1</span>
  1071. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1072. <span class="nt">metadata</span><span class="p">:</span>
  1073. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1074. <span class="nt">spec</span><span class="p">:</span>
  1075. <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">10s</span>
  1076. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
  1077. <span class="w"> </span><span class="p p-Indicator">-</span><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-remote-ns</span>
  1078. <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>
  1079. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1080. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1081. <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">pokedex-credentials</span>
  1082. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1083. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1084. <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">best-pokemon</span>
  1085. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1086. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">remote-best-pokemon</span>
  1087. <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">best-pokemon</span>
  1088. </code></pre></div>
  1089. <p>To utilize the PushSecret feature effectively, the referenced <code>SecretStore</code> requires specific permissions on the target cluster. In particular it requires <code>create</code>, <code>read</code>, <code>update</code> and <code>delete</code> permissions on the Secret resource:</p>
  1090. <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>
  1091. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Role</span>
  1092. <span class="nt">metadata</span><span class="p">:</span>
  1093. <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">remote</span>
  1094. <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-push-role</span>
  1095. <span class="nt">rules</span><span class="p">:</span>
  1096. <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>
  1097. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  1098. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secrets</span>
  1099. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span>
  1100. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">get</span>
  1101. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">list</span>
  1102. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watch</span>
  1103. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create</span>
  1104. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">update</span>
  1105. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">patch</span>
  1106. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">delete</span>
  1107. <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">apiGroups</span><span class="p">:</span>
  1108. <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>
  1109. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  1110. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">selfsubjectrulesreviews</span>
  1111. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span>
  1112. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create</span>
  1113. </code></pre></div>
  1114. <h4 id="implementation-considerations">Implementation Considerations</h4>
  1115. <p>When utilizing the PushSecret feature and configuring the permissions for the SecretStore, consider the following:</p>
  1116. <ul>
  1117. <li>
  1118. <p><strong>RBAC Configuration</strong>: Ensure that the Role-Based Access Control (RBAC) configuration for the SecretStore grants the appropriate permissions for creating, reading, and updating resources in the target cluster.</p>
  1119. </li>
  1120. <li>
  1121. <p><strong>Least Privilege Principle</strong>: Adhere to the principle of least privilege when assigning permissions to the SecretStore. Only provide the minimum required permissions to accomplish the desired synchronization between Secrets.</p>
  1122. </li>
  1123. <li>
  1124. <p><strong>Namespace or Cluster Scope</strong>: Depending on your specific requirements, configure the SecretStore to operate at the desired scope, whether it is limited to a specific namespace or encompasses the entire cluster. Consider the security and access control implications of your chosen scope.</p>
  1125. </li>
  1126. </ul>
  1127. </article>
  1128. </div>
  1129. </div>
  1130. </main>
  1131. <footer class="md-footer">
  1132. <div class="md-footer-meta md-typeset">
  1133. <div class="md-footer-meta__inner md-grid">
  1134. <div class="md-copyright">
  1135. <div class="md-copyright__highlight">
  1136. &copy; 2023 The external-secrets Authors.<br/>
  1137. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1138. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1139. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1140. </div>
  1141. Made with
  1142. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1143. Material for MkDocs
  1144. </a>
  1145. </div>
  1146. </div>
  1147. </div>
  1148. </footer>
  1149. </div>
  1150. <div class="md-dialog" data-md-component="dialog">
  1151. <div class="md-dialog__inner md-typeset"></div>
  1152. </div>
  1153. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1154. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  1155. </body>
  1156. </html>