index.html 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494
  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 Cloud 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="../alibaba/" class="md-nav__link">
  601. Alibaba Cloud
  602. </a>
  603. </li>
  604. <li class="md-nav__item">
  605. <a href="../gitlab-variables/" class="md-nav__link">
  606. Gitlab Variables
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="../oracle-vault/" class="md-nav__link">
  611. Oracle Vault
  612. </a>
  613. </li>
  614. <li class="md-nav__item">
  615. <a href="../1password-automation/" class="md-nav__link">
  616. 1Password Secrets Automation
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../webhook/" class="md-nav__link">
  621. Webhook
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="../fake/" class="md-nav__link">
  626. Fake
  627. </a>
  628. </li>
  629. <li class="md-nav__item">
  630. <a href="../kubernetes/" class="md-nav__link">
  631. Kubernetes
  632. </a>
  633. </li>
  634. <li class="md-nav__item">
  635. <a href="../senhasegura-dsm/" class="md-nav__link">
  636. senhasegura DevOps Secrets Management (DSM)
  637. </a>
  638. </li>
  639. <li class="md-nav__item">
  640. <a href="../doppler/" class="md-nav__link">
  641. Doppler
  642. </a>
  643. </li>
  644. <li class="md-nav__item">
  645. <a href="../keeper-security/" class="md-nav__link">
  646. Keeper Security
  647. </a>
  648. </li>
  649. <li class="md-nav__item">
  650. <a href="../scaleway/" class="md-nav__link">
  651. Scaleway
  652. </a>
  653. </li>
  654. </ul>
  655. </nav>
  656. </li>
  657. <li class="md-nav__item md-nav__item--nested">
  658. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  659. <label class="md-nav__link" for="__nav_5">
  660. Examples
  661. <span class="md-nav__icon md-icon"></span>
  662. </label>
  663. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  664. <label class="md-nav__title" for="__nav_5">
  665. <span class="md-nav__icon md-icon"></span>
  666. Examples
  667. </label>
  668. <ul class="md-nav__list" data-md-scrollfix>
  669. <li class="md-nav__item">
  670. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  671. FluxCD
  672. </a>
  673. </li>
  674. <li class="md-nav__item">
  675. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  676. Anchore Engine
  677. </a>
  678. </li>
  679. <li class="md-nav__item">
  680. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  681. Jenkins
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../../examples/bitwarden/" class="md-nav__link">
  686. BitWarden
  687. </a>
  688. </li>
  689. </ul>
  690. </nav>
  691. </li>
  692. <li class="md-nav__item md-nav__item--nested">
  693. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  694. <label class="md-nav__link" for="__nav_6">
  695. Community
  696. <span class="md-nav__icon md-icon"></span>
  697. </label>
  698. <nav class="md-nav" aria-label="Community" data-md-level="1">
  699. <label class="md-nav__title" for="__nav_6">
  700. <span class="md-nav__icon md-icon"></span>
  701. Community
  702. </label>
  703. <ul class="md-nav__list" data-md-scrollfix>
  704. <li class="md-nav__item md-nav__item--nested">
  705. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  706. <label class="md-nav__link" for="__nav_6_1">
  707. Contributing
  708. <span class="md-nav__icon md-icon"></span>
  709. </label>
  710. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  711. <label class="md-nav__title" for="__nav_6_1">
  712. <span class="md-nav__icon md-icon"></span>
  713. Contributing
  714. </label>
  715. <ul class="md-nav__list" data-md-scrollfix>
  716. <li class="md-nav__item">
  717. <a href="../../contributing/devguide/" class="md-nav__link">
  718. Developer guide
  719. </a>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="../../contributing/process/" class="md-nav__link">
  723. Contributing Process
  724. </a>
  725. </li>
  726. <li class="md-nav__item">
  727. <a href="../../contributing/release/" class="md-nav__link">
  728. Release Process
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../contributing/coc/" class="md-nav__link">
  733. Code of Conduct
  734. </a>
  735. </li>
  736. <li class="md-nav__item">
  737. <a href="../../contributing/roadmap/" class="md-nav__link">
  738. Roadmap
  739. </a>
  740. </li>
  741. </ul>
  742. </nav>
  743. </li>
  744. <li class="md-nav__item md-nav__item--nested">
  745. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  746. <label class="md-nav__link" for="__nav_6_2">
  747. External Resources
  748. <span class="md-nav__icon md-icon"></span>
  749. </label>
  750. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  751. <label class="md-nav__title" for="__nav_6_2">
  752. <span class="md-nav__icon md-icon"></span>
  753. External Resources
  754. </label>
  755. <ul class="md-nav__list" data-md-scrollfix>
  756. <li class="md-nav__item">
  757. <a href="../../eso-talks/" class="md-nav__link">
  758. Talks
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../../eso-demos/" class="md-nav__link">
  763. Demos
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../eso-blogs/" class="md-nav__link">
  768. Blogs
  769. </a>
  770. </li>
  771. </ul>
  772. </nav>
  773. </li>
  774. </ul>
  775. </nav>
  776. </li>
  777. </ul>
  778. </nav>
  779. </div>
  780. </div>
  781. </div>
  782. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  783. <div class="md-sidebar__scrollwrap">
  784. <div class="md-sidebar__inner">
  785. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  786. <label class="md-nav__title" for="__toc">
  787. <span class="md-nav__icon md-icon"></span>
  788. Table of contents
  789. </label>
  790. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  791. <li class="md-nav__item">
  792. <a href="#parameter-store" class="md-nav__link">
  793. Parameter Store
  794. </a>
  795. <nav class="md-nav" aria-label="Parameter Store">
  796. <ul class="md-nav__list">
  797. <li class="md-nav__item">
  798. <a href="#iam-policy" class="md-nav__link">
  799. IAM Policy
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="#json-secret-values" class="md-nav__link">
  804. JSON Secret Values
  805. </a>
  806. </li>
  807. <li class="md-nav__item">
  808. <a href="#parameter-versions" class="md-nav__link">
  809. Parameter Versions
  810. </a>
  811. </li>
  812. </ul>
  813. </nav>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="#setsecret" class="md-nav__link">
  817. SetSecret
  818. </a>
  819. <nav class="md-nav" aria-label="SetSecret">
  820. <ul class="md-nav__list">
  821. <li class="md-nav__item">
  822. <a href="#creating-a-push-secret" class="md-nav__link">
  823. Creating a Push Secret
  824. </a>
  825. <nav class="md-nav" aria-label="Creating a Push Secret">
  826. <ul class="md-nav__list">
  827. <li class="md-nav__item">
  828. <a href="#check-successful-secret-sync" class="md-nav__link">
  829. Check successful secret sync
  830. </a>
  831. </li>
  832. <li class="md-nav__item">
  833. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  834. Test new secret using AWS CLI
  835. </a>
  836. </li>
  837. </ul>
  838. </nav>
  839. </li>
  840. </ul>
  841. </nav>
  842. </li>
  843. <li class="md-nav__item">
  844. <a href="#aws-authentication" class="md-nav__link">
  845. AWS Authentication
  846. </a>
  847. <nav class="md-nav" aria-label="AWS Authentication">
  848. <ul class="md-nav__list">
  849. <li class="md-nav__item">
  850. <a href="#controllers-pod-identity" class="md-nav__link">
  851. Controller's Pod Identity
  852. </a>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  856. Access Key ID &amp; Secret Access Key
  857. </a>
  858. </li>
  859. <li class="md-nav__item">
  860. <a href="#eks-service-account-credentials" class="md-nav__link">
  861. EKS Service Account credentials
  862. </a>
  863. </li>
  864. </ul>
  865. </nav>
  866. </li>
  867. <li class="md-nav__item">
  868. <a href="#custom-endpoints" class="md-nav__link">
  869. Custom Endpoints
  870. </a>
  871. </li>
  872. </ul>
  873. </nav>
  874. </div>
  875. </div>
  876. </div>
  877. <div class="md-content" data-md-component="content">
  878. <article class="md-content__inner md-typeset">
  879. <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">
  880. <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>
  881. </a>
  882. <h1>AWS Parameter Store</h1>
  883. <p><img alt="aws sm" src="../../pictures/diagrams-provider-aws-ssm-parameter-store.png" /></p>
  884. <h2 id="parameter-store">Parameter Store</h2>
  885. <p>A <code>ParameterStore</code> points to AWS SSM Parameter Store in a certain account within a
  886. defined region. You should define Roles that define fine-grained access to
  887. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  888. way users of the <code>SecretStore</code> can only access the secrets necessary.</p>
  889. <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>
  890. <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>
  891. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  892. <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>
  893. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  894. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  895. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  896. <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>
  897. <span class="w"> </span><span class="c1"># define a specific role to limit access</span><span class="w"></span>
  898. <span class="w"> </span><span class="c1"># to certain secrets</span><span class="w"></span>
  899. <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>
  900. <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>
  901. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  902. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  903. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  904. <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>
  905. <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>
  906. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  907. <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>
  908. <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>
  909. </code></pre></div>
  910. <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>
  911. <div class="admonition warning">
  912. <p class="admonition-title">API Pricing &amp; Throttling</p>
  913. <p>The SSM Parameter Store API is charged by throughput and
  914. is available in different tiers, <a href="https://aws.amazon.com/systems-manager/pricing/#Parameter_Store">see pricing</a>.
  915. Please estimate your costs before using ESO. Cost depends on the RefreshInterval of your ExternalSecrets.</p>
  916. </div>
  917. <h3 id="iam-policy">IAM Policy</h3>
  918. <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>
  919. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  920. <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>
  921. <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>
  922. <span class="w"> </span><span class="p">{</span><span class="w"></span>
  923. <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>
  924. <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>
  925. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter&quot;</span><span class="p">,</span><span class="w"></span>
  926. <span class="w"> </span><span class="s2">&quot;ssm:ListTagsForResource&quot;</span><span class="p">,</span><span class="w"></span>
  927. <span class="w"> </span><span class="s2">&quot;ssm:DescribeParameters&quot;</span><span class="w"></span>
  928. <span class="w"> </span><span class="p">],</span><span class="w"></span>
  929. <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>
  930. <span class="w"> </span><span class="p">}</span><span class="w"></span>
  931. <span class="w"> </span><span class="p">]</span><span class="w"></span>
  932. <span class="p">}</span><span class="w"></span>
  933. </code></pre></div>
  934. <h3 id="json-secret-values">JSON Secret Values</h3>
  935. <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>
  936. <p>Consider the following JSON object that is stored in the Parameter Store key <code>friendslist</code>:
  937. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  938. <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>
  939. <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>
  940. <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>
  941. <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>
  942. <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>
  943. <span class="w"> </span><span class="p">]</span><span class="w"></span>
  944. <span class="p">}</span><span class="w"></span>
  945. </code></pre></div></p>
  946. <p>This is an example on how you would look up nested keys in the above json object:
  947. <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>
  948. <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>
  949. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  950. <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>
  951. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  952. <span class="w"> </span><span class="c1"># [omitted for brevity]</span><span class="w"></span>
  953. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  954. <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>
  955. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  956. <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>
  957. <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>
  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">first_friend</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">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">friendslist</span><span class="w"></span>
  961. <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>
  962. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the tags in JSON format</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">tags</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="c1"># metadataPolicy to fetch a specific tag (dev) from the source secret</span><span class="w"></span>
  968. <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>
  969. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  970. <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>
  971. <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>
  972. <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>
  973. </code></pre></div></p>
  974. <h3 id="parameter-versions">Parameter Versions</h3>
  975. <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>
  976. <h2 id="setsecret">SetSecret</h2>
  977. <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>
  978. <h3 id="creating-a-push-secret">Creating a Push Secret</h3>
  979. <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>
  980. <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>
  981. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  982. <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>
  983. <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>
  984. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  985. <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>
  986. <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>
  987. <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>
  988. <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>
  989. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span><span class="w"></span>
  990. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span><span class="w"></span>
  991. <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>
  992. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  993. <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>
  994. <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>
  995. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  996. <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>
  997. </code></pre></div>
  998. <h4 id="check-successful-secret-sync">Check successful secret sync</h4>
  999. <p>To be able to check that the secret has been succesfully synced you can run the following command:</p>
  1000. <div class="highlight"><pre><span></span><code>kubectl get pushsecret pushsecret-example
  1001. </code></pre></div>
  1002. <p>If the secret has synced successfully it will show the status as "Synced".</p>
  1003. <h4 id="test-new-secret-using-aws-cli">Test new secret using AWS CLI</h4>
  1004. <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>
  1005. <p>Run the following commands to get your synchronized parameter from AWS Parameter Store:</p>
  1006. <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
  1007. </code></pre></div>
  1008. <p>You should see something similar to the following output:</p>
  1009. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  1010. <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>
  1011. <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>
  1012. <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>
  1013. <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>
  1014. <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>
  1015. <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>
  1016. <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>
  1017. <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>
  1018. <span class="w"> </span><span class="p">}</span><span class="w"></span>
  1019. <span class="p">}</span><span class="w"></span>
  1020. </code></pre></div>
  1021. <h2 id="aws-authentication">AWS Authentication</h2>
  1022. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  1023. <p><img alt="Pod Identity Authentication" src="../../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  1024. <p>Note: If you are using Parameter Store replace <code>service: SecretsManager</code> with <code>service: ParameterStore</code> in all examples below.</p>
  1025. <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>
  1026. <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>
  1027. <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>
  1028. <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>
  1029. <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>
  1030. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1031. <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>
  1032. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1033. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  1034. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  1035. <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>
  1036. <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>
  1037. <span class="w"> </span><span class="c1"># optional: do a sts:assumeRole before fetching secrets</span><span class="w"></span>
  1038. <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>
  1039. </code></pre></div>
  1040. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  1041. <p><img alt="SecretRef" src="../../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  1042. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  1043. <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>
  1044. <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>
  1045. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1046. <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>
  1047. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1048. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  1049. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  1050. <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>
  1051. <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>
  1052. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span><span class="w"></span>
  1053. <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>
  1054. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  1055. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  1056. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  1057. <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>
  1058. <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>
  1059. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  1060. <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>
  1061. <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>
  1062. </code></pre></div>
  1063. <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>
  1064. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  1065. <p><img alt="Service Account" src="../../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  1066. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  1067. 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>
  1068. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  1069. <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>
  1070. <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>
  1071. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1072. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"></span>
  1073. <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>
  1074. <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>
  1075. <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>
  1076. </code></pre></div>
  1077. <p>Reference the service account from above in the Secret Store:</p>
  1078. <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>
  1079. <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>
  1080. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1081. <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>
  1082. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1083. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  1084. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  1085. <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>
  1086. <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>
  1087. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  1088. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span><span class="w"></span>
  1089. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  1090. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-serviceaccount</span><span class="w"></span>
  1091. </code></pre></div>
  1092. <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>
  1093. <h2 id="custom-endpoints">Custom Endpoints</h2>
  1094. <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>
  1095. <p>Use the following environment variables to point the controller to your custom endpoints. Note: All resources managed by this controller are affected.</p>
  1096. <table>
  1097. <thead>
  1098. <tr>
  1099. <th>ENV VAR</th>
  1100. <th>DESCRIPTION</th>
  1101. </tr>
  1102. </thead>
  1103. <tbody>
  1104. <tr>
  1105. <td>AWS_SECRETSMANAGER_ENDPOINT</td>
  1106. <td>Endpoint for the Secrets Manager Service. The controller uses this endpoint to fetch secrets from AWS Secrets Manager.</td>
  1107. </tr>
  1108. <tr>
  1109. <td>AWS_SSM_ENDPOINT</td>
  1110. <td>Endpoint for the AWS Secure Systems Manager. The controller uses this endpoint to fetch secrets from SSM Parameter Store.</td>
  1111. </tr>
  1112. <tr>
  1113. <td>AWS_STS_ENDPOINT</td>
  1114. <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>
  1115. </tr>
  1116. </tbody>
  1117. </table>
  1118. </article>
  1119. </div>
  1120. </div>
  1121. </main>
  1122. <footer class="md-footer">
  1123. <nav class="md-footer__inner md-grid" aria-label="Footer">
  1124. <a href="../aws-secrets-manager/" class="md-footer__link md-footer__link--prev" aria-label="Previous: AWS Secrets Manager" rel="prev">
  1125. <div class="md-footer__button md-icon">
  1126. <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>
  1127. </div>
  1128. <div class="md-footer__title">
  1129. <div class="md-ellipsis">
  1130. <span class="md-footer__direction">
  1131. Previous
  1132. </span>
  1133. AWS Secrets Manager
  1134. </div>
  1135. </div>
  1136. </a>
  1137. <a href="../azure-key-vault/" class="md-footer__link md-footer__link--next" aria-label="Next: Azure Key Vault" rel="next">
  1138. <div class="md-footer__title">
  1139. <div class="md-ellipsis">
  1140. <span class="md-footer__direction">
  1141. Next
  1142. </span>
  1143. Azure Key Vault
  1144. </div>
  1145. </div>
  1146. <div class="md-footer__button md-icon">
  1147. <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>
  1148. </div>
  1149. </a>
  1150. </nav>
  1151. <div class="md-footer-meta md-typeset">
  1152. <div class="md-footer-meta__inner md-grid">
  1153. <div class="md-copyright">
  1154. <div class="md-copyright__highlight">
  1155. &copy; 2023 The external-secrets Authors.<br/>
  1156. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1157. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1158. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1159. </div>
  1160. Made with
  1161. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1162. Material for MkDocs
  1163. </a>
  1164. </div>
  1165. </div>
  1166. </div>
  1167. </footer>
  1168. </div>
  1169. <div class="md-dialog" data-md-component="dialog">
  1170. <div class="md-dialog__inner md-typeset"></div>
  1171. </div>
  1172. <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>
  1173. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1174. </body>
  1175. </html>