index.html 97 KB

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