index.html 55 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642
  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>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. 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. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. </ul>
  166. </nav>
  167. </li>
  168. <li class="md-nav__item md-nav__item--nested">
  169. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  170. <label class="md-nav__link" for="__nav_4">
  171. Guides
  172. <span class="md-nav__icon md-icon"></span>
  173. </label>
  174. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  175. <label class="md-nav__title" for="__nav_4">
  176. <span class="md-nav__icon md-icon"></span>
  177. Guides
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../guides-introduction/" class="md-nav__link">
  182. Introduction
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item md-nav__item--nested">
  191. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  192. <label class="md-nav__link" for="__nav_4_3">
  193. Advanced Templating
  194. <span class="md-nav__icon md-icon"></span>
  195. </label>
  196. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  197. <label class="md-nav__title" for="__nav_4_3">
  198. <span class="md-nav__icon md-icon"></span>
  199. Advanced Templating
  200. </label>
  201. <ul class="md-nav__list" data-md-scrollfix>
  202. <li class="md-nav__item">
  203. <a href="../guides-templating/" class="md-nav__link">
  204. v2
  205. </a>
  206. </li>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating-v1/" class="md-nav__link">
  209. v1
  210. </a>
  211. </li>
  212. </ul>
  213. </nav>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="../guides-controller-class/" class="md-nav__link">
  217. Controller Classes
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-multi-tenancy/" class="md-nav__link">
  232. Multi Tenancy
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-metrics/" class="md-nav__link">
  237. Metrics
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../guides-using-latest-image/" class="md-nav__link">
  242. Using Latest Image
  243. </a>
  244. </li>
  245. </ul>
  246. </nav>
  247. </li>
  248. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  249. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  250. <label class="md-nav__link" for="__nav_5">
  251. Provider
  252. <span class="md-nav__icon md-icon"></span>
  253. </label>
  254. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  255. <label class="md-nav__title" for="__nav_5">
  256. <span class="md-nav__icon md-icon"></span>
  257. Provider
  258. </label>
  259. <ul class="md-nav__list" data-md-scrollfix>
  260. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  261. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" checked>
  262. <label class="md-nav__link" for="__nav_5_1">
  263. AWS
  264. <span class="md-nav__icon md-icon"></span>
  265. </label>
  266. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  267. <label class="md-nav__title" for="__nav_5_1">
  268. <span class="md-nav__icon md-icon"></span>
  269. AWS
  270. </label>
  271. <ul class="md-nav__list" data-md-scrollfix>
  272. <li class="md-nav__item">
  273. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  274. Secrets Manager
  275. </a>
  276. </li>
  277. <li class="md-nav__item md-nav__item--active">
  278. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  279. <label class="md-nav__link md-nav__link--active" for="__toc">
  280. Parameter Store
  281. <span class="md-nav__icon md-icon"></span>
  282. </label>
  283. <a href="./" class="md-nav__link md-nav__link--active">
  284. Parameter Store
  285. </a>
  286. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  287. <label class="md-nav__title" for="__toc">
  288. <span class="md-nav__icon md-icon"></span>
  289. Table of contents
  290. </label>
  291. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  292. <li class="md-nav__item">
  293. <a href="#parameter-store" class="md-nav__link">
  294. Parameter Store
  295. </a>
  296. <nav class="md-nav" aria-label="Parameter Store">
  297. <ul class="md-nav__list">
  298. <li class="md-nav__item">
  299. <a href="#iam-policy" class="md-nav__link">
  300. IAM Policy
  301. </a>
  302. </li>
  303. <li class="md-nav__item">
  304. <a href="#json-secret-values" class="md-nav__link">
  305. JSON Secret Values
  306. </a>
  307. </li>
  308. </ul>
  309. </nav>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="#aws-authentication" class="md-nav__link">
  313. AWS Authentication
  314. </a>
  315. <nav class="md-nav" aria-label="AWS Authentication">
  316. <ul class="md-nav__list">
  317. <li class="md-nav__item">
  318. <a href="#controllers-pod-identity" class="md-nav__link">
  319. Controller's Pod Identity
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  324. Access Key ID &amp; Secret Access Key
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="#eks-service-account-credentials" class="md-nav__link">
  329. EKS Service Account credentials
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="#custom-endpoints" class="md-nav__link">
  337. Custom Endpoints
  338. </a>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. </ul>
  344. </nav>
  345. </li>
  346. <li class="md-nav__item md-nav__item--nested">
  347. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  348. <label class="md-nav__link" for="__nav_5_2">
  349. Azure
  350. <span class="md-nav__icon md-icon"></span>
  351. </label>
  352. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  353. <label class="md-nav__title" for="__nav_5_2">
  354. <span class="md-nav__icon md-icon"></span>
  355. Azure
  356. </label>
  357. <ul class="md-nav__list" data-md-scrollfix>
  358. <li class="md-nav__item">
  359. <a href="../provider-azure-key-vault/" class="md-nav__link">
  360. Key Vault
  361. </a>
  362. </li>
  363. </ul>
  364. </nav>
  365. </li>
  366. <li class="md-nav__item md-nav__item--nested">
  367. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  368. <label class="md-nav__link" for="__nav_5_3">
  369. Google
  370. <span class="md-nav__icon md-icon"></span>
  371. </label>
  372. <nav class="md-nav" aria-label="Google" data-md-level="2">
  373. <label class="md-nav__title" for="__nav_5_3">
  374. <span class="md-nav__icon md-icon"></span>
  375. Google
  376. </label>
  377. <ul class="md-nav__list" data-md-scrollfix>
  378. <li class="md-nav__item">
  379. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  380. Secret Manager
  381. </a>
  382. </li>
  383. </ul>
  384. </nav>
  385. </li>
  386. <li class="md-nav__item md-nav__item--nested">
  387. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  388. <label class="md-nav__link" for="__nav_5_4">
  389. IBM
  390. <span class="md-nav__icon md-icon"></span>
  391. </label>
  392. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  393. <label class="md-nav__title" for="__nav_5_4">
  394. <span class="md-nav__icon md-icon"></span>
  395. IBM
  396. </label>
  397. <ul class="md-nav__list" data-md-scrollfix>
  398. <li class="md-nav__item">
  399. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  400. Secrets Manager
  401. </a>
  402. </li>
  403. </ul>
  404. </nav>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="../provider-akeyless/" class="md-nav__link">
  408. Akeyless
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  413. HashiCorp Vault
  414. </a>
  415. </li>
  416. <li class="md-nav__item md-nav__item--nested">
  417. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  418. <label class="md-nav__link" for="__nav_5_7">
  419. Yandex
  420. <span class="md-nav__icon md-icon"></span>
  421. </label>
  422. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  423. <label class="md-nav__title" for="__nav_5_7">
  424. <span class="md-nav__icon md-icon"></span>
  425. Yandex
  426. </label>
  427. <ul class="md-nav__list" data-md-scrollfix>
  428. <li class="md-nav__item">
  429. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  430. Lockbox
  431. </a>
  432. </li>
  433. </ul>
  434. </nav>
  435. </li>
  436. <li class="md-nav__item md-nav__item--nested">
  437. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  438. <label class="md-nav__link" for="__nav_5_8">
  439. Gitlab
  440. <span class="md-nav__icon md-icon"></span>
  441. </label>
  442. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  443. <label class="md-nav__title" for="__nav_5_8">
  444. <span class="md-nav__icon md-icon"></span>
  445. Gitlab
  446. </label>
  447. <ul class="md-nav__list" data-md-scrollfix>
  448. <li class="md-nav__item">
  449. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  450. Gitlab Project Variables
  451. </a>
  452. </li>
  453. </ul>
  454. </nav>
  455. </li>
  456. <li class="md-nav__item md-nav__item--nested">
  457. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  458. <label class="md-nav__link" for="__nav_5_9">
  459. Oracle
  460. <span class="md-nav__icon md-icon"></span>
  461. </label>
  462. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  463. <label class="md-nav__title" for="__nav_5_9">
  464. <span class="md-nav__icon md-icon"></span>
  465. Oracle
  466. </label>
  467. <ul class="md-nav__list" data-md-scrollfix>
  468. <li class="md-nav__item">
  469. <a href="../provider-oracle-vault/" class="md-nav__link">
  470. Oracle Vault
  471. </a>
  472. </li>
  473. </ul>
  474. </nav>
  475. </li>
  476. <li class="md-nav__item">
  477. <a href="../provider-webhook/" class="md-nav__link">
  478. Webhook
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../provider-fake/" class="md-nav__link">
  483. Fake
  484. </a>
  485. </li>
  486. </ul>
  487. </nav>
  488. </li>
  489. <li class="md-nav__item md-nav__item--nested">
  490. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  491. <label class="md-nav__link" for="__nav_6">
  492. Examples
  493. <span class="md-nav__icon md-icon"></span>
  494. </label>
  495. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  496. <label class="md-nav__title" for="__nav_6">
  497. <span class="md-nav__icon md-icon"></span>
  498. Examples
  499. </label>
  500. <ul class="md-nav__list" data-md-scrollfix>
  501. <li class="md-nav__item">
  502. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  503. FluxCD
  504. </a>
  505. </li>
  506. <li class="md-nav__item">
  507. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  508. Anchore Engine
  509. </a>
  510. </li>
  511. <li class="md-nav__item">
  512. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  513. Jenkins
  514. </a>
  515. </li>
  516. </ul>
  517. </nav>
  518. </li>
  519. <li class="md-nav__item md-nav__item--nested">
  520. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  521. <label class="md-nav__link" for="__nav_7">
  522. References
  523. <span class="md-nav__icon md-icon"></span>
  524. </label>
  525. <nav class="md-nav" aria-label="References" data-md-level="1">
  526. <label class="md-nav__title" for="__nav_7">
  527. <span class="md-nav__icon md-icon"></span>
  528. References
  529. </label>
  530. <ul class="md-nav__list" data-md-scrollfix>
  531. <li class="md-nav__item">
  532. <a href="../spec/" class="md-nav__link">
  533. API specification
  534. </a>
  535. </li>
  536. </ul>
  537. </nav>
  538. </li>
  539. <li class="md-nav__item md-nav__item--nested">
  540. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  541. <label class="md-nav__link" for="__nav_8">
  542. Contributing
  543. <span class="md-nav__icon md-icon"></span>
  544. </label>
  545. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  546. <label class="md-nav__title" for="__nav_8">
  547. <span class="md-nav__icon md-icon"></span>
  548. Contributing
  549. </label>
  550. <ul class="md-nav__list" data-md-scrollfix>
  551. <li class="md-nav__item">
  552. <a href="../contributing-devguide/" class="md-nav__link">
  553. Developer guide
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../contributing-process/" class="md-nav__link">
  558. Contributing Process
  559. </a>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../contributing-coc/" class="md-nav__link">
  563. Code of Conduct
  564. </a>
  565. </li>
  566. </ul>
  567. </nav>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="../deprecation-policy/" class="md-nav__link">
  571. Deprecation Policy
  572. </a>
  573. </li>
  574. </ul>
  575. </nav>
  576. </div>
  577. </div>
  578. </div>
  579. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  580. <div class="md-sidebar__scrollwrap">
  581. <div class="md-sidebar__inner">
  582. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  583. <label class="md-nav__title" for="__toc">
  584. <span class="md-nav__icon md-icon"></span>
  585. Table of contents
  586. </label>
  587. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  588. <li class="md-nav__item">
  589. <a href="#parameter-store" class="md-nav__link">
  590. Parameter Store
  591. </a>
  592. <nav class="md-nav" aria-label="Parameter Store">
  593. <ul class="md-nav__list">
  594. <li class="md-nav__item">
  595. <a href="#iam-policy" class="md-nav__link">
  596. IAM Policy
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="#json-secret-values" class="md-nav__link">
  601. JSON Secret Values
  602. </a>
  603. </li>
  604. </ul>
  605. </nav>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="#aws-authentication" class="md-nav__link">
  609. AWS Authentication
  610. </a>
  611. <nav class="md-nav" aria-label="AWS Authentication">
  612. <ul class="md-nav__list">
  613. <li class="md-nav__item">
  614. <a href="#controllers-pod-identity" class="md-nav__link">
  615. Controller's Pod Identity
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  620. Access Key ID &amp; Secret Access Key
  621. </a>
  622. </li>
  623. <li class="md-nav__item">
  624. <a href="#eks-service-account-credentials" class="md-nav__link">
  625. EKS Service Account credentials
  626. </a>
  627. </li>
  628. </ul>
  629. </nav>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="#custom-endpoints" class="md-nav__link">
  633. Custom Endpoints
  634. </a>
  635. </li>
  636. </ul>
  637. </nav>
  638. </div>
  639. </div>
  640. </div>
  641. <div class="md-content" data-md-component="content">
  642. <article class="md-content__inner md-typeset">
  643. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-aws-parameter-store.md" title="Edit this page" class="md-content__button md-icon">
  644. <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>
  645. </a>
  646. <h1>Parameter Store</h1>
  647. <p><img alt="aws sm" src="../pictures/diagrams-provider-aws-ssm-parameter-store.png" /></p>
  648. <h2 id="parameter-store">Parameter Store</h2>
  649. <p>A <code>ParameterStore</code> points to AWS SSM Parameter Store in a certain account within a
  650. defined region. You should define Roles that define fine-grained access to
  651. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  652. way users of the <code>SecretStore</code> can only access the secrets necessary.</p>
  653. <p><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>
  654. <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>
  655. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  656. <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>
  657. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  658. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  659. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  660. <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>
  661. <span class="w"> </span><span class="c1"># define a specific role to limit access</span><span class="w"></span>
  662. <span class="w"> </span><span class="c1"># to certain secrets</span><span class="w"></span>
  663. <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">iam-role</span><span class="w"></span>
  664. <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>
  665. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  666. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  667. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  668. <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>
  669. <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>
  670. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  671. <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>
  672. <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>
  673. </code></pre></div>
  674. <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>
  675. <div class="admonition warning">
  676. <p class="admonition-title">API Pricing &amp; Throttling</p>
  677. <p>The SSM Parameter Store API is charged by throughput and
  678. is available in different tiers, <a href="https://aws.amazon.com/systems-manager/pricing/#Parameter_Store">see pricing</a>.
  679. Please estimate your costs before using ESO. Cost depends on the RefreshInterval of your ExternalSecrets.</p>
  680. </div>
  681. <h3 id="iam-policy">IAM Policy</h3>
  682. <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>
  683. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  684. <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>
  685. <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>
  686. <span class="w"> </span><span class="p">{</span><span class="w"></span>
  687. <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>
  688. <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>
  689. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter*&quot;</span><span class="w"></span>
  690. <span class="w"> </span><span class="p">],</span><span class="w"></span>
  691. <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:123456789012:parameter/dev-*&quot;</span><span class="w"></span>
  692. <span class="w"> </span><span class="p">}</span><span class="w"></span>
  693. <span class="w"> </span><span class="p">]</span><span class="w"></span>
  694. <span class="p">}</span><span class="w"></span>
  695. </code></pre></div>
  696. <h3 id="json-secret-values">JSON Secret Values</h3>
  697. <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>
  698. <p>Consider the following JSON object that is stored in the Parameter Store key <code>my-json-secret</code>:
  699. <div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span>
  700. <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>
  701. <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>
  702. <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>
  703. <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>
  704. <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>
  705. <span class="w"> </span><span class="p">]</span><span class="w"></span>
  706. <span class="p">}</span><span class="w"></span>
  707. </code></pre></div></p>
  708. <p>This is an example on how you would look up nested keys in the above json object:
  709. <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>
  710. <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>
  711. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  712. <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">example</span><span class="w"></span>
  713. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  714. <span class="w"> </span><span class="c1"># [omitted for brevity]</span><span class="w"></span>
  715. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  716. <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">firstname</span><span class="w"></span>
  717. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  718. <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">my-json-secret</span><span class="w"></span>
  719. <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>
  720. <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>
  721. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  722. <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">my-json-secret</span><span class="w"></span>
  723. <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>
  724. </code></pre></div></p>
  725. <h2 id="aws-authentication">AWS Authentication</h2>
  726. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  727. <p><img alt="Pod Identity Authentication" src="../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  728. <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>
  729. <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>
  730. <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>
  731. <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>
  732. <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>
  733. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  734. <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>
  735. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  736. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  737. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  738. <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>
  739. <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>
  740. <span class="w"> </span><span class="c1"># optional: do a sts:assumeRole before fetching secrets</span><span class="w"></span>
  741. <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>
  742. </code></pre></div>
  743. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  744. <p><img alt="SecretRef" src="../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  745. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  746. <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>
  747. <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>
  748. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  749. <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>
  750. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  751. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  752. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  753. <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>
  754. <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>
  755. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span><span class="w"></span>
  756. <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>
  757. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  758. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  759. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  760. <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>
  761. <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>
  762. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  763. <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>
  764. <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>
  765. </code></pre></div>
  766. <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>
  767. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  768. <p><img alt="Service Account" src="../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  769. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  770. 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>
  771. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  772. <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>
  773. <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>
  774. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  775. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"></span>
  776. <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>
  777. <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>
  778. <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>
  779. </code></pre></div>
  780. <p>Reference the service account from above in the Secret Store:</p>
  781. <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>
  782. <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>
  783. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  784. <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>
  785. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  786. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  787. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  788. <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>
  789. <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>
  790. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  791. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span><span class="w"></span>
  792. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  793. <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>
  794. </code></pre></div>
  795. <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>
  796. <h2 id="custom-endpoints">Custom Endpoints</h2>
  797. <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>
  798. <p>Use the following environment variables to point the controller to your custom endpoints. Note: All resources managed by this controller are affected.</p>
  799. <table>
  800. <thead>
  801. <tr>
  802. <th>ENV VAR</th>
  803. <th>DESCRIPTION</th>
  804. </tr>
  805. </thead>
  806. <tbody>
  807. <tr>
  808. <td>AWS_SECRETSMANAGER_ENDPOINT</td>
  809. <td>Endpoint for the Secrets Manager Service. The controller uses this endpoint to fetch secrets from AWS Secrets Manager.</td>
  810. </tr>
  811. <tr>
  812. <td>AWS_SSM_ENDPOINT</td>
  813. <td>Endpoint for the AWS Secure Systems Manager. The controller uses this endpoint to fetch secrets from SSM Parameter Store.</td>
  814. </tr>
  815. <tr>
  816. <td>AWS_STS_ENDPOINT</td>
  817. <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>
  818. </tr>
  819. </tbody>
  820. </table>
  821. </article>
  822. </div>
  823. </div>
  824. </main>
  825. <footer class="md-footer">
  826. <nav class="md-footer__inner md-grid" aria-label="Footer">
  827. <a href="../provider-aws-secrets-manager/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Secrets Manager" rel="prev">
  828. <div class="md-footer__button md-icon">
  829. <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>
  830. </div>
  831. <div class="md-footer__title">
  832. <div class="md-ellipsis">
  833. <span class="md-footer__direction">
  834. Previous
  835. </span>
  836. Secrets Manager
  837. </div>
  838. </div>
  839. </a>
  840. <a href="../provider-azure-key-vault/" class="md-footer__link md-footer__link--next" aria-label="Next: Key Vault" rel="next">
  841. <div class="md-footer__title">
  842. <div class="md-ellipsis">
  843. <span class="md-footer__direction">
  844. Next
  845. </span>
  846. Key Vault
  847. </div>
  848. </div>
  849. <div class="md-footer__button md-icon">
  850. <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>
  851. </div>
  852. </a>
  853. </nav>
  854. <div class="md-footer-meta md-typeset">
  855. <div class="md-footer-meta__inner md-grid">
  856. <div class="md-copyright">
  857. Made with
  858. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  859. Material for MkDocs
  860. </a>
  861. </div>
  862. </div>
  863. </div>
  864. </footer>
  865. </div>
  866. <div class="md-dialog" data-md-component="dialog">
  867. <div class="md-dialog__inner md-typeset"></div>
  868. </div>
  869. <script id="__config" type="application/json">{"base": "..", "features": [], "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>
  870. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  871. </body>
  872. </html>