index.html 74 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603
  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="../aws-secrets-manager/">
  7. <link rel="next" href="../azure-key-vault/">
  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>AWS Parameter Store - 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="#parameter-store" 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. AWS Parameter Store
  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 md-nav__item--active">
  503. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  504. <label class="md-nav__link md-nav__link--active" for="__toc">
  505. AWS Parameter Store
  506. <span class="md-nav__icon md-icon"></span>
  507. </label>
  508. <a href="./" class="md-nav__link md-nav__link--active">
  509. AWS Parameter Store
  510. </a>
  511. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  512. <label class="md-nav__title" for="__toc">
  513. <span class="md-nav__icon md-icon"></span>
  514. Table of contents
  515. </label>
  516. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  517. <li class="md-nav__item">
  518. <a href="#parameter-store" class="md-nav__link">
  519. Parameter Store
  520. </a>
  521. <nav class="md-nav" aria-label="Parameter Store">
  522. <ul class="md-nav__list">
  523. <li class="md-nav__item">
  524. <a href="#iam-policy" class="md-nav__link">
  525. IAM Policy
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="#json-secret-values" class="md-nav__link">
  530. JSON Secret Values
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="#parameter-versions" class="md-nav__link">
  535. Parameter Versions
  536. </a>
  537. </li>
  538. </ul>
  539. </nav>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="#setsecret" class="md-nav__link">
  543. SetSecret
  544. </a>
  545. <nav class="md-nav" aria-label="SetSecret">
  546. <ul class="md-nav__list">
  547. <li class="md-nav__item">
  548. <a href="#creating-a-push-secret" class="md-nav__link">
  549. Creating a Push Secret
  550. </a>
  551. <nav class="md-nav" aria-label="Creating a Push Secret">
  552. <ul class="md-nav__list">
  553. <li class="md-nav__item">
  554. <a href="#check-successful-secret-sync" class="md-nav__link">
  555. Check successful secret sync
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  560. Test new secret using AWS CLI
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. </ul>
  567. </nav>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="#aws-authentication" class="md-nav__link">
  571. AWS Authentication
  572. </a>
  573. <nav class="md-nav" aria-label="AWS Authentication">
  574. <ul class="md-nav__list">
  575. <li class="md-nav__item">
  576. <a href="#controllers-pod-identity" class="md-nav__link">
  577. Controller's Pod Identity
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  582. Access Key ID &amp; Secret Access Key
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="#eks-service-account-credentials" class="md-nav__link">
  587. EKS Service Account credentials
  588. </a>
  589. </li>
  590. </ul>
  591. </nav>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="#custom-endpoints" class="md-nav__link">
  595. Custom Endpoints
  596. </a>
  597. </li>
  598. </ul>
  599. </nav>
  600. </li>
  601. <li class="md-nav__item">
  602. <a href="../azure-key-vault/" class="md-nav__link">
  603. Azure Key Vault
  604. </a>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="../google-secrets-manager/" class="md-nav__link">
  608. Google Cloud Secret Manager
  609. </a>
  610. </li>
  611. <li class="md-nav__item">
  612. <a href="../hashicorp-vault/" class="md-nav__link">
  613. HashiCorp Vault
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../kubernetes/" class="md-nav__link">
  618. Kubernetes
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../ibm-secrets-manager/" class="md-nav__link">
  623. IBM Secrets Manager
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../akeyless/" class="md-nav__link">
  628. Akeyless
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../yandex-certificate-manager/" class="md-nav__link">
  633. Yandex Certificate Manager
  634. </a>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="../yandex-lockbox/" class="md-nav__link">
  638. Yandex Lockbox
  639. </a>
  640. </li>
  641. <li class="md-nav__item">
  642. <a href="../alibaba/" class="md-nav__link">
  643. Alibaba Cloud
  644. </a>
  645. </li>
  646. <li class="md-nav__item">
  647. <a href="../gitlab-variables/" class="md-nav__link">
  648. GitLab Variables
  649. </a>
  650. </li>
  651. <li class="md-nav__item">
  652. <a href="../oracle-vault/" class="md-nav__link">
  653. Oracle Vault
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../1password-automation/" class="md-nav__link">
  658. 1Password Secrets Automation
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../webhook/" class="md-nav__link">
  663. Webhook
  664. </a>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="../fake/" class="md-nav__link">
  668. Fake
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../senhasegura-dsm/" class="md-nav__link">
  673. senhasegura DevOps Secrets Management (DSM)
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../doppler/" class="md-nav__link">
  678. Doppler
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="../keeper-security/" class="md-nav__link">
  683. Keeper Security
  684. </a>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="../scaleway/" class="md-nav__link">
  688. Scaleway
  689. </a>
  690. </li>
  691. </ul>
  692. </nav>
  693. </li>
  694. <li class="md-nav__item md-nav__item--nested">
  695. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  696. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  697. Examples
  698. <span class="md-nav__icon md-icon"></span>
  699. </label>
  700. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  701. <label class="md-nav__title" for="__nav_5">
  702. <span class="md-nav__icon md-icon"></span>
  703. Examples
  704. </label>
  705. <ul class="md-nav__list" data-md-scrollfix>
  706. <li class="md-nav__item">
  707. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  708. FluxCD
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  713. Anchore Engine
  714. </a>
  715. </li>
  716. <li class="md-nav__item">
  717. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  718. Jenkins
  719. </a>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="../../examples/bitwarden/" class="md-nav__link">
  723. BitWarden
  724. </a>
  725. </li>
  726. </ul>
  727. </nav>
  728. </li>
  729. <li class="md-nav__item md-nav__item--nested">
  730. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  731. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  732. Community
  733. <span class="md-nav__icon md-icon"></span>
  734. </label>
  735. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  736. <label class="md-nav__title" for="__nav_6">
  737. <span class="md-nav__icon md-icon"></span>
  738. Community
  739. </label>
  740. <ul class="md-nav__list" data-md-scrollfix>
  741. <li class="md-nav__item md-nav__item--nested">
  742. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  743. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  744. Contributing
  745. <span class="md-nav__icon md-icon"></span>
  746. </label>
  747. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  748. <label class="md-nav__title" for="__nav_6_1">
  749. <span class="md-nav__icon md-icon"></span>
  750. Contributing
  751. </label>
  752. <ul class="md-nav__list" data-md-scrollfix>
  753. <li class="md-nav__item">
  754. <a href="../../contributing/devguide/" class="md-nav__link">
  755. Developer guide
  756. </a>
  757. </li>
  758. <li class="md-nav__item">
  759. <a href="../../contributing/process/" class="md-nav__link">
  760. Contributing Process
  761. </a>
  762. </li>
  763. <li class="md-nav__item">
  764. <a href="../../contributing/release/" class="md-nav__link">
  765. Release Process
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../../contributing/coc/" class="md-nav__link">
  770. Code of Conduct
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../contributing/roadmap/" class="md-nav__link">
  775. Roadmap
  776. </a>
  777. </li>
  778. </ul>
  779. </nav>
  780. </li>
  781. <li class="md-nav__item md-nav__item--nested">
  782. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  783. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  784. External Resources
  785. <span class="md-nav__icon md-icon"></span>
  786. </label>
  787. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  788. <label class="md-nav__title" for="__nav_6_2">
  789. <span class="md-nav__icon md-icon"></span>
  790. External Resources
  791. </label>
  792. <ul class="md-nav__list" data-md-scrollfix>
  793. <li class="md-nav__item">
  794. <a href="../../eso-talks/" class="md-nav__link">
  795. Talks
  796. </a>
  797. </li>
  798. <li class="md-nav__item">
  799. <a href="../../eso-demos/" class="md-nav__link">
  800. Demos
  801. </a>
  802. </li>
  803. <li class="md-nav__item">
  804. <a href="../../eso-blogs/" class="md-nav__link">
  805. Blogs
  806. </a>
  807. </li>
  808. </ul>
  809. </nav>
  810. </li>
  811. </ul>
  812. </nav>
  813. </li>
  814. </ul>
  815. </nav>
  816. </div>
  817. </div>
  818. </div>
  819. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  820. <div class="md-sidebar__scrollwrap">
  821. <div class="md-sidebar__inner">
  822. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  823. <label class="md-nav__title" for="__toc">
  824. <span class="md-nav__icon md-icon"></span>
  825. Table of contents
  826. </label>
  827. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  828. <li class="md-nav__item">
  829. <a href="#parameter-store" class="md-nav__link">
  830. Parameter Store
  831. </a>
  832. <nav class="md-nav" aria-label="Parameter Store">
  833. <ul class="md-nav__list">
  834. <li class="md-nav__item">
  835. <a href="#iam-policy" class="md-nav__link">
  836. IAM Policy
  837. </a>
  838. </li>
  839. <li class="md-nav__item">
  840. <a href="#json-secret-values" class="md-nav__link">
  841. JSON Secret Values
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="#parameter-versions" class="md-nav__link">
  846. Parameter Versions
  847. </a>
  848. </li>
  849. </ul>
  850. </nav>
  851. </li>
  852. <li class="md-nav__item">
  853. <a href="#setsecret" class="md-nav__link">
  854. SetSecret
  855. </a>
  856. <nav class="md-nav" aria-label="SetSecret">
  857. <ul class="md-nav__list">
  858. <li class="md-nav__item">
  859. <a href="#creating-a-push-secret" class="md-nav__link">
  860. Creating a Push Secret
  861. </a>
  862. <nav class="md-nav" aria-label="Creating a Push Secret">
  863. <ul class="md-nav__list">
  864. <li class="md-nav__item">
  865. <a href="#check-successful-secret-sync" class="md-nav__link">
  866. Check successful secret sync
  867. </a>
  868. </li>
  869. <li class="md-nav__item">
  870. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  871. Test new secret using AWS CLI
  872. </a>
  873. </li>
  874. </ul>
  875. </nav>
  876. </li>
  877. </ul>
  878. </nav>
  879. </li>
  880. <li class="md-nav__item">
  881. <a href="#aws-authentication" class="md-nav__link">
  882. AWS Authentication
  883. </a>
  884. <nav class="md-nav" aria-label="AWS Authentication">
  885. <ul class="md-nav__list">
  886. <li class="md-nav__item">
  887. <a href="#controllers-pod-identity" class="md-nav__link">
  888. Controller's Pod Identity
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  893. Access Key ID &amp; Secret Access Key
  894. </a>
  895. </li>
  896. <li class="md-nav__item">
  897. <a href="#eks-service-account-credentials" class="md-nav__link">
  898. EKS Service Account credentials
  899. </a>
  900. </li>
  901. </ul>
  902. </nav>
  903. </li>
  904. <li class="md-nav__item">
  905. <a href="#custom-endpoints" class="md-nav__link">
  906. Custom Endpoints
  907. </a>
  908. </li>
  909. </ul>
  910. </nav>
  911. </div>
  912. </div>
  913. </div>
  914. <div class="md-content" data-md-component="content">
  915. <article class="md-content__inner md-typeset">
  916. <h1>AWS Parameter Store</h1>
  917. <p><img alt="aws sm" src="../../pictures/diagrams-provider-aws-ssm-parameter-store.png" /></p>
  918. <h2 id="parameter-store">Parameter Store</h2>
  919. <p>A <code>ParameterStore</code> points to AWS SSM Parameter Store in a certain account within a
  920. defined region. You should define Roles that define fine-grained access to
  921. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  922. way users of the <code>SecretStore</code> can only access the secrets necessary.</p>
  923. <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>
  924. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  925. <span class="nt">metadata</span><span class="p">:</span>
  926. <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">parameterstore</span>
  927. <span class="nt">spec</span><span class="p">:</span>
  928. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  929. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  930. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ParameterStore</span>
  931. <span class="w"> </span><span class="c1"># define a specific role to limit access</span>
  932. <span class="w"> </span><span class="c1"># to certain secrets</span>
  933. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arn:aws:iam::123456789012:role/external-secrets</span>
  934. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  935. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  936. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  937. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  938. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  939. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access-key</span>
  940. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  941. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  942. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  943. </code></pre></div>
  944. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>accessKeyIDSecretRef</code> and <code>secretAccessKeySecretRef</code> with the namespaces where the secrets reside.</p>
  945. <div class="admonition warning">
  946. <p class="admonition-title">API Pricing &amp; Throttling</p>
  947. <p>The SSM Parameter Store API is charged by throughput and
  948. is available in different tiers, <a href="https://aws.amazon.com/systems-manager/pricing/#Parameter_Store">see pricing</a>.
  949. Please estimate your costs before using ESO. Cost depends on the RefreshInterval of your ExternalSecrets.</p>
  950. </div>
  951. <h3 id="iam-policy">IAM Policy</h3>
  952. <p>The example policy below shows the minimum required permissions for fetching SSM parameters. This policy permits pinning down access to secrets with a path matching <code>dev-*</code>. Other operations may require additional permission. For example, finding parameters based on tags will also require <code>ssm:DescribeParameters</code> and <code>tag:GetResources</code> permission with <code>"Resource": "*"</code>. Generally, the specific permission required will be logged as an error if an operation fails.</p>
  953. <p>For further information see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-access.html">AWS Documentation</a>.</p>
  954. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  955. <span class="w"> </span><span class="nt">&quot;Version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2012-10-17&quot;</span><span class="p">,</span>
  956. <span class="w"> </span><span class="nt">&quot;Statement&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  957. <span class="w"> </span><span class="p">{</span>
  958. <span class="w"> </span><span class="nt">&quot;Effect&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Allow&quot;</span><span class="p">,</span>
  959. <span class="w"> </span><span class="nt">&quot;Action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  960. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter*&quot;</span><span class="p">,</span>
  961. <span class="w"> </span><span class="p">],</span>
  962. <span class="w"> </span><span class="nt">&quot;Resource&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;arn:aws:ssm:us-east-2:1234567889911:parameter/dev-*&quot;</span>
  963. <span class="w"> </span><span class="p">}</span>
  964. <span class="w"> </span><span class="p">]</span>
  965. <span class="p">}</span>
  966. </code></pre></div>
  967. <h3 id="json-secret-values">JSON Secret Values</h3>
  968. <p>You can store JSON objects in a parameter. You can access nested values or arrays using <a href="https://github.com/tidwall/gjson/blob/master/SYNTAX.md">gjson syntax</a>:</p>
  969. <p>Consider the following JSON object that is stored in the Parameter Store key <code>friendslist</code>:
  970. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  971. <span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Tom&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;last&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Anderson&quot;</span><span class="p">},</span>
  972. <span class="w"> </span><span class="nt">&quot;friends&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  973. <span class="w"> </span><span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Dale&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;last&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Murphy&quot;</span><span class="p">},</span>
  974. <span class="w"> </span><span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Roger&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;last&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Craig&quot;</span><span class="p">},</span>
  975. <span class="w"> </span><span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Jane&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;last&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Murphy&quot;</span><span class="p">}</span>
  976. <span class="w"> </span><span class="p">]</span>
  977. <span class="p">}</span>
  978. </code></pre></div></p>
  979. <p>This is an example on how you would look up nested keys in the above json object:
  980. <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>
  981. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  982. <span class="nt">metadata</span><span class="p">:</span>
  983. <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">extract-data</span>
  984. <span class="nt">spec</span><span class="p">:</span>
  985. <span class="w"> </span><span class="c1"># [omitted for brevity]</span>
  986. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  987. <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">my_name</span>
  988. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  989. <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">friendslist</span>
  990. <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">name.first</span><span class="w"> </span><span class="c1"># Tom</span>
  991. <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">first_friend</span>
  992. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  993. <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">friendslist</span>
  994. <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">friends.1.first</span><span class="w"> </span><span class="c1"># Roger</span>
  995. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the tags in JSON format</span>
  996. <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>
  997. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  998. <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>
  999. <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>
  1000. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific tag (dev) from the source secret</span>
  1001. <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>
  1002. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1003. <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>
  1004. <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>
  1005. <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">dev</span>
  1006. </code></pre></div></p>
  1007. <h3 id="parameter-versions">Parameter Versions</h3>
  1008. <p>ParameterStore creates a new version of a parameter every time it is updated with a new value. The parameter can be referenced via the <code>version</code> property</p>
  1009. <h2 id="setsecret">SetSecret</h2>
  1010. <p>The SetSecret method for the Parameter Store allows the user to set the value stored within the Kubernetes cluster to the remote AWS Parameter Store.</p>
  1011. <h3 id="creating-a-push-secret">Creating a Push Secret</h3>
  1012. <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>
  1013. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1014. <span class="nt">metadata</span><span class="p">:</span>
  1015. <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">pushsecret-example</span><span class="w"> </span><span class="c1"># Customisable</span>
  1016. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"> </span><span class="c1"># Same of the SecretStores</span>
  1017. <span class="nt">spec</span><span class="p">:</span>
  1018. <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><span class="w"> </span><span class="c1"># Refresh interval for which push secret will reconcile</span>
  1019. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span><span class="w"> </span><span class="c1"># A list of secret stores to push secrets to</span>
  1020. <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">aws-parameterstore</span>
  1021. <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>
  1022. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1023. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1024. <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><span class="w"> </span><span class="c1"># Source Kubernetes secret to be pushed</span>
  1025. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1026. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1027. <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><span class="w"> </span><span class="c1"># Source Kubernetes secret key to be pushed</span>
  1028. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1029. <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">my-first-parameter</span><span class="w"> </span><span class="c1"># Remote reference (where the secret is going to be pushed)</span>
  1030. </code></pre></div>
  1031. <h4 id="check-successful-secret-sync">Check successful secret sync</h4>
  1032. <p>To be able to check that the secret has been succesfully synced you can run the following command:</p>
  1033. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>get<span class="w"> </span>pushsecret<span class="w"> </span>pushsecret-example
  1034. </code></pre></div>
  1035. <p>If the secret has synced successfully it will show the status as "Synced".</p>
  1036. <h4 id="test-new-secret-using-aws-cli">Test new secret using AWS CLI</h4>
  1037. <p>To View your parameter on AWS Parameter Store using the AWS CLI, install and login to the AWS CLI using the following guide: <a href="https://aws.amazon.com/cli/">AWS CLI</a>.</p>
  1038. <p>Run the following commands to get your synchronized parameter from AWS Parameter Store:</p>
  1039. <div class="highlight"><pre><span></span><code>aws<span class="w"> </span>ssm<span class="w"> </span>get-parameter<span class="w"> </span>--name<span class="o">=</span>my-first-parameter<span class="w"> </span>--region<span class="o">=</span>us-east-1
  1040. </code></pre></div>
  1041. <p>You should see something similar to the following output:</p>
  1042. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1043. <span class="w"> </span><span class="nt">&quot;Parameter&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1044. <span class="w"> </span><span class="nt">&quot;Name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;my-first-parameter&quot;</span><span class="p">,</span>
  1045. <span class="w"> </span><span class="nt">&quot;Type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;String&quot;</span><span class="p">,</span>
  1046. <span class="w"> </span><span class="nt">&quot;Value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;charmander&quot;</span><span class="p">,</span>
  1047. <span class="w"> </span><span class="nt">&quot;Version&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
  1048. <span class="w"> </span><span class="nt">&quot;LastModifiedDate&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2022-09-15T13:04:31.098000-03:00&quot;</span><span class="p">,</span>
  1049. <span class="w"> </span><span class="nt">&quot;ARN&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;arn:aws:ssm:us-east-1:1234567890123:parameter/my-first-parameter&quot;</span><span class="p">,</span>
  1050. <span class="w"> </span><span class="nt">&quot;DataType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;text&quot;</span>
  1051. <span class="w"> </span><span class="p">}</span>
  1052. <span class="p">}</span>
  1053. </code></pre></div>
  1054. <h2 id="aws-authentication">AWS Authentication</h2>
  1055. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  1056. <p><img alt="Pod Identity Authentication" src="../../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  1057. <p>Note: If you are using Parameter Store replace <code>service: SecretsManager</code> with <code>service: ParameterStore</code> in all examples below.</p>
  1058. <p>This is basicially a zero-configuration authentication method that inherits the credentials from the runtime environment using the <a href="https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default">aws sdk default credential chain</a>.</p>
  1059. <p>You can attach a role to the pod using <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">IRSA</a>, <a href="https://github.com/uswitch/kiam">kiam</a> or <a href="https://github.com/jtblin/kube2iam">kube2iam</a>. When no other authentication method is configured in the <code>Kind=Secretstore</code> this role is used to make all API calls against AWS Secrets Manager or SSM Parameter Store.</p>
  1060. <p>Based on the Pod's identity you can do a <code>sts:assumeRole</code> before fetching the secrets to limit access to certain keys in your provider. This is optional.</p>
  1061. <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>
  1062. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1063. <span class="nt">metadata</span><span class="p">:</span>
  1064. <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">team-b-store</span>
  1065. <span class="nt">spec</span><span class="p">:</span>
  1066. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1067. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1068. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  1069. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  1070. <span class="w"> </span><span class="c1"># optional: do a sts:assumeRole before fetching secrets</span>
  1071. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-b</span>
  1072. </code></pre></div>
  1073. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  1074. <p><img alt="SecretRef" src="../../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  1075. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  1076. <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>
  1077. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1078. <span class="nt">metadata</span><span class="p">:</span>
  1079. <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">team-b-store</span>
  1080. <span class="nt">spec</span><span class="p">:</span>
  1081. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1082. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1083. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  1084. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  1085. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span>
  1086. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-b</span>
  1087. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1088. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1089. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1090. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  1091. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access-key</span>
  1092. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1093. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  1094. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  1095. </code></pre></div>
  1096. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>accessKeyIDSecretRef</code>, <code>secretAccessKeySecretRef</code> with the namespaces where the secrets reside.</p>
  1097. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  1098. <p><img alt="Service Account" src="../../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  1099. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  1100. You must have <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection">Service Account Volume Projection</a> enabled - it is by default on EKS. See <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-technical-overview.html">EKS guide</a> on how to set up IAM roles for service accounts.</p>
  1101. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  1102. <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>
  1103. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  1104. <span class="nt">metadata</span><span class="p">:</span>
  1105. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1106. <span class="w"> </span><span class="nt">eks.amazonaws.com/role-arn</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arn:aws:iam::123456789012:role/team-a</span>
  1107. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-serviceaccount</span>
  1108. <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>
  1109. </code></pre></div>
  1110. <p>Reference the service account from above in the Secret Store:</p>
  1111. <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>
  1112. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1113. <span class="nt">metadata</span><span class="p">:</span>
  1114. <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">secretstore-sample</span>
  1115. <span class="nt">spec</span><span class="p">:</span>
  1116. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1117. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1118. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  1119. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  1120. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1121. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  1122. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</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">my-serviceaccount</span>
  1124. </code></pre></div>
  1125. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> for <code>serviceAccountRef</code> with the namespace where the service account resides.</p>
  1126. <h2 id="custom-endpoints">Custom Endpoints</h2>
  1127. <p>You can define custom AWS endpoints if you want to use regional, vpc or custom endpoints. See List of endpoints for <a href="https://docs.aws.amazon.com/general/latest/gr/asm.html">Secrets Manager</a>, <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html">Secure Systems Manager</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/sts.html">Security Token Service</a>.</p>
  1128. <p>Use the following environment variables to point the controller to your custom endpoints. Note: All resources managed by this controller are affected.</p>
  1129. <table>
  1130. <thead>
  1131. <tr>
  1132. <th>ENV VAR</th>
  1133. <th>DESCRIPTION</th>
  1134. </tr>
  1135. </thead>
  1136. <tbody>
  1137. <tr>
  1138. <td>AWS_SECRETSMANAGER_ENDPOINT</td>
  1139. <td>Endpoint for the Secrets Manager Service. The controller uses this endpoint to fetch secrets from AWS Secrets Manager.</td>
  1140. </tr>
  1141. <tr>
  1142. <td>AWS_SSM_ENDPOINT</td>
  1143. <td>Endpoint for the AWS Secure Systems Manager. The controller uses this endpoint to fetch secrets from SSM Parameter Store.</td>
  1144. </tr>
  1145. <tr>
  1146. <td>AWS_STS_ENDPOINT</td>
  1147. <td>Endpoint for the Security Token Service. The controller uses this endpoint when creating a session and when doing <code>assumeRole</code> or <code>assumeRoleWithWebIdentity</code> calls.</td>
  1148. </tr>
  1149. </tbody>
  1150. </table>
  1151. </article>
  1152. </div>
  1153. </div>
  1154. </main>
  1155. <footer class="md-footer">
  1156. <div class="md-footer-meta md-typeset">
  1157. <div class="md-footer-meta__inner md-grid">
  1158. <div class="md-copyright">
  1159. <div class="md-copyright__highlight">
  1160. &copy; 2023 The external-secrets Authors.<br/>
  1161. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1162. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1163. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1164. </div>
  1165. Made with
  1166. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1167. Material for MkDocs
  1168. </a>
  1169. </div>
  1170. </div>
  1171. </div>
  1172. </footer>
  1173. </div>
  1174. <div class="md-dialog" data-md-component="dialog">
  1175. <div class="md-dialog__inner md-typeset"></div>
  1176. </div>
  1177. <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>
  1178. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  1179. </body>
  1180. </html>