index.html 95 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862
  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="prev" href="../aws-secrets-manager/">
  7. <link rel="next" href="../azure-key-vault/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.27">
  10. <title>AWS Parameter Store - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.6543a935.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#parameter-store" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. AWS Parameter Store
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  64. <label class="md-header__button md-icon" for="__search">
  65. <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>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <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>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <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>
  74. <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>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <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>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item md-tabs__item--active">
  126. <a href="../aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. </ul>
  146. </div>
  147. </nav>
  148. <main class="md-main" data-md-component="main">
  149. <div class="md-main__inner md-grid">
  150. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  151. <div class="md-sidebar__scrollwrap">
  152. <div class="md-sidebar__inner">
  153. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  154. <label class="md-nav__title" for="__drawer">
  155. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  156. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  157. </a>
  158. External Secrets Operator
  159. </label>
  160. <div class="md-nav__source">
  161. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  162. <div class="md-source__icon md-icon">
  163. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  164. </div>
  165. <div class="md-source__repository">
  166. External Secrets Operator
  167. </div>
  168. </a>
  169. </div>
  170. <ul class="md-nav__list" data-md-scrollfix>
  171. <li class="md-nav__item md-nav__item--nested">
  172. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  173. <div class="md-nav__link md-nav__container">
  174. <a href="../.." class="md-nav__link ">
  175. <span class="md-ellipsis">
  176. Introduction
  177. </span>
  178. </a>
  179. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  180. <span class="md-nav__icon md-icon"></span>
  181. </label>
  182. </div>
  183. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  184. <label class="md-nav__title" for="__nav_1">
  185. <span class="md-nav__icon md-icon"></span>
  186. Introduction
  187. </label>
  188. <ul class="md-nav__list" data-md-scrollfix>
  189. <li class="md-nav__item">
  190. <a href="../../introduction/overview/" class="md-nav__link">
  191. <span class="md-ellipsis">
  192. Overview
  193. </span>
  194. </a>
  195. </li>
  196. <li class="md-nav__item">
  197. <a href="../../introduction/getting-started/" class="md-nav__link">
  198. <span class="md-ellipsis">
  199. Getting started
  200. </span>
  201. </a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="../../introduction/faq/" class="md-nav__link">
  205. <span class="md-ellipsis">
  206. FAQ
  207. </span>
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../../introduction/stability-support/" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. Stability and Support
  214. </span>
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Deprecation Policy
  221. </span>
  222. </a>
  223. </li>
  224. </ul>
  225. </nav>
  226. </li>
  227. <li class="md-nav__item md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  229. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  230. <span class="md-ellipsis">
  231. API
  232. </span>
  233. <span class="md-nav__icon md-icon"></span>
  234. </label>
  235. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  236. <label class="md-nav__title" for="__nav_2">
  237. <span class="md-nav__icon md-icon"></span>
  238. API
  239. </label>
  240. <ul class="md-nav__list" data-md-scrollfix>
  241. <li class="md-nav__item">
  242. <a href="../../api/components/" class="md-nav__link">
  243. <span class="md-ellipsis">
  244. Components
  245. </span>
  246. </a>
  247. </li>
  248. <li class="md-nav__item md-nav__item--nested">
  249. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  250. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  251. <span class="md-ellipsis">
  252. Core Resources
  253. </span>
  254. <span class="md-nav__icon md-icon"></span>
  255. </label>
  256. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  257. <label class="md-nav__title" for="__nav_2_2">
  258. <span class="md-nav__icon md-icon"></span>
  259. Core Resources
  260. </label>
  261. <ul class="md-nav__list" data-md-scrollfix>
  262. <li class="md-nav__item">
  263. <a href="../../api/externalsecret/" class="md-nav__link">
  264. <span class="md-ellipsis">
  265. ExternalSecret
  266. </span>
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="../../api/secretstore/" class="md-nav__link">
  271. <span class="md-ellipsis">
  272. SecretStore
  273. </span>
  274. </a>
  275. </li>
  276. <li class="md-nav__item">
  277. <a href="../../api/clustersecretstore/" class="md-nav__link">
  278. <span class="md-ellipsis">
  279. ClusterSecretStore
  280. </span>
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  285. <span class="md-ellipsis">
  286. ClusterExternalSecret
  287. </span>
  288. </a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="../../api/pushsecret/" class="md-nav__link">
  292. <span class="md-ellipsis">
  293. PushSecret
  294. </span>
  295. </a>
  296. </li>
  297. </ul>
  298. </nav>
  299. </li>
  300. <li class="md-nav__item md-nav__item--nested">
  301. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  302. <div class="md-nav__link md-nav__container">
  303. <a href="../../api/generator/" class="md-nav__link ">
  304. <span class="md-ellipsis">
  305. Generators
  306. </span>
  307. </a>
  308. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. </div>
  312. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  313. <label class="md-nav__title" for="__nav_2_3">
  314. <span class="md-nav__icon md-icon"></span>
  315. Generators
  316. </label>
  317. <ul class="md-nav__list" data-md-scrollfix>
  318. <li class="md-nav__item">
  319. <a href="../../api/generator/acr/" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. Azure Container Registry
  322. </span>
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../../api/generator/ecr/" class="md-nav__link">
  327. <span class="md-ellipsis">
  328. AWS Elastic Container Registry
  329. </span>
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/generator/gcr/" class="md-nav__link">
  334. <span class="md-ellipsis">
  335. Google Container Registry
  336. </span>
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="../../api/generator/vault/" class="md-nav__link">
  341. <span class="md-ellipsis">
  342. Vault Dynamic Secret
  343. </span>
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="../../api/generator/password/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. Password
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../../api/generator/fake/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. Fake
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../../api/generator/webhook/" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. Webhook
  364. </span>
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../../api/generator/github/" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. Github
  371. </span>
  372. </a>
  373. </li>
  374. </ul>
  375. </nav>
  376. </li>
  377. <li class="md-nav__item md-nav__item--nested">
  378. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  379. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  380. <span class="md-ellipsis">
  381. Reference Docs
  382. </span>
  383. <span class="md-nav__icon md-icon"></span>
  384. </label>
  385. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  386. <label class="md-nav__title" for="__nav_2_4">
  387. <span class="md-nav__icon md-icon"></span>
  388. Reference Docs
  389. </label>
  390. <ul class="md-nav__list" data-md-scrollfix>
  391. <li class="md-nav__item">
  392. <a href="../../api/spec/" class="md-nav__link">
  393. <span class="md-ellipsis">
  394. API specification
  395. </span>
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="../../api/controller-options/" class="md-nav__link">
  400. <span class="md-ellipsis">
  401. Controller Options
  402. </span>
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../api/metrics/" class="md-nav__link">
  407. <span class="md-ellipsis">
  408. Metrics
  409. </span>
  410. </a>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. </ul>
  416. </nav>
  417. </li>
  418. <li class="md-nav__item md-nav__item--nested">
  419. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  420. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  421. <span class="md-ellipsis">
  422. Guides
  423. </span>
  424. <span class="md-nav__icon md-icon"></span>
  425. </label>
  426. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  427. <label class="md-nav__title" for="__nav_3">
  428. <span class="md-nav__icon md-icon"></span>
  429. Guides
  430. </label>
  431. <ul class="md-nav__list" data-md-scrollfix>
  432. <li class="md-nav__item">
  433. <a href="../../guides/introduction/" class="md-nav__link">
  434. <span class="md-ellipsis">
  435. Introduction
  436. </span>
  437. </a>
  438. </li>
  439. <li class="md-nav__item md-nav__item--nested">
  440. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  441. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  442. <span class="md-ellipsis">
  443. External Secrets
  444. </span>
  445. <span class="md-nav__icon md-icon"></span>
  446. </label>
  447. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  448. <label class="md-nav__title" for="__nav_3_2">
  449. <span class="md-nav__icon md-icon"></span>
  450. External Secrets
  451. </label>
  452. <ul class="md-nav__list" data-md-scrollfix>
  453. <li class="md-nav__item">
  454. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  455. <span class="md-ellipsis">
  456. Extract structured data
  457. </span>
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../../guides/getallsecrets/" class="md-nav__link">
  462. <span class="md-ellipsis">
  463. Find Secrets by Name or Metadata
  464. </span>
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  469. <span class="md-ellipsis">
  470. Rewriting Keys
  471. </span>
  472. </a>
  473. </li>
  474. <li class="md-nav__item md-nav__item--nested">
  475. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  476. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  477. <span class="md-ellipsis">
  478. Advanced Templating
  479. </span>
  480. <span class="md-nav__icon md-icon"></span>
  481. </label>
  482. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  483. <label class="md-nav__title" for="__nav_3_2_4">
  484. <span class="md-nav__icon md-icon"></span>
  485. Advanced Templating
  486. </label>
  487. <ul class="md-nav__list" data-md-scrollfix>
  488. <li class="md-nav__item">
  489. <a href="../../guides/templating/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. v2
  492. </span>
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../guides/templating-v1/" class="md-nav__link">
  497. <span class="md-ellipsis">
  498. v1
  499. </span>
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  507. <span class="md-ellipsis">
  508. Kubernetes Secret Types
  509. </span>
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  514. <span class="md-ellipsis">
  515. Lifecycle: ownership & deletion
  516. </span>
  517. </a>
  518. </li>
  519. <li class="md-nav__item">
  520. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  521. <span class="md-ellipsis">
  522. Decoding Strategies
  523. </span>
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../../guides/controller-class/" class="md-nav__link">
  528. <span class="md-ellipsis">
  529. Controller Classes
  530. </span>
  531. </a>
  532. </li>
  533. </ul>
  534. </nav>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../../guides/generator/" class="md-nav__link">
  538. <span class="md-ellipsis">
  539. Generators
  540. </span>
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../guides/pushsecrets/" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. Push Secrets
  547. </span>
  548. </a>
  549. </li>
  550. <li class="md-nav__item md-nav__item--nested">
  551. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  552. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  553. <span class="md-ellipsis">
  554. Operations
  555. </span>
  556. <span class="md-nav__icon md-icon"></span>
  557. </label>
  558. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  559. <label class="md-nav__title" for="__nav_3_5">
  560. <span class="md-nav__icon md-icon"></span>
  561. Operations
  562. </label>
  563. <ul class="md-nav__list" data-md-scrollfix>
  564. <li class="md-nav__item">
  565. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  566. <span class="md-ellipsis">
  567. Multi Tenancy
  568. </span>
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../../guides/security-best-practices/" class="md-nav__link">
  573. <span class="md-ellipsis">
  574. Security Best Practices
  575. </span>
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../guides/threat-model/" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. Threat Model
  582. </span>
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../guides/v1beta1/" class="md-nav__link">
  587. <span class="md-ellipsis">
  588. Upgrading to v1beta1
  589. </span>
  590. </a>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../guides/using-latest-image/" class="md-nav__link">
  594. <span class="md-ellipsis">
  595. Using Latest Image
  596. </span>
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  601. <span class="md-ellipsis">
  602. Disable Cluster Features
  603. </span>
  604. </a>
  605. </li>
  606. </ul>
  607. </nav>
  608. </li>
  609. </ul>
  610. </nav>
  611. </li>
  612. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  613. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  614. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  615. <span class="md-ellipsis">
  616. Provider
  617. </span>
  618. <span class="md-nav__icon md-icon"></span>
  619. </label>
  620. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  621. <label class="md-nav__title" for="__nav_4">
  622. <span class="md-nav__icon md-icon"></span>
  623. Provider
  624. </label>
  625. <ul class="md-nav__list" data-md-scrollfix>
  626. <li class="md-nav__item">
  627. <a href="../aws-secrets-manager/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. AWS Secrets Manager
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item md-nav__item--active">
  634. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  635. <label class="md-nav__link md-nav__link--active" for="__toc">
  636. <span class="md-ellipsis">
  637. AWS Parameter Store
  638. </span>
  639. <span class="md-nav__icon md-icon"></span>
  640. </label>
  641. <a href="./" class="md-nav__link md-nav__link--active">
  642. <span class="md-ellipsis">
  643. AWS Parameter Store
  644. </span>
  645. </a>
  646. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  647. <label class="md-nav__title" for="__toc">
  648. <span class="md-nav__icon md-icon"></span>
  649. Table of contents
  650. </label>
  651. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  652. <li class="md-nav__item">
  653. <a href="#parameter-store" class="md-nav__link">
  654. <span class="md-ellipsis">
  655. Parameter Store
  656. </span>
  657. </a>
  658. <nav class="md-nav" aria-label="Parameter Store">
  659. <ul class="md-nav__list">
  660. <li class="md-nav__item">
  661. <a href="#iam-policy" class="md-nav__link">
  662. <span class="md-ellipsis">
  663. IAM Policy
  664. </span>
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="#json-secret-values" class="md-nav__link">
  669. <span class="md-ellipsis">
  670. JSON Secret Values
  671. </span>
  672. </a>
  673. </li>
  674. <li class="md-nav__item">
  675. <a href="#parameter-versions" class="md-nav__link">
  676. <span class="md-ellipsis">
  677. Parameter Versions
  678. </span>
  679. </a>
  680. </li>
  681. </ul>
  682. </nav>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="#setsecret" class="md-nav__link">
  686. <span class="md-ellipsis">
  687. SetSecret
  688. </span>
  689. </a>
  690. <nav class="md-nav" aria-label="SetSecret">
  691. <ul class="md-nav__list">
  692. <li class="md-nav__item">
  693. <a href="#creating-a-push-secret" class="md-nav__link">
  694. <span class="md-ellipsis">
  695. Creating a Push Secret
  696. </span>
  697. </a>
  698. <nav class="md-nav" aria-label="Creating a Push Secret">
  699. <ul class="md-nav__list">
  700. <li class="md-nav__item">
  701. <a href="#additional-metadata-for-pushsecret" class="md-nav__link">
  702. <span class="md-ellipsis">
  703. Additional Metadata for PushSecret
  704. </span>
  705. </a>
  706. </li>
  707. <li class="md-nav__item">
  708. <a href="#check-successful-secret-sync" class="md-nav__link">
  709. <span class="md-ellipsis">
  710. Check successful secret sync
  711. </span>
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  716. <span class="md-ellipsis">
  717. Test new secret using AWS CLI
  718. </span>
  719. </a>
  720. </li>
  721. </ul>
  722. </nav>
  723. </li>
  724. </ul>
  725. </nav>
  726. </li>
  727. <li class="md-nav__item">
  728. <a href="#aws-authentication" class="md-nav__link">
  729. <span class="md-ellipsis">
  730. AWS Authentication
  731. </span>
  732. </a>
  733. <nav class="md-nav" aria-label="AWS Authentication">
  734. <ul class="md-nav__list">
  735. <li class="md-nav__item">
  736. <a href="#controllers-pod-identity" class="md-nav__link">
  737. <span class="md-ellipsis">
  738. Controller's Pod Identity
  739. </span>
  740. </a>
  741. </li>
  742. <li class="md-nav__item">
  743. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  744. <span class="md-ellipsis">
  745. Access Key ID &amp; Secret Access Key
  746. </span>
  747. </a>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="#eks-service-account-credentials" class="md-nav__link">
  751. <span class="md-ellipsis">
  752. EKS Service Account credentials
  753. </span>
  754. </a>
  755. </li>
  756. </ul>
  757. </nav>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="#custom-endpoints" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. Custom Endpoints
  763. </span>
  764. </a>
  765. </li>
  766. </ul>
  767. </nav>
  768. </li>
  769. <li class="md-nav__item">
  770. <a href="../azure-key-vault/" class="md-nav__link">
  771. <span class="md-ellipsis">
  772. Azure Key Vault
  773. </span>
  774. </a>
  775. </li>
  776. <li class="md-nav__item">
  777. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  778. <span class="md-ellipsis">
  779. Bitwarden Secrets Manager
  780. </span>
  781. </a>
  782. </li>
  783. <li class="md-nav__item">
  784. <a href="../chef/" class="md-nav__link">
  785. <span class="md-ellipsis">
  786. Chef
  787. </span>
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="../conjur/" class="md-nav__link">
  792. <span class="md-ellipsis">
  793. CyberArk Conjur
  794. </span>
  795. </a>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="../device42/" class="md-nav__link">
  799. <span class="md-ellipsis">
  800. Device42
  801. </span>
  802. </a>
  803. </li>
  804. <li class="md-nav__item">
  805. <a href="../google-secrets-manager/" class="md-nav__link">
  806. <span class="md-ellipsis">
  807. Google Cloud Secret Manager
  808. </span>
  809. </a>
  810. </li>
  811. <li class="md-nav__item">
  812. <a href="../hashicorp-vault/" class="md-nav__link">
  813. <span class="md-ellipsis">
  814. HashiCorp Vault
  815. </span>
  816. </a>
  817. </li>
  818. <li class="md-nav__item">
  819. <a href="../kubernetes/" class="md-nav__link">
  820. <span class="md-ellipsis">
  821. Kubernetes
  822. </span>
  823. </a>
  824. </li>
  825. <li class="md-nav__item">
  826. <a href="../ibm-secrets-manager/" class="md-nav__link">
  827. <span class="md-ellipsis">
  828. IBM Secrets Manager
  829. </span>
  830. </a>
  831. </li>
  832. <li class="md-nav__item">
  833. <a href="../akeyless/" class="md-nav__link">
  834. <span class="md-ellipsis">
  835. Akeyless
  836. </span>
  837. </a>
  838. </li>
  839. <li class="md-nav__item">
  840. <a href="../yandex-certificate-manager/" class="md-nav__link">
  841. <span class="md-ellipsis">
  842. Yandex Certificate Manager
  843. </span>
  844. </a>
  845. </li>
  846. <li class="md-nav__item">
  847. <a href="../yandex-lockbox/" class="md-nav__link">
  848. <span class="md-ellipsis">
  849. Yandex Lockbox
  850. </span>
  851. </a>
  852. </li>
  853. <li class="md-nav__item">
  854. <a href="../alibaba/" class="md-nav__link">
  855. <span class="md-ellipsis">
  856. Alibaba Cloud
  857. </span>
  858. </a>
  859. </li>
  860. <li class="md-nav__item">
  861. <a href="../gitlab-variables/" class="md-nav__link">
  862. <span class="md-ellipsis">
  863. GitLab Variables
  864. </span>
  865. </a>
  866. </li>
  867. <li class="md-nav__item">
  868. <a href="../oracle-vault/" class="md-nav__link">
  869. <span class="md-ellipsis">
  870. Oracle Vault
  871. </span>
  872. </a>
  873. </li>
  874. <li class="md-nav__item">
  875. <a href="../1password-automation/" class="md-nav__link">
  876. <span class="md-ellipsis">
  877. 1Password Secrets Automation
  878. </span>
  879. </a>
  880. </li>
  881. <li class="md-nav__item">
  882. <a href="../webhook/" class="md-nav__link">
  883. <span class="md-ellipsis">
  884. Webhook
  885. </span>
  886. </a>
  887. </li>
  888. <li class="md-nav__item">
  889. <a href="../fake/" class="md-nav__link">
  890. <span class="md-ellipsis">
  891. Fake
  892. </span>
  893. </a>
  894. </li>
  895. <li class="md-nav__item">
  896. <a href="../senhasegura-dsm/" class="md-nav__link">
  897. <span class="md-ellipsis">
  898. senhasegura DevOps Secrets Management (DSM)
  899. </span>
  900. </a>
  901. </li>
  902. <li class="md-nav__item">
  903. <a href="../doppler/" class="md-nav__link">
  904. <span class="md-ellipsis">
  905. Doppler
  906. </span>
  907. </a>
  908. </li>
  909. <li class="md-nav__item">
  910. <a href="../keeper-security/" class="md-nav__link">
  911. <span class="md-ellipsis">
  912. Keeper Security
  913. </span>
  914. </a>
  915. </li>
  916. <li class="md-nav__item">
  917. <a href="../cloak/" class="md-nav__link">
  918. <span class="md-ellipsis">
  919. Cloak End 2 End Encrypted Secrets
  920. </span>
  921. </a>
  922. </li>
  923. <li class="md-nav__item">
  924. <a href="../scaleway/" class="md-nav__link">
  925. <span class="md-ellipsis">
  926. Scaleway
  927. </span>
  928. </a>
  929. </li>
  930. <li class="md-nav__item">
  931. <a href="../delinea/" class="md-nav__link">
  932. <span class="md-ellipsis">
  933. Delinea
  934. </span>
  935. </a>
  936. </li>
  937. <li class="md-nav__item">
  938. <a href="../passbolt/" class="md-nav__link">
  939. <span class="md-ellipsis">
  940. Passbolt
  941. </span>
  942. </a>
  943. </li>
  944. <li class="md-nav__item">
  945. <a href="../pulumi/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. Pulumi ESC
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../onboardbase/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. Onboardbase
  955. </span>
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="../../provider-passworddepot/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. Password Depot
  962. </span>
  963. </a>
  964. </li>
  965. <li class="md-nav__item">
  966. <a href="../fortanix/" class="md-nav__link">
  967. <span class="md-ellipsis">
  968. Fortanix
  969. </span>
  970. </a>
  971. </li>
  972. <li class="md-nav__item">
  973. <a href="../infisical/" class="md-nav__link">
  974. <span class="md-ellipsis">
  975. Infisical
  976. </span>
  977. </a>
  978. </li>
  979. </ul>
  980. </nav>
  981. </li>
  982. <li class="md-nav__item md-nav__item--nested">
  983. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  984. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  985. <span class="md-ellipsis">
  986. Examples
  987. </span>
  988. <span class="md-nav__icon md-icon"></span>
  989. </label>
  990. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  991. <label class="md-nav__title" for="__nav_5">
  992. <span class="md-nav__icon md-icon"></span>
  993. Examples
  994. </label>
  995. <ul class="md-nav__list" data-md-scrollfix>
  996. <li class="md-nav__item">
  997. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. FluxCD
  1000. </span>
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Anchore Engine
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Jenkins
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../../examples/bitwarden/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. BitWarden
  1021. </span>
  1022. </a>
  1023. </li>
  1024. </ul>
  1025. </nav>
  1026. </li>
  1027. <li class="md-nav__item md-nav__item--nested">
  1028. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1029. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1030. <span class="md-ellipsis">
  1031. Community
  1032. </span>
  1033. <span class="md-nav__icon md-icon"></span>
  1034. </label>
  1035. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1036. <label class="md-nav__title" for="__nav_6">
  1037. <span class="md-nav__icon md-icon"></span>
  1038. Community
  1039. </label>
  1040. <ul class="md-nav__list" data-md-scrollfix>
  1041. <li class="md-nav__item md-nav__item--nested">
  1042. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1043. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1044. <span class="md-ellipsis">
  1045. Contributing
  1046. </span>
  1047. <span class="md-nav__icon md-icon"></span>
  1048. </label>
  1049. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1050. <label class="md-nav__title" for="__nav_6_1">
  1051. <span class="md-nav__icon md-icon"></span>
  1052. Contributing
  1053. </label>
  1054. <ul class="md-nav__list" data-md-scrollfix>
  1055. <li class="md-nav__item">
  1056. <a href="../../contributing/devguide/" class="md-nav__link">
  1057. <span class="md-ellipsis">
  1058. Developer guide
  1059. </span>
  1060. </a>
  1061. </li>
  1062. <li class="md-nav__item">
  1063. <a href="../../contributing/process/" class="md-nav__link">
  1064. <span class="md-ellipsis">
  1065. Contributing Process
  1066. </span>
  1067. </a>
  1068. </li>
  1069. <li class="md-nav__item">
  1070. <a href="../../contributing/release/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Release Process
  1073. </span>
  1074. </a>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="../../contributing/coc/" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. Code of Conduct
  1080. </span>
  1081. </a>
  1082. </li>
  1083. <li class="md-nav__item">
  1084. <a href="../../contributing/roadmap/" class="md-nav__link">
  1085. <span class="md-ellipsis">
  1086. Roadmap
  1087. </span>
  1088. </a>
  1089. </li>
  1090. </ul>
  1091. </nav>
  1092. </li>
  1093. <li class="md-nav__item md-nav__item--nested">
  1094. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1095. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1096. <span class="md-ellipsis">
  1097. External Resources
  1098. </span>
  1099. <span class="md-nav__icon md-icon"></span>
  1100. </label>
  1101. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1102. <label class="md-nav__title" for="__nav_6_2">
  1103. <span class="md-nav__icon md-icon"></span>
  1104. External Resources
  1105. </label>
  1106. <ul class="md-nav__list" data-md-scrollfix>
  1107. <li class="md-nav__item">
  1108. <a href="../../eso-talks/" class="md-nav__link">
  1109. <span class="md-ellipsis">
  1110. Talks
  1111. </span>
  1112. </a>
  1113. </li>
  1114. <li class="md-nav__item">
  1115. <a href="../../eso-demos/" class="md-nav__link">
  1116. <span class="md-ellipsis">
  1117. Demos
  1118. </span>
  1119. </a>
  1120. </li>
  1121. <li class="md-nav__item">
  1122. <a href="../../eso-blogs/" class="md-nav__link">
  1123. <span class="md-ellipsis">
  1124. Blogs
  1125. </span>
  1126. </a>
  1127. </li>
  1128. </ul>
  1129. </nav>
  1130. </li>
  1131. </ul>
  1132. </nav>
  1133. </li>
  1134. <li class="md-nav__item md-nav__item--nested">
  1135. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1136. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1137. <span class="md-ellipsis">
  1138. References
  1139. </span>
  1140. <span class="md-nav__icon md-icon"></span>
  1141. </label>
  1142. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1143. <label class="md-nav__title" for="__nav_7">
  1144. <span class="md-nav__icon md-icon"></span>
  1145. References
  1146. </label>
  1147. <ul class="md-nav__list" data-md-scrollfix>
  1148. <li class="md-nav__item">
  1149. <a href="../../spec/" class="md-nav__link">
  1150. <span class="md-ellipsis">
  1151. API specification
  1152. </span>
  1153. </a>
  1154. </li>
  1155. </ul>
  1156. </nav>
  1157. </li>
  1158. </ul>
  1159. </nav>
  1160. </div>
  1161. </div>
  1162. </div>
  1163. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1164. <div class="md-sidebar__scrollwrap">
  1165. <div class="md-sidebar__inner">
  1166. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1167. <label class="md-nav__title" for="__toc">
  1168. <span class="md-nav__icon md-icon"></span>
  1169. Table of contents
  1170. </label>
  1171. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1172. <li class="md-nav__item">
  1173. <a href="#parameter-store" class="md-nav__link">
  1174. <span class="md-ellipsis">
  1175. Parameter Store
  1176. </span>
  1177. </a>
  1178. <nav class="md-nav" aria-label="Parameter Store">
  1179. <ul class="md-nav__list">
  1180. <li class="md-nav__item">
  1181. <a href="#iam-policy" class="md-nav__link">
  1182. <span class="md-ellipsis">
  1183. IAM Policy
  1184. </span>
  1185. </a>
  1186. </li>
  1187. <li class="md-nav__item">
  1188. <a href="#json-secret-values" class="md-nav__link">
  1189. <span class="md-ellipsis">
  1190. JSON Secret Values
  1191. </span>
  1192. </a>
  1193. </li>
  1194. <li class="md-nav__item">
  1195. <a href="#parameter-versions" class="md-nav__link">
  1196. <span class="md-ellipsis">
  1197. Parameter Versions
  1198. </span>
  1199. </a>
  1200. </li>
  1201. </ul>
  1202. </nav>
  1203. </li>
  1204. <li class="md-nav__item">
  1205. <a href="#setsecret" class="md-nav__link">
  1206. <span class="md-ellipsis">
  1207. SetSecret
  1208. </span>
  1209. </a>
  1210. <nav class="md-nav" aria-label="SetSecret">
  1211. <ul class="md-nav__list">
  1212. <li class="md-nav__item">
  1213. <a href="#creating-a-push-secret" class="md-nav__link">
  1214. <span class="md-ellipsis">
  1215. Creating a Push Secret
  1216. </span>
  1217. </a>
  1218. <nav class="md-nav" aria-label="Creating a Push Secret">
  1219. <ul class="md-nav__list">
  1220. <li class="md-nav__item">
  1221. <a href="#additional-metadata-for-pushsecret" class="md-nav__link">
  1222. <span class="md-ellipsis">
  1223. Additional Metadata for PushSecret
  1224. </span>
  1225. </a>
  1226. </li>
  1227. <li class="md-nav__item">
  1228. <a href="#check-successful-secret-sync" class="md-nav__link">
  1229. <span class="md-ellipsis">
  1230. Check successful secret sync
  1231. </span>
  1232. </a>
  1233. </li>
  1234. <li class="md-nav__item">
  1235. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  1236. <span class="md-ellipsis">
  1237. Test new secret using AWS CLI
  1238. </span>
  1239. </a>
  1240. </li>
  1241. </ul>
  1242. </nav>
  1243. </li>
  1244. </ul>
  1245. </nav>
  1246. </li>
  1247. <li class="md-nav__item">
  1248. <a href="#aws-authentication" class="md-nav__link">
  1249. <span class="md-ellipsis">
  1250. AWS Authentication
  1251. </span>
  1252. </a>
  1253. <nav class="md-nav" aria-label="AWS Authentication">
  1254. <ul class="md-nav__list">
  1255. <li class="md-nav__item">
  1256. <a href="#controllers-pod-identity" class="md-nav__link">
  1257. <span class="md-ellipsis">
  1258. Controller's Pod Identity
  1259. </span>
  1260. </a>
  1261. </li>
  1262. <li class="md-nav__item">
  1263. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  1264. <span class="md-ellipsis">
  1265. Access Key ID &amp; Secret Access Key
  1266. </span>
  1267. </a>
  1268. </li>
  1269. <li class="md-nav__item">
  1270. <a href="#eks-service-account-credentials" class="md-nav__link">
  1271. <span class="md-ellipsis">
  1272. EKS Service Account credentials
  1273. </span>
  1274. </a>
  1275. </li>
  1276. </ul>
  1277. </nav>
  1278. </li>
  1279. <li class="md-nav__item">
  1280. <a href="#custom-endpoints" class="md-nav__link">
  1281. <span class="md-ellipsis">
  1282. Custom Endpoints
  1283. </span>
  1284. </a>
  1285. </li>
  1286. </ul>
  1287. </nav>
  1288. </div>
  1289. </div>
  1290. </div>
  1291. <div class="md-content" data-md-component="content">
  1292. <article class="md-content__inner md-typeset">
  1293. <h1>AWS Parameter Store</h1>
  1294. <p><img alt="aws sm" src="../../pictures/diagrams-provider-aws-ssm-parameter-store.png" /></p>
  1295. <h2 id="parameter-store">Parameter Store</h2>
  1296. <p>A <code>ParameterStore</code> points to AWS SSM Parameter Store in a certain account within a
  1297. defined region. You should define Roles that define fine-grained access to
  1298. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  1299. way users of the <code>SecretStore</code> can only access the secrets necessary.</p>
  1300. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1301. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1302. <span class="nt">metadata</span><span class="p">:</span>
  1303. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">parameterstore</span>
  1304. <span class="nt">spec</span><span class="p">:</span>
  1305. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1306. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1307. <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>
  1308. <span class="w"> </span><span class="c1"># define a specific role to limit access</span>
  1309. <span class="w"> </span><span class="c1"># to certain secrets</span>
  1310. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arn:aws:iam::123456789012:role/external-secrets</span>
  1311. <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>
  1312. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1313. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1314. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1315. <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>
  1316. <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>
  1317. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1318. <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>
  1319. <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>
  1320. </code></pre></div>
  1321. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>accessKeyIDSecretRef</code> and <code>secretAccessKeySecretRef</code> with the namespaces where the secrets reside.</p>
  1322. <div class="admonition warning">
  1323. <p class="admonition-title">API Pricing &amp; Throttling</p>
  1324. <p>The SSM Parameter Store API is charged by throughput and
  1325. is available in different tiers, <a href="https://aws.amazon.com/systems-manager/pricing/#Parameter_Store">see pricing</a>.
  1326. Please estimate your costs before using ESO. Cost depends on the RefreshInterval of your ExternalSecrets.</p>
  1327. </div>
  1328. <h3 id="iam-policy">IAM Policy</h3>
  1329. <p>The example policy below shows the minimum required permissions for fetching SSM parameters. This policy permits pinning down access to secrets with a path matching <code>dev-*</code>. Other operations may require additional permission. For example, finding parameters based on tags will also require <code>ssm:DescribeParameters</code> and <code>tag:GetResources</code> permission with <code>"Resource": "*"</code>. Generally, the specific permission required will be logged as an error if an operation fails.</p>
  1330. <p>For further information see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-access.html">AWS Documentation</a>.</p>
  1331. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1332. <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>
  1333. <span class="w"> </span><span class="nt">&quot;Statement&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1334. <span class="w"> </span><span class="p">{</span>
  1335. <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>
  1336. <span class="w"> </span><span class="nt">&quot;Action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1337. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter*&quot;</span><span class="p">,</span>
  1338. <span class="w"> </span><span class="p">],</span>
  1339. <span class="w"> </span><span class="nt">&quot;Resource&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;arn:aws:ssm:us-east-2:1234567889911:parameter/dev-*&quot;</span>
  1340. <span class="w"> </span><span class="p">}</span>
  1341. <span class="w"> </span><span class="p">]</span>
  1342. <span class="p">}</span>
  1343. </code></pre></div>
  1344. <h3 id="json-secret-values">JSON Secret Values</h3>
  1345. <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>
  1346. <p>Consider the following JSON object that is stored in the Parameter Store key <code>friendslist</code>:
  1347. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1348. <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>
  1349. <span class="w"> </span><span class="nt">&quot;friends&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1350. <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>
  1351. <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>
  1352. <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>
  1353. <span class="w"> </span><span class="p">]</span>
  1354. <span class="p">}</span>
  1355. </code></pre></div></p>
  1356. <p>This is an example on how you would look up nested keys in the above json object:
  1357. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1358. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1359. <span class="nt">metadata</span><span class="p">:</span>
  1360. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">extract-data</span>
  1361. <span class="nt">spec</span><span class="p">:</span>
  1362. <span class="w"> </span><span class="c1"># [omitted for brevity]</span>
  1363. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1364. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_name</span>
  1365. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1366. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">friendslist</span>
  1367. <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>
  1368. <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>
  1369. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1370. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">friendslist</span>
  1371. <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>
  1372. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the tags in JSON format</span>
  1373. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tags</span>
  1374. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1375. <span class="w"> </span><span class="nt">metadataPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Fetch</span>
  1376. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">database-credentials</span>
  1377. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific tag (dev) from the source secret</span>
  1378. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">developer</span>
  1379. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1380. <span class="w"> </span><span class="nt">metadataPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Fetch</span>
  1381. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">database-credentials</span>
  1382. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dev</span>
  1383. </code></pre></div></p>
  1384. <h3 id="parameter-versions">Parameter Versions</h3>
  1385. <p>ParameterStore creates a new version of a parameter every time it is updated with a new value. The parameter can be referenced via the <code>version</code> property</p>
  1386. <h2 id="setsecret">SetSecret</h2>
  1387. <p>The SetSecret method for the Parameter Store allows the user to set the value stored within the Kubernetes cluster to the remote AWS Parameter Store.</p>
  1388. <h3 id="creating-a-push-secret">Creating a Push Secret</h3>
  1389. <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>
  1390. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1391. <span class="nt">metadata</span><span class="p">:</span>
  1392. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pushsecret-example</span><span class="w"> </span><span class="c1"># Customisable</span>
  1393. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"> </span><span class="c1"># Same of the SecretStores</span>
  1394. <span class="nt">spec</span><span class="p">:</span>
  1395. <span class="w"> </span><span class="nt">updatePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Replace</span><span class="w"> </span><span class="c1"># Policy to overwrite existing secrets in the provider on sync</span>
  1396. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete</span><span class="w"> </span><span class="c1"># the provider&#39; secret will be deleted if the PushSecret is deleted</span>
  1397. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10s</span><span class="w"> </span><span class="c1"># Refresh interval for which push secret will reconcile</span>
  1398. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span><span class="w"> </span><span class="c1"># A list of secret stores to push secrets to</span>
  1399. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aws-parameterstore</span>
  1400. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1401. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1402. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1403. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pokedex-credentials</span><span class="w"> </span><span class="c1"># Source Kubernetes secret to be pushed</span>
  1404. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1405. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1406. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
  1407. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
  1408. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1409. <span class="w"> </span><span class="nt">best-pokemon</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.best-pokemon</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">toString</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">upper</span><span class="nv"> </span><span class="s">}}</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">really</span><span class="nv"> </span><span class="s">best!&quot;</span>
  1410. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span>
  1411. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span>
  1412. <span class="w"> </span><span class="c1"># It does not update the configmap, it creates a secret with: data[&quot;alertmanager.yml&quot;] = ...result...</span>
  1413. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1414. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1415. <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">application-config-tmpl</span>
  1416. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1417. <span class="w"> </span><span class="p p-Indicator">-</span><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">config.yml</span>
  1418. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1419. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">None</span><span class="w"> </span><span class="c1"># Also supports the ReverseUnicode strategy</span>
  1420. <span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1421. <span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">best-pokemon</span><span class="w"> </span><span class="c1"># Source Kubernetes secret key to be pushed</span>
  1422. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1423. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-first-parameter</span><span class="w"> </span><span class="c1"># Remote reference (where the secret is going to be pushed)</span>
  1424. </code></pre></div>
  1425. <h4 id="additional-metadata-for-pushsecret">Additional Metadata for PushSecret</h4>
  1426. <p>Optionally, it is possible to configure additional options for the parameter such as <code>Type</code> and encryption Key. To control this behaviour you can set the following provider's <code>metadata</code>:</p>
  1427. <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>
  1428. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1429. <span class="nt">metadata</span><span class="p">:</span>
  1430. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pushsecret-example</span><span class="w"> </span><span class="c1"># Customisable</span>
  1431. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"> </span><span class="c1"># Same of the SecretStores</span>
  1432. <span class="nt">spec</span><span class="p">:</span>
  1433. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete</span><span class="w"> </span><span class="c1"># the provider&#39; secret will be deleted if the PushSecret is deleted</span>
  1434. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10s</span><span class="w"> </span><span class="c1"># Refresh interval for which push secret will reconcile</span>
  1435. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span><span class="w"> </span><span class="c1"># A list of secret stores to push secrets to</span>
  1436. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aws-parameterstore</span>
  1437. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1438. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1439. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1440. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pokedex-credentials</span><span class="w"> </span><span class="c1"># Source Kubernetes secret to be pushed</span>
  1441. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1442. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1443. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1444. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-first-parameter</span><span class="w"> </span><span class="c1"># Remote reference (where the secret is going to be pushed)</span>
  1445. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1446. <span class="w"> </span><span class="nt">parameterStoreType</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecureString&quot;</span>
  1447. <span class="w"> </span><span class="nt">parameterStoreKeyID</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bb123123-b2b0-4f60-ac3a-44a13f0e6b6c&quot;</span>
  1448. </code></pre></div>
  1449. <p><code>parameterStoreType</code> takes three options. <code>String</code>, <code>StringList</code>, and <code>SecureString</code>, where <code>String</code> is the <em>default</em>.</p>
  1450. <p><code>parameterStoreKeyID</code> takes a KMS Key <code>$ID</code> or <code>$ARN</code> (in case a key source is created in another account) as a string, where <code>alias/aws/ssm</code> is the <em>default</em>. This property is only used if <code>parameterStoreType</code> is set as <code>SecureString</code>.</p>
  1451. <h4 id="check-successful-secret-sync">Check successful secret sync</h4>
  1452. <p>To be able to check that the secret has been succesfully synced you can run the following command:</p>
  1453. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>get<span class="w"> </span>pushsecret<span class="w"> </span>pushsecret-example
  1454. </code></pre></div>
  1455. <p>If the secret has synced successfully it will show the status as "Synced".</p>
  1456. <h4 id="test-new-secret-using-aws-cli">Test new secret using AWS CLI</h4>
  1457. <p>To View your parameter on AWS Parameter Store using the AWS CLI, install and login to the AWS CLI using the following guide: <a href="https://aws.amazon.com/cli/">AWS CLI</a>.</p>
  1458. <p>Run the following commands to get your synchronized parameter from AWS Parameter Store:</p>
  1459. <div class="highlight"><pre><span></span><code>aws<span class="w"> </span>ssm<span class="w"> </span>get-parameter<span class="w"> </span>--name<span class="o">=</span>my-first-parameter<span class="w"> </span>--region<span class="o">=</span>us-east-1
  1460. </code></pre></div>
  1461. <p>You should see something similar to the following output:</p>
  1462. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1463. <span class="w"> </span><span class="nt">&quot;Parameter&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1464. <span class="w"> </span><span class="nt">&quot;Name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;my-first-parameter&quot;</span><span class="p">,</span>
  1465. <span class="w"> </span><span class="nt">&quot;Type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;String&quot;</span><span class="p">,</span>
  1466. <span class="w"> </span><span class="nt">&quot;Value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;charmander&quot;</span><span class="p">,</span>
  1467. <span class="w"> </span><span class="nt">&quot;Version&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
  1468. <span class="w"> </span><span class="nt">&quot;LastModifiedDate&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2022-09-15T13:04:31.098000-03:00&quot;</span><span class="p">,</span>
  1469. <span class="w"> </span><span class="nt">&quot;ARN&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;arn:aws:ssm:us-east-1:1234567890123:parameter/my-first-parameter&quot;</span><span class="p">,</span>
  1470. <span class="w"> </span><span class="nt">&quot;DataType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;text&quot;</span>
  1471. <span class="w"> </span><span class="p">}</span>
  1472. <span class="p">}</span>
  1473. </code></pre></div>
  1474. <h2 id="aws-authentication">AWS Authentication</h2>
  1475. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  1476. <p><img alt="Pod Identity Authentication" src="../../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  1477. <p>Note: If you are using Parameter Store replace <code>service: SecretsManager</code> with <code>service: ParameterStore</code> in all examples below.</p>
  1478. <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>
  1479. <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>
  1480. <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>
  1481. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1482. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1483. <span class="nt">metadata</span><span class="p">:</span>
  1484. <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>
  1485. <span class="nt">spec</span><span class="p">:</span>
  1486. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1487. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1488. <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>
  1489. <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>
  1490. <span class="w"> </span><span class="c1"># optional: do a sts:assumeRole before fetching secrets</span>
  1491. <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>
  1492. </code></pre></div>
  1493. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  1494. <p><img alt="SecretRef" src="../../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  1495. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  1496. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1497. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1498. <span class="nt">metadata</span><span class="p">:</span>
  1499. <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>
  1500. <span class="nt">spec</span><span class="p">:</span>
  1501. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1502. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1503. <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>
  1504. <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>
  1505. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span>
  1506. <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>
  1507. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1508. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1509. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1510. <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>
  1511. <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>
  1512. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1513. <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>
  1514. <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>
  1515. </code></pre></div>
  1516. <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>
  1517. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  1518. <p><img alt="Service Account" src="../../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  1519. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  1520. 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>
  1521. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  1522. <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>
  1523. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  1524. <span class="nt">metadata</span><span class="p">:</span>
  1525. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1526. <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>
  1527. <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>
  1528. <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>
  1529. </code></pre></div>
  1530. <p>Reference the service account from above in the Secret Store:</p>
  1531. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1532. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1533. <span class="nt">metadata</span><span class="p">:</span>
  1534. <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>
  1535. <span class="nt">spec</span><span class="p">:</span>
  1536. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1537. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1538. <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>
  1539. <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>
  1540. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1541. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  1542. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1543. <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>
  1544. </code></pre></div>
  1545. <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>
  1546. <h2 id="custom-endpoints">Custom Endpoints</h2>
  1547. <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>
  1548. <p>Use the following environment variables to point the controller to your custom endpoints. Note: All resources managed by this controller are affected.</p>
  1549. <table>
  1550. <thead>
  1551. <tr>
  1552. <th>ENV VAR</th>
  1553. <th>DESCRIPTION</th>
  1554. </tr>
  1555. </thead>
  1556. <tbody>
  1557. <tr>
  1558. <td>AWS_SECRETSMANAGER_ENDPOINT</td>
  1559. <td>Endpoint for the Secrets Manager Service. The controller uses this endpoint to fetch secrets from AWS Secrets Manager.</td>
  1560. </tr>
  1561. <tr>
  1562. <td>AWS_SSM_ENDPOINT</td>
  1563. <td>Endpoint for the AWS Secure Systems Manager. The controller uses this endpoint to fetch secrets from SSM Parameter Store.</td>
  1564. </tr>
  1565. <tr>
  1566. <td>AWS_STS_ENDPOINT</td>
  1567. <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>
  1568. </tr>
  1569. </tbody>
  1570. </table>
  1571. </article>
  1572. </div>
  1573. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1574. </div>
  1575. </main>
  1576. <footer class="md-footer">
  1577. <div class="md-footer-meta md-typeset">
  1578. <div class="md-footer-meta__inner md-grid">
  1579. <div class="md-copyright">
  1580. <div class="md-copyright__highlight">
  1581. &copy; 2024 The external-secrets Authors.<br/>
  1582. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1583. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1584. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1585. </div>
  1586. Made with
  1587. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1588. Material for MkDocs
  1589. </a>
  1590. </div>
  1591. </div>
  1592. </div>
  1593. </footer>
  1594. </div>
  1595. <div class="md-dialog" data-md-component="dialog">
  1596. <div class="md-dialog__inner md-typeset"></div>
  1597. </div>
  1598. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1599. <script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
  1600. </body>
  1601. </html>