index.html 75 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478
  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="icon" href="../../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>AWS Parameter Store - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("../..",location),__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>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#parameter-store" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. AWS Parameter Store
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <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>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../aws-secrets-manager/" class="md-tabs__link md-tabs__link--active">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/vault/" class="md-nav__link">
  294. Vault Dynamic Secret
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/password/" class="md-nav__link">
  299. Password
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../../api/generator/fake/" class="md-nav__link">
  304. Fake
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  312. <label class="md-nav__link" for="__nav_2_4">
  313. Reference Docs
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_2_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. Reference Docs
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../../api/spec/" class="md-nav__link">
  324. API specification
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/controller-options/" class="md-nav__link">
  329. Controller Options
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/metrics/" class="md-nav__link">
  334. Metrics
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  345. <label class="md-nav__link" for="__nav_3">
  346. Guides
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  350. <label class="md-nav__title" for="__nav_3">
  351. <span class="md-nav__icon md-icon"></span>
  352. Guides
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../../guides/introduction/" class="md-nav__link">
  357. Introduction
  358. </a>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  362. <label class="md-nav__link" for="__nav_3_2">
  363. Advanced Templating
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_3_2">
  368. <span class="md-nav__icon md-icon"></span>
  369. Advanced Templating
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../../guides/templating/" class="md-nav__link">
  374. v2
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../../guides/templating-v1/" class="md-nav__link">
  379. v1
  380. </a>
  381. </li>
  382. </ul>
  383. </nav>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../../guides/generator/" class="md-nav__link">
  387. Generators
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  392. All keys, One secret
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  397. Common K8S Secret Types
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../guides/controller-class/" class="md-nav__link">
  402. Controller Classes
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  407. Lifecycle: ownership & deletion
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  412. Decoding Strategies
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/getallsecrets/" class="md-nav__link">
  417. Getting Multiple Secrets
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  422. Multi Tenancy
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  427. Rewriting Keys
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../guides/v1beta1/" class="md-nav__link">
  432. Upgrading to v1beta1
  433. </a>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="../../guides/using-latest-image/" class="md-nav__link">
  437. Using Latest Image
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  442. Disable Cluster Features
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  449. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  450. <label class="md-nav__link" for="__nav_4">
  451. Provider
  452. <span class="md-nav__icon md-icon"></span>
  453. </label>
  454. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  455. <label class="md-nav__title" for="__nav_4">
  456. <span class="md-nav__icon md-icon"></span>
  457. Provider
  458. </label>
  459. <ul class="md-nav__list" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="../aws-secrets-manager/" class="md-nav__link">
  462. AWS Secrets Manager
  463. </a>
  464. </li>
  465. <li class="md-nav__item md-nav__item--active">
  466. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  467. <label class="md-nav__link md-nav__link--active" for="__toc">
  468. AWS Parameter Store
  469. <span class="md-nav__icon md-icon"></span>
  470. </label>
  471. <a href="./" class="md-nav__link md-nav__link--active">
  472. AWS Parameter Store
  473. </a>
  474. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  475. <label class="md-nav__title" for="__toc">
  476. <span class="md-nav__icon md-icon"></span>
  477. Table of contents
  478. </label>
  479. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  480. <li class="md-nav__item">
  481. <a href="#parameter-store" class="md-nav__link">
  482. Parameter Store
  483. </a>
  484. <nav class="md-nav" aria-label="Parameter Store">
  485. <ul class="md-nav__list">
  486. <li class="md-nav__item">
  487. <a href="#iam-policy" class="md-nav__link">
  488. IAM Policy
  489. </a>
  490. </li>
  491. <li class="md-nav__item">
  492. <a href="#json-secret-values" class="md-nav__link">
  493. JSON Secret Values
  494. </a>
  495. </li>
  496. <li class="md-nav__item">
  497. <a href="#parameter-versions" class="md-nav__link">
  498. Parameter Versions
  499. </a>
  500. </li>
  501. </ul>
  502. </nav>
  503. </li>
  504. <li class="md-nav__item">
  505. <a href="#setsecret" class="md-nav__link">
  506. SetSecret
  507. </a>
  508. <nav class="md-nav" aria-label="SetSecret">
  509. <ul class="md-nav__list">
  510. <li class="md-nav__item">
  511. <a href="#creating-a-push-secret" class="md-nav__link">
  512. Creating a Push Secret
  513. </a>
  514. <nav class="md-nav" aria-label="Creating a Push Secret">
  515. <ul class="md-nav__list">
  516. <li class="md-nav__item">
  517. <a href="#check-successful-secret-sync" class="md-nav__link">
  518. Check successful secret sync
  519. </a>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  523. Test new secret using AWS CLI
  524. </a>
  525. </li>
  526. </ul>
  527. </nav>
  528. </li>
  529. </ul>
  530. </nav>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="#aws-authentication" class="md-nav__link">
  534. AWS Authentication
  535. </a>
  536. <nav class="md-nav" aria-label="AWS Authentication">
  537. <ul class="md-nav__list">
  538. <li class="md-nav__item">
  539. <a href="#controllers-pod-identity" class="md-nav__link">
  540. Controller's Pod Identity
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  545. Access Key ID &amp; Secret Access Key
  546. </a>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="#eks-service-account-credentials" class="md-nav__link">
  550. EKS Service Account credentials
  551. </a>
  552. </li>
  553. </ul>
  554. </nav>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="#custom-endpoints" class="md-nav__link">
  558. Custom Endpoints
  559. </a>
  560. </li>
  561. </ul>
  562. </nav>
  563. </li>
  564. <li class="md-nav__item">
  565. <a href="../azure-key-vault/" class="md-nav__link">
  566. Azure Key Vault
  567. </a>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="../google-secrets-manager/" class="md-nav__link">
  571. Google Secret Manager
  572. </a>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="../ibm-secrets-manager/" class="md-nav__link">
  576. IBM Secrets Manager
  577. </a>
  578. </li>
  579. <li class="md-nav__item">
  580. <a href="../akeyless/" class="md-nav__link">
  581. Akeyless
  582. </a>
  583. </li>
  584. <li class="md-nav__item">
  585. <a href="../hashicorp-vault/" class="md-nav__link">
  586. HashiCorp Vault
  587. </a>
  588. </li>
  589. <li class="md-nav__item">
  590. <a href="../yandex-certificate-manager/" class="md-nav__link">
  591. Yandex Certificate Manager
  592. </a>
  593. </li>
  594. <li class="md-nav__item">
  595. <a href="../yandex-lockbox/" class="md-nav__link">
  596. Yandex Lockbox
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="../gitlab-variables/" class="md-nav__link">
  601. Gitlab Variables
  602. </a>
  603. </li>
  604. <li class="md-nav__item">
  605. <a href="../oracle-vault/" class="md-nav__link">
  606. Oracle Vault
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="../1password-automation/" class="md-nav__link">
  611. 1Password Secrets Automation
  612. </a>
  613. </li>
  614. <li class="md-nav__item">
  615. <a href="../webhook/" class="md-nav__link">
  616. Webhook
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../fake/" class="md-nav__link">
  621. Fake
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="../kubernetes/" class="md-nav__link">
  626. Kubernetes
  627. </a>
  628. </li>
  629. <li class="md-nav__item">
  630. <a href="../senhasegura-dsm/" class="md-nav__link">
  631. senhasegura DevOps Secrets Management (DSM)
  632. </a>
  633. </li>
  634. <li class="md-nav__item">
  635. <a href="../doppler/" class="md-nav__link">
  636. Doppler
  637. </a>
  638. </li>
  639. <li class="md-nav__item">
  640. <a href="../keeper-security/" class="md-nav__link">
  641. Keeper Security
  642. </a>
  643. </li>
  644. <li class="md-nav__item">
  645. <a href="../scaleway/" class="md-nav__link">
  646. Scaleway
  647. </a>
  648. </li>
  649. </ul>
  650. </nav>
  651. </li>
  652. <li class="md-nav__item md-nav__item--nested">
  653. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  654. <label class="md-nav__link" for="__nav_5">
  655. Examples
  656. <span class="md-nav__icon md-icon"></span>
  657. </label>
  658. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  659. <label class="md-nav__title" for="__nav_5">
  660. <span class="md-nav__icon md-icon"></span>
  661. Examples
  662. </label>
  663. <ul class="md-nav__list" data-md-scrollfix>
  664. <li class="md-nav__item">
  665. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  666. FluxCD
  667. </a>
  668. </li>
  669. <li class="md-nav__item">
  670. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  671. Anchore Engine
  672. </a>
  673. </li>
  674. <li class="md-nav__item">
  675. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  676. Jenkins
  677. </a>
  678. </li>
  679. <li class="md-nav__item">
  680. <a href="../../examples/bitwarden/" class="md-nav__link">
  681. BitWarden
  682. </a>
  683. </li>
  684. </ul>
  685. </nav>
  686. </li>
  687. <li class="md-nav__item md-nav__item--nested">
  688. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  689. <label class="md-nav__link" for="__nav_6">
  690. Community
  691. <span class="md-nav__icon md-icon"></span>
  692. </label>
  693. <nav class="md-nav" aria-label="Community" data-md-level="1">
  694. <label class="md-nav__title" for="__nav_6">
  695. <span class="md-nav__icon md-icon"></span>
  696. Community
  697. </label>
  698. <ul class="md-nav__list" data-md-scrollfix>
  699. <li class="md-nav__item md-nav__item--nested">
  700. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  701. <label class="md-nav__link" for="__nav_6_1">
  702. Contributing
  703. <span class="md-nav__icon md-icon"></span>
  704. </label>
  705. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  706. <label class="md-nav__title" for="__nav_6_1">
  707. <span class="md-nav__icon md-icon"></span>
  708. Contributing
  709. </label>
  710. <ul class="md-nav__list" data-md-scrollfix>
  711. <li class="md-nav__item">
  712. <a href="../../contributing/devguide/" class="md-nav__link">
  713. Developer guide
  714. </a>
  715. </li>
  716. <li class="md-nav__item">
  717. <a href="../../contributing/process/" class="md-nav__link">
  718. Contributing Process
  719. </a>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="../../contributing/release/" class="md-nav__link">
  723. Release Process
  724. </a>
  725. </li>
  726. <li class="md-nav__item">
  727. <a href="../../contributing/coc/" class="md-nav__link">
  728. Code of Conduct
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../contributing/roadmap/" class="md-nav__link">
  733. Roadmap
  734. </a>
  735. </li>
  736. </ul>
  737. </nav>
  738. </li>
  739. <li class="md-nav__item md-nav__item--nested">
  740. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  741. <label class="md-nav__link" for="__nav_6_2">
  742. External Resources
  743. <span class="md-nav__icon md-icon"></span>
  744. </label>
  745. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  746. <label class="md-nav__title" for="__nav_6_2">
  747. <span class="md-nav__icon md-icon"></span>
  748. External Resources
  749. </label>
  750. <ul class="md-nav__list" data-md-scrollfix>
  751. <li class="md-nav__item">
  752. <a href="../../eso-talks/" class="md-nav__link">
  753. Talks
  754. </a>
  755. </li>
  756. <li class="md-nav__item">
  757. <a href="../../eso-demos/" class="md-nav__link">
  758. Demos
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../../eso-blogs/" class="md-nav__link">
  763. Blogs
  764. </a>
  765. </li>
  766. </ul>
  767. </nav>
  768. </li>
  769. </ul>
  770. </nav>
  771. </li>
  772. </ul>
  773. </nav>
  774. </div>
  775. </div>
  776. </div>
  777. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  778. <div class="md-sidebar__scrollwrap">
  779. <div class="md-sidebar__inner">
  780. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  781. <label class="md-nav__title" for="__toc">
  782. <span class="md-nav__icon md-icon"></span>
  783. Table of contents
  784. </label>
  785. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  786. <li class="md-nav__item">
  787. <a href="#parameter-store" class="md-nav__link">
  788. Parameter Store
  789. </a>
  790. <nav class="md-nav" aria-label="Parameter Store">
  791. <ul class="md-nav__list">
  792. <li class="md-nav__item">
  793. <a href="#iam-policy" class="md-nav__link">
  794. IAM Policy
  795. </a>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="#json-secret-values" class="md-nav__link">
  799. JSON Secret Values
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="#parameter-versions" class="md-nav__link">
  804. Parameter Versions
  805. </a>
  806. </li>
  807. </ul>
  808. </nav>
  809. </li>
  810. <li class="md-nav__item">
  811. <a href="#setsecret" class="md-nav__link">
  812. SetSecret
  813. </a>
  814. <nav class="md-nav" aria-label="SetSecret">
  815. <ul class="md-nav__list">
  816. <li class="md-nav__item">
  817. <a href="#creating-a-push-secret" class="md-nav__link">
  818. Creating a Push Secret
  819. </a>
  820. <nav class="md-nav" aria-label="Creating a Push Secret">
  821. <ul class="md-nav__list">
  822. <li class="md-nav__item">
  823. <a href="#check-successful-secret-sync" class="md-nav__link">
  824. Check successful secret sync
  825. </a>
  826. </li>
  827. <li class="md-nav__item">
  828. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  829. Test new secret using AWS CLI
  830. </a>
  831. </li>
  832. </ul>
  833. </nav>
  834. </li>
  835. </ul>
  836. </nav>
  837. </li>
  838. <li class="md-nav__item">
  839. <a href="#aws-authentication" class="md-nav__link">
  840. AWS Authentication
  841. </a>
  842. <nav class="md-nav" aria-label="AWS Authentication">
  843. <ul class="md-nav__list">
  844. <li class="md-nav__item">
  845. <a href="#controllers-pod-identity" class="md-nav__link">
  846. Controller's Pod Identity
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  851. Access Key ID &amp; Secret Access Key
  852. </a>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="#eks-service-account-credentials" class="md-nav__link">
  856. EKS Service Account credentials
  857. </a>
  858. </li>
  859. </ul>
  860. </nav>
  861. </li>
  862. <li class="md-nav__item">
  863. <a href="#custom-endpoints" class="md-nav__link">
  864. Custom Endpoints
  865. </a>
  866. </li>
  867. </ul>
  868. </nav>
  869. </div>
  870. </div>
  871. </div>
  872. <div class="md-content" data-md-component="content">
  873. <article class="md-content__inner md-typeset">
  874. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/provider/aws-parameter-store.md" title="Edit this page" class="md-content__button md-icon">
  875. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  876. </a>
  877. <h1>AWS Parameter Store</h1>
  878. <p><img alt="aws sm" src="../../pictures/diagrams-provider-aws-ssm-parameter-store.png" /></p>
  879. <h2 id="parameter-store">Parameter Store</h2>
  880. <p>A <code>ParameterStore</code> points to AWS SSM Parameter Store in a certain account within a
  881. defined region. You should define Roles that define fine-grained access to
  882. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  883. way users of the <code>SecretStore</code> can only access the secrets necessary.</p>
  884. <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><span class="w"></span>
  885. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  886. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  887. <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><span class="w"></span>
  888. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  889. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  890. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  891. <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><span class="w"></span>
  892. <span class="w"> </span><span class="c1"># define a specific role to limit access</span><span class="w"></span>
  893. <span class="w"> </span><span class="c1"># to certain secrets</span><span class="w"></span>
  894. <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><span class="w"></span>
  895. <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><span class="w"></span>
  896. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  897. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  898. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  899. <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><span class="w"></span>
  900. <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><span class="w"></span>
  901. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  902. <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><span class="w"></span>
  903. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span><span class="w"></span>
  904. </code></pre></div>
  905. <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>
  906. <div class="admonition warning">
  907. <p class="admonition-title">API Pricing &amp; Throttling</p>
  908. <p>The SSM Parameter Store API is charged by throughput and
  909. is available in different tiers, <a href="https://aws.amazon.com/systems-manager/pricing/#Parameter_Store">see pricing</a>.
  910. Please estimate your costs before using ESO. Cost depends on the RefreshInterval of your ExternalSecrets.</p>
  911. </div>
  912. <h3 id="iam-policy">IAM Policy</h3>
  913. <p>Create a IAM Policy to pin down access to secrets matching <code>dev-*</code>, for further information see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-access.html">AWS Documentation</a>:</p>
  914. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  915. <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><span class="w"></span>
  916. <span class="w"> </span><span class="nt">&quot;Statement&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span>
  917. <span class="w"> </span><span class="p">{</span><span class="w"></span>
  918. <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><span class="w"></span>
  919. <span class="w"> </span><span class="nt">&quot;Action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span>
  920. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter&quot;</span><span class="p">,</span><span class="w"></span>
  921. <span class="w"> </span><span class="s2">&quot;ssm:ListTagsForResource&quot;</span><span class="p">,</span><span class="w"></span>
  922. <span class="w"> </span><span class="s2">&quot;ssm:DescribeParameters&quot;</span><span class="w"></span>
  923. <span class="w"> </span><span class="p">],</span><span class="w"></span>
  924. <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><span class="w"></span>
  925. <span class="w"> </span><span class="p">}</span><span class="w"></span>
  926. <span class="w"> </span><span class="p">]</span><span class="w"></span>
  927. <span class="p">}</span><span class="w"></span>
  928. </code></pre></div>
  929. <h3 id="json-secret-values">JSON Secret Values</h3>
  930. <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>
  931. <p>Consider the following JSON object that is stored in the Parameter Store key <code>friendslist</code>:
  932. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  933. <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><span class="w"></span>
  934. <span class="w"> </span><span class="nt">&quot;friends&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span>
  935. <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><span class="w"></span>
  936. <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><span class="w"></span>
  937. <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><span class="w"></span>
  938. <span class="w"> </span><span class="p">]</span><span class="w"></span>
  939. <span class="p">}</span><span class="w"></span>
  940. </code></pre></div></p>
  941. <p>This is an example on how you would look up nested keys in the above json object:
  942. <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><span class="w"></span>
  943. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  944. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  945. <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><span class="w"></span>
  946. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  947. <span class="w"> </span><span class="c1"># [omitted for brevity]</span><span class="w"></span>
  948. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  949. <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><span class="w"></span>
  950. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  951. <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><span class="w"></span>
  952. <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><span class="w"></span>
  953. <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><span class="w"></span>
  954. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  955. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">friendslist</span><span class="w"></span>
  956. <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><span class="w"></span>
  957. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the tags in JSON format</span><span class="w"></span>
  958. <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><span class="w"></span>
  959. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  960. <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><span class="w"> </span>
  961. <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><span class="w"></span>
  962. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific tag (dev) from the source secret</span><span class="w"></span>
  963. <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><span class="w"></span>
  964. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  965. <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><span class="w"> </span>
  966. <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><span class="w"></span>
  967. <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><span class="w"></span>
  968. </code></pre></div></p>
  969. <h3 id="parameter-versions">Parameter Versions</h3>
  970. <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>
  971. <h2 id="setsecret">SetSecret</h2>
  972. <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>
  973. <h3 id="creating-a-push-secret">Creating a Push Secret</h3>
  974. <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><span class="w"></span>
  975. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span><span class="w"></span>
  976. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  977. <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><span class="w"></span>
  978. <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><span class="w"></span>
  979. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  980. <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><span class="w"></span>
  981. <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><span class="w"></span>
  982. <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><span class="w"></span>
  983. <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><span class="w"></span>
  984. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span><span class="w"></span>
  985. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span><span class="w"></span>
  986. <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><span class="w"></span>
  987. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  988. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span><span class="w"></span>
  989. <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><span class="w"></span>
  990. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  991. <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><span class="w"></span>
  992. </code></pre></div>
  993. <h4 id="check-successful-secret-sync">Check successful secret sync</h4>
  994. <p>To be able to check that the secret has been succesfully synced you can run the following command:</p>
  995. <div class="highlight"><pre><span></span><code>kubectl get pushsecret pushsecret-example
  996. </code></pre></div>
  997. <p>If the secret has synced successfully it will show the status as "Synced".</p>
  998. <h4 id="test-new-secret-using-aws-cli">Test new secret using AWS CLI</h4>
  999. <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>
  1000. <p>Run the following commands to get your synchronized parameter from AWS Parameter Store:</p>
  1001. <div class="highlight"><pre><span></span><code>aws ssm get-parameter --name<span class="o">=</span>my-first-parameter --region<span class="o">=</span>us-east-1
  1002. </code></pre></div>
  1003. <p>You should see something similar to the following output:</p>
  1004. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  1005. <span class="w"> </span><span class="nt">&quot;Parameter&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
  1006. <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><span class="w"></span>
  1007. <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><span class="w"></span>
  1008. <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><span class="w"></span>
  1009. <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><span class="w"></span>
  1010. <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><span class="w"></span>
  1011. <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><span class="w"></span>
  1012. <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><span class="w"></span>
  1013. <span class="w"> </span><span class="p">}</span><span class="w"></span>
  1014. <span class="p">}</span><span class="w"></span>
  1015. </code></pre></div>
  1016. <h2 id="aws-authentication">AWS Authentication</h2>
  1017. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  1018. <p><img alt="Pod Identity Authentication" src="../../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  1019. <p>Note: If you are using Parameter Store replace <code>service: SecretsManager</code> with <code>service: ParameterStore</code> in all examples below.</p>
  1020. <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>
  1021. <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>
  1022. <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>
  1023. <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><span class="w"></span>
  1024. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  1025. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1026. <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><span class="w"></span>
  1027. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1028. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  1029. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  1030. <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><span class="w"></span>
  1031. <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><span class="w"></span>
  1032. <span class="w"> </span><span class="c1"># optional: do a sts:assumeRole before fetching secrets</span><span class="w"></span>
  1033. <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><span class="w"></span>
  1034. </code></pre></div>
  1035. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  1036. <p><img alt="SecretRef" src="../../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  1037. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  1038. <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><span class="w"></span>
  1039. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  1040. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1041. <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><span class="w"></span>
  1042. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1043. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  1044. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  1045. <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><span class="w"></span>
  1046. <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><span class="w"></span>
  1047. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span><span class="w"></span>
  1048. <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><span class="w"></span>
  1049. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  1050. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  1051. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  1052. <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><span class="w"></span>
  1053. <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><span class="w"></span>
  1054. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  1055. <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><span class="w"></span>
  1056. <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><span class="w"></span>
  1057. </code></pre></div>
  1058. <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>
  1059. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  1060. <p><img alt="Service Account" src="../../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  1061. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  1062. 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>
  1063. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  1064. <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><span class="w"></span>
  1065. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span><span class="w"></span>
  1066. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1067. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"></span>
  1068. <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><span class="w"></span>
  1069. <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><span class="w"></span>
  1070. <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>
  1071. </code></pre></div>
  1072. <p>Reference the service account from above in the Secret Store:</p>
  1073. <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><span class="w"></span>
  1074. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  1075. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1076. <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><span class="w"></span>
  1077. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1078. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  1079. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  1080. <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><span class="w"></span>
  1081. <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><span class="w"></span>
  1082. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  1083. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span><span class="w"></span>
  1084. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  1085. <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><span class="w"></span>
  1086. </code></pre></div>
  1087. <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>
  1088. <h2 id="custom-endpoints">Custom Endpoints</h2>
  1089. <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>
  1090. <p>Use the following environment variables to point the controller to your custom endpoints. Note: All resources managed by this controller are affected.</p>
  1091. <table>
  1092. <thead>
  1093. <tr>
  1094. <th>ENV VAR</th>
  1095. <th>DESCRIPTION</th>
  1096. </tr>
  1097. </thead>
  1098. <tbody>
  1099. <tr>
  1100. <td>AWS_SECRETSMANAGER_ENDPOINT</td>
  1101. <td>Endpoint for the Secrets Manager Service. The controller uses this endpoint to fetch secrets from AWS Secrets Manager.</td>
  1102. </tr>
  1103. <tr>
  1104. <td>AWS_SSM_ENDPOINT</td>
  1105. <td>Endpoint for the AWS Secure Systems Manager. The controller uses this endpoint to fetch secrets from SSM Parameter Store.</td>
  1106. </tr>
  1107. <tr>
  1108. <td>AWS_STS_ENDPOINT</td>
  1109. <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>
  1110. </tr>
  1111. </tbody>
  1112. </table>
  1113. </article>
  1114. </div>
  1115. </div>
  1116. </main>
  1117. <footer class="md-footer">
  1118. <nav class="md-footer__inner md-grid" aria-label="Footer">
  1119. <a href="../aws-secrets-manager/" class="md-footer__link md-footer__link--prev" aria-label="Previous: AWS Secrets Manager" rel="prev">
  1120. <div class="md-footer__button md-icon">
  1121. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  1122. </div>
  1123. <div class="md-footer__title">
  1124. <div class="md-ellipsis">
  1125. <span class="md-footer__direction">
  1126. Previous
  1127. </span>
  1128. AWS Secrets Manager
  1129. </div>
  1130. </div>
  1131. </a>
  1132. <a href="../azure-key-vault/" class="md-footer__link md-footer__link--next" aria-label="Next: Azure Key Vault" rel="next">
  1133. <div class="md-footer__title">
  1134. <div class="md-ellipsis">
  1135. <span class="md-footer__direction">
  1136. Next
  1137. </span>
  1138. Azure Key Vault
  1139. </div>
  1140. </div>
  1141. <div class="md-footer__button md-icon">
  1142. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  1143. </div>
  1144. </a>
  1145. </nav>
  1146. <div class="md-footer-meta md-typeset">
  1147. <div class="md-footer-meta__inner md-grid">
  1148. <div class="md-copyright">
  1149. <div class="md-copyright__highlight">
  1150. &copy; 2023 The external-secrets Authors.<br/>
  1151. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1152. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1153. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1154. </div>
  1155. Made with
  1156. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1157. Material for MkDocs
  1158. </a>
  1159. </div>
  1160. </div>
  1161. </div>
  1162. </footer>
  1163. </div>
  1164. <div class="md-dialog" data-md-component="dialog">
  1165. <div class="md-dialog__inner md-typeset"></div>
  1166. </div>
  1167. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  1168. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1169. </body>
  1170. </html>