index.html 99 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986
  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="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.36">
  10. <title>AWS Parameter Store - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.06209087.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <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">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <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>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  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. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  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 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></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. <form class="md-header__option" data-md-component="palette">
  65. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  68. </label>
  69. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  72. </label>
  73. </form>
  74. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var 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(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  75. <label class="md-header__button md-icon" for="__search">
  76. <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.52 6.52 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 5"/></svg>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <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>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <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.52 6.52 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 5"/></svg>
  85. <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 11z"/></svg>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <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 12z"/></svg>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.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 2024 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.81"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item">
  127. <a href="../../api/components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item">
  132. <a href="../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item md-tabs__item--active">
  137. <a href="../aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.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 2024 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.81"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../introduction/getting-started/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Getting started
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/faq/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. FAQ
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/stability-support/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Stability and Support
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. Deprecation Policy
  227. </span>
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  235. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  236. <span class="md-ellipsis">
  237. API
  238. </span>
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  242. <label class="md-nav__title" for="__nav_2">
  243. <span class="md-nav__icon md-icon"></span>
  244. API
  245. </label>
  246. <ul class="md-nav__list" data-md-scrollfix>
  247. <li class="md-nav__item">
  248. <a href="../../api/components/" class="md-nav__link">
  249. <span class="md-ellipsis">
  250. Components
  251. </span>
  252. </a>
  253. </li>
  254. <li class="md-nav__item md-nav__item--nested">
  255. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  256. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  257. <span class="md-ellipsis">
  258. Core Resources
  259. </span>
  260. <span class="md-nav__icon md-icon"></span>
  261. </label>
  262. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  263. <label class="md-nav__title" for="__nav_2_2">
  264. <span class="md-nav__icon md-icon"></span>
  265. Core Resources
  266. </label>
  267. <ul class="md-nav__list" data-md-scrollfix>
  268. <li class="md-nav__item">
  269. <a href="../../api/externalsecret/" class="md-nav__link">
  270. <span class="md-ellipsis">
  271. ExternalSecret
  272. </span>
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../../api/secretstore/" class="md-nav__link">
  277. <span class="md-ellipsis">
  278. SecretStore
  279. </span>
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/clustersecretstore/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ClusterSecretStore
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. ClusterExternalSecret
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../api/pushsecret/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. PushSecret
  300. </span>
  301. </a>
  302. </li>
  303. </ul>
  304. </nav>
  305. </li>
  306. <li class="md-nav__item md-nav__item--nested">
  307. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  308. <div class="md-nav__link md-nav__container">
  309. <a href="../../api/generator/" class="md-nav__link ">
  310. <span class="md-ellipsis">
  311. Generators
  312. </span>
  313. </a>
  314. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  315. <span class="md-nav__icon md-icon"></span>
  316. </label>
  317. </div>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_3">
  320. <span class="md-nav__icon md-icon"></span>
  321. Generators
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../../api/generator/acr/" class="md-nav__link">
  326. <span class="md-ellipsis">
  327. Azure Container Registry
  328. </span>
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../../api/generator/ecr/" class="md-nav__link">
  333. <span class="md-ellipsis">
  334. AWS Elastic Container Registry
  335. </span>
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../../api/generator/gcr/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. Google Container Registry
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/vault/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Vault Dynamic Secret
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/password/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. Password
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/fake/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. Fake
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/webhook/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Webhook
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/github/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Github
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/uuid/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. UUID
  384. </span>
  385. </a>
  386. </li>
  387. </ul>
  388. </nav>
  389. </li>
  390. <li class="md-nav__item md-nav__item--nested">
  391. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  392. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  393. <span class="md-ellipsis">
  394. Reference Docs
  395. </span>
  396. <span class="md-nav__icon md-icon"></span>
  397. </label>
  398. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  399. <label class="md-nav__title" for="__nav_2_4">
  400. <span class="md-nav__icon md-icon"></span>
  401. Reference Docs
  402. </label>
  403. <ul class="md-nav__list" data-md-scrollfix>
  404. <li class="md-nav__item">
  405. <a href="../../api/spec/" class="md-nav__link">
  406. <span class="md-ellipsis">
  407. API specification
  408. </span>
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="../../api/controller-options/" class="md-nav__link">
  413. <span class="md-ellipsis">
  414. Controller Options
  415. </span>
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../api/metrics/" class="md-nav__link">
  420. <span class="md-ellipsis">
  421. Metrics
  422. </span>
  423. </a>
  424. </li>
  425. </ul>
  426. </nav>
  427. </li>
  428. </ul>
  429. </nav>
  430. </li>
  431. <li class="md-nav__item md-nav__item--nested">
  432. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  433. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  434. <span class="md-ellipsis">
  435. Guides
  436. </span>
  437. <span class="md-nav__icon md-icon"></span>
  438. </label>
  439. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  440. <label class="md-nav__title" for="__nav_3">
  441. <span class="md-nav__icon md-icon"></span>
  442. Guides
  443. </label>
  444. <ul class="md-nav__list" data-md-scrollfix>
  445. <li class="md-nav__item">
  446. <a href="../../guides/introduction/" class="md-nav__link">
  447. <span class="md-ellipsis">
  448. Introduction
  449. </span>
  450. </a>
  451. </li>
  452. <li class="md-nav__item md-nav__item--nested">
  453. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  454. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  455. <span class="md-ellipsis">
  456. External Secrets
  457. </span>
  458. <span class="md-nav__icon md-icon"></span>
  459. </label>
  460. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  461. <label class="md-nav__title" for="__nav_3_2">
  462. <span class="md-nav__icon md-icon"></span>
  463. External Secrets
  464. </label>
  465. <ul class="md-nav__list" data-md-scrollfix>
  466. <li class="md-nav__item">
  467. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. Extract structured data
  470. </span>
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../../guides/getallsecrets/" class="md-nav__link">
  475. <span class="md-ellipsis">
  476. Find Secrets by Name or Metadata
  477. </span>
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  482. <span class="md-ellipsis">
  483. Rewriting Keys
  484. </span>
  485. </a>
  486. </li>
  487. <li class="md-nav__item md-nav__item--nested">
  488. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  489. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  490. <span class="md-ellipsis">
  491. Advanced Templating
  492. </span>
  493. <span class="md-nav__icon md-icon"></span>
  494. </label>
  495. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  496. <label class="md-nav__title" for="__nav_3_2_4">
  497. <span class="md-nav__icon md-icon"></span>
  498. Advanced Templating
  499. </label>
  500. <ul class="md-nav__list" data-md-scrollfix>
  501. <li class="md-nav__item">
  502. <a href="../../guides/templating/" class="md-nav__link">
  503. <span class="md-ellipsis">
  504. v2
  505. </span>
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../guides/templating-v1/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. v1
  512. </span>
  513. </a>
  514. </li>
  515. </ul>
  516. </nav>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  520. <span class="md-ellipsis">
  521. Kubernetes Secret Types
  522. </span>
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  527. <span class="md-ellipsis">
  528. Lifecycle: ownership & deletion
  529. </span>
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  534. <span class="md-ellipsis">
  535. Decoding Strategies
  536. </span>
  537. </a>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../guides/controller-class/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Controller Classes
  543. </span>
  544. </a>
  545. </li>
  546. </ul>
  547. </nav>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="../../guides/generator/" class="md-nav__link">
  551. <span class="md-ellipsis">
  552. Generators
  553. </span>
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../../guides/pushsecrets/" class="md-nav__link">
  558. <span class="md-ellipsis">
  559. Push Secrets
  560. </span>
  561. </a>
  562. </li>
  563. <li class="md-nav__item md-nav__item--nested">
  564. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  565. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  566. <span class="md-ellipsis">
  567. Operations
  568. </span>
  569. <span class="md-nav__icon md-icon"></span>
  570. </label>
  571. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  572. <label class="md-nav__title" for="__nav_3_5">
  573. <span class="md-nav__icon md-icon"></span>
  574. Operations
  575. </label>
  576. <ul class="md-nav__list" data-md-scrollfix>
  577. <li class="md-nav__item">
  578. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  579. <span class="md-ellipsis">
  580. Multi Tenancy
  581. </span>
  582. </a>
  583. </li>
  584. <li class="md-nav__item">
  585. <a href="../../guides/security-best-practices/" class="md-nav__link">
  586. <span class="md-ellipsis">
  587. Security Best Practices
  588. </span>
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../../guides/threat-model/" class="md-nav__link">
  593. <span class="md-ellipsis">
  594. Threat Model
  595. </span>
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../../guides/v1beta1/" class="md-nav__link">
  600. <span class="md-ellipsis">
  601. Upgrading to v1beta1
  602. </span>
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../guides/using-latest-image/" class="md-nav__link">
  607. <span class="md-ellipsis">
  608. Using Latest Image
  609. </span>
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. Disable Cluster Features
  616. </span>
  617. </a>
  618. </li>
  619. </ul>
  620. </nav>
  621. </li>
  622. </ul>
  623. </nav>
  624. </li>
  625. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  626. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  627. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  628. <span class="md-ellipsis">
  629. Provider
  630. </span>
  631. <span class="md-nav__icon md-icon"></span>
  632. </label>
  633. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  634. <label class="md-nav__title" for="__nav_4">
  635. <span class="md-nav__icon md-icon"></span>
  636. Provider
  637. </label>
  638. <ul class="md-nav__list" data-md-scrollfix>
  639. <li class="md-nav__item">
  640. <a href="../aws-secrets-manager/" class="md-nav__link">
  641. <span class="md-ellipsis">
  642. AWS Secrets Manager
  643. </span>
  644. </a>
  645. </li>
  646. <li class="md-nav__item md-nav__item--active">
  647. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  648. <label class="md-nav__link md-nav__link--active" for="__toc">
  649. <span class="md-ellipsis">
  650. AWS Parameter Store
  651. </span>
  652. <span class="md-nav__icon md-icon"></span>
  653. </label>
  654. <a href="./" class="md-nav__link md-nav__link--active">
  655. <span class="md-ellipsis">
  656. AWS Parameter Store
  657. </span>
  658. </a>
  659. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  660. <label class="md-nav__title" for="__toc">
  661. <span class="md-nav__icon md-icon"></span>
  662. Table of contents
  663. </label>
  664. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  665. <li class="md-nav__item">
  666. <a href="#parameter-store" class="md-nav__link">
  667. <span class="md-ellipsis">
  668. Parameter Store
  669. </span>
  670. </a>
  671. <nav class="md-nav" aria-label="Parameter Store">
  672. <ul class="md-nav__list">
  673. <li class="md-nav__item">
  674. <a href="#iam-policy" class="md-nav__link">
  675. <span class="md-ellipsis">
  676. IAM Policy
  677. </span>
  678. </a>
  679. <nav class="md-nav" aria-label="IAM Policy">
  680. <ul class="md-nav__list">
  681. <li class="md-nav__item">
  682. <a href="#fetching-parameters" class="md-nav__link">
  683. <span class="md-ellipsis">
  684. Fetching Parameters
  685. </span>
  686. </a>
  687. </li>
  688. <li class="md-nav__item">
  689. <a href="#pushing-parameters" class="md-nav__link">
  690. <span class="md-ellipsis">
  691. Pushing Parameters
  692. </span>
  693. </a>
  694. </li>
  695. </ul>
  696. </nav>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="#json-secret-values" class="md-nav__link">
  700. <span class="md-ellipsis">
  701. JSON Secret Values
  702. </span>
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="#parameter-versions" class="md-nav__link">
  707. <span class="md-ellipsis">
  708. Parameter Versions
  709. </span>
  710. </a>
  711. </li>
  712. </ul>
  713. </nav>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="#setsecret" class="md-nav__link">
  717. <span class="md-ellipsis">
  718. SetSecret
  719. </span>
  720. </a>
  721. <nav class="md-nav" aria-label="SetSecret">
  722. <ul class="md-nav__list">
  723. <li class="md-nav__item">
  724. <a href="#creating-a-push-secret" class="md-nav__link">
  725. <span class="md-ellipsis">
  726. Creating a Push Secret
  727. </span>
  728. </a>
  729. <nav class="md-nav" aria-label="Creating a Push Secret">
  730. <ul class="md-nav__list">
  731. <li class="md-nav__item">
  732. <a href="#additional-metadata-for-pushsecret" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. Additional Metadata for PushSecret
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="#check-successful-secret-sync" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. Check successful secret sync
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. Test new secret using AWS CLI
  749. </span>
  750. </a>
  751. </li>
  752. </ul>
  753. </nav>
  754. </li>
  755. </ul>
  756. </nav>
  757. </li>
  758. <li class="md-nav__item">
  759. <a href="#aws-authentication" class="md-nav__link">
  760. <span class="md-ellipsis">
  761. AWS Authentication
  762. </span>
  763. </a>
  764. <nav class="md-nav" aria-label="AWS Authentication">
  765. <ul class="md-nav__list">
  766. <li class="md-nav__item">
  767. <a href="#controllers-pod-identity" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. Controller's Pod Identity
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Access Key ID &amp; Secret Access Key
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="#eks-service-account-credentials" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. EKS Service Account credentials
  784. </span>
  785. </a>
  786. </li>
  787. </ul>
  788. </nav>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="#custom-endpoints" class="md-nav__link">
  792. <span class="md-ellipsis">
  793. Custom Endpoints
  794. </span>
  795. </a>
  796. </li>
  797. </ul>
  798. </nav>
  799. </li>
  800. <li class="md-nav__item">
  801. <a href="../azure-key-vault/" class="md-nav__link">
  802. <span class="md-ellipsis">
  803. Azure Key Vault
  804. </span>
  805. </a>
  806. </li>
  807. <li class="md-nav__item">
  808. <a href="../beyondtrust/" class="md-nav__link">
  809. <span class="md-ellipsis">
  810. BeyondTrust
  811. </span>
  812. </a>
  813. </li>
  814. <li class="md-nav__item">
  815. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  816. <span class="md-ellipsis">
  817. Bitwarden Secrets Manager
  818. </span>
  819. </a>
  820. </li>
  821. <li class="md-nav__item">
  822. <a href="../chef/" class="md-nav__link">
  823. <span class="md-ellipsis">
  824. Chef
  825. </span>
  826. </a>
  827. </li>
  828. <li class="md-nav__item">
  829. <a href="../conjur/" class="md-nav__link">
  830. <span class="md-ellipsis">
  831. CyberArk Conjur
  832. </span>
  833. </a>
  834. </li>
  835. <li class="md-nav__item">
  836. <a href="../device42/" class="md-nav__link">
  837. <span class="md-ellipsis">
  838. Device42
  839. </span>
  840. </a>
  841. </li>
  842. <li class="md-nav__item">
  843. <a href="../google-secrets-manager/" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. Google Cloud Secret Manager
  846. </span>
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="../hashicorp-vault/" class="md-nav__link">
  851. <span class="md-ellipsis">
  852. HashiCorp Vault
  853. </span>
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="../kubernetes/" class="md-nav__link">
  858. <span class="md-ellipsis">
  859. Kubernetes
  860. </span>
  861. </a>
  862. </li>
  863. <li class="md-nav__item">
  864. <a href="../ibm-secrets-manager/" class="md-nav__link">
  865. <span class="md-ellipsis">
  866. IBM Secrets Manager
  867. </span>
  868. </a>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="../akeyless/" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. Akeyless
  874. </span>
  875. </a>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="../yandex-certificate-manager/" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. Yandex Certificate Manager
  881. </span>
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="../yandex-lockbox/" class="md-nav__link">
  886. <span class="md-ellipsis">
  887. Yandex Lockbox
  888. </span>
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="../alibaba/" class="md-nav__link">
  893. <span class="md-ellipsis">
  894. Alibaba Cloud
  895. </span>
  896. </a>
  897. </li>
  898. <li class="md-nav__item">
  899. <a href="../gitlab-variables/" class="md-nav__link">
  900. <span class="md-ellipsis">
  901. GitLab Variables
  902. </span>
  903. </a>
  904. </li>
  905. <li class="md-nav__item">
  906. <a href="../oracle-vault/" class="md-nav__link">
  907. <span class="md-ellipsis">
  908. Oracle Vault
  909. </span>
  910. </a>
  911. </li>
  912. <li class="md-nav__item">
  913. <a href="../1password-automation/" class="md-nav__link">
  914. <span class="md-ellipsis">
  915. 1Password Secrets Automation
  916. </span>
  917. </a>
  918. </li>
  919. <li class="md-nav__item">
  920. <a href="../webhook/" class="md-nav__link">
  921. <span class="md-ellipsis">
  922. Webhook
  923. </span>
  924. </a>
  925. </li>
  926. <li class="md-nav__item">
  927. <a href="../fake/" class="md-nav__link">
  928. <span class="md-ellipsis">
  929. Fake
  930. </span>
  931. </a>
  932. </li>
  933. <li class="md-nav__item">
  934. <a href="../senhasegura-dsm/" class="md-nav__link">
  935. <span class="md-ellipsis">
  936. senhasegura DevOps Secrets Management (DSM)
  937. </span>
  938. </a>
  939. </li>
  940. <li class="md-nav__item">
  941. <a href="../doppler/" class="md-nav__link">
  942. <span class="md-ellipsis">
  943. Doppler
  944. </span>
  945. </a>
  946. </li>
  947. <li class="md-nav__item">
  948. <a href="../keeper-security/" class="md-nav__link">
  949. <span class="md-ellipsis">
  950. Keeper Security
  951. </span>
  952. </a>
  953. </li>
  954. <li class="md-nav__item">
  955. <a href="../cloak/" class="md-nav__link">
  956. <span class="md-ellipsis">
  957. Cloak End 2 End Encrypted Secrets
  958. </span>
  959. </a>
  960. </li>
  961. <li class="md-nav__item">
  962. <a href="../scaleway/" class="md-nav__link">
  963. <span class="md-ellipsis">
  964. Scaleway
  965. </span>
  966. </a>
  967. </li>
  968. <li class="md-nav__item">
  969. <a href="../delinea/" class="md-nav__link">
  970. <span class="md-ellipsis">
  971. Delinea
  972. </span>
  973. </a>
  974. </li>
  975. <li class="md-nav__item">
  976. <a href="../secretserver/" class="md-nav__link">
  977. <span class="md-ellipsis">
  978. Secret Server
  979. </span>
  980. </a>
  981. </li>
  982. <li class="md-nav__item">
  983. <a href="../passbolt/" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. Passbolt
  986. </span>
  987. </a>
  988. </li>
  989. <li class="md-nav__item">
  990. <a href="../pulumi/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. Pulumi ESC
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../onboardbase/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Onboardbase
  1000. </span>
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="../../provider-passworddepot/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Password Depot
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../fortanix/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Fortanix
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../infisical/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Infisical
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../previder/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Previder
  1028. </span>
  1029. </a>
  1030. </li>
  1031. </ul>
  1032. </nav>
  1033. </li>
  1034. <li class="md-nav__item md-nav__item--nested">
  1035. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1036. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1037. <span class="md-ellipsis">
  1038. Examples
  1039. </span>
  1040. <span class="md-nav__icon md-icon"></span>
  1041. </label>
  1042. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1043. <label class="md-nav__title" for="__nav_5">
  1044. <span class="md-nav__icon md-icon"></span>
  1045. Examples
  1046. </label>
  1047. <ul class="md-nav__list" data-md-scrollfix>
  1048. <li class="md-nav__item">
  1049. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1050. <span class="md-ellipsis">
  1051. FluxCD
  1052. </span>
  1053. </a>
  1054. </li>
  1055. <li class="md-nav__item">
  1056. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1057. <span class="md-ellipsis">
  1058. Anchore Engine
  1059. </span>
  1060. </a>
  1061. </li>
  1062. <li class="md-nav__item">
  1063. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1064. <span class="md-ellipsis">
  1065. Jenkins
  1066. </span>
  1067. </a>
  1068. </li>
  1069. <li class="md-nav__item">
  1070. <a href="../../examples/bitwarden/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. BitWarden
  1073. </span>
  1074. </a>
  1075. </li>
  1076. </ul>
  1077. </nav>
  1078. </li>
  1079. <li class="md-nav__item md-nav__item--nested">
  1080. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1081. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1082. <span class="md-ellipsis">
  1083. Community
  1084. </span>
  1085. <span class="md-nav__icon md-icon"></span>
  1086. </label>
  1087. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1088. <label class="md-nav__title" for="__nav_6">
  1089. <span class="md-nav__icon md-icon"></span>
  1090. Community
  1091. </label>
  1092. <ul class="md-nav__list" data-md-scrollfix>
  1093. <li class="md-nav__item md-nav__item--nested">
  1094. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1095. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1096. <span class="md-ellipsis">
  1097. Contributing
  1098. </span>
  1099. <span class="md-nav__icon md-icon"></span>
  1100. </label>
  1101. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1102. <label class="md-nav__title" for="__nav_6_1">
  1103. <span class="md-nav__icon md-icon"></span>
  1104. Contributing
  1105. </label>
  1106. <ul class="md-nav__list" data-md-scrollfix>
  1107. <li class="md-nav__item">
  1108. <a href="../../contributing/devguide/" class="md-nav__link">
  1109. <span class="md-ellipsis">
  1110. Developer guide
  1111. </span>
  1112. </a>
  1113. </li>
  1114. <li class="md-nav__item">
  1115. <a href="../../contributing/process/" class="md-nav__link">
  1116. <span class="md-ellipsis">
  1117. Contributing Process
  1118. </span>
  1119. </a>
  1120. </li>
  1121. <li class="md-nav__item">
  1122. <a href="../../contributing/release/" class="md-nav__link">
  1123. <span class="md-ellipsis">
  1124. Release Process
  1125. </span>
  1126. </a>
  1127. </li>
  1128. <li class="md-nav__item">
  1129. <a href="../../contributing/coc/" class="md-nav__link">
  1130. <span class="md-ellipsis">
  1131. Code of Conduct
  1132. </span>
  1133. </a>
  1134. </li>
  1135. <li class="md-nav__item">
  1136. <a href="../../contributing/roadmap/" class="md-nav__link">
  1137. <span class="md-ellipsis">
  1138. Roadmap
  1139. </span>
  1140. </a>
  1141. </li>
  1142. </ul>
  1143. </nav>
  1144. </li>
  1145. <li class="md-nav__item md-nav__item--nested">
  1146. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1147. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1148. <span class="md-ellipsis">
  1149. External Resources
  1150. </span>
  1151. <span class="md-nav__icon md-icon"></span>
  1152. </label>
  1153. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1154. <label class="md-nav__title" for="__nav_6_2">
  1155. <span class="md-nav__icon md-icon"></span>
  1156. External Resources
  1157. </label>
  1158. <ul class="md-nav__list" data-md-scrollfix>
  1159. <li class="md-nav__item">
  1160. <a href="../../eso-talks/" class="md-nav__link">
  1161. <span class="md-ellipsis">
  1162. Talks
  1163. </span>
  1164. </a>
  1165. </li>
  1166. <li class="md-nav__item">
  1167. <a href="../../eso-demos/" class="md-nav__link">
  1168. <span class="md-ellipsis">
  1169. Demos
  1170. </span>
  1171. </a>
  1172. </li>
  1173. <li class="md-nav__item">
  1174. <a href="../../eso-blogs/" class="md-nav__link">
  1175. <span class="md-ellipsis">
  1176. Blogs
  1177. </span>
  1178. </a>
  1179. </li>
  1180. <li class="md-nav__item">
  1181. <a href="../../eso-tools/" class="md-nav__link">
  1182. <span class="md-ellipsis">
  1183. Tools
  1184. </span>
  1185. </a>
  1186. </li>
  1187. </ul>
  1188. </nav>
  1189. </li>
  1190. </ul>
  1191. </nav>
  1192. </li>
  1193. </ul>
  1194. </nav>
  1195. </div>
  1196. </div>
  1197. </div>
  1198. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1199. <div class="md-sidebar__scrollwrap">
  1200. <div class="md-sidebar__inner">
  1201. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1202. <label class="md-nav__title" for="__toc">
  1203. <span class="md-nav__icon md-icon"></span>
  1204. Table of contents
  1205. </label>
  1206. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1207. <li class="md-nav__item">
  1208. <a href="#parameter-store" class="md-nav__link">
  1209. <span class="md-ellipsis">
  1210. Parameter Store
  1211. </span>
  1212. </a>
  1213. <nav class="md-nav" aria-label="Parameter Store">
  1214. <ul class="md-nav__list">
  1215. <li class="md-nav__item">
  1216. <a href="#iam-policy" class="md-nav__link">
  1217. <span class="md-ellipsis">
  1218. IAM Policy
  1219. </span>
  1220. </a>
  1221. <nav class="md-nav" aria-label="IAM Policy">
  1222. <ul class="md-nav__list">
  1223. <li class="md-nav__item">
  1224. <a href="#fetching-parameters" class="md-nav__link">
  1225. <span class="md-ellipsis">
  1226. Fetching Parameters
  1227. </span>
  1228. </a>
  1229. </li>
  1230. <li class="md-nav__item">
  1231. <a href="#pushing-parameters" class="md-nav__link">
  1232. <span class="md-ellipsis">
  1233. Pushing Parameters
  1234. </span>
  1235. </a>
  1236. </li>
  1237. </ul>
  1238. </nav>
  1239. </li>
  1240. <li class="md-nav__item">
  1241. <a href="#json-secret-values" class="md-nav__link">
  1242. <span class="md-ellipsis">
  1243. JSON Secret Values
  1244. </span>
  1245. </a>
  1246. </li>
  1247. <li class="md-nav__item">
  1248. <a href="#parameter-versions" class="md-nav__link">
  1249. <span class="md-ellipsis">
  1250. Parameter Versions
  1251. </span>
  1252. </a>
  1253. </li>
  1254. </ul>
  1255. </nav>
  1256. </li>
  1257. <li class="md-nav__item">
  1258. <a href="#setsecret" class="md-nav__link">
  1259. <span class="md-ellipsis">
  1260. SetSecret
  1261. </span>
  1262. </a>
  1263. <nav class="md-nav" aria-label="SetSecret">
  1264. <ul class="md-nav__list">
  1265. <li class="md-nav__item">
  1266. <a href="#creating-a-push-secret" class="md-nav__link">
  1267. <span class="md-ellipsis">
  1268. Creating a Push Secret
  1269. </span>
  1270. </a>
  1271. <nav class="md-nav" aria-label="Creating a Push Secret">
  1272. <ul class="md-nav__list">
  1273. <li class="md-nav__item">
  1274. <a href="#additional-metadata-for-pushsecret" class="md-nav__link">
  1275. <span class="md-ellipsis">
  1276. Additional Metadata for PushSecret
  1277. </span>
  1278. </a>
  1279. </li>
  1280. <li class="md-nav__item">
  1281. <a href="#check-successful-secret-sync" class="md-nav__link">
  1282. <span class="md-ellipsis">
  1283. Check successful secret sync
  1284. </span>
  1285. </a>
  1286. </li>
  1287. <li class="md-nav__item">
  1288. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  1289. <span class="md-ellipsis">
  1290. Test new secret using AWS CLI
  1291. </span>
  1292. </a>
  1293. </li>
  1294. </ul>
  1295. </nav>
  1296. </li>
  1297. </ul>
  1298. </nav>
  1299. </li>
  1300. <li class="md-nav__item">
  1301. <a href="#aws-authentication" class="md-nav__link">
  1302. <span class="md-ellipsis">
  1303. AWS Authentication
  1304. </span>
  1305. </a>
  1306. <nav class="md-nav" aria-label="AWS Authentication">
  1307. <ul class="md-nav__list">
  1308. <li class="md-nav__item">
  1309. <a href="#controllers-pod-identity" class="md-nav__link">
  1310. <span class="md-ellipsis">
  1311. Controller's Pod Identity
  1312. </span>
  1313. </a>
  1314. </li>
  1315. <li class="md-nav__item">
  1316. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  1317. <span class="md-ellipsis">
  1318. Access Key ID &amp; Secret Access Key
  1319. </span>
  1320. </a>
  1321. </li>
  1322. <li class="md-nav__item">
  1323. <a href="#eks-service-account-credentials" class="md-nav__link">
  1324. <span class="md-ellipsis">
  1325. EKS Service Account credentials
  1326. </span>
  1327. </a>
  1328. </li>
  1329. </ul>
  1330. </nav>
  1331. </li>
  1332. <li class="md-nav__item">
  1333. <a href="#custom-endpoints" class="md-nav__link">
  1334. <span class="md-ellipsis">
  1335. Custom Endpoints
  1336. </span>
  1337. </a>
  1338. </li>
  1339. </ul>
  1340. </nav>
  1341. </div>
  1342. </div>
  1343. </div>
  1344. <div class="md-content" data-md-component="content">
  1345. <article class="md-content__inner md-typeset">
  1346. <h1>AWS Parameter Store</h1>
  1347. <p><img alt="aws sm" src="../../pictures/diagrams-provider-aws-ssm-parameter-store.png" /></p>
  1348. <h2 id="parameter-store">Parameter Store</h2>
  1349. <p>A <code>ParameterStore</code> points to AWS SSM Parameter Store in a certain account within a
  1350. defined region. You should define Roles that define fine-grained access to
  1351. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  1352. way users of the <code>SecretStore</code> can only access the secrets necessary.</p>
  1353. <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>
  1354. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1355. <span class="nt">metadata</span><span class="p">:</span>
  1356. <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>
  1357. <span class="nt">spec</span><span class="p">:</span>
  1358. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1359. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1360. <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>
  1361. <span class="w"> </span><span class="c1"># define a specific role to limit access</span>
  1362. <span class="w"> </span><span class="c1"># to certain secrets</span>
  1363. <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>
  1364. <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>
  1365. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1366. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1367. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1368. <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>
  1369. <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>
  1370. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1371. <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>
  1372. <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>
  1373. </code></pre></div>
  1374. <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>
  1375. <div class="admonition warning">
  1376. <p class="admonition-title">API Pricing &amp; Throttling</p>
  1377. <p>The SSM Parameter Store API is charged by throughput and
  1378. is available in different tiers, <a href="https://aws.amazon.com/systems-manager/pricing/#Parameter_Store">see pricing</a>.
  1379. Please estimate your costs before using ESO. Cost depends on the RefreshInterval of your ExternalSecrets.</p>
  1380. </div>
  1381. <h3 id="iam-policy">IAM Policy</h3>
  1382. <h4 id="fetching-parameters">Fetching Parameters</h4>
  1383. <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>
  1384. <p>For further information see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-access.html">AWS Documentation</a>.</p>
  1385. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1386. <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>
  1387. <span class="w"> </span><span class="nt">&quot;Statement&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1388. <span class="w"> </span><span class="p">{</span>
  1389. <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>
  1390. <span class="w"> </span><span class="nt">&quot;Action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1391. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter*&quot;</span><span class="p">,</span>
  1392. <span class="w"> </span><span class="p">],</span>
  1393. <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>
  1394. <span class="w"> </span><span class="p">}</span>
  1395. <span class="w"> </span><span class="p">]</span>
  1396. <span class="p">}</span>
  1397. </code></pre></div>
  1398. <h4 id="pushing-parameters">Pushing Parameters</h4>
  1399. <p>The example policy below shows the minimum required permissions for pushing SSM parameters. Like with the fetching policy it restricts the path in which it can push secrets too.</p>
  1400. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1401. <span class="w"> </span><span class="nt">&quot;Action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1402. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter*&quot;</span><span class="p">,</span>
  1403. <span class="w"> </span><span class="s2">&quot;ssm:PutParameter*&quot;</span><span class="p">,</span>
  1404. <span class="w"> </span><span class="s2">&quot;ssm:AddTagsToResource&quot;</span><span class="p">,</span>
  1405. <span class="w"> </span><span class="s2">&quot;ssm:ListTagsForResource&quot;</span>
  1406. <span class="w"> </span><span class="p">],</span>
  1407. <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>
  1408. <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>
  1409. <span class="p">}</span>
  1410. </code></pre></div>
  1411. <h3 id="json-secret-values">JSON Secret Values</h3>
  1412. <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>
  1413. <p>Consider the following JSON object that is stored in the Parameter Store key <code>friendslist</code>:</p>
  1414. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1415. <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>
  1416. <span class="w"> </span><span class="nt">&quot;friends&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1417. <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>
  1418. <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>
  1419. <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>
  1420. <span class="w"> </span><span class="p">]</span>
  1421. <span class="p">}</span>
  1422. </code></pre></div>
  1423. <p>This is an example on how you would look up nested keys in the above json object:</p>
  1424. <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>
  1425. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1426. <span class="nt">metadata</span><span class="p">:</span>
  1427. <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>
  1428. <span class="nt">spec</span><span class="p">:</span>
  1429. <span class="w"> </span><span class="c1"># [omitted for brevity]</span>
  1430. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1431. <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>
  1432. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1433. <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>
  1434. <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>
  1435. <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>
  1436. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1437. <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>
  1438. <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>
  1439. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the tags in JSON format</span>
  1440. <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>
  1441. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1442. <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>
  1443. <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>
  1444. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific tag (dev) from the source secret</span>
  1445. <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>
  1446. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1447. <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>
  1448. <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>
  1449. <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>
  1450. </code></pre></div>
  1451. <h3 id="parameter-versions">Parameter Versions</h3>
  1452. <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>
  1453. <h2 id="setsecret">SetSecret</h2>
  1454. <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>
  1455. <h3 id="creating-a-push-secret">Creating a Push Secret</h3>
  1456. <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>
  1457. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1458. <span class="nt">metadata</span><span class="p">:</span>
  1459. <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>
  1460. <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>
  1461. <span class="nt">spec</span><span class="p">:</span>
  1462. <span class="w"> </span><span class="nt">updatePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Replace</span><span class="w"> </span><span class="c1"># Policy to overwrite existing secrets in the provider on sync</span>
  1463. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete</span><span class="w"> </span><span class="c1"># the provider&#39; secret will be deleted if the PushSecret is deleted</span>
  1464. <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>
  1465. <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>
  1466. <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>
  1467. <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>
  1468. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1469. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1470. <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>
  1471. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1472. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1473. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
  1474. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
  1475. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1476. <span class="w"> </span><span class="nt">best-pokemon</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.best-pokemon</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">toString</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">upper</span><span class="nv"> </span><span class="s">}}</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">really</span><span class="nv"> </span><span class="s">best!&quot;</span>
  1477. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span>
  1478. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span>
  1479. <span class="w"> </span><span class="c1"># It does not update the configmap, it creates a secret with: data[&quot;alertmanager.yml&quot;] = ...result...</span>
  1480. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1481. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1482. <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">application-config-tmpl</span>
  1483. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1484. <span class="w"> </span><span class="p p-Indicator">-</span><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">config.yml</span>
  1485. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1486. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">None</span><span class="w"> </span><span class="c1"># Also supports the ReverseUnicode strategy</span>
  1487. <span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1488. <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>
  1489. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1490. <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>
  1491. </code></pre></div>
  1492. <h4 id="additional-metadata-for-pushsecret">Additional Metadata for PushSecret</h4>
  1493. <p>Optionally, it is possible to configure additional options for the parameter such as <code>Type</code> and encryption Key. To control this behaviour you can set the following provider's <code>metadata</code>:</p>
  1494. <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>
  1495. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1496. <span class="nt">metadata</span><span class="p">:</span>
  1497. <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>
  1498. <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>
  1499. <span class="nt">spec</span><span class="p">:</span>
  1500. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete</span><span class="w"> </span><span class="c1"># the provider&#39; secret will be deleted if the PushSecret is deleted</span>
  1501. <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>
  1502. <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>
  1503. <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>
  1504. <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>
  1505. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1506. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1507. <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>
  1508. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1509. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1510. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1511. <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>
  1512. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1513. <span class="w"> </span><span class="nt">parameterStoreType</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecureString&quot;</span>
  1514. <span class="w"> </span><span class="nt">parameterStoreKeyID</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bb123123-b2b0-4f60-ac3a-44a13f0e6b6c&quot;</span>
  1515. </code></pre></div>
  1516. <p><code>parameterStoreType</code> takes three options. <code>String</code>, <code>StringList</code>, and <code>SecureString</code>, where <code>String</code> is the <em>default</em>.</p>
  1517. <p><code>parameterStoreKeyID</code> takes a KMS Key <code>$ID</code> or <code>$ARN</code> (in case a key source is created in another account) as a string, where <code>alias/aws/ssm</code> is the <em>default</em>. This property is only used if <code>parameterStoreType</code> is set as <code>SecureString</code>.</p>
  1518. <h4 id="check-successful-secret-sync">Check successful secret sync</h4>
  1519. <p>To be able to check that the secret has been succesfully synced you can run the following command:</p>
  1520. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>get<span class="w"> </span>pushsecret<span class="w"> </span>pushsecret-example
  1521. </code></pre></div>
  1522. <p>If the secret has synced successfully it will show the status as "Synced".</p>
  1523. <h4 id="test-new-secret-using-aws-cli">Test new secret using AWS CLI</h4>
  1524. <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>
  1525. <p>Run the following commands to get your synchronized parameter from AWS Parameter Store:</p>
  1526. <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
  1527. </code></pre></div>
  1528. <p>You should see something similar to the following output:</p>
  1529. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1530. <span class="w"> </span><span class="nt">&quot;Parameter&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1531. <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>
  1532. <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>
  1533. <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>
  1534. <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>
  1535. <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>
  1536. <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>
  1537. <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>
  1538. <span class="w"> </span><span class="p">}</span>
  1539. <span class="p">}</span>
  1540. </code></pre></div>
  1541. <h2 id="aws-authentication">AWS Authentication</h2>
  1542. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  1543. <p><img alt="Pod Identity Authentication" src="../../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  1544. <p>Note: If you are using Parameter Store replace <code>service: SecretsManager</code> with <code>service: ParameterStore</code> in all examples below.</p>
  1545. <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>
  1546. <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>
  1547. <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>
  1548. <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>
  1549. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1550. <span class="nt">metadata</span><span class="p">:</span>
  1551. <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>
  1552. <span class="nt">spec</span><span class="p">:</span>
  1553. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1554. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1555. <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>
  1556. <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>
  1557. <span class="w"> </span><span class="c1"># optional: do a sts:assumeRole before fetching secrets</span>
  1558. <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>
  1559. </code></pre></div>
  1560. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  1561. <p><img alt="SecretRef" src="../../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  1562. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  1563. <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>
  1564. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1565. <span class="nt">metadata</span><span class="p">:</span>
  1566. <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>
  1567. <span class="nt">spec</span><span class="p">:</span>
  1568. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1569. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1570. <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>
  1571. <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>
  1572. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span>
  1573. <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>
  1574. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1575. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1576. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1577. <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>
  1578. <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>
  1579. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1580. <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>
  1581. <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>
  1582. </code></pre></div>
  1583. <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>
  1584. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  1585. <p><img alt="Service Account" src="../../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  1586. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  1587. 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>
  1588. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  1589. <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>
  1590. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  1591. <span class="nt">metadata</span><span class="p">:</span>
  1592. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1593. <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>
  1594. <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>
  1595. <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>
  1596. </code></pre></div>
  1597. <p>Reference the service account from above in the Secret Store:</p>
  1598. <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>
  1599. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1600. <span class="nt">metadata</span><span class="p">:</span>
  1601. <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>
  1602. <span class="nt">spec</span><span class="p">:</span>
  1603. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1604. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1605. <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>
  1606. <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>
  1607. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1608. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  1609. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1610. <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>
  1611. </code></pre></div>
  1612. <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>
  1613. <h2 id="custom-endpoints">Custom Endpoints</h2>
  1614. <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>
  1615. <p>Use the following environment variables to point the controller to your custom endpoints. Note: All resources managed by this controller are affected.</p>
  1616. <table>
  1617. <thead>
  1618. <tr>
  1619. <th>ENV VAR</th>
  1620. <th>DESCRIPTION</th>
  1621. </tr>
  1622. </thead>
  1623. <tbody>
  1624. <tr>
  1625. <td>AWS_SECRETSMANAGER_ENDPOINT</td>
  1626. <td>Endpoint for the Secrets Manager Service. The controller uses this endpoint to fetch secrets from AWS Secrets Manager.</td>
  1627. </tr>
  1628. <tr>
  1629. <td>AWS_SSM_ENDPOINT</td>
  1630. <td>Endpoint for the AWS Secure Systems Manager. The controller uses this endpoint to fetch secrets from SSM Parameter Store.</td>
  1631. </tr>
  1632. <tr>
  1633. <td>AWS_STS_ENDPOINT</td>
  1634. <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>
  1635. </tr>
  1636. </tbody>
  1637. </table>
  1638. </article>
  1639. </div>
  1640. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1641. </div>
  1642. </main>
  1643. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1644. <footer class="md-footer">
  1645. <div class="md-footer-meta md-typeset">
  1646. <div class="md-footer-meta__inner md-grid">
  1647. <div class="md-copyright">
  1648. <div class="md-copyright__highlight">
  1649. &copy; 2024 The external-secrets Authors.<br/>
  1650. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1651. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1652. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1653. </div>
  1654. Made with
  1655. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1656. Material for MkDocs
  1657. </a>
  1658. </div>
  1659. </div>
  1660. </div>
  1661. </footer>
  1662. </div>
  1663. <div class="md-dialog" data-md-component="dialog">
  1664. <div class="md-dialog__inner md-typeset"></div>
  1665. </div>
  1666. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.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>
  1667. <script src="../../assets/javascripts/bundle.56dfad97.min.js"></script>
  1668. </body>
  1669. </html>