index.html 101 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426
  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.5.3, mkdocs-material-9.5.17">
  10. <title>AWS Parameter Store - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.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" 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.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  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. <li class="md-tabs__item">
  146. <a href="../../contributing-devguide.md" class="md-tabs__link">
  147. Contributing
  148. </a>
  149. </li>
  150. <li class="md-tabs__item">
  151. <a href="../../deprecation-policy.md" class="md-tabs__link">
  152. Deprecation Policy
  153. </a>
  154. </li>
  155. </ul>
  156. </div>
  157. </nav>
  158. <main class="md-main" data-md-component="main">
  159. <div class="md-main__inner md-grid">
  160. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  161. <div class="md-sidebar__scrollwrap">
  162. <div class="md-sidebar__inner">
  163. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  164. <label class="md-nav__title" for="__drawer">
  165. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  166. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  167. </a>
  168. External Secrets Operator
  169. </label>
  170. <div class="md-nav__source">
  171. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  172. <div class="md-source__icon md-icon">
  173. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  174. </div>
  175. <div class="md-source__repository">
  176. External Secrets Operator
  177. </div>
  178. </a>
  179. </div>
  180. <ul class="md-nav__list" data-md-scrollfix>
  181. <li class="md-nav__item md-nav__item--nested">
  182. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  183. <div class="md-nav__link md-nav__container">
  184. <a href="../.." class="md-nav__link ">
  185. <span class="md-ellipsis">
  186. Introduction
  187. </span>
  188. </a>
  189. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  190. <span class="md-nav__icon md-icon"></span>
  191. </label>
  192. </div>
  193. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  194. <label class="md-nav__title" for="__nav_1">
  195. <span class="md-nav__icon md-icon"></span>
  196. Introduction
  197. </label>
  198. <ul class="md-nav__list" data-md-scrollfix>
  199. <li class="md-nav__item">
  200. <a href="../../introduction/overview/" class="md-nav__link">
  201. <span class="md-ellipsis">
  202. Overview
  203. </span>
  204. </a>
  205. </li>
  206. <li class="md-nav__item">
  207. <a href="../../introduction/getting-started/" class="md-nav__link">
  208. <span class="md-ellipsis">
  209. Getting started
  210. </span>
  211. </a>
  212. </li>
  213. <li class="md-nav__item">
  214. <a href="../../introduction/faq/" class="md-nav__link">
  215. <span class="md-ellipsis">
  216. FAQ
  217. </span>
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../../introduction/stability-support/" class="md-nav__link">
  222. <span class="md-ellipsis">
  223. Stability and Support
  224. </span>
  225. </a>
  226. </li>
  227. <li class="md-nav__item">
  228. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  229. <span class="md-ellipsis">
  230. Deprecation Policy
  231. </span>
  232. </a>
  233. </li>
  234. </ul>
  235. </nav>
  236. </li>
  237. <li class="md-nav__item md-nav__item--nested">
  238. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  239. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  240. <span class="md-ellipsis">
  241. API
  242. </span>
  243. <span class="md-nav__icon md-icon"></span>
  244. </label>
  245. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  246. <label class="md-nav__title" for="__nav_2">
  247. <span class="md-nav__icon md-icon"></span>
  248. API
  249. </label>
  250. <ul class="md-nav__list" data-md-scrollfix>
  251. <li class="md-nav__item">
  252. <a href="../../api/components/" class="md-nav__link">
  253. <span class="md-ellipsis">
  254. Components
  255. </span>
  256. </a>
  257. </li>
  258. <li class="md-nav__item md-nav__item--nested">
  259. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  260. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  261. <span class="md-ellipsis">
  262. Core Resources
  263. </span>
  264. <span class="md-nav__icon md-icon"></span>
  265. </label>
  266. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  267. <label class="md-nav__title" for="__nav_2_2">
  268. <span class="md-nav__icon md-icon"></span>
  269. Core Resources
  270. </label>
  271. <ul class="md-nav__list" data-md-scrollfix>
  272. <li class="md-nav__item">
  273. <a href="../../api/externalsecret/" class="md-nav__link">
  274. <span class="md-ellipsis">
  275. ExternalSecret
  276. </span>
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../../api/secretstore/" class="md-nav__link">
  281. <span class="md-ellipsis">
  282. SecretStore
  283. </span>
  284. </a>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../../api/clustersecretstore/" class="md-nav__link">
  288. <span class="md-ellipsis">
  289. ClusterSecretStore
  290. </span>
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  295. <span class="md-ellipsis">
  296. ClusterExternalSecret
  297. </span>
  298. </a>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="../../api/pushsecret/" class="md-nav__link">
  302. <span class="md-ellipsis">
  303. PushSecret
  304. </span>
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  312. <div class="md-nav__link md-nav__container">
  313. <a href="../../api/generator/" class="md-nav__link ">
  314. <span class="md-ellipsis">
  315. Generators
  316. </span>
  317. </a>
  318. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  319. <span class="md-nav__icon md-icon"></span>
  320. </label>
  321. </div>
  322. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  323. <label class="md-nav__title" for="__nav_2_3">
  324. <span class="md-nav__icon md-icon"></span>
  325. Generators
  326. </label>
  327. <ul class="md-nav__list" data-md-scrollfix>
  328. <li class="md-nav__item">
  329. <a href="../../api/generator/acr/" class="md-nav__link">
  330. <span class="md-ellipsis">
  331. Azure Container Registry
  332. </span>
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../../api/generator/ecr/" class="md-nav__link">
  337. <span class="md-ellipsis">
  338. AWS Elastic Container Registry
  339. </span>
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="../../api/generator/gcr/" class="md-nav__link">
  344. <span class="md-ellipsis">
  345. Google Container Registry
  346. </span>
  347. </a>
  348. </li>
  349. <li class="md-nav__item">
  350. <a href="../../api/generator/vault/" class="md-nav__link">
  351. <span class="md-ellipsis">
  352. Vault Dynamic Secret
  353. </span>
  354. </a>
  355. </li>
  356. <li class="md-nav__item">
  357. <a href="../../api/generator/password/" class="md-nav__link">
  358. <span class="md-ellipsis">
  359. Password
  360. </span>
  361. </a>
  362. </li>
  363. <li class="md-nav__item">
  364. <a href="../../api/generator/fake/" class="md-nav__link">
  365. <span class="md-ellipsis">
  366. Fake
  367. </span>
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../../api/generator/webhook/" class="md-nav__link">
  372. <span class="md-ellipsis">
  373. Webhook
  374. </span>
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item md-nav__item--nested">
  381. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  382. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  383. <span class="md-ellipsis">
  384. Reference Docs
  385. </span>
  386. <span class="md-nav__icon md-icon"></span>
  387. </label>
  388. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  389. <label class="md-nav__title" for="__nav_2_4">
  390. <span class="md-nav__icon md-icon"></span>
  391. Reference Docs
  392. </label>
  393. <ul class="md-nav__list" data-md-scrollfix>
  394. <li class="md-nav__item">
  395. <a href="../../api/spec/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. API specification
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/controller-options/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Controller Options
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../api/metrics/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. Metrics
  412. </span>
  413. </a>
  414. </li>
  415. </ul>
  416. </nav>
  417. </li>
  418. </ul>
  419. </nav>
  420. </li>
  421. <li class="md-nav__item md-nav__item--nested">
  422. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  423. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  424. <span class="md-ellipsis">
  425. Guides
  426. </span>
  427. <span class="md-nav__icon md-icon"></span>
  428. </label>
  429. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  430. <label class="md-nav__title" for="__nav_3">
  431. <span class="md-nav__icon md-icon"></span>
  432. Guides
  433. </label>
  434. <ul class="md-nav__list" data-md-scrollfix>
  435. <li class="md-nav__item">
  436. <a href="../../guides/introduction/" class="md-nav__link">
  437. <span class="md-ellipsis">
  438. Introduction
  439. </span>
  440. </a>
  441. </li>
  442. <li class="md-nav__item md-nav__item--nested">
  443. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  444. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  445. <span class="md-ellipsis">
  446. External Secrets
  447. </span>
  448. <span class="md-nav__icon md-icon"></span>
  449. </label>
  450. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  451. <label class="md-nav__title" for="__nav_3_2">
  452. <span class="md-nav__icon md-icon"></span>
  453. External Secrets
  454. </label>
  455. <ul class="md-nav__list" data-md-scrollfix>
  456. <li class="md-nav__item">
  457. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  458. <span class="md-ellipsis">
  459. Extract structured data
  460. </span>
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../../guides/getallsecrets/" class="md-nav__link">
  465. <span class="md-ellipsis">
  466. Find Secrets by Name or Metadata
  467. </span>
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  472. <span class="md-ellipsis">
  473. Rewriting Keys
  474. </span>
  475. </a>
  476. </li>
  477. <li class="md-nav__item md-nav__item--nested">
  478. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  479. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  480. <span class="md-ellipsis">
  481. Advanced Templating
  482. </span>
  483. <span class="md-nav__icon md-icon"></span>
  484. </label>
  485. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  486. <label class="md-nav__title" for="__nav_3_2_4">
  487. <span class="md-nav__icon md-icon"></span>
  488. Advanced Templating
  489. </label>
  490. <ul class="md-nav__list" data-md-scrollfix>
  491. <li class="md-nav__item">
  492. <a href="../../guides/templating/" class="md-nav__link">
  493. <span class="md-ellipsis">
  494. v2
  495. </span>
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../guides/templating-v1/" class="md-nav__link">
  500. <span class="md-ellipsis">
  501. v1
  502. </span>
  503. </a>
  504. </li>
  505. </ul>
  506. </nav>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. Kubernetes Secret Types
  512. </span>
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. Lifecycle: ownership & deletion
  519. </span>
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. Decoding Strategies
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="../../guides/controller-class/" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. Controller Classes
  533. </span>
  534. </a>
  535. </li>
  536. </ul>
  537. </nav>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../guides/generator/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Generators
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../guides/pushsecrets/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Push Secrets
  550. </span>
  551. </a>
  552. </li>
  553. <li class="md-nav__item md-nav__item--nested">
  554. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  555. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  556. <span class="md-ellipsis">
  557. Operations
  558. </span>
  559. <span class="md-nav__icon md-icon"></span>
  560. </label>
  561. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  562. <label class="md-nav__title" for="__nav_3_5">
  563. <span class="md-nav__icon md-icon"></span>
  564. Operations
  565. </label>
  566. <ul class="md-nav__list" data-md-scrollfix>
  567. <li class="md-nav__item">
  568. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  569. <span class="md-ellipsis">
  570. Multi Tenancy
  571. </span>
  572. </a>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="../../guides/security-best-practices/" class="md-nav__link">
  576. <span class="md-ellipsis">
  577. Security Best Practices
  578. </span>
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../../guides/threat-model/" class="md-nav__link">
  583. <span class="md-ellipsis">
  584. Threat Model
  585. </span>
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../guides/v1beta1/" class="md-nav__link">
  590. <span class="md-ellipsis">
  591. Upgrading to v1beta1
  592. </span>
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../guides/using-latest-image/" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. Using Latest Image
  599. </span>
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  604. <span class="md-ellipsis">
  605. Disable Cluster Features
  606. </span>
  607. </a>
  608. </li>
  609. </ul>
  610. </nav>
  611. </li>
  612. </ul>
  613. </nav>
  614. </li>
  615. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  616. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  617. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  618. <span class="md-ellipsis">
  619. Provider
  620. </span>
  621. <span class="md-nav__icon md-icon"></span>
  622. </label>
  623. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  624. <label class="md-nav__title" for="__nav_4">
  625. <span class="md-nav__icon md-icon"></span>
  626. Provider
  627. </label>
  628. <ul class="md-nav__list" data-md-scrollfix>
  629. <li class="md-nav__item">
  630. <a href="../aws-secrets-manager/" class="md-nav__link">
  631. <span class="md-ellipsis">
  632. AWS Secrets Manager
  633. </span>
  634. </a>
  635. </li>
  636. <li class="md-nav__item md-nav__item--active">
  637. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  638. <label class="md-nav__link md-nav__link--active" for="__toc">
  639. <span class="md-ellipsis">
  640. AWS Parameter Store
  641. </span>
  642. <span class="md-nav__icon md-icon"></span>
  643. </label>
  644. <a href="./" class="md-nav__link md-nav__link--active">
  645. <span class="md-ellipsis">
  646. AWS Parameter Store
  647. </span>
  648. </a>
  649. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  650. <label class="md-nav__title" for="__toc">
  651. <span class="md-nav__icon md-icon"></span>
  652. Table of contents
  653. </label>
  654. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  655. <li class="md-nav__item">
  656. <a href="#parameter-store" class="md-nav__link">
  657. <span class="md-ellipsis">
  658. Parameter Store
  659. </span>
  660. </a>
  661. <nav class="md-nav" aria-label="Parameter Store">
  662. <ul class="md-nav__list">
  663. <li class="md-nav__item">
  664. <a href="#iam-policy" class="md-nav__link">
  665. <span class="md-ellipsis">
  666. IAM Policy
  667. </span>
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="#json-secret-values" class="md-nav__link">
  672. <span class="md-ellipsis">
  673. JSON Secret Values
  674. </span>
  675. </a>
  676. </li>
  677. <li class="md-nav__item">
  678. <a href="#parameter-versions" class="md-nav__link">
  679. <span class="md-ellipsis">
  680. Parameter Versions
  681. </span>
  682. </a>
  683. </li>
  684. </ul>
  685. </nav>
  686. </li>
  687. <li class="md-nav__item">
  688. <a href="#setsecret" class="md-nav__link">
  689. <span class="md-ellipsis">
  690. SetSecret
  691. </span>
  692. </a>
  693. <nav class="md-nav" aria-label="SetSecret">
  694. <ul class="md-nav__list">
  695. <li class="md-nav__item">
  696. <a href="#creating-a-push-secret" class="md-nav__link">
  697. <span class="md-ellipsis">
  698. Creating a Push Secret
  699. </span>
  700. </a>
  701. <nav class="md-nav" aria-label="Creating a Push Secret">
  702. <ul class="md-nav__list">
  703. <li class="md-nav__item">
  704. <a href="#check-successful-secret-sync" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. Check successful secret sync
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Test new secret using AWS CLI
  714. </span>
  715. </a>
  716. </li>
  717. </ul>
  718. </nav>
  719. </li>
  720. </ul>
  721. </nav>
  722. </li>
  723. <li class="md-nav__item">
  724. <a href="#aws-authentication" class="md-nav__link">
  725. <span class="md-ellipsis">
  726. AWS Authentication
  727. </span>
  728. </a>
  729. <nav class="md-nav" aria-label="AWS Authentication">
  730. <ul class="md-nav__list">
  731. <li class="md-nav__item">
  732. <a href="#controllers-pod-identity" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. Controller's Pod Identity
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. Access Key ID &amp; Secret Access Key
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="#eks-service-account-credentials" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. EKS Service Account credentials
  749. </span>
  750. </a>
  751. </li>
  752. </ul>
  753. </nav>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="#custom-endpoints" class="md-nav__link">
  757. <span class="md-ellipsis">
  758. Custom Endpoints
  759. </span>
  760. </a>
  761. </li>
  762. </ul>
  763. </nav>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="../azure-key-vault/" class="md-nav__link">
  767. <span class="md-ellipsis">
  768. Azure Key Vault
  769. </span>
  770. </a>
  771. </li>
  772. <li class="md-nav__item">
  773. <a href="../chef/" class="md-nav__link">
  774. <span class="md-ellipsis">
  775. Chef
  776. </span>
  777. </a>
  778. </li>
  779. <li class="md-nav__item">
  780. <a href="../conjur/" class="md-nav__link">
  781. <span class="md-ellipsis">
  782. CyberArk Conjur
  783. </span>
  784. </a>
  785. </li>
  786. <li class="md-nav__item">
  787. <a href="../google-secrets-manager/" class="md-nav__link">
  788. <span class="md-ellipsis">
  789. Google Cloud Secret Manager
  790. </span>
  791. </a>
  792. </li>
  793. <li class="md-nav__item">
  794. <a href="../hashicorp-vault/" class="md-nav__link">
  795. <span class="md-ellipsis">
  796. HashiCorp Vault
  797. </span>
  798. </a>
  799. </li>
  800. <li class="md-nav__item">
  801. <a href="../kubernetes/" class="md-nav__link">
  802. <span class="md-ellipsis">
  803. Kubernetes
  804. </span>
  805. </a>
  806. </li>
  807. <li class="md-nav__item">
  808. <a href="../ibm-secrets-manager/" class="md-nav__link">
  809. <span class="md-ellipsis">
  810. IBM Secrets Manager
  811. </span>
  812. </a>
  813. </li>
  814. <li class="md-nav__item">
  815. <a href="../akeyless/" class="md-nav__link">
  816. <span class="md-ellipsis">
  817. Akeyless
  818. </span>
  819. </a>
  820. </li>
  821. <li class="md-nav__item">
  822. <a href="../yandex-certificate-manager/" class="md-nav__link">
  823. <span class="md-ellipsis">
  824. Yandex Certificate Manager
  825. </span>
  826. </a>
  827. </li>
  828. <li class="md-nav__item">
  829. <a href="../yandex-lockbox/" class="md-nav__link">
  830. <span class="md-ellipsis">
  831. Yandex Lockbox
  832. </span>
  833. </a>
  834. </li>
  835. <li class="md-nav__item">
  836. <a href="../alibaba/" class="md-nav__link">
  837. <span class="md-ellipsis">
  838. Alibaba Cloud
  839. </span>
  840. </a>
  841. </li>
  842. <li class="md-nav__item">
  843. <a href="../gitlab-variables/" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. GitLab Variables
  846. </span>
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="../oracle-vault/" class="md-nav__link">
  851. <span class="md-ellipsis">
  852. Oracle Vault
  853. </span>
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="../1password-automation/" class="md-nav__link">
  858. <span class="md-ellipsis">
  859. 1Password Secrets Automation
  860. </span>
  861. </a>
  862. </li>
  863. <li class="md-nav__item">
  864. <a href="../webhook/" class="md-nav__link">
  865. <span class="md-ellipsis">
  866. Webhook
  867. </span>
  868. </a>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="../fake/" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. Fake
  874. </span>
  875. </a>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="../senhasegura-dsm/" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. senhasegura DevOps Secrets Management (DSM)
  881. </span>
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="../doppler/" class="md-nav__link">
  886. <span class="md-ellipsis">
  887. Doppler
  888. </span>
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="../keeper-security/" class="md-nav__link">
  893. <span class="md-ellipsis">
  894. Keeper Security
  895. </span>
  896. </a>
  897. </li>
  898. <li class="md-nav__item">
  899. <a href="../cloak/" class="md-nav__link">
  900. <span class="md-ellipsis">
  901. Cloak End 2 End Encrypted Secrets
  902. </span>
  903. </a>
  904. </li>
  905. <li class="md-nav__item">
  906. <a href="../scaleway/" class="md-nav__link">
  907. <span class="md-ellipsis">
  908. Scaleway
  909. </span>
  910. </a>
  911. </li>
  912. <li class="md-nav__item">
  913. <a href="../delinea/" class="md-nav__link">
  914. <span class="md-ellipsis">
  915. Delinea
  916. </span>
  917. </a>
  918. </li>
  919. <li class="md-nav__item">
  920. <a href="../pulumi/" class="md-nav__link">
  921. <span class="md-ellipsis">
  922. Pulumi ESC
  923. </span>
  924. </a>
  925. </li>
  926. <li class="md-nav__item">
  927. <a href="../onboardbase/" class="md-nav__link">
  928. <span class="md-ellipsis">
  929. Onboardbase
  930. </span>
  931. </a>
  932. </li>
  933. </ul>
  934. </nav>
  935. </li>
  936. <li class="md-nav__item md-nav__item--nested">
  937. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  938. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  939. <span class="md-ellipsis">
  940. Examples
  941. </span>
  942. <span class="md-nav__icon md-icon"></span>
  943. </label>
  944. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  945. <label class="md-nav__title" for="__nav_5">
  946. <span class="md-nav__icon md-icon"></span>
  947. Examples
  948. </label>
  949. <ul class="md-nav__list" data-md-scrollfix>
  950. <li class="md-nav__item">
  951. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  952. <span class="md-ellipsis">
  953. FluxCD
  954. </span>
  955. </a>
  956. </li>
  957. <li class="md-nav__item">
  958. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  959. <span class="md-ellipsis">
  960. Anchore Engine
  961. </span>
  962. </a>
  963. </li>
  964. <li class="md-nav__item">
  965. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  966. <span class="md-ellipsis">
  967. Jenkins
  968. </span>
  969. </a>
  970. </li>
  971. <li class="md-nav__item">
  972. <a href="../../examples/bitwarden/" class="md-nav__link">
  973. <span class="md-ellipsis">
  974. BitWarden
  975. </span>
  976. </a>
  977. </li>
  978. </ul>
  979. </nav>
  980. </li>
  981. <li class="md-nav__item md-nav__item--nested">
  982. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  983. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  984. <span class="md-ellipsis">
  985. Community
  986. </span>
  987. <span class="md-nav__icon md-icon"></span>
  988. </label>
  989. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  990. <label class="md-nav__title" for="__nav_6">
  991. <span class="md-nav__icon md-icon"></span>
  992. Community
  993. </label>
  994. <ul class="md-nav__list" data-md-scrollfix>
  995. <li class="md-nav__item md-nav__item--nested">
  996. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  997. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  998. <span class="md-ellipsis">
  999. Contributing
  1000. </span>
  1001. <span class="md-nav__icon md-icon"></span>
  1002. </label>
  1003. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1004. <label class="md-nav__title" for="__nav_6_1">
  1005. <span class="md-nav__icon md-icon"></span>
  1006. Contributing
  1007. </label>
  1008. <ul class="md-nav__list" data-md-scrollfix>
  1009. <li class="md-nav__item">
  1010. <a href="../../contributing/devguide/" class="md-nav__link">
  1011. <span class="md-ellipsis">
  1012. Developer guide
  1013. </span>
  1014. </a>
  1015. </li>
  1016. <li class="md-nav__item">
  1017. <a href="../../contributing/process/" class="md-nav__link">
  1018. <span class="md-ellipsis">
  1019. Contributing Process
  1020. </span>
  1021. </a>
  1022. </li>
  1023. <li class="md-nav__item">
  1024. <a href="../../contributing/release/" class="md-nav__link">
  1025. <span class="md-ellipsis">
  1026. Release Process
  1027. </span>
  1028. </a>
  1029. </li>
  1030. <li class="md-nav__item">
  1031. <a href="../../contributing/coc/" class="md-nav__link">
  1032. <span class="md-ellipsis">
  1033. Code of Conduct
  1034. </span>
  1035. </a>
  1036. </li>
  1037. <li class="md-nav__item">
  1038. <a href="../../contributing/roadmap/" class="md-nav__link">
  1039. <span class="md-ellipsis">
  1040. Roadmap
  1041. </span>
  1042. </a>
  1043. </li>
  1044. </ul>
  1045. </nav>
  1046. </li>
  1047. <li class="md-nav__item md-nav__item--nested">
  1048. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1049. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1050. <span class="md-ellipsis">
  1051. External Resources
  1052. </span>
  1053. <span class="md-nav__icon md-icon"></span>
  1054. </label>
  1055. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1056. <label class="md-nav__title" for="__nav_6_2">
  1057. <span class="md-nav__icon md-icon"></span>
  1058. External Resources
  1059. </label>
  1060. <ul class="md-nav__list" data-md-scrollfix>
  1061. <li class="md-nav__item">
  1062. <a href="../../eso-talks/" class="md-nav__link">
  1063. <span class="md-ellipsis">
  1064. Talks
  1065. </span>
  1066. </a>
  1067. </li>
  1068. <li class="md-nav__item">
  1069. <a href="../../eso-demos/" class="md-nav__link">
  1070. <span class="md-ellipsis">
  1071. Demos
  1072. </span>
  1073. </a>
  1074. </li>
  1075. <li class="md-nav__item">
  1076. <a href="../../eso-blogs/" class="md-nav__link">
  1077. <span class="md-ellipsis">
  1078. Blogs
  1079. </span>
  1080. </a>
  1081. </li>
  1082. </ul>
  1083. </nav>
  1084. </li>
  1085. <li class="md-nav__item md-nav__item--nested">
  1086. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_3" >
  1087. <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
  1088. <span class="md-ellipsis">
  1089. AWS
  1090. </span>
  1091. <span class="md-nav__icon md-icon"></span>
  1092. </label>
  1093. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
  1094. <label class="md-nav__title" for="__nav_6_3">
  1095. <span class="md-nav__icon md-icon"></span>
  1096. AWS
  1097. </label>
  1098. <ul class="md-nav__list" data-md-scrollfix>
  1099. <li class="md-nav__item">
  1100. <a href="../../provider-aws-secrets-manager.md" class="md-nav__link">
  1101. <span class="md-ellipsis">
  1102. Secrets Manager
  1103. </span>
  1104. </a>
  1105. </li>
  1106. <li class="md-nav__item">
  1107. <a href="../../provider-aws-parameter-store.md" class="md-nav__link">
  1108. <span class="md-ellipsis">
  1109. Parameter Store
  1110. </span>
  1111. </a>
  1112. </li>
  1113. </ul>
  1114. </nav>
  1115. </li>
  1116. <li class="md-nav__item md-nav__item--nested">
  1117. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_4" >
  1118. <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
  1119. <span class="md-ellipsis">
  1120. Azure
  1121. </span>
  1122. <span class="md-nav__icon md-icon"></span>
  1123. </label>
  1124. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
  1125. <label class="md-nav__title" for="__nav_6_4">
  1126. <span class="md-nav__icon md-icon"></span>
  1127. Azure
  1128. </label>
  1129. <ul class="md-nav__list" data-md-scrollfix>
  1130. <li class="md-nav__item">
  1131. <a href="../../provider-azure-key-vault.md" class="md-nav__link">
  1132. <span class="md-ellipsis">
  1133. Key Vault
  1134. </span>
  1135. </a>
  1136. </li>
  1137. </ul>
  1138. </nav>
  1139. </li>
  1140. <li class="md-nav__item md-nav__item--nested">
  1141. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_5" >
  1142. <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
  1143. <span class="md-ellipsis">
  1144. Google
  1145. </span>
  1146. <span class="md-nav__icon md-icon"></span>
  1147. </label>
  1148. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
  1149. <label class="md-nav__title" for="__nav_6_5">
  1150. <span class="md-nav__icon md-icon"></span>
  1151. Google
  1152. </label>
  1153. <ul class="md-nav__list" data-md-scrollfix>
  1154. <li class="md-nav__item">
  1155. <a href="../../provider-google-secrets-manager.md" class="md-nav__link">
  1156. <span class="md-ellipsis">
  1157. Secrets Manager
  1158. </span>
  1159. </a>
  1160. </li>
  1161. </ul>
  1162. </nav>
  1163. </li>
  1164. <li class="md-nav__item md-nav__item--nested">
  1165. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_6" >
  1166. <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
  1167. <span class="md-ellipsis">
  1168. IBM
  1169. </span>
  1170. <span class="md-nav__icon md-icon"></span>
  1171. </label>
  1172. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
  1173. <label class="md-nav__title" for="__nav_6_6">
  1174. <span class="md-nav__icon md-icon"></span>
  1175. IBM
  1176. </label>
  1177. <ul class="md-nav__list" data-md-scrollfix>
  1178. <li class="md-nav__item">
  1179. <a href="../../provider-ibm-secrets-manager.md" class="md-nav__link">
  1180. <span class="md-ellipsis">
  1181. Secrets Manager
  1182. </span>
  1183. </a>
  1184. </li>
  1185. </ul>
  1186. </nav>
  1187. </li>
  1188. <li class="md-nav__item">
  1189. <a href="../../provider-hashicorp-vault.md" class="md-nav__link">
  1190. <span class="md-ellipsis">
  1191. HashiCorp Vault
  1192. </span>
  1193. </a>
  1194. </li>
  1195. <li class="md-nav__item md-nav__item--nested">
  1196. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_8" >
  1197. <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
  1198. <span class="md-ellipsis">
  1199. Yandex
  1200. </span>
  1201. <span class="md-nav__icon md-icon"></span>
  1202. </label>
  1203. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
  1204. <label class="md-nav__title" for="__nav_6_8">
  1205. <span class="md-nav__icon md-icon"></span>
  1206. Yandex
  1207. </label>
  1208. <ul class="md-nav__list" data-md-scrollfix>
  1209. <li class="md-nav__item">
  1210. <a href="../../provider-yandex-lockbox.md" class="md-nav__link">
  1211. <span class="md-ellipsis">
  1212. Lockbox
  1213. </span>
  1214. </a>
  1215. </li>
  1216. </ul>
  1217. </nav>
  1218. </li>
  1219. <li class="md-nav__item">
  1220. <a href="../../provider-passworddepot/" class="md-nav__link">
  1221. <span class="md-ellipsis">
  1222. Password Depot
  1223. </span>
  1224. </a>
  1225. </li>
  1226. <li class="md-nav__item md-nav__item--nested">
  1227. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_10" >
  1228. <label class="md-nav__link" for="__nav_6_10" id="__nav_6_10_label" tabindex="0">
  1229. <span class="md-ellipsis">
  1230. Gitlab
  1231. </span>
  1232. <span class="md-nav__icon md-icon"></span>
  1233. </label>
  1234. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_10_label" aria-expanded="false">
  1235. <label class="md-nav__title" for="__nav_6_10">
  1236. <span class="md-nav__icon md-icon"></span>
  1237. Gitlab
  1238. </label>
  1239. <ul class="md-nav__list" data-md-scrollfix>
  1240. <li class="md-nav__item">
  1241. <a href="../../provider-gitlab-project-variables.md" class="md-nav__link">
  1242. <span class="md-ellipsis">
  1243. Gitlab Project Variables
  1244. </span>
  1245. </a>
  1246. </li>
  1247. </ul>
  1248. </nav>
  1249. </li>
  1250. <li class="md-nav__item md-nav__item--nested">
  1251. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_11" >
  1252. <label class="md-nav__link" for="__nav_6_11" id="__nav_6_11_label" tabindex="0">
  1253. <span class="md-ellipsis">
  1254. Oracle
  1255. </span>
  1256. <span class="md-nav__icon md-icon"></span>
  1257. </label>
  1258. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_11_label" aria-expanded="false">
  1259. <label class="md-nav__title" for="__nav_6_11">
  1260. <span class="md-nav__icon md-icon"></span>
  1261. Oracle
  1262. </label>
  1263. <ul class="md-nav__list" data-md-scrollfix>
  1264. <li class="md-nav__item">
  1265. <a href="../../provider-oracle-vault.md" class="md-nav__link">
  1266. <span class="md-ellipsis">
  1267. Oracle Vault
  1268. </span>
  1269. </a>
  1270. </li>
  1271. </ul>
  1272. </nav>
  1273. </li>
  1274. </ul>
  1275. </nav>
  1276. </li>
  1277. <li class="md-nav__item md-nav__item--nested">
  1278. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1279. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1280. <span class="md-ellipsis">
  1281. References
  1282. </span>
  1283. <span class="md-nav__icon md-icon"></span>
  1284. </label>
  1285. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1286. <label class="md-nav__title" for="__nav_7">
  1287. <span class="md-nav__icon md-icon"></span>
  1288. References
  1289. </label>
  1290. <ul class="md-nav__list" data-md-scrollfix>
  1291. <li class="md-nav__item">
  1292. <a href="../../spec/" class="md-nav__link">
  1293. <span class="md-ellipsis">
  1294. API specification
  1295. </span>
  1296. </a>
  1297. </li>
  1298. </ul>
  1299. </nav>
  1300. </li>
  1301. <li class="md-nav__item md-nav__item--nested">
  1302. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
  1303. <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
  1304. <span class="md-ellipsis">
  1305. Contributing
  1306. </span>
  1307. <span class="md-nav__icon md-icon"></span>
  1308. </label>
  1309. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  1310. <label class="md-nav__title" for="__nav_8">
  1311. <span class="md-nav__icon md-icon"></span>
  1312. Contributing
  1313. </label>
  1314. <ul class="md-nav__list" data-md-scrollfix>
  1315. <li class="md-nav__item">
  1316. <a href="../../contributing-devguide.md" class="md-nav__link">
  1317. <span class="md-ellipsis">
  1318. Developer guide
  1319. </span>
  1320. </a>
  1321. </li>
  1322. <li class="md-nav__item">
  1323. <a href="../../contributing-process.md" class="md-nav__link">
  1324. <span class="md-ellipsis">
  1325. Contributing Process
  1326. </span>
  1327. </a>
  1328. </li>
  1329. <li class="md-nav__item">
  1330. <a href="../../contributing-coc.md" class="md-nav__link">
  1331. <span class="md-ellipsis">
  1332. Code of Conduct
  1333. </span>
  1334. </a>
  1335. </li>
  1336. </ul>
  1337. </nav>
  1338. </li>
  1339. <li class="md-nav__item">
  1340. <a href="../../deprecation-policy.md" class="md-nav__link">
  1341. <span class="md-ellipsis">
  1342. Deprecation Policy
  1343. </span>
  1344. </a>
  1345. </li>
  1346. </ul>
  1347. </nav>
  1348. </div>
  1349. </div>
  1350. </div>
  1351. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1352. <div class="md-sidebar__scrollwrap">
  1353. <div class="md-sidebar__inner">
  1354. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1355. <label class="md-nav__title" for="__toc">
  1356. <span class="md-nav__icon md-icon"></span>
  1357. Table of contents
  1358. </label>
  1359. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1360. <li class="md-nav__item">
  1361. <a href="#parameter-store" class="md-nav__link">
  1362. <span class="md-ellipsis">
  1363. Parameter Store
  1364. </span>
  1365. </a>
  1366. <nav class="md-nav" aria-label="Parameter Store">
  1367. <ul class="md-nav__list">
  1368. <li class="md-nav__item">
  1369. <a href="#iam-policy" class="md-nav__link">
  1370. <span class="md-ellipsis">
  1371. IAM Policy
  1372. </span>
  1373. </a>
  1374. </li>
  1375. <li class="md-nav__item">
  1376. <a href="#json-secret-values" class="md-nav__link">
  1377. <span class="md-ellipsis">
  1378. JSON Secret Values
  1379. </span>
  1380. </a>
  1381. </li>
  1382. <li class="md-nav__item">
  1383. <a href="#parameter-versions" class="md-nav__link">
  1384. <span class="md-ellipsis">
  1385. Parameter Versions
  1386. </span>
  1387. </a>
  1388. </li>
  1389. </ul>
  1390. </nav>
  1391. </li>
  1392. <li class="md-nav__item">
  1393. <a href="#setsecret" class="md-nav__link">
  1394. <span class="md-ellipsis">
  1395. SetSecret
  1396. </span>
  1397. </a>
  1398. <nav class="md-nav" aria-label="SetSecret">
  1399. <ul class="md-nav__list">
  1400. <li class="md-nav__item">
  1401. <a href="#creating-a-push-secret" class="md-nav__link">
  1402. <span class="md-ellipsis">
  1403. Creating a Push Secret
  1404. </span>
  1405. </a>
  1406. <nav class="md-nav" aria-label="Creating a Push Secret">
  1407. <ul class="md-nav__list">
  1408. <li class="md-nav__item">
  1409. <a href="#check-successful-secret-sync" class="md-nav__link">
  1410. <span class="md-ellipsis">
  1411. Check successful secret sync
  1412. </span>
  1413. </a>
  1414. </li>
  1415. <li class="md-nav__item">
  1416. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  1417. <span class="md-ellipsis">
  1418. Test new secret using AWS CLI
  1419. </span>
  1420. </a>
  1421. </li>
  1422. </ul>
  1423. </nav>
  1424. </li>
  1425. </ul>
  1426. </nav>
  1427. </li>
  1428. <li class="md-nav__item">
  1429. <a href="#aws-authentication" class="md-nav__link">
  1430. <span class="md-ellipsis">
  1431. AWS Authentication
  1432. </span>
  1433. </a>
  1434. <nav class="md-nav" aria-label="AWS Authentication">
  1435. <ul class="md-nav__list">
  1436. <li class="md-nav__item">
  1437. <a href="#controllers-pod-identity" class="md-nav__link">
  1438. <span class="md-ellipsis">
  1439. Controller's Pod Identity
  1440. </span>
  1441. </a>
  1442. </li>
  1443. <li class="md-nav__item">
  1444. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  1445. <span class="md-ellipsis">
  1446. Access Key ID &amp; Secret Access Key
  1447. </span>
  1448. </a>
  1449. </li>
  1450. <li class="md-nav__item">
  1451. <a href="#eks-service-account-credentials" class="md-nav__link">
  1452. <span class="md-ellipsis">
  1453. EKS Service Account credentials
  1454. </span>
  1455. </a>
  1456. </li>
  1457. </ul>
  1458. </nav>
  1459. </li>
  1460. <li class="md-nav__item">
  1461. <a href="#custom-endpoints" class="md-nav__link">
  1462. <span class="md-ellipsis">
  1463. Custom Endpoints
  1464. </span>
  1465. </a>
  1466. </li>
  1467. </ul>
  1468. </nav>
  1469. </div>
  1470. </div>
  1471. </div>
  1472. <div class="md-content" data-md-component="content">
  1473. <article class="md-content__inner md-typeset">
  1474. <h1>AWS Parameter Store</h1>
  1475. <p><img alt="aws sm" src="../../pictures/diagrams-provider-aws-ssm-parameter-store.png" /></p>
  1476. <h2 id="parameter-store">Parameter Store</h2>
  1477. <p>A <code>ParameterStore</code> points to AWS SSM Parameter Store in a certain account within a
  1478. defined region. You should define Roles that define fine-grained access to
  1479. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  1480. way users of the <code>SecretStore</code> can only access the secrets necessary.</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">parameterstore</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">ParameterStore</span>
  1489. <span class="w"> </span><span class="c1"># define a specific role to limit access</span>
  1490. <span class="w"> </span><span class="c1"># to certain 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">arn:aws:iam::123456789012:role/external-secrets</span>
  1492. <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>
  1493. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1494. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1495. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1496. <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>
  1497. <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>
  1498. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</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">awssm-secret</span>
  1500. <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>
  1501. </code></pre></div>
  1502. <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>
  1503. <div class="admonition warning">
  1504. <p class="admonition-title">API Pricing &amp; Throttling</p>
  1505. <p>The SSM Parameter Store API is charged by throughput and
  1506. is available in different tiers, <a href="https://aws.amazon.com/systems-manager/pricing/#Parameter_Store">see pricing</a>.
  1507. Please estimate your costs before using ESO. Cost depends on the RefreshInterval of your ExternalSecrets.</p>
  1508. </div>
  1509. <h3 id="iam-policy">IAM Policy</h3>
  1510. <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>
  1511. <p>For further information see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-access.html">AWS Documentation</a>.</p>
  1512. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1513. <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>
  1514. <span class="w"> </span><span class="nt">&quot;Statement&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1515. <span class="w"> </span><span class="p">{</span>
  1516. <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>
  1517. <span class="w"> </span><span class="nt">&quot;Action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1518. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter*&quot;</span><span class="p">,</span>
  1519. <span class="w"> </span><span class="p">],</span>
  1520. <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>
  1521. <span class="w"> </span><span class="p">}</span>
  1522. <span class="w"> </span><span class="p">]</span>
  1523. <span class="p">}</span>
  1524. </code></pre></div>
  1525. <h3 id="json-secret-values">JSON Secret Values</h3>
  1526. <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>
  1527. <p>Consider the following JSON object that is stored in the Parameter Store key <code>friendslist</code>:
  1528. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1529. <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>
  1530. <span class="w"> </span><span class="nt">&quot;friends&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1531. <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>
  1532. <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>
  1533. <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>
  1534. <span class="w"> </span><span class="p">]</span>
  1535. <span class="p">}</span>
  1536. </code></pre></div></p>
  1537. <p>This is an example on how you would look up nested keys in the above json object:
  1538. <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>
  1539. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1540. <span class="nt">metadata</span><span class="p">:</span>
  1541. <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>
  1542. <span class="nt">spec</span><span class="p">:</span>
  1543. <span class="w"> </span><span class="c1"># [omitted for brevity]</span>
  1544. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1545. <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>
  1546. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1547. <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>
  1548. <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>
  1549. <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>
  1550. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1551. <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>
  1552. <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>
  1553. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the tags in JSON format</span>
  1554. <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>
  1555. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1556. <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>
  1557. <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>
  1558. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific tag (dev) from the source secret</span>
  1559. <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>
  1560. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1561. <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>
  1562. <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>
  1563. <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>
  1564. </code></pre></div></p>
  1565. <h3 id="parameter-versions">Parameter Versions</h3>
  1566. <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>
  1567. <h2 id="setsecret">SetSecret</h2>
  1568. <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>
  1569. <h3 id="creating-a-push-secret">Creating a Push Secret</h3>
  1570. <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>
  1571. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1572. <span class="nt">metadata</span><span class="p">:</span>
  1573. <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>
  1574. <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>
  1575. <span class="nt">spec</span><span class="p">:</span>
  1576. <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>
  1577. <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>
  1578. <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>
  1579. <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>
  1580. <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>
  1581. <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>
  1582. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1583. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1584. <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>
  1585. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1586. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1587. <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>
  1588. <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>
  1589. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1590. <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>
  1591. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span>
  1592. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span>
  1593. <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>
  1594. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1595. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1596. <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>
  1597. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1598. <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>
  1599. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1600. <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>
  1601. <span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1602. <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>
  1603. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1604. <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>
  1605. </code></pre></div>
  1606. <h4 id="check-successful-secret-sync">Check successful secret sync</h4>
  1607. <p>To be able to check that the secret has been succesfully synced you can run the following command:</p>
  1608. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>get<span class="w"> </span>pushsecret<span class="w"> </span>pushsecret-example
  1609. </code></pre></div>
  1610. <p>If the secret has synced successfully it will show the status as "Synced".</p>
  1611. <h4 id="test-new-secret-using-aws-cli">Test new secret using AWS CLI</h4>
  1612. <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>
  1613. <p>Run the following commands to get your synchronized parameter from AWS Parameter Store:</p>
  1614. <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
  1615. </code></pre></div>
  1616. <p>You should see something similar to the following output:</p>
  1617. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1618. <span class="w"> </span><span class="nt">&quot;Parameter&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1619. <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>
  1620. <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>
  1621. <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>
  1622. <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>
  1623. <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>
  1624. <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>
  1625. <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>
  1626. <span class="w"> </span><span class="p">}</span>
  1627. <span class="p">}</span>
  1628. </code></pre></div>
  1629. <h2 id="aws-authentication">AWS Authentication</h2>
  1630. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  1631. <p><img alt="Pod Identity Authentication" src="../../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  1632. <p>Note: If you are using Parameter Store replace <code>service: SecretsManager</code> with <code>service: ParameterStore</code> in all examples below.</p>
  1633. <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>
  1634. <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>
  1635. <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>
  1636. <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>
  1637. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1638. <span class="nt">metadata</span><span class="p">:</span>
  1639. <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>
  1640. <span class="nt">spec</span><span class="p">:</span>
  1641. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1642. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1643. <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>
  1644. <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>
  1645. <span class="w"> </span><span class="c1"># optional: do a sts:assumeRole before fetching secrets</span>
  1646. <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>
  1647. </code></pre></div>
  1648. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  1649. <p><img alt="SecretRef" src="../../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  1650. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  1651. <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>
  1652. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1653. <span class="nt">metadata</span><span class="p">:</span>
  1654. <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>
  1655. <span class="nt">spec</span><span class="p">:</span>
  1656. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1657. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1658. <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>
  1659. <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>
  1660. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span>
  1661. <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>
  1662. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1663. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1664. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1665. <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>
  1666. <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>
  1667. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1668. <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>
  1669. <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>
  1670. </code></pre></div>
  1671. <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>
  1672. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  1673. <p><img alt="Service Account" src="../../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  1674. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  1675. 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>
  1676. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  1677. <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>
  1678. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  1679. <span class="nt">metadata</span><span class="p">:</span>
  1680. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1681. <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>
  1682. <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>
  1683. <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>
  1684. </code></pre></div>
  1685. <p>Reference the service account from above in the Secret Store:</p>
  1686. <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>
  1687. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1688. <span class="nt">metadata</span><span class="p">:</span>
  1689. <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>
  1690. <span class="nt">spec</span><span class="p">:</span>
  1691. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1692. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1693. <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>
  1694. <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>
  1695. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1696. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  1697. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1698. <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>
  1699. </code></pre></div>
  1700. <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>
  1701. <h2 id="custom-endpoints">Custom Endpoints</h2>
  1702. <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>
  1703. <p>Use the following environment variables to point the controller to your custom endpoints. Note: All resources managed by this controller are affected.</p>
  1704. <table>
  1705. <thead>
  1706. <tr>
  1707. <th>ENV VAR</th>
  1708. <th>DESCRIPTION</th>
  1709. </tr>
  1710. </thead>
  1711. <tbody>
  1712. <tr>
  1713. <td>AWS_SECRETSMANAGER_ENDPOINT</td>
  1714. <td>Endpoint for the Secrets Manager Service. The controller uses this endpoint to fetch secrets from AWS Secrets Manager.</td>
  1715. </tr>
  1716. <tr>
  1717. <td>AWS_SSM_ENDPOINT</td>
  1718. <td>Endpoint for the AWS Secure Systems Manager. The controller uses this endpoint to fetch secrets from SSM Parameter Store.</td>
  1719. </tr>
  1720. <tr>
  1721. <td>AWS_STS_ENDPOINT</td>
  1722. <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>
  1723. </tr>
  1724. </tbody>
  1725. </table>
  1726. </article>
  1727. </div>
  1728. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1729. </div>
  1730. </main>
  1731. <footer class="md-footer">
  1732. <div class="md-footer-meta md-typeset">
  1733. <div class="md-footer-meta__inner md-grid">
  1734. <div class="md-copyright">
  1735. <div class="md-copyright__highlight">
  1736. &copy; 2024 The external-secrets Authors.<br/>
  1737. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1738. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1739. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1740. </div>
  1741. Made with
  1742. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1743. Material for MkDocs
  1744. </a>
  1745. </div>
  1746. </div>
  1747. </div>
  1748. </footer>
  1749. </div>
  1750. <div class="md-dialog" data-md-component="dialog">
  1751. <div class="md-dialog__inner md-typeset"></div>
  1752. </div>
  1753. <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>
  1754. <script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>
  1755. </body>
  1756. </html>