index.html 84 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401
  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.5.3, mkdocs-material-9.5.7">
  10. <title>Kubernetes - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.f2e4d321.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. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#external-secret-spec" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <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>
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. Kubernetes
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  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.5.1 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 md-tabs__item--active">
  126. <a href="../aws-secrets-manager/" class="md-tabs__link">
  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.5.1 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--section 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__container">
  169. <a href="../.." class="md-nav__link ">
  170. <span class="md-ellipsis">
  171. Introduction
  172. </span>
  173. </a>
  174. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
  175. <span class="md-nav__icon md-icon"></span>
  176. </label>
  177. </div>
  178. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  179. <label class="md-nav__title" for="__nav_1">
  180. <span class="md-nav__icon md-icon"></span>
  181. Introduction
  182. </label>
  183. <ul class="md-nav__list" data-md-scrollfix>
  184. <li class="md-nav__item">
  185. <a href="../../introduction/overview/" class="md-nav__link">
  186. <span class="md-ellipsis">
  187. Overview
  188. </span>
  189. </a>
  190. </li>
  191. <li class="md-nav__item">
  192. <a href="../../introduction/getting-started/" class="md-nav__link">
  193. <span class="md-ellipsis">
  194. Getting started
  195. </span>
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/faq/" class="md-nav__link">
  200. <span class="md-ellipsis">
  201. FAQ
  202. </span>
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../../introduction/stability-support/" class="md-nav__link">
  207. <span class="md-ellipsis">
  208. Stability and Support
  209. </span>
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  214. <span class="md-ellipsis">
  215. Deprecation Policy
  216. </span>
  217. </a>
  218. </li>
  219. </ul>
  220. </nav>
  221. </li>
  222. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  223. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  224. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  225. <span class="md-ellipsis">
  226. API
  227. </span>
  228. <span class="md-nav__icon md-icon"></span>
  229. </label>
  230. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  231. <label class="md-nav__title" for="__nav_2">
  232. <span class="md-nav__icon md-icon"></span>
  233. API
  234. </label>
  235. <ul class="md-nav__list" data-md-scrollfix>
  236. <li class="md-nav__item">
  237. <a href="../../api/components/" class="md-nav__link">
  238. <span class="md-ellipsis">
  239. Components
  240. </span>
  241. </a>
  242. </li>
  243. <li class="md-nav__item md-nav__item--nested">
  244. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  245. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  246. <span class="md-ellipsis">
  247. Core Resources
  248. </span>
  249. <span class="md-nav__icon md-icon"></span>
  250. </label>
  251. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  252. <label class="md-nav__title" for="__nav_2_2">
  253. <span class="md-nav__icon md-icon"></span>
  254. Core Resources
  255. </label>
  256. <ul class="md-nav__list" data-md-scrollfix>
  257. <li class="md-nav__item">
  258. <a href="../../api/externalsecret/" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. ExternalSecret
  261. </span>
  262. </a>
  263. </li>
  264. <li class="md-nav__item">
  265. <a href="../../api/secretstore/" class="md-nav__link">
  266. <span class="md-ellipsis">
  267. SecretStore
  268. </span>
  269. </a>
  270. </li>
  271. <li class="md-nav__item">
  272. <a href="../../api/clustersecretstore/" class="md-nav__link">
  273. <span class="md-ellipsis">
  274. ClusterSecretStore
  275. </span>
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  280. <span class="md-ellipsis">
  281. ClusterExternalSecret
  282. </span>
  283. </a>
  284. </li>
  285. <li class="md-nav__item">
  286. <a href="../../api/pushsecret/" class="md-nav__link">
  287. <span class="md-ellipsis">
  288. PushSecret
  289. </span>
  290. </a>
  291. </li>
  292. </ul>
  293. </nav>
  294. </li>
  295. <li class="md-nav__item md-nav__item--nested">
  296. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  297. <div class="md-nav__link md-nav__container">
  298. <a href="../../api/generator/" class="md-nav__link ">
  299. <span class="md-ellipsis">
  300. Generators
  301. </span>
  302. </a>
  303. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  304. <span class="md-nav__icon md-icon"></span>
  305. </label>
  306. </div>
  307. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  308. <label class="md-nav__title" for="__nav_2_3">
  309. <span class="md-nav__icon md-icon"></span>
  310. Generators
  311. </label>
  312. <ul class="md-nav__list" data-md-scrollfix>
  313. <li class="md-nav__item">
  314. <a href="../../api/generator/acr/" class="md-nav__link">
  315. <span class="md-ellipsis">
  316. Azure Container Registry
  317. </span>
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../../api/generator/ecr/" class="md-nav__link">
  322. <span class="md-ellipsis">
  323. AWS Elastic Container Registry
  324. </span>
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/generator/gcr/" class="md-nav__link">
  329. <span class="md-ellipsis">
  330. Google Container Registry
  331. </span>
  332. </a>
  333. </li>
  334. <li class="md-nav__item">
  335. <a href="../../api/generator/vault/" class="md-nav__link">
  336. <span class="md-ellipsis">
  337. Vault Dynamic Secret
  338. </span>
  339. </a>
  340. </li>
  341. <li class="md-nav__item">
  342. <a href="../../api/generator/password/" class="md-nav__link">
  343. <span class="md-ellipsis">
  344. Password
  345. </span>
  346. </a>
  347. </li>
  348. <li class="md-nav__item">
  349. <a href="../../api/generator/fake/" class="md-nav__link">
  350. <span class="md-ellipsis">
  351. Fake
  352. </span>
  353. </a>
  354. </li>
  355. </ul>
  356. </nav>
  357. </li>
  358. <li class="md-nav__item md-nav__item--nested">
  359. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  360. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  361. <span class="md-ellipsis">
  362. Reference Docs
  363. </span>
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  367. <label class="md-nav__title" for="__nav_2_4">
  368. <span class="md-nav__icon md-icon"></span>
  369. Reference Docs
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../../api/spec/" class="md-nav__link">
  374. <span class="md-ellipsis">
  375. API specification
  376. </span>
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="../../api/controller-options/" class="md-nav__link">
  381. <span class="md-ellipsis">
  382. Controller Options
  383. </span>
  384. </a>
  385. </li>
  386. <li class="md-nav__item">
  387. <a href="../../api/metrics/" class="md-nav__link">
  388. <span class="md-ellipsis">
  389. Metrics
  390. </span>
  391. </a>
  392. </li>
  393. </ul>
  394. </nav>
  395. </li>
  396. </ul>
  397. </nav>
  398. </li>
  399. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  400. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  401. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  402. <span class="md-ellipsis">
  403. Guides
  404. </span>
  405. <span class="md-nav__icon md-icon"></span>
  406. </label>
  407. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  408. <label class="md-nav__title" for="__nav_3">
  409. <span class="md-nav__icon md-icon"></span>
  410. Guides
  411. </label>
  412. <ul class="md-nav__list" data-md-scrollfix>
  413. <li class="md-nav__item">
  414. <a href="../../guides/introduction/" class="md-nav__link">
  415. <span class="md-ellipsis">
  416. Introduction
  417. </span>
  418. </a>
  419. </li>
  420. <li class="md-nav__item md-nav__item--nested">
  421. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  422. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  423. <span class="md-ellipsis">
  424. External Secrets
  425. </span>
  426. <span class="md-nav__icon md-icon"></span>
  427. </label>
  428. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  429. <label class="md-nav__title" for="__nav_3_2">
  430. <span class="md-nav__icon md-icon"></span>
  431. External Secrets
  432. </label>
  433. <ul class="md-nav__list" data-md-scrollfix>
  434. <li class="md-nav__item">
  435. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. Extract structured data
  438. </span>
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../../guides/getallsecrets/" class="md-nav__link">
  443. <span class="md-ellipsis">
  444. Find Secrets by Name or Metadata
  445. </span>
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  450. <span class="md-ellipsis">
  451. Rewriting Keys
  452. </span>
  453. </a>
  454. </li>
  455. <li class="md-nav__item md-nav__item--nested">
  456. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  457. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  458. <span class="md-ellipsis">
  459. Advanced Templating
  460. </span>
  461. <span class="md-nav__icon md-icon"></span>
  462. </label>
  463. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  464. <label class="md-nav__title" for="__nav_3_2_4">
  465. <span class="md-nav__icon md-icon"></span>
  466. Advanced Templating
  467. </label>
  468. <ul class="md-nav__list" data-md-scrollfix>
  469. <li class="md-nav__item">
  470. <a href="../../guides/templating/" class="md-nav__link">
  471. <span class="md-ellipsis">
  472. v2
  473. </span>
  474. </a>
  475. </li>
  476. <li class="md-nav__item">
  477. <a href="../../guides/templating-v1/" class="md-nav__link">
  478. <span class="md-ellipsis">
  479. v1
  480. </span>
  481. </a>
  482. </li>
  483. </ul>
  484. </nav>
  485. </li>
  486. <li class="md-nav__item">
  487. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  488. <span class="md-ellipsis">
  489. Kubernetes Secret Types
  490. </span>
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  495. <span class="md-ellipsis">
  496. Lifecycle: ownership & deletion
  497. </span>
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  502. <span class="md-ellipsis">
  503. Decoding Strategies
  504. </span>
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="../../guides/controller-class/" class="md-nav__link">
  509. <span class="md-ellipsis">
  510. Controller Classes
  511. </span>
  512. </a>
  513. </li>
  514. </ul>
  515. </nav>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="../../guides/generator/" class="md-nav__link">
  519. <span class="md-ellipsis">
  520. Generators
  521. </span>
  522. </a>
  523. </li>
  524. <li class="md-nav__item">
  525. <a href="../../guides/pushsecrets/" class="md-nav__link">
  526. <span class="md-ellipsis">
  527. Push Secrets
  528. </span>
  529. </a>
  530. </li>
  531. <li class="md-nav__item md-nav__item--nested">
  532. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  533. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  534. <span class="md-ellipsis">
  535. Operations
  536. </span>
  537. <span class="md-nav__icon md-icon"></span>
  538. </label>
  539. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  540. <label class="md-nav__title" for="__nav_3_5">
  541. <span class="md-nav__icon md-icon"></span>
  542. Operations
  543. </label>
  544. <ul class="md-nav__list" data-md-scrollfix>
  545. <li class="md-nav__item">
  546. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  547. <span class="md-ellipsis">
  548. Multi Tenancy
  549. </span>
  550. </a>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="../../guides/security-best-practices/" class="md-nav__link">
  554. <span class="md-ellipsis">
  555. Security Best Practices
  556. </span>
  557. </a>
  558. </li>
  559. <li class="md-nav__item">
  560. <a href="../../guides/threat-model/" class="md-nav__link">
  561. <span class="md-ellipsis">
  562. Threat Model
  563. </span>
  564. </a>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="../../guides/v1beta1/" class="md-nav__link">
  568. <span class="md-ellipsis">
  569. Upgrading to v1beta1
  570. </span>
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="../../guides/using-latest-image/" class="md-nav__link">
  575. <span class="md-ellipsis">
  576. Using Latest Image
  577. </span>
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  582. <span class="md-ellipsis">
  583. Disable Cluster Features
  584. </span>
  585. </a>
  586. </li>
  587. </ul>
  588. </nav>
  589. </li>
  590. </ul>
  591. </nav>
  592. </li>
  593. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  594. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  595. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  596. <span class="md-ellipsis">
  597. Provider
  598. </span>
  599. <span class="md-nav__icon md-icon"></span>
  600. </label>
  601. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  602. <label class="md-nav__title" for="__nav_4">
  603. <span class="md-nav__icon md-icon"></span>
  604. Provider
  605. </label>
  606. <ul class="md-nav__list" data-md-scrollfix>
  607. <li class="md-nav__item">
  608. <a href="../aws-secrets-manager/" class="md-nav__link">
  609. <span class="md-ellipsis">
  610. AWS Secrets Manager
  611. </span>
  612. </a>
  613. </li>
  614. <li class="md-nav__item">
  615. <a href="../aws-parameter-store/" class="md-nav__link">
  616. <span class="md-ellipsis">
  617. AWS Parameter Store
  618. </span>
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../azure-key-vault/" class="md-nav__link">
  623. <span class="md-ellipsis">
  624. Azure Key Vault
  625. </span>
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../conjur/" class="md-nav__link">
  630. <span class="md-ellipsis">
  631. CyberArk Conjur
  632. </span>
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../google-secrets-manager/" class="md-nav__link">
  637. <span class="md-ellipsis">
  638. Google Cloud Secret Manager
  639. </span>
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../hashicorp-vault/" class="md-nav__link">
  644. <span class="md-ellipsis">
  645. HashiCorp Vault
  646. </span>
  647. </a>
  648. </li>
  649. <li class="md-nav__item md-nav__item--active">
  650. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  651. <label class="md-nav__link md-nav__link--active" for="__toc">
  652. <span class="md-ellipsis">
  653. Kubernetes
  654. </span>
  655. <span class="md-nav__icon md-icon"></span>
  656. </label>
  657. <a href="./" class="md-nav__link md-nav__link--active">
  658. <span class="md-ellipsis">
  659. Kubernetes
  660. </span>
  661. </a>
  662. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  663. <label class="md-nav__title" for="__toc">
  664. <span class="md-nav__icon md-icon"></span>
  665. Table of contents
  666. </label>
  667. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  668. <li class="md-nav__item">
  669. <a href="#external-secret-spec" class="md-nav__link">
  670. <span class="md-ellipsis">
  671. External Secret Spec
  672. </span>
  673. </a>
  674. <nav class="md-nav" aria-label="External Secret Spec">
  675. <ul class="md-nav__list">
  676. <li class="md-nav__item">
  677. <a href="#find-by-tag-name" class="md-nav__link">
  678. <span class="md-ellipsis">
  679. find by tag &amp; name
  680. </span>
  681. </a>
  682. </li>
  683. </ul>
  684. </nav>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="#target-api-server-configuration" class="md-nav__link">
  688. <span class="md-ellipsis">
  689. Target API-Server Configuration
  690. </span>
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="#authentication" class="md-nav__link">
  695. <span class="md-ellipsis">
  696. Authentication
  697. </span>
  698. </a>
  699. <nav class="md-nav" aria-label="Authentication">
  700. <ul class="md-nav__list">
  701. <li class="md-nav__item">
  702. <a href="#authenticating-with-bearertoken" class="md-nav__link">
  703. <span class="md-ellipsis">
  704. Authenticating with BearerToken
  705. </span>
  706. </a>
  707. </li>
  708. <li class="md-nav__item">
  709. <a href="#authenticating-with-serviceaccount" class="md-nav__link">
  710. <span class="md-ellipsis">
  711. Authenticating with ServiceAccount
  712. </span>
  713. </a>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="#authenticating-with-client-certificates" class="md-nav__link">
  717. <span class="md-ellipsis">
  718. Authenticating with Client Certificates
  719. </span>
  720. </a>
  721. </li>
  722. </ul>
  723. </nav>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="#pushsecret" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. PushSecret
  729. </span>
  730. </a>
  731. <nav class="md-nav" aria-label="PushSecret">
  732. <ul class="md-nav__list">
  733. <li class="md-nav__item">
  734. <a href="#implementation-considerations" class="md-nav__link">
  735. <span class="md-ellipsis">
  736. Implementation Considerations
  737. </span>
  738. </a>
  739. </li>
  740. </ul>
  741. </nav>
  742. </li>
  743. </ul>
  744. </nav>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../ibm-secrets-manager/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. IBM Secrets Manager
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="../akeyless/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Akeyless
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../yandex-certificate-manager/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. Yandex Certificate Manager
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="../yandex-lockbox/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Yandex Lockbox
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../alibaba/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. Alibaba Cloud
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../gitlab-variables/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. GitLab Variables
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="../oracle-vault/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. Oracle Vault
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../1password-automation/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. 1Password Secrets Automation
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="../webhook/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. Webhook
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="../fake/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. Fake
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="../senhasegura-dsm/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. senhasegura DevOps Secrets Management (DSM)
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="../doppler/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Doppler
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="../keeper-security/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. Keeper Security
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="../cloak/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. Cloak End 2 End Encrypted Secrets
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="../scaleway/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Scaleway
  848. </span>
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="../delinea/" class="md-nav__link">
  853. <span class="md-ellipsis">
  854. Delinea
  855. </span>
  856. </a>
  857. </li>
  858. </ul>
  859. </nav>
  860. </li>
  861. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  862. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  863. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
  864. <span class="md-ellipsis">
  865. Examples
  866. </span>
  867. <span class="md-nav__icon md-icon"></span>
  868. </label>
  869. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  870. <label class="md-nav__title" for="__nav_5">
  871. <span class="md-nav__icon md-icon"></span>
  872. Examples
  873. </label>
  874. <ul class="md-nav__list" data-md-scrollfix>
  875. <li class="md-nav__item">
  876. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  877. <span class="md-ellipsis">
  878. FluxCD
  879. </span>
  880. </a>
  881. </li>
  882. <li class="md-nav__item">
  883. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  884. <span class="md-ellipsis">
  885. Anchore Engine
  886. </span>
  887. </a>
  888. </li>
  889. <li class="md-nav__item">
  890. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  891. <span class="md-ellipsis">
  892. Jenkins
  893. </span>
  894. </a>
  895. </li>
  896. <li class="md-nav__item">
  897. <a href="../../examples/bitwarden/" class="md-nav__link">
  898. <span class="md-ellipsis">
  899. BitWarden
  900. </span>
  901. </a>
  902. </li>
  903. </ul>
  904. </nav>
  905. </li>
  906. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  907. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  908. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  909. <span class="md-ellipsis">
  910. Community
  911. </span>
  912. <span class="md-nav__icon md-icon"></span>
  913. </label>
  914. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  915. <label class="md-nav__title" for="__nav_6">
  916. <span class="md-nav__icon md-icon"></span>
  917. Community
  918. </label>
  919. <ul class="md-nav__list" data-md-scrollfix>
  920. <li class="md-nav__item md-nav__item--nested">
  921. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  922. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  923. <span class="md-ellipsis">
  924. Contributing
  925. </span>
  926. <span class="md-nav__icon md-icon"></span>
  927. </label>
  928. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  929. <label class="md-nav__title" for="__nav_6_1">
  930. <span class="md-nav__icon md-icon"></span>
  931. Contributing
  932. </label>
  933. <ul class="md-nav__list" data-md-scrollfix>
  934. <li class="md-nav__item">
  935. <a href="../../contributing/devguide/" class="md-nav__link">
  936. <span class="md-ellipsis">
  937. Developer guide
  938. </span>
  939. </a>
  940. </li>
  941. <li class="md-nav__item">
  942. <a href="../../contributing/process/" class="md-nav__link">
  943. <span class="md-ellipsis">
  944. Contributing Process
  945. </span>
  946. </a>
  947. </li>
  948. <li class="md-nav__item">
  949. <a href="../../contributing/release/" class="md-nav__link">
  950. <span class="md-ellipsis">
  951. Release Process
  952. </span>
  953. </a>
  954. </li>
  955. <li class="md-nav__item">
  956. <a href="../../contributing/coc/" class="md-nav__link">
  957. <span class="md-ellipsis">
  958. Code of Conduct
  959. </span>
  960. </a>
  961. </li>
  962. <li class="md-nav__item">
  963. <a href="../../contributing/roadmap/" class="md-nav__link">
  964. <span class="md-ellipsis">
  965. Roadmap
  966. </span>
  967. </a>
  968. </li>
  969. </ul>
  970. </nav>
  971. </li>
  972. <li class="md-nav__item md-nav__item--nested">
  973. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  974. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  975. <span class="md-ellipsis">
  976. External Resources
  977. </span>
  978. <span class="md-nav__icon md-icon"></span>
  979. </label>
  980. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  981. <label class="md-nav__title" for="__nav_6_2">
  982. <span class="md-nav__icon md-icon"></span>
  983. External Resources
  984. </label>
  985. <ul class="md-nav__list" data-md-scrollfix>
  986. <li class="md-nav__item">
  987. <a href="../../eso-talks/" class="md-nav__link">
  988. <span class="md-ellipsis">
  989. Talks
  990. </span>
  991. </a>
  992. </li>
  993. <li class="md-nav__item">
  994. <a href="../../eso-demos/" class="md-nav__link">
  995. <span class="md-ellipsis">
  996. Demos
  997. </span>
  998. </a>
  999. </li>
  1000. <li class="md-nav__item">
  1001. <a href="../../eso-blogs/" class="md-nav__link">
  1002. <span class="md-ellipsis">
  1003. Blogs
  1004. </span>
  1005. </a>
  1006. </li>
  1007. </ul>
  1008. </nav>
  1009. </li>
  1010. </ul>
  1011. </nav>
  1012. </li>
  1013. </ul>
  1014. </nav>
  1015. </div>
  1016. </div>
  1017. </div>
  1018. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1019. <div class="md-sidebar__scrollwrap">
  1020. <div class="md-sidebar__inner">
  1021. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1022. <label class="md-nav__title" for="__toc">
  1023. <span class="md-nav__icon md-icon"></span>
  1024. Table of contents
  1025. </label>
  1026. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1027. <li class="md-nav__item">
  1028. <a href="#external-secret-spec" class="md-nav__link">
  1029. <span class="md-ellipsis">
  1030. External Secret Spec
  1031. </span>
  1032. </a>
  1033. <nav class="md-nav" aria-label="External Secret Spec">
  1034. <ul class="md-nav__list">
  1035. <li class="md-nav__item">
  1036. <a href="#find-by-tag-name" class="md-nav__link">
  1037. <span class="md-ellipsis">
  1038. find by tag &amp; name
  1039. </span>
  1040. </a>
  1041. </li>
  1042. </ul>
  1043. </nav>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="#target-api-server-configuration" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Target API-Server Configuration
  1049. </span>
  1050. </a>
  1051. </li>
  1052. <li class="md-nav__item">
  1053. <a href="#authentication" class="md-nav__link">
  1054. <span class="md-ellipsis">
  1055. Authentication
  1056. </span>
  1057. </a>
  1058. <nav class="md-nav" aria-label="Authentication">
  1059. <ul class="md-nav__list">
  1060. <li class="md-nav__item">
  1061. <a href="#authenticating-with-bearertoken" class="md-nav__link">
  1062. <span class="md-ellipsis">
  1063. Authenticating with BearerToken
  1064. </span>
  1065. </a>
  1066. </li>
  1067. <li class="md-nav__item">
  1068. <a href="#authenticating-with-serviceaccount" class="md-nav__link">
  1069. <span class="md-ellipsis">
  1070. Authenticating with ServiceAccount
  1071. </span>
  1072. </a>
  1073. </li>
  1074. <li class="md-nav__item">
  1075. <a href="#authenticating-with-client-certificates" class="md-nav__link">
  1076. <span class="md-ellipsis">
  1077. Authenticating with Client Certificates
  1078. </span>
  1079. </a>
  1080. </li>
  1081. </ul>
  1082. </nav>
  1083. </li>
  1084. <li class="md-nav__item">
  1085. <a href="#pushsecret" class="md-nav__link">
  1086. <span class="md-ellipsis">
  1087. PushSecret
  1088. </span>
  1089. </a>
  1090. <nav class="md-nav" aria-label="PushSecret">
  1091. <ul class="md-nav__list">
  1092. <li class="md-nav__item">
  1093. <a href="#implementation-considerations" class="md-nav__link">
  1094. <span class="md-ellipsis">
  1095. Implementation Considerations
  1096. </span>
  1097. </a>
  1098. </li>
  1099. </ul>
  1100. </nav>
  1101. </li>
  1102. </ul>
  1103. </nav>
  1104. </div>
  1105. </div>
  1106. </div>
  1107. <div class="md-content" data-md-component="content">
  1108. <article class="md-content__inner md-typeset">
  1109. <h1>Kubernetes</h1>
  1110. <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>
  1111. <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>
  1112. <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>
  1113. <h3 id="external-secret-spec">External Secret Spec</h3>
  1114. <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>
  1115. <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>
  1116. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1117. <span class="nt">metadata</span><span class="p">:</span>
  1118. <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>
  1119. <span class="nt">spec</span><span class="p">:</span>
  1120. <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>
  1121. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1122. <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>
  1123. <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>
  1124. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1125. <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>
  1126. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1127. <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>
  1128. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1129. <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>
  1130. <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>
  1131. <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>
  1132. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1133. <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>
  1134. <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>
  1135. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the labels and annotations in JSON format</span>
  1136. <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>
  1137. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1138. <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>
  1139. <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>
  1140. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the labels in JSON format</span>
  1141. <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>
  1142. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1143. <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>
  1144. <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>
  1145. <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>
  1146. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific label (dev) from the source secret</span>
  1147. <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>
  1148. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1149. <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>
  1150. <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>
  1151. <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>
  1152. </code></pre></div>
  1153. <h4 id="find-by-tag-name">find by tag &amp; name</h4>
  1154. <p>You can fetch secrets based on labels or names matching a regexp:</p>
  1155. <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>
  1156. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1157. <span class="nt">metadata</span><span class="p">:</span>
  1158. <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>
  1159. <span class="nt">spec</span><span class="p">:</span>
  1160. <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>
  1161. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1162. <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>
  1163. <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>
  1164. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1165. <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>
  1166. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1167. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span>
  1168. <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
  1169. <span class="w"> </span><span class="c1"># match secret name with regexp</span>
  1170. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls-.*&quot;</span>
  1171. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span>
  1172. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
  1173. <span class="w"> </span><span class="c1"># fetch secrets based on label combination</span>
  1174. <span class="w"> </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;nginx&quot;</span>
  1175. </code></pre></div>
  1176. <h3 id="target-api-server-configuration">Target API-Server Configuration</h3>
  1177. <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.
  1178. 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>).
  1179. Use that if you want to connect to the same API server.
  1180. 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.
  1181. You may also define it inline as base64 encoded value using the <code>caBundle</code> property.</p>
  1182. <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>
  1183. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1184. <span class="nt">metadata</span><span class="p">:</span>
  1185. <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>
  1186. <span class="nt">spec</span><span class="p">:</span>
  1187. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1188. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1189. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span>
  1190. <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>
  1191. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  1192. <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>
  1193. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span>
  1194. <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>
  1195. <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>
  1196. <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>
  1197. </code></pre></div>
  1198. <h3 id="authentication">Authentication</h3>
  1199. <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>
  1200. <p><strong>NOTE:</strong> <code>SelfSubjectRulesReview</code> permission is required in order to validation work properly. Please use the following role as reference:</p>
  1201. <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>
  1202. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Role</span>
  1203. <span class="nt">metadata</span><span class="p">:</span>
  1204. <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>
  1205. <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>
  1206. <span class="nt">rules</span><span class="p">:</span>
  1207. <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>
  1208. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  1209. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secrets</span>
  1210. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span>
  1211. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">get</span>
  1212. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">list</span>
  1213. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watch</span>
  1214. <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">apiGroups</span><span class="p">:</span>
  1215. <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>
  1216. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  1217. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">selfsubjectrulesreviews</span>
  1218. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span>
  1219. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create</span>
  1220. </code></pre></div>
  1221. <h4 id="authenticating-with-bearertoken">Authenticating with BearerToken</h4>
  1222. <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>
  1223. <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>
  1224. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1225. <span class="nt">metadata</span><span class="p">:</span>
  1226. <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>
  1227. <span class="nt">data</span><span class="p">:</span>
  1228. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;....&quot;</span>
  1229. </code></pre></div>
  1230. <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>
  1231. <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>
  1232. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1233. <span class="nt">metadata</span><span class="p">:</span>
  1234. <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>
  1235. <span class="nt">spec</span><span class="p">:</span>
  1236. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1237. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1238. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span>
  1239. <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>
  1240. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  1241. <span class="w"> </span><span class="c1"># ...</span>
  1242. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1243. <span class="w"> </span><span class="nt">token</span><span class="p">:</span>
  1244. <span class="w"> </span><span class="nt">bearerToken</span><span class="p">:</span>
  1245. <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>
  1246. <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>
  1247. </code></pre></div>
  1248. <h4 id="authenticating-with-serviceaccount">Authenticating with ServiceAccount</h4>
  1249. <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>
  1250. <div class="highlight"><pre><span></span><code>$ kubectl create serviceaccount my-store
  1251. </code></pre></div>
  1252. <p>This Service Account needs permissions to read <code>Secret</code> and create <code>SelfSubjectRulesReview</code> resources. Please see the above role.</p>
  1253. <div class="highlight"><pre><span></span><code>$ kubectl create rolebinding my-store --role=eso-store-role --serviceaccount=default:my-store
  1254. </code></pre></div>
  1255. <p>Create a SecretStore: the <code>auth</code> section indicates that the type <code>serviceAccount</code> will be used for authentication.</p>
  1256. <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>
  1257. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1258. <span class="nt">metadata</span><span class="p">:</span>
  1259. <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>
  1260. <span class="nt">spec</span><span class="p">:</span>
  1261. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1262. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1263. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span>
  1264. <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>
  1265. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  1266. <span class="w"> </span><span class="c1"># ...</span>
  1267. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1268. <span class="w"> </span><span class="nt">serviceAccount</span><span class="p">:</span>
  1269. <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>
  1270. </code></pre></div>
  1271. <h4 id="authenticating-with-client-certificates">Authenticating with Client Certificates</h4>
  1272. <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>
  1273. <div class="highlight"><pre><span></span><code>$ kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
  1274. </code></pre></div>
  1275. <p>Reference the <code>tls-secret</code> in the SecretStore</p>
  1276. <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>
  1277. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1278. <span class="nt">metadata</span><span class="p">:</span>
  1279. <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>
  1280. <span class="nt">spec</span><span class="p">:</span>
  1281. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1282. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1283. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span>
  1284. <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>
  1285. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  1286. <span class="w"> </span><span class="c1"># ...</span>
  1287. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1288. <span class="w"> </span><span class="nt">cert</span><span class="p">:</span>
  1289. <span class="w"> </span><span class="nt">clientCert</span><span class="p">:</span>
  1290. <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>
  1291. <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>
  1292. <span class="w"> </span><span class="nt">clientKey</span><span class="p">:</span>
  1293. <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>
  1294. <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>
  1295. </code></pre></div>
  1296. <h3 id="pushsecret">PushSecret</h3>
  1297. <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>
  1298. <p>To configure the PushSecret resource, you need to specify the following parameters:</p>
  1299. <ul>
  1300. <li>
  1301. <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>
  1302. </li>
  1303. <li>
  1304. <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>
  1305. </li>
  1306. <li>
  1307. <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>
  1308. </li>
  1309. </ul>
  1310. <p>Here's an example:</p>
  1311. <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>
  1312. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1313. <span class="nt">metadata</span><span class="p">:</span>
  1314. <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>
  1315. <span class="nt">spec</span><span class="p">:</span>
  1316. <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>
  1317. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
  1318. <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>
  1319. <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>
  1320. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1321. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1322. <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>
  1323. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1324. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1325. <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>
  1326. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1327. <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>
  1328. <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>
  1329. </code></pre></div>
  1330. <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>
  1331. <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>
  1332. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Role</span>
  1333. <span class="nt">metadata</span><span class="p">:</span>
  1334. <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>
  1335. <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>
  1336. <span class="nt">rules</span><span class="p">:</span>
  1337. <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>
  1338. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  1339. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secrets</span>
  1340. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span>
  1341. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">get</span>
  1342. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">list</span>
  1343. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watch</span>
  1344. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create</span>
  1345. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">update</span>
  1346. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">patch</span>
  1347. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">delete</span>
  1348. <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">apiGroups</span><span class="p">:</span>
  1349. <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>
  1350. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  1351. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">selfsubjectrulesreviews</span>
  1352. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span>
  1353. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create</span>
  1354. </code></pre></div>
  1355. <h4 id="implementation-considerations">Implementation Considerations</h4>
  1356. <p>When utilizing the PushSecret feature and configuring the permissions for the SecretStore, consider the following:</p>
  1357. <ul>
  1358. <li>
  1359. <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>
  1360. </li>
  1361. <li>
  1362. <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>
  1363. </li>
  1364. <li>
  1365. <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>
  1366. </li>
  1367. </ul>
  1368. </article>
  1369. </div>
  1370. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1371. </div>
  1372. </main>
  1373. <footer class="md-footer">
  1374. <div class="md-footer-meta md-typeset">
  1375. <div class="md-footer-meta__inner md-grid">
  1376. <div class="md-copyright">
  1377. <div class="md-copyright__highlight">
  1378. &copy; 2023 The external-secrets Authors.<br/>
  1379. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1380. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1381. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1382. </div>
  1383. Made with
  1384. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1385. Material for MkDocs
  1386. </a>
  1387. </div>
  1388. </div>
  1389. </div>
  1390. </footer>
  1391. </div>
  1392. <div class="md-dialog" data-md-component="dialog">
  1393. <div class="md-dialog__inner md-typeset"></div>
  1394. </div>
  1395. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.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>
  1396. <script src="../../assets/javascripts/bundle.caa56a14.min.js"></script>
  1397. </body>
  1398. </html>