index.html 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567
  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.9">
  8. <title>Secrets Manager - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.2b4465f4.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="#secrets-manager" 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. Secrets Manager
  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">
  191. <a href="../guides-templating/" class="md-nav__link">
  192. Advanced Templating
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../guides-controller-class/" class="md-nav__link">
  197. Controller Classes
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  202. All keys, One secret
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  207. Common K8S Secret Types
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../guides-multi-tenancy/" class="md-nav__link">
  212. Multi Tenancy
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="../guides-metrics/" class="md-nav__link">
  217. Metrics
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-using-latest-image/" class="md-nav__link">
  222. Using Latest Image
  223. </a>
  224. </li>
  225. </ul>
  226. </nav>
  227. </li>
  228. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  229. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  230. <label class="md-nav__link" for="__nav_5">
  231. Provider
  232. <span class="md-nav__icon md-icon"></span>
  233. </label>
  234. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  235. <label class="md-nav__title" for="__nav_5">
  236. <span class="md-nav__icon md-icon"></span>
  237. Provider
  238. </label>
  239. <ul class="md-nav__list" data-md-scrollfix>
  240. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  241. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" checked>
  242. <label class="md-nav__link" for="__nav_5_1">
  243. AWS
  244. <span class="md-nav__icon md-icon"></span>
  245. </label>
  246. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  247. <label class="md-nav__title" for="__nav_5_1">
  248. <span class="md-nav__icon md-icon"></span>
  249. AWS
  250. </label>
  251. <ul class="md-nav__list" data-md-scrollfix>
  252. <li class="md-nav__item md-nav__item--active">
  253. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  254. <label class="md-nav__link md-nav__link--active" for="__toc">
  255. Secrets Manager
  256. <span class="md-nav__icon md-icon"></span>
  257. </label>
  258. <a href="./" class="md-nav__link md-nav__link--active">
  259. Secrets Manager
  260. </a>
  261. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  262. <label class="md-nav__title" for="__toc">
  263. <span class="md-nav__icon md-icon"></span>
  264. Table of contents
  265. </label>
  266. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  267. <li class="md-nav__item">
  268. <a href="#secrets-manager" class="md-nav__link">
  269. Secrets Manager
  270. </a>
  271. <nav class="md-nav" aria-label="Secrets Manager">
  272. <ul class="md-nav__list">
  273. <li class="md-nav__item">
  274. <a href="#iam-policy" class="md-nav__link">
  275. IAM Policy
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="#json-secret-values" class="md-nav__link">
  280. JSON Secret Values
  281. </a>
  282. </li>
  283. </ul>
  284. </nav>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="#aws-authentication" class="md-nav__link">
  288. AWS Authentication
  289. </a>
  290. <nav class="md-nav" aria-label="AWS Authentication">
  291. <ul class="md-nav__list">
  292. <li class="md-nav__item">
  293. <a href="#controllers-pod-identity" class="md-nav__link">
  294. Controller's Pod Identity
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  299. Access Key ID &amp; Secret Access Key
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="#eks-service-account-credentials" class="md-nav__link">
  304. EKS Service Account credentials
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. </ul>
  311. </nav>
  312. </li>
  313. <li class="md-nav__item">
  314. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  315. Parameter Store
  316. </a>
  317. </li>
  318. </ul>
  319. </nav>
  320. </li>
  321. <li class="md-nav__item md-nav__item--nested">
  322. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  323. <label class="md-nav__link" for="__nav_5_2">
  324. Azure
  325. <span class="md-nav__icon md-icon"></span>
  326. </label>
  327. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  328. <label class="md-nav__title" for="__nav_5_2">
  329. <span class="md-nav__icon md-icon"></span>
  330. Azure
  331. </label>
  332. <ul class="md-nav__list" data-md-scrollfix>
  333. <li class="md-nav__item">
  334. <a href="../provider-azure-key-vault/" class="md-nav__link">
  335. Key Vault
  336. </a>
  337. </li>
  338. </ul>
  339. </nav>
  340. </li>
  341. <li class="md-nav__item md-nav__item--nested">
  342. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  343. <label class="md-nav__link" for="__nav_5_3">
  344. Google
  345. <span class="md-nav__icon md-icon"></span>
  346. </label>
  347. <nav class="md-nav" aria-label="Google" data-md-level="2">
  348. <label class="md-nav__title" for="__nav_5_3">
  349. <span class="md-nav__icon md-icon"></span>
  350. Google
  351. </label>
  352. <ul class="md-nav__list" data-md-scrollfix>
  353. <li class="md-nav__item">
  354. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  355. Secret Manager
  356. </a>
  357. </li>
  358. </ul>
  359. </nav>
  360. </li>
  361. <li class="md-nav__item md-nav__item--nested">
  362. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  363. <label class="md-nav__link" for="__nav_5_4">
  364. IBM
  365. <span class="md-nav__icon md-icon"></span>
  366. </label>
  367. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  368. <label class="md-nav__title" for="__nav_5_4">
  369. <span class="md-nav__icon md-icon"></span>
  370. IBM
  371. </label>
  372. <ul class="md-nav__list" data-md-scrollfix>
  373. <li class="md-nav__item">
  374. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  375. Secrets Manager
  376. </a>
  377. </li>
  378. </ul>
  379. </nav>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="../provider-akeyless/" class="md-nav__link">
  383. Akeyless
  384. </a>
  385. </li>
  386. <li class="md-nav__item">
  387. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  388. HashiCorp Vault
  389. </a>
  390. </li>
  391. <li class="md-nav__item md-nav__item--nested">
  392. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  393. <label class="md-nav__link" for="__nav_5_7">
  394. Yandex
  395. <span class="md-nav__icon md-icon"></span>
  396. </label>
  397. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  398. <label class="md-nav__title" for="__nav_5_7">
  399. <span class="md-nav__icon md-icon"></span>
  400. Yandex
  401. </label>
  402. <ul class="md-nav__list" data-md-scrollfix>
  403. <li class="md-nav__item">
  404. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  405. Lockbox
  406. </a>
  407. </li>
  408. </ul>
  409. </nav>
  410. </li>
  411. <li class="md-nav__item md-nav__item--nested">
  412. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  413. <label class="md-nav__link" for="__nav_5_8">
  414. Gitlab
  415. <span class="md-nav__icon md-icon"></span>
  416. </label>
  417. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  418. <label class="md-nav__title" for="__nav_5_8">
  419. <span class="md-nav__icon md-icon"></span>
  420. Gitlab
  421. </label>
  422. <ul class="md-nav__list" data-md-scrollfix>
  423. <li class="md-nav__item">
  424. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  425. Gitlab Project Variables
  426. </a>
  427. </li>
  428. </ul>
  429. </nav>
  430. </li>
  431. <li class="md-nav__item md-nav__item--nested">
  432. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  433. <label class="md-nav__link" for="__nav_5_9">
  434. Oracle
  435. <span class="md-nav__icon md-icon"></span>
  436. </label>
  437. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  438. <label class="md-nav__title" for="__nav_5_9">
  439. <span class="md-nav__icon md-icon"></span>
  440. Oracle
  441. </label>
  442. <ul class="md-nav__list" data-md-scrollfix>
  443. <li class="md-nav__item">
  444. <a href="../provider-oracle-vault/" class="md-nav__link">
  445. Oracle Vault
  446. </a>
  447. </li>
  448. </ul>
  449. </nav>
  450. </li>
  451. <li class="md-nav__item">
  452. <a href="../provider-webhook/" class="md-nav__link">
  453. Webhook
  454. </a>
  455. </li>
  456. <li class="md-nav__item">
  457. <a href="../provider-fake/" class="md-nav__link">
  458. Fake
  459. </a>
  460. </li>
  461. </ul>
  462. </nav>
  463. </li>
  464. <li class="md-nav__item md-nav__item--nested">
  465. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  466. <label class="md-nav__link" for="__nav_6">
  467. Examples
  468. <span class="md-nav__icon md-icon"></span>
  469. </label>
  470. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  471. <label class="md-nav__title" for="__nav_6">
  472. <span class="md-nav__icon md-icon"></span>
  473. Examples
  474. </label>
  475. <ul class="md-nav__list" data-md-scrollfix>
  476. <li class="md-nav__item">
  477. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  478. FluxCD
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  483. Anchore Engine
  484. </a>
  485. </li>
  486. <li class="md-nav__item">
  487. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  488. Jenkins
  489. </a>
  490. </li>
  491. </ul>
  492. </nav>
  493. </li>
  494. <li class="md-nav__item md-nav__item--nested">
  495. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  496. <label class="md-nav__link" for="__nav_7">
  497. References
  498. <span class="md-nav__icon md-icon"></span>
  499. </label>
  500. <nav class="md-nav" aria-label="References" data-md-level="1">
  501. <label class="md-nav__title" for="__nav_7">
  502. <span class="md-nav__icon md-icon"></span>
  503. References
  504. </label>
  505. <ul class="md-nav__list" data-md-scrollfix>
  506. <li class="md-nav__item">
  507. <a href="../spec/" class="md-nav__link">
  508. API specification
  509. </a>
  510. </li>
  511. </ul>
  512. </nav>
  513. </li>
  514. <li class="md-nav__item md-nav__item--nested">
  515. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  516. <label class="md-nav__link" for="__nav_8">
  517. Contributing
  518. <span class="md-nav__icon md-icon"></span>
  519. </label>
  520. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  521. <label class="md-nav__title" for="__nav_8">
  522. <span class="md-nav__icon md-icon"></span>
  523. Contributing
  524. </label>
  525. <ul class="md-nav__list" data-md-scrollfix>
  526. <li class="md-nav__item">
  527. <a href="../contributing-devguide/" class="md-nav__link">
  528. Developer guide
  529. </a>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../contributing-process/" class="md-nav__link">
  533. Contributing Process
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../contributing-coc/" class="md-nav__link">
  538. Code of Conduct
  539. </a>
  540. </li>
  541. </ul>
  542. </nav>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="../deprecation-policy/" class="md-nav__link">
  546. Deprecation Policy
  547. </a>
  548. </li>
  549. </ul>
  550. </nav>
  551. </div>
  552. </div>
  553. </div>
  554. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  555. <div class="md-sidebar__scrollwrap">
  556. <div class="md-sidebar__inner">
  557. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  558. <label class="md-nav__title" for="__toc">
  559. <span class="md-nav__icon md-icon"></span>
  560. Table of contents
  561. </label>
  562. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  563. <li class="md-nav__item">
  564. <a href="#secrets-manager" class="md-nav__link">
  565. Secrets Manager
  566. </a>
  567. <nav class="md-nav" aria-label="Secrets Manager">
  568. <ul class="md-nav__list">
  569. <li class="md-nav__item">
  570. <a href="#iam-policy" class="md-nav__link">
  571. IAM Policy
  572. </a>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="#json-secret-values" class="md-nav__link">
  576. JSON Secret Values
  577. </a>
  578. </li>
  579. </ul>
  580. </nav>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="#aws-authentication" class="md-nav__link">
  584. AWS Authentication
  585. </a>
  586. <nav class="md-nav" aria-label="AWS Authentication">
  587. <ul class="md-nav__list">
  588. <li class="md-nav__item">
  589. <a href="#controllers-pod-identity" class="md-nav__link">
  590. Controller's Pod Identity
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  595. Access Key ID &amp; Secret Access Key
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="#eks-service-account-credentials" class="md-nav__link">
  600. EKS Service Account credentials
  601. </a>
  602. </li>
  603. </ul>
  604. </nav>
  605. </li>
  606. </ul>
  607. </nav>
  608. </div>
  609. </div>
  610. </div>
  611. <div class="md-content" data-md-component="content">
  612. <article class="md-content__inner md-typeset">
  613. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-aws-secrets-manager.md" title="Edit this page" class="md-content__button md-icon">
  614. <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>
  615. </a>
  616. <h1>Secrets Manager</h1>
  617. <p><img alt="aws sm" src="../pictures/eso-az-kv-aws-sm.png" /></p>
  618. <h2 id="secrets-manager">Secrets Manager</h2>
  619. <p>A <code>SecretStore</code> points to AWS Secrets Manager in a certain account within a
  620. defined region. You should define Roles that define fine-grained access to
  621. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  622. way users of the <code>SecretStore</code> can only access the secrets necessary.</p>
  623. <p><div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  624. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  625. <span class="nt">metadata</span><span class="p">:</span>
  626. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span>
  627. <span class="nt">spec</span><span class="p">:</span>
  628. <span class="nt">provider</span><span class="p">:</span>
  629. <span class="nt">aws</span><span class="p">:</span>
  630. <span class="nt">service</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  631. <span class="c1"># define a specific role to limit access</span>
  632. <span class="c1"># to certain secrets.</span>
  633. <span class="c1"># role is a optional field that </span>
  634. <span class="c1"># can be omitted for test purposes</span>
  635. <span class="nt">role</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">iam-role</span>
  636. <span class="nt">region</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  637. <span class="nt">auth</span><span class="p">:</span>
  638. <span class="nt">secretRef</span><span class="p">:</span>
  639. <span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  640. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  641. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">access-key</span>
  642. <span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  643. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  644. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  645. </code></pre></div>
  646. <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>
  647. <h3 id="iam-policy">IAM Policy</h3>
  648. <p>Create a IAM Policy to pin down access to secrets matching <code>dev-*</code>.</p>
  649. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  650. <span class="nt">&quot;Version&quot;</span><span class="p">:</span> <span class="s2">&quot;2012-10-17&quot;</span><span class="p">,</span>
  651. <span class="nt">&quot;Statement&quot;</span><span class="p">:</span> <span class="p">[</span>
  652. <span class="p">{</span>
  653. <span class="nt">&quot;Effect&quot;</span><span class="p">:</span> <span class="s2">&quot;Allow&quot;</span><span class="p">,</span>
  654. <span class="nt">&quot;Action&quot;</span><span class="p">:</span> <span class="p">[</span>
  655. <span class="s2">&quot;secretsmanager:GetResourcePolicy&quot;</span><span class="p">,</span>
  656. <span class="s2">&quot;secretsmanager:GetSecretValue&quot;</span><span class="p">,</span>
  657. <span class="s2">&quot;secretsmanager:DescribeSecret&quot;</span><span class="p">,</span>
  658. <span class="s2">&quot;secretsmanager:ListSecretVersionIds&quot;</span>
  659. <span class="p">],</span>
  660. <span class="nt">&quot;Resource&quot;</span><span class="p">:</span> <span class="p">[</span>
  661. <span class="s2">&quot;arn:aws:secretsmanager:us-west-2:111122223333:secret:dev-*&quot;</span><span class="p">,</span>
  662. <span class="p">]</span>
  663. <span class="p">}</span>
  664. <span class="p">]</span>
  665. <span class="p">}</span>
  666. </code></pre></div>
  667. <h3 id="json-secret-values">JSON Secret Values</h3>
  668. <p>SecretsManager supports <em>simple</em> key/value pairs that are stored as json. If you use the API you can store more complex JSON objects. You can access nested values or arrays using <a href="https://github.com/tidwall/gjson/blob/master/SYNTAX.md">gjson syntax</a>:</p>
  669. <p>Consider the following JSON object that is stored in the SecretsManager key <code>my-json-secret</code>:
  670. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  671. <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span> <span class="s2">&quot;Tom&quot;</span><span class="p">,</span> <span class="nt">&quot;last&quot;</span><span class="p">:</span> <span class="s2">&quot;Anderson&quot;</span><span class="p">},</span>
  672. <span class="nt">&quot;friends&quot;</span><span class="p">:</span> <span class="p">[</span>
  673. <span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span> <span class="s2">&quot;Dale&quot;</span><span class="p">,</span> <span class="nt">&quot;last&quot;</span><span class="p">:</span> <span class="s2">&quot;Murphy&quot;</span><span class="p">},</span>
  674. <span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span> <span class="s2">&quot;Roger&quot;</span><span class="p">,</span> <span class="nt">&quot;last&quot;</span><span class="p">:</span> <span class="s2">&quot;Craig&quot;</span><span class="p">},</span>
  675. <span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span> <span class="s2">&quot;Jane&quot;</span><span class="p">,</span> <span class="nt">&quot;last&quot;</span><span class="p">:</span> <span class="s2">&quot;Murphy&quot;</span><span class="p">}</span>
  676. <span class="p">]</span>
  677. <span class="p">}</span>
  678. </code></pre></div></p>
  679. <p>This is an example on how you would look up nested keys in the above json object:</p>
  680. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  681. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  682. <span class="nt">metadata</span><span class="p">:</span>
  683. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  684. <span class="nt">spec</span><span class="p">:</span>
  685. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1m</span>
  686. <span class="nt">secretStoreRef</span><span class="p">:</span>
  687. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span>
  688. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  689. <span class="nt">target</span><span class="p">:</span>
  690. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-to-be-created</span>
  691. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
  692. <span class="nt">data</span><span class="p">:</span>
  693. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">firstname</span>
  694. <span class="nt">remoteRef</span><span class="p">:</span>
  695. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-json-secret</span>
  696. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">name.first</span> <span class="c1"># Tom</span>
  697. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">first_friend</span>
  698. <span class="nt">remoteRef</span><span class="p">:</span>
  699. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-json-secret</span>
  700. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">friends.1.first</span> <span class="c1"># Roger</span>
  701. </code></pre></div>
  702. <h2 id="aws-authentication">AWS Authentication</h2>
  703. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  704. <p><img alt="Pod Identity Authentication" src="../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  705. <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>
  706. <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>
  707. <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>
  708. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  709. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  710. <span class="nt">metadata</span><span class="p">:</span>
  711. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">team-b-store</span>
  712. <span class="nt">spec</span><span class="p">:</span>
  713. <span class="nt">provider</span><span class="p">:</span>
  714. <span class="nt">aws</span><span class="p">:</span>
  715. <span class="nt">service</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  716. <span class="nt">region</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  717. <span class="c1"># optional: do a sts:assumeRole before fetching secrets</span>
  718. <span class="nt">role</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">team-b</span>
  719. </code></pre></div>
  720. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  721. <p><img alt="SecretRef" src="../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  722. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  723. <p><div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  724. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  725. <span class="nt">metadata</span><span class="p">:</span>
  726. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">team-b-store</span>
  727. <span class="nt">spec</span><span class="p">:</span>
  728. <span class="nt">provider</span><span class="p">:</span>
  729. <span class="nt">aws</span><span class="p">:</span>
  730. <span class="nt">service</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  731. <span class="nt">region</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  732. <span class="c1"># optional: assume role before fetching secrets</span>
  733. <span class="nt">role</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">team-b</span>
  734. <span class="nt">auth</span><span class="p">:</span>
  735. <span class="nt">secretRef</span><span class="p">:</span>
  736. <span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  737. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  738. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">access-key</span>
  739. <span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  740. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  741. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  742. </code></pre></div>
  743. <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>
  744. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  745. <p><img alt="Service Account" src="../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  746. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  747. 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>
  748. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  749. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
  750. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  751. <span class="nt">metadata</span><span class="p">:</span>
  752. <span class="nt">annotations</span><span class="p">:</span>
  753. <span class="nt">eks.amazonaws.com/role-arn</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">arn:aws:iam::123456789012:role/team-a</span>
  754. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-serviceaccount</span>
  755. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">default</span>
  756. </code></pre></div>
  757. <p>Reference the service account from above in the Secret Store:
  758. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  759. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  760. <span class="nt">metadata</span><span class="p">:</span>
  761. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span>
  762. <span class="nt">spec</span><span class="p">:</span>
  763. <span class="nt">provider</span><span class="p">:</span>
  764. <span class="nt">aws</span><span class="p">:</span>
  765. <span class="nt">service</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  766. <span class="nt">region</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  767. <span class="nt">auth</span><span class="p">:</span>
  768. <span class="nt">jwt</span><span class="p">:</span>
  769. <span class="nt">serviceAccountRef</span><span class="p">:</span>
  770. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-serviceaccount</span>
  771. </code></pre></div>
  772. <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>
  773. </article>
  774. </div>
  775. </div>
  776. </main>
  777. <footer class="md-footer">
  778. <nav class="md-footer__inner md-grid" aria-label="Footer">
  779. <a href="../guides-using-latest-image/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Using Latest Image" rel="prev">
  780. <div class="md-footer__button md-icon">
  781. <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>
  782. </div>
  783. <div class="md-footer__title">
  784. <div class="md-ellipsis">
  785. <span class="md-footer__direction">
  786. Previous
  787. </span>
  788. Using Latest Image
  789. </div>
  790. </div>
  791. </a>
  792. <a href="../provider-aws-parameter-store/" class="md-footer__link md-footer__link--next" aria-label="Next: Parameter Store" rel="next">
  793. <div class="md-footer__title">
  794. <div class="md-ellipsis">
  795. <span class="md-footer__direction">
  796. Next
  797. </span>
  798. Parameter Store
  799. </div>
  800. </div>
  801. <div class="md-footer__button md-icon">
  802. <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>
  803. </div>
  804. </a>
  805. </nav>
  806. <div class="md-footer-meta md-typeset">
  807. <div class="md-footer-meta__inner md-grid">
  808. <div class="md-copyright">
  809. Made with
  810. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  811. Material for MkDocs
  812. </a>
  813. </div>
  814. </div>
  815. </div>
  816. </footer>
  817. </div>
  818. <div class="md-dialog" data-md-component="dialog">
  819. <div class="md-dialog__inner md-typeset"></div>
  820. </div>
  821. <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.22074ed6.min.js", "version": {"provider": "mike"}}</script>
  822. <script src="../assets/javascripts/bundle.960e086b.min.js"></script>
  823. </body>
  824. </html>