index.html 52 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239
  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.4.3, mkdocs-material-9.1.9">
  8. <title>Provider aws access - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.85bb2934.min.css">
  10. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  11. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  12. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  13. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  14. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  15. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  16. </head>
  17. <body dir="ltr">
  18. <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
  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="#aws-authentication" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-color-scheme="default" 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. Provider aws access
  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" title="Clear" 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" role="presentation"></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"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  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-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="../../provider/aws-secrets-manager/" class="md-tabs__link">
  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"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  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 md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  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" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  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 md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  208. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  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 md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  225. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  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 md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  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" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  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 md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  312. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  313. Reference Docs
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  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 md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  345. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  346. Guides
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  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 md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  362. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  363. External Secrets
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  367. <label class="md-nav__title" for="__nav_3_2">
  368. <span class="md-nav__icon md-icon"></span>
  369. External Secrets
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  374. Extract structured data
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../../guides/getallsecrets/" class="md-nav__link">
  379. Find Secrets by Name or Metadata
  380. </a>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  384. Rewriting Keys
  385. </a>
  386. </li>
  387. <li class="md-nav__item md-nav__item--nested">
  388. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  389. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  390. Advanced Templating
  391. <span class="md-nav__icon md-icon"></span>
  392. </label>
  393. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  394. <label class="md-nav__title" for="__nav_3_2_4">
  395. <span class="md-nav__icon md-icon"></span>
  396. Advanced Templating
  397. </label>
  398. <ul class="md-nav__list" data-md-scrollfix>
  399. <li class="md-nav__item">
  400. <a href="../../guides/templating/" class="md-nav__link">
  401. v2
  402. </a>
  403. </li>
  404. <li class="md-nav__item">
  405. <a href="../../guides/templating-v1/" class="md-nav__link">
  406. v1
  407. </a>
  408. </li>
  409. </ul>
  410. </nav>
  411. </li>
  412. <li class="md-nav__item">
  413. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  414. Kubernetes Secret Types
  415. </a>
  416. </li>
  417. <li class="md-nav__item">
  418. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  419. Lifecycle: ownership & deletion
  420. </a>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  424. Decoding Strategies
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="../../guides/controller-class/" class="md-nav__link">
  429. Controller Classes
  430. </a>
  431. </li>
  432. </ul>
  433. </nav>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="../../guides/generator/" class="md-nav__link">
  437. Generators
  438. </a>
  439. </li>
  440. <li class="md-nav__item md-nav__item--nested">
  441. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
  442. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  443. Operations
  444. <span class="md-nav__icon md-icon"></span>
  445. </label>
  446. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
  447. <label class="md-nav__title" for="__nav_3_4">
  448. <span class="md-nav__icon md-icon"></span>
  449. Operations
  450. </label>
  451. <ul class="md-nav__list" data-md-scrollfix>
  452. <li class="md-nav__item">
  453. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  454. Multi Tenancy
  455. </a>
  456. </li>
  457. <li class="md-nav__item">
  458. <a href="../../guides/security-best-practices/" class="md-nav__link">
  459. Security Best Practices
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../../guides/v1beta1/" class="md-nav__link">
  464. Upgrading to v1beta1
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../../guides/using-latest-image/" class="md-nav__link">
  469. Using Latest Image
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  474. Disable Cluster Features
  475. </a>
  476. </li>
  477. </ul>
  478. </nav>
  479. </li>
  480. </ul>
  481. </nav>
  482. </li>
  483. <li class="md-nav__item md-nav__item--nested">
  484. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  485. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  486. Provider
  487. <span class="md-nav__icon md-icon"></span>
  488. </label>
  489. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  490. <label class="md-nav__title" for="__nav_4">
  491. <span class="md-nav__icon md-icon"></span>
  492. Provider
  493. </label>
  494. <ul class="md-nav__list" data-md-scrollfix>
  495. <li class="md-nav__item">
  496. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  497. AWS Secrets Manager
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  502. AWS Parameter Store
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  507. Azure Key Vault
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  512. Google Cloud Secret Manager
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  517. HashiCorp Vault
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../../provider/kubernetes/" class="md-nav__link">
  522. Kubernetes
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  527. IBM Secrets Manager
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../provider/akeyless/" class="md-nav__link">
  532. Akeyless
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  537. Yandex Certificate Manager
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  542. Yandex Lockbox
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../../provider/alibaba/" class="md-nav__link">
  547. Alibaba Cloud
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  552. GitLab Variables
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="../../provider/oracle-vault/" class="md-nav__link">
  557. Oracle Vault
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../provider/1password-automation/" class="md-nav__link">
  562. 1Password Secrets Automation
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="../../provider/webhook/" class="md-nav__link">
  567. Webhook
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="../../provider/fake/" class="md-nav__link">
  572. Fake
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  577. senhasegura DevOps Secrets Management (DSM)
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../provider/doppler/" class="md-nav__link">
  582. Doppler
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../provider/keeper-security/" class="md-nav__link">
  587. Keeper Security
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="../../provider/scaleway/" class="md-nav__link">
  592. Scaleway
  593. </a>
  594. </li>
  595. </ul>
  596. </nav>
  597. </li>
  598. <li class="md-nav__item md-nav__item--nested">
  599. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  600. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  601. Examples
  602. <span class="md-nav__icon md-icon"></span>
  603. </label>
  604. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  605. <label class="md-nav__title" for="__nav_5">
  606. <span class="md-nav__icon md-icon"></span>
  607. Examples
  608. </label>
  609. <ul class="md-nav__list" data-md-scrollfix>
  610. <li class="md-nav__item">
  611. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  612. FluxCD
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  617. Anchore Engine
  618. </a>
  619. </li>
  620. <li class="md-nav__item">
  621. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  622. Jenkins
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="../../examples/bitwarden/" class="md-nav__link">
  627. BitWarden
  628. </a>
  629. </li>
  630. </ul>
  631. </nav>
  632. </li>
  633. <li class="md-nav__item md-nav__item--nested">
  634. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  635. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  636. Community
  637. <span class="md-nav__icon md-icon"></span>
  638. </label>
  639. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  640. <label class="md-nav__title" for="__nav_6">
  641. <span class="md-nav__icon md-icon"></span>
  642. Community
  643. </label>
  644. <ul class="md-nav__list" data-md-scrollfix>
  645. <li class="md-nav__item md-nav__item--nested">
  646. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  647. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  648. Contributing
  649. <span class="md-nav__icon md-icon"></span>
  650. </label>
  651. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  652. <label class="md-nav__title" for="__nav_6_1">
  653. <span class="md-nav__icon md-icon"></span>
  654. Contributing
  655. </label>
  656. <ul class="md-nav__list" data-md-scrollfix>
  657. <li class="md-nav__item">
  658. <a href="../../contributing/devguide/" class="md-nav__link">
  659. Developer guide
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../../contributing/process/" class="md-nav__link">
  664. Contributing Process
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="../../contributing/release/" class="md-nav__link">
  669. Release Process
  670. </a>
  671. </li>
  672. <li class="md-nav__item">
  673. <a href="../../contributing/coc/" class="md-nav__link">
  674. Code of Conduct
  675. </a>
  676. </li>
  677. <li class="md-nav__item">
  678. <a href="../../contributing/roadmap/" class="md-nav__link">
  679. Roadmap
  680. </a>
  681. </li>
  682. </ul>
  683. </nav>
  684. </li>
  685. <li class="md-nav__item md-nav__item--nested">
  686. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  687. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  688. External Resources
  689. <span class="md-nav__icon md-icon"></span>
  690. </label>
  691. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  692. <label class="md-nav__title" for="__nav_6_2">
  693. <span class="md-nav__icon md-icon"></span>
  694. External Resources
  695. </label>
  696. <ul class="md-nav__list" data-md-scrollfix>
  697. <li class="md-nav__item">
  698. <a href="../../eso-talks/" class="md-nav__link">
  699. Talks
  700. </a>
  701. </li>
  702. <li class="md-nav__item">
  703. <a href="../../eso-demos/" class="md-nav__link">
  704. Demos
  705. </a>
  706. </li>
  707. <li class="md-nav__item">
  708. <a href="../../eso-blogs/" class="md-nav__link">
  709. Blogs
  710. </a>
  711. </li>
  712. </ul>
  713. </nav>
  714. </li>
  715. </ul>
  716. </nav>
  717. </li>
  718. </ul>
  719. </nav>
  720. </div>
  721. </div>
  722. </div>
  723. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  724. <div class="md-sidebar__scrollwrap">
  725. <div class="md-sidebar__inner">
  726. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  727. <label class="md-nav__title" for="__toc">
  728. <span class="md-nav__icon md-icon"></span>
  729. Table of contents
  730. </label>
  731. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  732. <li class="md-nav__item">
  733. <a href="#aws-authentication" class="md-nav__link">
  734. AWS Authentication
  735. </a>
  736. <nav class="md-nav" aria-label="AWS Authentication">
  737. <ul class="md-nav__list">
  738. <li class="md-nav__item">
  739. <a href="#controllers-pod-identity" class="md-nav__link">
  740. Controller's Pod Identity
  741. </a>
  742. </li>
  743. <li class="md-nav__item">
  744. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  745. Access Key ID &amp; Secret Access Key
  746. </a>
  747. </li>
  748. <li class="md-nav__item">
  749. <a href="#eks-service-account-credentials" class="md-nav__link">
  750. EKS Service Account credentials
  751. </a>
  752. </li>
  753. </ul>
  754. </nav>
  755. </li>
  756. <li class="md-nav__item">
  757. <a href="#custom-endpoints" class="md-nav__link">
  758. Custom Endpoints
  759. </a>
  760. </li>
  761. </ul>
  762. </nav>
  763. </div>
  764. </div>
  765. </div>
  766. <div class="md-content" data-md-component="content">
  767. <article class="md-content__inner md-typeset">
  768. <h1>Provider aws access</h1>
  769. <h2 id="aws-authentication">AWS Authentication</h2>
  770. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  771. <p><img alt="Pod Identity Authentication" src="../../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  772. <p>Note: If you are using Parameter Store replace <code>service: SecretsManager</code> with <code>service: ParameterStore</code> in all examples below.</p>
  773. <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>
  774. <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>
  775. <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>
  776. <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>
  777. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  778. <span class="nt">metadata</span><span class="p">:</span>
  779. <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>
  780. <span class="nt">spec</span><span class="p">:</span>
  781. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  782. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  783. <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>
  784. <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>
  785. <span class="w"> </span><span class="c1"># optional: do a sts:assumeRole before fetching secrets</span>
  786. <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>
  787. </code></pre></div>
  788. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  789. <p><img alt="SecretRef" src="../../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  790. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  791. <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>
  792. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  793. <span class="nt">metadata</span><span class="p">:</span>
  794. <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>
  795. <span class="nt">spec</span><span class="p">:</span>
  796. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  797. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  798. <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>
  799. <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>
  800. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span>
  801. <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>
  802. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  803. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  804. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  805. <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>
  806. <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>
  807. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  808. <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>
  809. <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>
  810. </code></pre></div>
  811. <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>
  812. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  813. <p><img alt="Service Account" src="../../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  814. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  815. 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>
  816. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  817. <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>
  818. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  819. <span class="nt">metadata</span><span class="p">:</span>
  820. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  821. <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>
  822. <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>
  823. <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>
  824. </code></pre></div>
  825. <p>Reference the service account from above in the Secret Store:</p>
  826. <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>
  827. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  828. <span class="nt">metadata</span><span class="p">:</span>
  829. <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>
  830. <span class="nt">spec</span><span class="p">:</span>
  831. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  832. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  833. <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>
  834. <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>
  835. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  836. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  837. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  838. <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>
  839. </code></pre></div>
  840. <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>
  841. <h2 id="custom-endpoints">Custom Endpoints</h2>
  842. <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>
  843. <p>Use the following environment variables to point the controller to your custom endpoints. Note: All resources managed by this controller are affected.</p>
  844. <table>
  845. <thead>
  846. <tr>
  847. <th>ENV VAR</th>
  848. <th>DESCRIPTION</th>
  849. </tr>
  850. </thead>
  851. <tbody>
  852. <tr>
  853. <td>AWS_SECRETSMANAGER_ENDPOINT</td>
  854. <td>Endpoint for the Secrets Manager Service. The controller uses this endpoint to fetch secrets from AWS Secrets Manager.</td>
  855. </tr>
  856. <tr>
  857. <td>AWS_SSM_ENDPOINT</td>
  858. <td>Endpoint for the AWS Secure Systems Manager. The controller uses this endpoint to fetch secrets from SSM Parameter Store.</td>
  859. </tr>
  860. <tr>
  861. <td>AWS_STS_ENDPOINT</td>
  862. <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>
  863. </tr>
  864. </tbody>
  865. </table>
  866. </article>
  867. </div>
  868. </div>
  869. </main>
  870. <footer class="md-footer">
  871. <div class="md-footer-meta md-typeset">
  872. <div class="md-footer-meta__inner md-grid">
  873. <div class="md-copyright">
  874. <div class="md-copyright__highlight">
  875. &copy; 2023 The external-secrets Authors.<br/>
  876. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  877. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  878. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  879. </div>
  880. Made with
  881. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  882. Material for MkDocs
  883. </a>
  884. </div>
  885. </div>
  886. </div>
  887. </footer>
  888. </div>
  889. <div class="md-dialog" data-md-component="dialog">
  890. <div class="md-dialog__inner md-typeset"></div>
  891. </div>
  892. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  893. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  894. </body>
  895. </html>