index.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933
  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. <meta http-equiv="x-ua-compatible" content="ie=edge">
  7. <meta name="lang:clipboard.copy" content="Copy to clipboard">
  8. <meta name="lang:clipboard.copied" content="Copied to clipboard">
  9. <meta name="lang:search.language" content="en">
  10. <meta name="lang:search.pipeline.stopwords" content="True">
  11. <meta name="lang:search.pipeline.trimmer" content="True">
  12. <meta name="lang:search.result.none" content="No matching documents">
  13. <meta name="lang:search.result.one" content="1 matching document">
  14. <meta name="lang:search.result.other" content="# matching documents">
  15. <meta name="lang:search.tokenizer" content="[\s\-]+">
  16. <link rel="shortcut icon" href="../assets/images/favicon.png">
  17. <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">
  18. <title>Parameter Store - External Secrets Operator</title>
  19. <link rel="stylesheet" href="../assets/stylesheets/application.1b62728e.css">
  20. <script src="../assets/javascripts/modernizr.268332fc.js"></script>
  21. <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
  22. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  23. <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
  24. <link rel="stylesheet" href="../assets/fonts/material-icons.css">
  25. </head>
  26. <body dir="ltr">
  27. <svg class="md-svg">
  28. <defs>
  29. <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
  30. </defs>
  31. </svg>
  32. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  33. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  34. <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
  35. <a href="#parameter-store" tabindex="1" class="md-skip">
  36. Skip to content
  37. </a>
  38. <header class="md-header" data-md-component="header">
  39. <nav class="md-header-nav md-grid">
  40. <div class="md-flex">
  41. <div class="md-flex__cell md-flex__cell--shrink">
  42. <a href=".." title="External Secrets Operator" class="md-header-nav__button md-logo">
  43. <i class="md-icon"></i>
  44. </a>
  45. </div>
  46. <div class="md-flex__cell md-flex__cell--shrink">
  47. <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
  48. </div>
  49. <div class="md-flex__cell md-flex__cell--stretch">
  50. <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
  51. <span class="md-header-nav__topic">
  52. External Secrets Operator
  53. </span>
  54. <span class="md-header-nav__topic">
  55. Parameter Store
  56. </span>
  57. </div>
  58. </div>
  59. <div class="md-flex__cell md-flex__cell--shrink">
  60. <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
  61. <div class="md-search" data-md-component="search" role="dialog">
  62. <label class="md-search__overlay" for="__search"></label>
  63. <div class="md-search__inner" role="search">
  64. <form class="md-search__form" name="search">
  65. <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
  66. <label class="md-icon md-search__icon" for="__search"></label>
  67. <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
  68. &#xE5CD;
  69. </button>
  70. </form>
  71. <div class="md-search__output">
  72. <div class="md-search__scrollwrap" data-md-scrollfix>
  73. <div class="md-search-result" data-md-component="result">
  74. <div class="md-search-result__meta">
  75. Type to start searching
  76. </div>
  77. <ol class="md-search-result__list"></ol>
  78. </div>
  79. </div>
  80. </div>
  81. </div>
  82. </div>
  83. </div>
  84. <div class="md-flex__cell md-flex__cell--shrink">
  85. <div class="md-header-nav__source">
  86. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  87. <div class="md-source__icon">
  88. <svg viewBox="0 0 24 24" width="24" height="24">
  89. <use xlink:href="#__github" width="24" height="24"></use>
  90. </svg>
  91. </div>
  92. <div class="md-source__repository">
  93. External Secrets Operator
  94. </div>
  95. </a>
  96. </div>
  97. </div>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container">
  102. <main class="md-main" role="main">
  103. <div class="md-main__inner md-grid" data-md-component="container">
  104. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  105. <div class="md-sidebar__scrollwrap">
  106. <div class="md-sidebar__inner">
  107. <nav class="md-nav md-nav--primary" data-md-level="0">
  108. <label class="md-nav__title md-nav__title--site" for="__drawer">
  109. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo">
  110. <i class="md-icon"></i>
  111. </a>
  112. External Secrets Operator
  113. </label>
  114. <div class="md-nav__source">
  115. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  116. <div class="md-source__icon">
  117. <svg viewBox="0 0 24 24" width="24" height="24">
  118. <use xlink:href="#__github" width="24" height="24"></use>
  119. </svg>
  120. </div>
  121. <div class="md-source__repository">
  122. External Secrets Operator
  123. </div>
  124. </a>
  125. </div>
  126. <ul class="md-nav__list" data-md-scrollfix>
  127. <li class="md-nav__item">
  128. <a href=".." title="Introduction" class="md-nav__link">
  129. Introduction
  130. </a>
  131. </li>
  132. <li class="md-nav__item">
  133. <a href="../api-overview/" title="Overview" class="md-nav__link">
  134. Overview
  135. </a>
  136. </li>
  137. <li class="md-nav__item md-nav__item--nested">
  138. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
  139. <label class="md-nav__link" for="nav-3">
  140. API Types
  141. </label>
  142. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  143. <label class="md-nav__title" for="nav-3">
  144. API Types
  145. </label>
  146. <ul class="md-nav__list" data-md-scrollfix>
  147. <li class="md-nav__item">
  148. <a href="../api-externalsecret/" title="ExternalSecret" class="md-nav__link">
  149. ExternalSecret
  150. </a>
  151. </li>
  152. <li class="md-nav__item">
  153. <a href="../api-secretstore/" title="SecretStore" class="md-nav__link">
  154. SecretStore
  155. </a>
  156. </li>
  157. <li class="md-nav__item">
  158. <a href="../api-clustersecretstore/" title="ClusterSecretStore" class="md-nav__link">
  159. ClusterSecretStore
  160. </a>
  161. </li>
  162. </ul>
  163. </nav>
  164. </li>
  165. <li class="md-nav__item md-nav__item--nested">
  166. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
  167. <label class="md-nav__link" for="nav-4">
  168. Guides
  169. </label>
  170. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  171. <label class="md-nav__title" for="nav-4">
  172. Guides
  173. </label>
  174. <ul class="md-nav__list" data-md-scrollfix>
  175. <li class="md-nav__item">
  176. <a href="../guides-introduction/" title="Introduction" class="md-nav__link">
  177. Introduction
  178. </a>
  179. </li>
  180. <li class="md-nav__item">
  181. <a href="../guides-getting-started/" title="Getting started" class="md-nav__link">
  182. Getting started
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-templating/" title="Advanced Templating" class="md-nav__link">
  187. Advanced Templating
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-multi-tenancy/" title="Multi Tenancy" class="md-nav__link">
  192. Multi Tenancy
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../guides-metrics/" title="Metrics" class="md-nav__link">
  197. Metrics
  198. </a>
  199. </li>
  200. </ul>
  201. </nav>
  202. </li>
  203. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  204. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
  205. <label class="md-nav__link" for="nav-5">
  206. Provider
  207. </label>
  208. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  209. <label class="md-nav__title" for="nav-5">
  210. Provider
  211. </label>
  212. <ul class="md-nav__list" data-md-scrollfix>
  213. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  214. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1" checked>
  215. <label class="md-nav__link" for="nav-5-1">
  216. AWS
  217. </label>
  218. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  219. <label class="md-nav__title" for="nav-5-1">
  220. AWS
  221. </label>
  222. <ul class="md-nav__list" data-md-scrollfix>
  223. <li class="md-nav__item">
  224. <a href="../provider-aws-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  225. Secrets Manager
  226. </a>
  227. </li>
  228. <li class="md-nav__item md-nav__item--active">
  229. <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  230. <label class="md-nav__link md-nav__link--active" for="__toc">
  231. Parameter Store
  232. </label>
  233. <a href="./" title="Parameter Store" class="md-nav__link md-nav__link--active">
  234. Parameter Store
  235. </a>
  236. <nav class="md-nav md-nav--secondary">
  237. <label class="md-nav__title" for="__toc">Table of contents</label>
  238. <ul class="md-nav__list" data-md-scrollfix>
  239. <li class="md-nav__item">
  240. <a href="#parameter-store" class="md-nav__link">
  241. Parameter Store
  242. </a>
  243. <nav class="md-nav">
  244. <ul class="md-nav__list">
  245. <li class="md-nav__item">
  246. <a href="#iam-policy" class="md-nav__link">
  247. IAM Policy
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="#json-secret-values" class="md-nav__link">
  252. JSON Secret Values
  253. </a>
  254. </li>
  255. </ul>
  256. </nav>
  257. </li>
  258. <li class="md-nav__item">
  259. <a href="#aws-authentication" class="md-nav__link">
  260. AWS Authentication
  261. </a>
  262. </li>
  263. </ul>
  264. </nav>
  265. </li>
  266. </ul>
  267. </nav>
  268. </li>
  269. <li class="md-nav__item md-nav__item--nested">
  270. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
  271. <label class="md-nav__link" for="nav-5-2">
  272. Azure
  273. </label>
  274. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  275. <label class="md-nav__title" for="nav-5-2">
  276. Azure
  277. </label>
  278. <ul class="md-nav__list" data-md-scrollfix>
  279. <li class="md-nav__item">
  280. <a href="../provider-azure-key-vault/" title="Key Vault" class="md-nav__link">
  281. Key Vault
  282. </a>
  283. </li>
  284. </ul>
  285. </nav>
  286. </li>
  287. <li class="md-nav__item md-nav__item--nested">
  288. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
  289. <label class="md-nav__link" for="nav-5-3">
  290. Google
  291. </label>
  292. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  293. <label class="md-nav__title" for="nav-5-3">
  294. Google
  295. </label>
  296. <ul class="md-nav__list" data-md-scrollfix>
  297. <li class="md-nav__item">
  298. <a href="../provider-google-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  299. Secrets Manager
  300. </a>
  301. </li>
  302. </ul>
  303. </nav>
  304. </li>
  305. <li class="md-nav__item">
  306. <a href="../provider-hashicorp-vault/" title="HashiCorp Vault" class="md-nav__link">
  307. HashiCorp Vault
  308. </a>
  309. </li>
  310. </ul>
  311. </nav>
  312. </li>
  313. <li class="md-nav__item md-nav__item--nested">
  314. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
  315. <label class="md-nav__link" for="nav-6">
  316. References
  317. </label>
  318. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  319. <label class="md-nav__title" for="nav-6">
  320. References
  321. </label>
  322. <ul class="md-nav__list" data-md-scrollfix>
  323. <li class="md-nav__item">
  324. <a href="../spec/" title="API specification" class="md-nav__link">
  325. API specification
  326. </a>
  327. </li>
  328. </ul>
  329. </nav>
  330. </li>
  331. <li class="md-nav__item md-nav__item--nested">
  332. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
  333. <label class="md-nav__link" for="nav-7">
  334. Contributing
  335. </label>
  336. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  337. <label class="md-nav__title" for="nav-7">
  338. Contributing
  339. </label>
  340. <ul class="md-nav__list" data-md-scrollfix>
  341. <li class="md-nav__item">
  342. <a href="../contributing-devguide/" title="Developer guide" class="md-nav__link">
  343. Developer guide
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="../contributing-process/" title="Contributing Process" class="md-nav__link">
  348. Contributing Process
  349. </a>
  350. </li>
  351. <li class="md-nav__item">
  352. <a href="../contributing-coc/" title="Code of Conduct" class="md-nav__link">
  353. Code of Conduct
  354. </a>
  355. </li>
  356. </ul>
  357. </nav>
  358. </li>
  359. </ul>
  360. </nav>
  361. </div>
  362. </div>
  363. </div>
  364. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  365. <div class="md-sidebar__scrollwrap">
  366. <div class="md-sidebar__inner">
  367. <nav class="md-nav md-nav--secondary">
  368. <label class="md-nav__title" for="__toc">Table of contents</label>
  369. <ul class="md-nav__list" data-md-scrollfix>
  370. <li class="md-nav__item">
  371. <a href="#parameter-store" class="md-nav__link">
  372. Parameter Store
  373. </a>
  374. <nav class="md-nav">
  375. <ul class="md-nav__list">
  376. <li class="md-nav__item">
  377. <a href="#iam-policy" class="md-nav__link">
  378. IAM Policy
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="#json-secret-values" class="md-nav__link">
  383. JSON Secret Values
  384. </a>
  385. </li>
  386. </ul>
  387. </nav>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="#aws-authentication" class="md-nav__link">
  391. AWS Authentication
  392. </a>
  393. </li>
  394. </ul>
  395. </nav>
  396. </div>
  397. </div>
  398. </div>
  399. <div class="md-content">
  400. <article class="md-content__inner md-typeset">
  401. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-aws-parameter-store.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
  402. <h1>Parameter Store</h1>
  403. <p><img alt="aws sm" src="../pictures/diagrams-provider-aws-ssm-parameter-store.png" /></p>
  404. <h2 id="parameter-store">Parameter Store</h2>
  405. <p>A <code>ParameterStore</code> points to AWS SSM Parameter Store in a certain account within a
  406. defined region. You should define Roles that define fine-grained access to
  407. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  408. way users of the <code>SecretStore</code> can only access the secrets necessary.</p>
  409. <div class="highlight"><pre><span></span><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  410. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  411. <span class="nt">metadata</span><span class="p">:</span>
  412. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span>
  413. <span class="nt">spec</span><span class="p">:</span>
  414. <span class="nt">controller</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev</span>
  415. <span class="nt">provider</span><span class="p">:</span>
  416. <span class="nt">aws</span><span class="p">:</span>
  417. <span class="nt">service</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ParameterStore</span>
  418. <span class="c1"># define a specific role to limit access</span>
  419. <span class="c1"># to certain secrets</span>
  420. <span class="nt">role</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">iam-role</span>
  421. <span class="nt">region</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  422. <span class="nt">auth</span><span class="p">:</span>
  423. <span class="nt">secretRef</span><span class="p">:</span>
  424. <span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  425. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  426. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">access-key</span>
  427. <span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  428. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  429. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  430. </pre></div>
  431. <div class="admonition warning">
  432. <p class="admonition-title">API Pricing &amp; Throttling</p>
  433. <p>The SSM Parameter Store API is charged by throughput and
  434. is available in different tiers, <a href="https://aws.amazon.com/systems-manager/pricing/#Parameter_Store">see pricing</a>.
  435. Please estimate your costs before using ESO. Cost depends on the RefreshInterval of your ExternalSecrets.</p>
  436. </div>
  437. <h3 id="iam-policy">IAM Policy</h3>
  438. <p>Create a IAM Policy to pin down access to secrets matching <code>dev-*</code>, for futher information see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-access.html">AWS Documentation</a>:</p>
  439. <div class="highlight"><pre><span></span><span class="p">{</span>
  440. <span class="nt">&quot;Version&quot;</span><span class="p">:</span> <span class="s2">&quot;2012-10-17&quot;</span><span class="p">,</span>
  441. <span class="nt">&quot;Statement&quot;</span><span class="p">:</span> <span class="p">[</span>
  442. <span class="p">{</span>
  443. <span class="nt">&quot;Effect&quot;</span><span class="p">:</span> <span class="s2">&quot;Deny&quot;</span><span class="p">,</span>
  444. <span class="nt">&quot;Action&quot;</span><span class="p">:</span> <span class="p">[</span>
  445. <span class="s2">&quot;ssm:GetParameter*&quot;</span>
  446. <span class="p">],</span>
  447. <span class="nt">&quot;Resource&quot;</span><span class="p">:</span> <span class="s2">&quot;arn:aws:ssm:us-east-2:123456789012:parameter/dev-*&quot;</span>
  448. <span class="p">}</span>
  449. <span class="p">]</span>
  450. <span class="p">}</span>
  451. </pre></div>
  452. <h3 id="json-secret-values">JSON Secret Values</h3>
  453. <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>
  454. <p>Consider the following JSON object that is stored in the Parameter Store key <code>my-json-secret</code>:
  455. <div class="highlight"><pre><span></span><span class="p">{</span>
  456. <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>
  457. <span class="nt">&quot;friends&quot;</span><span class="p">:</span> <span class="p">[</span>
  458. <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>
  459. <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>
  460. <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>
  461. <span class="p">]</span>
  462. <span class="p">}</span>
  463. </pre></div></p>
  464. <p>This is an example on how you would look up nested keys in the above json object:
  465. <div class="highlight"><pre><span></span><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  466. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  467. <span class="nt">metadata</span><span class="p">:</span>
  468. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  469. <span class="nt">spec</span><span class="p">:</span>
  470. <span class="c1"># [omitted for brevity]</span>
  471. <span class="nt">data</span><span class="p">:</span>
  472. <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>
  473. <span class="nt">remoteRef</span><span class="p">:</span>
  474. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-json-secret</span>
  475. <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>
  476. <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>
  477. <span class="nt">remoteRef</span><span class="p">:</span>
  478. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-json-secret</span>
  479. <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>
  480. </pre></div></p>
  481. <h2 id="aws-authentication">AWS Authentication</h2>
  482. <p>Access to AWS providers can be granted in various ways:</p>
  483. <ul>
  484. <li><a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">IRSA</a>: IAM roles for service accounts.</li>
  485. <li>Per pod IAM authentication: <a href="https://github.com/uswitch/kiam">kiam</a> or <a href="https://github.com/jtblin/kube2iam">kube2iam</a>.</li>
  486. <li>Directly provide AWS credentials to the External Secrets Operator pod by using environment variables.</li>
  487. </ul>
  488. <p>Additionally, before fetching a secret from a store, ESO is able to assume role (as a proxy so to speak). It is advisable to use multiple roles in a multi-tenant environment.</p>
  489. </article>
  490. </div>
  491. </div>
  492. </main>
  493. <footer class="md-footer">
  494. <div class="md-footer-nav">
  495. <nav class="md-footer-nav__inner md-grid">
  496. <a href="../provider-aws-secrets-manager/" title="Secrets Manager" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  497. <div class="md-flex__cell md-flex__cell--shrink">
  498. <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
  499. </div>
  500. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  501. <span class="md-flex__ellipsis">
  502. <span class="md-footer-nav__direction">
  503. Previous
  504. </span>
  505. Secrets Manager
  506. </span>
  507. </div>
  508. </a>
  509. <a href="../provider-azure-key-vault/" title="Key Vault" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
  510. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  511. <span class="md-flex__ellipsis">
  512. <span class="md-footer-nav__direction">
  513. Next
  514. </span>
  515. Key Vault
  516. </span>
  517. </div>
  518. <div class="md-flex__cell md-flex__cell--shrink">
  519. <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
  520. </div>
  521. </a>
  522. </nav>
  523. </div>
  524. <div class="md-footer-meta md-typeset">
  525. <div class="md-footer-meta__inner md-grid">
  526. <div class="md-footer-copyright">
  527. powered by
  528. <a href="https://www.mkdocs.org">MkDocs</a>
  529. and
  530. <a href="https://squidfunk.github.io/mkdocs-material/">
  531. Material for MkDocs</a>
  532. </div>
  533. </div>
  534. </div>
  535. </footer>
  536. </div>
  537. <script src="../assets/javascripts/application.808e90bb.js"></script>
  538. <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
  539. </body>
  540. </html>