index.html 86 KB

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