index.html 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589
  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="../components/">
  7. <link rel="next" href="../secretstore/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
  10. <title>ExternalSecret - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <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">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <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>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#template" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. ExternalSecret
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <form class="md-header__option" data-md-component="palette">
  65. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  68. </label>
  69. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  72. </label>
  73. </form>
  74. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var 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(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  75. <label class="md-header__button md-icon" for="__search">
  76. <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.52 6.52 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 5"/></svg>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <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>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <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.52 6.52 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 5"/></svg>
  85. <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 11z"/></svg>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <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 12z"/></svg>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item md-tabs__item--active">
  127. <a href="../components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item">
  132. <a href="../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item">
  137. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../introduction/getting-started/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Getting started
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/faq/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. FAQ
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/stability-support/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Stability and Support
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. Deprecation Policy
  227. </span>
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  235. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  236. <span class="md-ellipsis">
  237. API
  238. </span>
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  242. <label class="md-nav__title" for="__nav_2">
  243. <span class="md-nav__icon md-icon"></span>
  244. API
  245. </label>
  246. <ul class="md-nav__list" data-md-scrollfix>
  247. <li class="md-nav__item">
  248. <a href="../components/" class="md-nav__link">
  249. <span class="md-ellipsis">
  250. Components
  251. </span>
  252. </a>
  253. </li>
  254. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  255. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2" checked>
  256. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  257. <span class="md-ellipsis">
  258. Core Resources
  259. </span>
  260. <span class="md-nav__icon md-icon"></span>
  261. </label>
  262. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="true">
  263. <label class="md-nav__title" for="__nav_2_2">
  264. <span class="md-nav__icon md-icon"></span>
  265. Core Resources
  266. </label>
  267. <ul class="md-nav__list" data-md-scrollfix>
  268. <li class="md-nav__item md-nav__item--active">
  269. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  270. <label class="md-nav__link md-nav__link--active" for="__toc">
  271. <span class="md-ellipsis">
  272. ExternalSecret
  273. </span>
  274. <span class="md-nav__icon md-icon"></span>
  275. </label>
  276. <a href="./" class="md-nav__link md-nav__link--active">
  277. <span class="md-ellipsis">
  278. ExternalSecret
  279. </span>
  280. </a>
  281. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  282. <label class="md-nav__title" for="__toc">
  283. <span class="md-nav__icon md-icon"></span>
  284. Table of contents
  285. </label>
  286. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  287. <li class="md-nav__item">
  288. <a href="#template" class="md-nav__link">
  289. <span class="md-ellipsis">
  290. Template
  291. </span>
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="#update-behavior" class="md-nav__link">
  296. <span class="md-ellipsis">
  297. Update Behavior
  298. </span>
  299. </a>
  300. </li>
  301. <li class="md-nav__item">
  302. <a href="#features" class="md-nav__link">
  303. <span class="md-ellipsis">
  304. Features
  305. </span>
  306. </a>
  307. </li>
  308. <li class="md-nav__item">
  309. <a href="#example" class="md-nav__link">
  310. <span class="md-ellipsis">
  311. Example
  312. </span>
  313. </a>
  314. </li>
  315. </ul>
  316. </nav>
  317. </li>
  318. <li class="md-nav__item">
  319. <a href="../secretstore/" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. SecretStore
  322. </span>
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../clustersecretstore/" class="md-nav__link">
  327. <span class="md-ellipsis">
  328. ClusterSecretStore
  329. </span>
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../clusterexternalsecret/" class="md-nav__link">
  334. <span class="md-ellipsis">
  335. ClusterExternalSecret
  336. </span>
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="../pushsecret/" class="md-nav__link">
  341. <span class="md-ellipsis">
  342. PushSecret
  343. </span>
  344. </a>
  345. </li>
  346. </ul>
  347. </nav>
  348. </li>
  349. <li class="md-nav__item md-nav__item--nested">
  350. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  351. <div class="md-nav__link md-nav__container">
  352. <a href="../generator/" class="md-nav__link ">
  353. <span class="md-ellipsis">
  354. Generators
  355. </span>
  356. </a>
  357. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  358. <span class="md-nav__icon md-icon"></span>
  359. </label>
  360. </div>
  361. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  362. <label class="md-nav__title" for="__nav_2_3">
  363. <span class="md-nav__icon md-icon"></span>
  364. Generators
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../generator/acr/" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. Azure Container Registry
  371. </span>
  372. </a>
  373. </li>
  374. <li class="md-nav__item">
  375. <a href="../generator/ecr/" class="md-nav__link">
  376. <span class="md-ellipsis">
  377. AWS Elastic Container Registry
  378. </span>
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="../generator/gcr/" class="md-nav__link">
  383. <span class="md-ellipsis">
  384. Google Container Registry
  385. </span>
  386. </a>
  387. </li>
  388. <li class="md-nav__item">
  389. <a href="../generator/vault/" class="md-nav__link">
  390. <span class="md-ellipsis">
  391. Vault Dynamic Secret
  392. </span>
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../generator/password/" class="md-nav__link">
  397. <span class="md-ellipsis">
  398. Password
  399. </span>
  400. </a>
  401. </li>
  402. <li class="md-nav__item">
  403. <a href="../generator/fake/" class="md-nav__link">
  404. <span class="md-ellipsis">
  405. Fake
  406. </span>
  407. </a>
  408. </li>
  409. <li class="md-nav__item">
  410. <a href="../generator/webhook/" class="md-nav__link">
  411. <span class="md-ellipsis">
  412. Webhook
  413. </span>
  414. </a>
  415. </li>
  416. <li class="md-nav__item">
  417. <a href="../generator/github/" class="md-nav__link">
  418. <span class="md-ellipsis">
  419. Github
  420. </span>
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../generator/uuid/" class="md-nav__link">
  425. <span class="md-ellipsis">
  426. UUID
  427. </span>
  428. </a>
  429. </li>
  430. </ul>
  431. </nav>
  432. </li>
  433. <li class="md-nav__item md-nav__item--nested">
  434. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  435. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  436. <span class="md-ellipsis">
  437. Reference Docs
  438. </span>
  439. <span class="md-nav__icon md-icon"></span>
  440. </label>
  441. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  442. <label class="md-nav__title" for="__nav_2_4">
  443. <span class="md-nav__icon md-icon"></span>
  444. Reference Docs
  445. </label>
  446. <ul class="md-nav__list" data-md-scrollfix>
  447. <li class="md-nav__item">
  448. <a href="../spec/" class="md-nav__link">
  449. <span class="md-ellipsis">
  450. API specification
  451. </span>
  452. </a>
  453. </li>
  454. <li class="md-nav__item">
  455. <a href="../controller-options/" class="md-nav__link">
  456. <span class="md-ellipsis">
  457. Controller Options
  458. </span>
  459. </a>
  460. </li>
  461. <li class="md-nav__item">
  462. <a href="../metrics/" class="md-nav__link">
  463. <span class="md-ellipsis">
  464. Metrics
  465. </span>
  466. </a>
  467. </li>
  468. </ul>
  469. </nav>
  470. </li>
  471. </ul>
  472. </nav>
  473. </li>
  474. <li class="md-nav__item md-nav__item--nested">
  475. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  476. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  477. <span class="md-ellipsis">
  478. Guides
  479. </span>
  480. <span class="md-nav__icon md-icon"></span>
  481. </label>
  482. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  483. <label class="md-nav__title" for="__nav_3">
  484. <span class="md-nav__icon md-icon"></span>
  485. Guides
  486. </label>
  487. <ul class="md-nav__list" data-md-scrollfix>
  488. <li class="md-nav__item">
  489. <a href="../../guides/introduction/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. Introduction
  492. </span>
  493. </a>
  494. </li>
  495. <li class="md-nav__item md-nav__item--nested">
  496. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  497. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  498. <span class="md-ellipsis">
  499. External Secrets
  500. </span>
  501. <span class="md-nav__icon md-icon"></span>
  502. </label>
  503. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  504. <label class="md-nav__title" for="__nav_3_2">
  505. <span class="md-nav__icon md-icon"></span>
  506. External Secrets
  507. </label>
  508. <ul class="md-nav__list" data-md-scrollfix>
  509. <li class="md-nav__item">
  510. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  511. <span class="md-ellipsis">
  512. Extract structured data
  513. </span>
  514. </a>
  515. </li>
  516. <li class="md-nav__item">
  517. <a href="../../guides/getallsecrets/" class="md-nav__link">
  518. <span class="md-ellipsis">
  519. Find Secrets by Name or Metadata
  520. </span>
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  525. <span class="md-ellipsis">
  526. Rewriting Keys
  527. </span>
  528. </a>
  529. </li>
  530. <li class="md-nav__item md-nav__item--nested">
  531. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  532. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  533. <span class="md-ellipsis">
  534. Advanced Templating
  535. </span>
  536. <span class="md-nav__icon md-icon"></span>
  537. </label>
  538. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  539. <label class="md-nav__title" for="__nav_3_2_4">
  540. <span class="md-nav__icon md-icon"></span>
  541. Advanced Templating
  542. </label>
  543. <ul class="md-nav__list" data-md-scrollfix>
  544. <li class="md-nav__item">
  545. <a href="../../guides/templating/" class="md-nav__link">
  546. <span class="md-ellipsis">
  547. v2
  548. </span>
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../../guides/templating-v1/" class="md-nav__link">
  553. <span class="md-ellipsis">
  554. v1
  555. </span>
  556. </a>
  557. </li>
  558. </ul>
  559. </nav>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  563. <span class="md-ellipsis">
  564. Kubernetes Secret Types
  565. </span>
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  570. <span class="md-ellipsis">
  571. Lifecycle: ownership & deletion
  572. </span>
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  577. <span class="md-ellipsis">
  578. Decoding Strategies
  579. </span>
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../../guides/controller-class/" class="md-nav__link">
  584. <span class="md-ellipsis">
  585. Controller Classes
  586. </span>
  587. </a>
  588. </li>
  589. </ul>
  590. </nav>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../guides/generator/" class="md-nav__link">
  594. <span class="md-ellipsis">
  595. Generators
  596. </span>
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="../../guides/pushsecrets/" class="md-nav__link">
  601. <span class="md-ellipsis">
  602. Push Secrets
  603. </span>
  604. </a>
  605. </li>
  606. <li class="md-nav__item md-nav__item--nested">
  607. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  608. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  609. <span class="md-ellipsis">
  610. Operations
  611. </span>
  612. <span class="md-nav__icon md-icon"></span>
  613. </label>
  614. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  615. <label class="md-nav__title" for="__nav_3_5">
  616. <span class="md-nav__icon md-icon"></span>
  617. Operations
  618. </label>
  619. <ul class="md-nav__list" data-md-scrollfix>
  620. <li class="md-nav__item">
  621. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  622. <span class="md-ellipsis">
  623. Multi Tenancy
  624. </span>
  625. </a>
  626. </li>
  627. <li class="md-nav__item">
  628. <a href="../../guides/security-best-practices/" class="md-nav__link">
  629. <span class="md-ellipsis">
  630. Security Best Practices
  631. </span>
  632. </a>
  633. </li>
  634. <li class="md-nav__item">
  635. <a href="../../guides/threat-model/" class="md-nav__link">
  636. <span class="md-ellipsis">
  637. Threat Model
  638. </span>
  639. </a>
  640. </li>
  641. <li class="md-nav__item">
  642. <a href="../../guides/v1beta1/" class="md-nav__link">
  643. <span class="md-ellipsis">
  644. Upgrading to v1beta1
  645. </span>
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="../../guides/using-latest-image/" class="md-nav__link">
  650. <span class="md-ellipsis">
  651. Using Latest Image
  652. </span>
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  657. <span class="md-ellipsis">
  658. Disable Cluster Features
  659. </span>
  660. </a>
  661. </li>
  662. </ul>
  663. </nav>
  664. </li>
  665. </ul>
  666. </nav>
  667. </li>
  668. <li class="md-nav__item md-nav__item--nested">
  669. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  670. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  671. <span class="md-ellipsis">
  672. Provider
  673. </span>
  674. <span class="md-nav__icon md-icon"></span>
  675. </label>
  676. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  677. <label class="md-nav__title" for="__nav_4">
  678. <span class="md-nav__icon md-icon"></span>
  679. Provider
  680. </label>
  681. <ul class="md-nav__list" data-md-scrollfix>
  682. <li class="md-nav__item">
  683. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. AWS Secrets Manager
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. AWS Parameter Store
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. Azure Key Vault
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../provider/beyondtrust/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. BeyondTrust
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Bitwarden Secrets Manager
  714. </span>
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../provider/chef/" class="md-nav__link">
  719. <span class="md-ellipsis">
  720. Chef
  721. </span>
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../provider/conjur/" class="md-nav__link">
  726. <span class="md-ellipsis">
  727. CyberArk Conjur
  728. </span>
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../provider/device42/" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. Device42
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. Google Cloud Secret Manager
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. HashiCorp Vault
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../provider/kubernetes/" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. Kubernetes
  756. </span>
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. IBM Secrets Manager
  763. </span>
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../provider/akeyless/" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. Akeyless
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Yandex Certificate Manager
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Yandex Lockbox
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../provider/alibaba/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. Alibaba Cloud
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. GitLab Variables
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../../provider/oracle-vault/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. Oracle Vault
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../../provider/1password-automation/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. 1Password Secrets Automation
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="../../provider/webhook/" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Webhook
  819. </span>
  820. </a>
  821. </li>
  822. <li class="md-nav__item">
  823. <a href="../../provider/fake/" class="md-nav__link">
  824. <span class="md-ellipsis">
  825. Fake
  826. </span>
  827. </a>
  828. </li>
  829. <li class="md-nav__item">
  830. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  831. <span class="md-ellipsis">
  832. senhasegura DevOps Secrets Management (DSM)
  833. </span>
  834. </a>
  835. </li>
  836. <li class="md-nav__item">
  837. <a href="../../provider/doppler/" class="md-nav__link">
  838. <span class="md-ellipsis">
  839. Doppler
  840. </span>
  841. </a>
  842. </li>
  843. <li class="md-nav__item">
  844. <a href="../../provider/keeper-security/" class="md-nav__link">
  845. <span class="md-ellipsis">
  846. Keeper Security
  847. </span>
  848. </a>
  849. </li>
  850. <li class="md-nav__item">
  851. <a href="../../provider/cloak/" class="md-nav__link">
  852. <span class="md-ellipsis">
  853. Cloak End 2 End Encrypted Secrets
  854. </span>
  855. </a>
  856. </li>
  857. <li class="md-nav__item">
  858. <a href="../../provider/scaleway/" class="md-nav__link">
  859. <span class="md-ellipsis">
  860. Scaleway
  861. </span>
  862. </a>
  863. </li>
  864. <li class="md-nav__item">
  865. <a href="../../provider/delinea/" class="md-nav__link">
  866. <span class="md-ellipsis">
  867. Delinea
  868. </span>
  869. </a>
  870. </li>
  871. <li class="md-nav__item">
  872. <a href="../../provider/secretserver/" class="md-nav__link">
  873. <span class="md-ellipsis">
  874. Secret Server
  875. </span>
  876. </a>
  877. </li>
  878. <li class="md-nav__item">
  879. <a href="../../provider/passbolt/" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Passbolt
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="../../provider/pulumi/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Pulumi ESC
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../provider/onboardbase/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. Onboardbase
  896. </span>
  897. </a>
  898. </li>
  899. <li class="md-nav__item">
  900. <a href="../../provider-passworddepot/" class="md-nav__link">
  901. <span class="md-ellipsis">
  902. Password Depot
  903. </span>
  904. </a>
  905. </li>
  906. <li class="md-nav__item">
  907. <a href="../../provider/fortanix/" class="md-nav__link">
  908. <span class="md-ellipsis">
  909. Fortanix
  910. </span>
  911. </a>
  912. </li>
  913. <li class="md-nav__item">
  914. <a href="../../provider/infisical/" class="md-nav__link">
  915. <span class="md-ellipsis">
  916. Infisical
  917. </span>
  918. </a>
  919. </li>
  920. <li class="md-nav__item">
  921. <a href="../../provider/previder/" class="md-nav__link">
  922. <span class="md-ellipsis">
  923. Previder
  924. </span>
  925. </a>
  926. </li>
  927. </ul>
  928. </nav>
  929. </li>
  930. <li class="md-nav__item md-nav__item--nested">
  931. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  932. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  933. <span class="md-ellipsis">
  934. Examples
  935. </span>
  936. <span class="md-nav__icon md-icon"></span>
  937. </label>
  938. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  939. <label class="md-nav__title" for="__nav_5">
  940. <span class="md-nav__icon md-icon"></span>
  941. Examples
  942. </label>
  943. <ul class="md-nav__list" data-md-scrollfix>
  944. <li class="md-nav__item">
  945. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. FluxCD
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. Anchore Engine
  955. </span>
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. Jenkins
  962. </span>
  963. </a>
  964. </li>
  965. <li class="md-nav__item">
  966. <a href="../../examples/bitwarden/" class="md-nav__link">
  967. <span class="md-ellipsis">
  968. BitWarden
  969. </span>
  970. </a>
  971. </li>
  972. </ul>
  973. </nav>
  974. </li>
  975. <li class="md-nav__item md-nav__item--nested">
  976. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  977. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  978. <span class="md-ellipsis">
  979. Community
  980. </span>
  981. <span class="md-nav__icon md-icon"></span>
  982. </label>
  983. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  984. <label class="md-nav__title" for="__nav_6">
  985. <span class="md-nav__icon md-icon"></span>
  986. Community
  987. </label>
  988. <ul class="md-nav__list" data-md-scrollfix>
  989. <li class="md-nav__item md-nav__item--nested">
  990. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  991. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  992. <span class="md-ellipsis">
  993. Contributing
  994. </span>
  995. <span class="md-nav__icon md-icon"></span>
  996. </label>
  997. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  998. <label class="md-nav__title" for="__nav_6_1">
  999. <span class="md-nav__icon md-icon"></span>
  1000. Contributing
  1001. </label>
  1002. <ul class="md-nav__list" data-md-scrollfix>
  1003. <li class="md-nav__item">
  1004. <a href="../../contributing/devguide/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Developer guide
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../../contributing/process/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Contributing Process
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../../contributing/release/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Release Process
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../../contributing/coc/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Code of Conduct
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../../contributing/roadmap/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Roadmap
  1035. </span>
  1036. </a>
  1037. </li>
  1038. </ul>
  1039. </nav>
  1040. </li>
  1041. <li class="md-nav__item md-nav__item--nested">
  1042. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1043. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1044. <span class="md-ellipsis">
  1045. External Resources
  1046. </span>
  1047. <span class="md-nav__icon md-icon"></span>
  1048. </label>
  1049. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1050. <label class="md-nav__title" for="__nav_6_2">
  1051. <span class="md-nav__icon md-icon"></span>
  1052. External Resources
  1053. </label>
  1054. <ul class="md-nav__list" data-md-scrollfix>
  1055. <li class="md-nav__item">
  1056. <a href="../../eso-talks/" class="md-nav__link">
  1057. <span class="md-ellipsis">
  1058. Talks
  1059. </span>
  1060. </a>
  1061. </li>
  1062. <li class="md-nav__item">
  1063. <a href="../../eso-demos/" class="md-nav__link">
  1064. <span class="md-ellipsis">
  1065. Demos
  1066. </span>
  1067. </a>
  1068. </li>
  1069. <li class="md-nav__item">
  1070. <a href="../../eso-blogs/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Blogs
  1073. </span>
  1074. </a>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="../../eso-tools/" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. Tools
  1080. </span>
  1081. </a>
  1082. </li>
  1083. </ul>
  1084. </nav>
  1085. </li>
  1086. </ul>
  1087. </nav>
  1088. </li>
  1089. </ul>
  1090. </nav>
  1091. </div>
  1092. </div>
  1093. </div>
  1094. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1095. <div class="md-sidebar__scrollwrap">
  1096. <div class="md-sidebar__inner">
  1097. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1098. <label class="md-nav__title" for="__toc">
  1099. <span class="md-nav__icon md-icon"></span>
  1100. Table of contents
  1101. </label>
  1102. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1103. <li class="md-nav__item">
  1104. <a href="#template" class="md-nav__link">
  1105. <span class="md-ellipsis">
  1106. Template
  1107. </span>
  1108. </a>
  1109. </li>
  1110. <li class="md-nav__item">
  1111. <a href="#update-behavior" class="md-nav__link">
  1112. <span class="md-ellipsis">
  1113. Update Behavior
  1114. </span>
  1115. </a>
  1116. </li>
  1117. <li class="md-nav__item">
  1118. <a href="#features" class="md-nav__link">
  1119. <span class="md-ellipsis">
  1120. Features
  1121. </span>
  1122. </a>
  1123. </li>
  1124. <li class="md-nav__item">
  1125. <a href="#example" class="md-nav__link">
  1126. <span class="md-ellipsis">
  1127. Example
  1128. </span>
  1129. </a>
  1130. </li>
  1131. </ul>
  1132. </nav>
  1133. </div>
  1134. </div>
  1135. </div>
  1136. <div class="md-content" data-md-component="content">
  1137. <article class="md-content__inner md-typeset">
  1138. <h1>ExternalSecret</h1>
  1139. <p>The <code>ExternalSecret</code> describes what data should be fetched, how the data should
  1140. be transformed and saved as a <code>Kind=Secret</code>:</p>
  1141. <ul>
  1142. <li>tells the operator what secrets should be synced by using <code>spec.data</code> to
  1143. explicitly sync individual keys or use <code>spec.dataFrom</code> to get <strong>all values</strong>
  1144. from the external API.</li>
  1145. <li>you can specify how the secret should look like by specifying a
  1146. <code>spec.target.template</code></li>
  1147. </ul>
  1148. <h2 id="template">Template</h2>
  1149. <p>When the controller reconciles the <code>ExternalSecret</code> it will use the <code>spec.template</code> as a blueprint to construct a new <code>Kind=Secret</code>. You can use golang templates to define the blueprint and use template functions to transform secret values. You can also pull in <code>ConfigMaps</code> that contain golang-template data using <code>templateFrom</code>. See <a href="../../guides/templating/">advanced templating</a> for details.</p>
  1150. <h2 id="update-behavior">Update Behavior</h2>
  1151. <p>The <code>Kind=Secret</code> is updated when:</p>
  1152. <ul>
  1153. <li>the <code>spec.refreshInterval</code> has passed and is not <code>0</code></li>
  1154. <li>the <code>ExternalSecret</code>'s <code>labels</code> or <code>annotations</code> are changed</li>
  1155. <li>the <code>ExternalSecret</code>'s <code>spec</code> has been changed</li>
  1156. </ul>
  1157. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client:</p>
  1158. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  1159. </code></pre></div>
  1160. <h2 id="features">Features</h2>
  1161. <p>Individual features are described in the <a href="../../guides/introduction/">Guides section</a>:</p>
  1162. <ul>
  1163. <li><a href="../../guides/getallsecrets/">Find many secrets / Extract from structured data</a></li>
  1164. <li><a href="../../guides/templating/">Templating</a></li>
  1165. <li><a href="../../guides/generator/">Using Generators</a></li>
  1166. <li><a href="../../guides/ownership-deletion-policy/">Secret Ownership and Deletion</a></li>
  1167. <li><a href="../../guides/datafrom-rewrite/">Key Rewriting</a></li>
  1168. <li><a href="../../guides/decoding-strategy/">Decoding Strategy</a></li>
  1169. </ul>
  1170. <h2 id="example">Example</h2>
  1171. <p>Take a look at an annotated example to understand the design behind the
  1172. <code>ExternalSecret</code>.</p>
  1173. <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>
  1174. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1175. <span class="nt">metadata</span><span class="p">:</span>
  1176. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;hello-world&quot;</span>
  1177. <span class="w"> </span><span class="c1"># labels and annotations are copied over to the</span>
  1178. <span class="w"> </span><span class="c1"># secret that will be created</span>
  1179. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1180. <span class="w"> </span><span class="nt">acme.org/owned-by</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;q-team&quot;</span>
  1181. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1182. <span class="w"> </span><span class="nt">acme.org/sha</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1234</span>
  1183. <span class="nt">spec</span><span class="p">:</span>
  1184. <span class="w"> </span><span class="c1"># Optional, SecretStoreRef defines the default SecretStore to use when fetching the secret data.</span>
  1185. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1186. <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-store</span>
  1187. <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><span class="w"> </span><span class="c1"># or ClusterSecretStore</span>
  1188. <span class="w"> </span><span class="c1"># RefreshInterval is the amount of time before the values reading again from the SecretStore provider</span>
  1189. <span class="w"> </span><span class="c1"># Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot; (from time.ParseDuration)</span>
  1190. <span class="w"> </span><span class="c1"># May be set to zero to fetch and create it once</span>
  1191. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1h&quot;</span>
  1192. <span class="w"> </span><span class="c1"># the target describes the secret that shall be created</span>
  1193. <span class="w"> </span><span class="c1"># there can only be one target per ExternalSecret</span>
  1194. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1195. <span class="w"> </span><span class="c1"># The secret name of the resource</span>
  1196. <span class="w"> </span><span class="c1"># Defaults to .metadata.name of the ExternalSecret</span>
  1197. <span class="w"> </span><span class="c1"># It is immutable</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">application-config</span>
  1199. <span class="w"> </span><span class="c1"># Specifies the ExternalSecret ownership details in the created Secret. Options:</span>
  1200. <span class="w"> </span><span class="c1"># - Owner: (default) Creates the Secret and sets .metadata.ownerReferences. If the ExternalSecret is deleted, the Secret will also be deleted.</span>
  1201. <span class="w"> </span><span class="c1"># - Merge: Does not create the Secret but merges data fields into the existing Secret (expects the Secret to already exist).</span>
  1202. <span class="w"> </span><span class="c1"># - Orphan: Creates the Secret but does not set .metadata.ownerReferences. If the Secret already exists, it will be updated.</span>
  1203. <span class="w"> </span><span class="c1"># - None: Does not create or update the Secret (reserved for future use with injector).</span>
  1204. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Merge</span>
  1205. <span class="w"> </span><span class="c1"># Specifies what happens to the Secret when data fields are deleted from the provider (e.g., Vault, AWS Parameter Store). Options:</span>
  1206. <span class="w"> </span><span class="c1"># - Retain: (default) Retains the Secret if all Secret data fields have been deleted from the provider.</span>
  1207. <span class="w"> </span><span class="c1"># - Delete: Removes the Secret if all Secret data fields from the provider are deleted.</span>
  1208. <span class="w"> </span><span class="c1"># - Merge: Removes keys from the Secret but not the Secret itself.</span>
  1209. <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">Retain</span>
  1210. <span class="w"> </span><span class="c1"># Specify a blueprint for the resulting Kind=Secret</span>
  1211. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1212. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubernetes.io/dockerconfigjson</span><span class="w"> </span><span class="c1"># or TLS...</span>
  1213. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1214. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
  1215. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
  1216. <span class="w"> </span><span class="c1"># Use inline templates to construct your desired config file that contains your secret</span>
  1217. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1218. <span class="w"> </span><span class="nt">config.yml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1219. <span class="w"> </span><span class="no">database:</span>
  1220. <span class="w"> </span><span class="no">connection: postgres://{{ .username }}:{{ .password }}@{{ .database_host }}:5432/payments</span>
  1221. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span>
  1222. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span>
  1223. <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>
  1224. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1225. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1226. <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>
  1227. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1228. <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>
  1229. <span class="w"> </span><span class="c1"># Data defines the connection between the Kubernetes Secret keys and the Provider data</span>
  1230. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1231. <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">username</span>
  1232. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1233. <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>
  1234. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1235. <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">username</span>
  1236. <span class="w"> </span><span class="nt">decodingStrategy</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"># can be None, Base64, Base64URL or Auto</span>
  1237. <span class="w"> </span><span class="c1"># define the source of the secret. Can be a SecretStore or a Generator kind</span>
  1238. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1239. <span class="w"> </span><span class="c1"># point to a SecretStore that should be used to fetch a secret.</span>
  1240. <span class="w"> </span><span class="c1"># must be defined if no spec.secretStoreRef is defined.</span>
  1241. <span class="w"> </span><span class="nt">storeRef</span><span class="p">:</span>
  1242. <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-secretstore</span>
  1243. <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">ClusterSecretStore</span>
  1244. <span class="w"> </span><span class="c1"># Used to fetch all properties from the Provider key</span>
  1245. <span class="w"> </span><span class="c1"># If multiple dataFrom are specified, secrets are merged in the specified order</span>
  1246. <span class="w"> </span><span class="c1"># Can be defined using sourceRef.generatorRef or extract / find</span>
  1247. <span class="w"> </span><span class="c1"># Both use cases are exemplified below</span>
  1248. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1249. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1250. <span class="w"> </span><span class="nt">generatorRef</span><span class="p">:</span>
  1251. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">generators.external-secrets.io/v1alpha1</span>
  1252. <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">ECRAuthorizationToken</span>
  1253. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-ecr&quot;</span>
  1254. <span class="w"> </span><span class="c1">#Or</span>
  1255. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1256. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1257. <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>
  1258. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1259. <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">data</span>
  1260. <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">Default</span>
  1261. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Auto</span>
  1262. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1263. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1264. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;exp-(.*?)-ression&quot;</span>
  1265. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;rewriting-${1}-with-groups&quot;</span>
  1266. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span>
  1267. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path-to-filter</span>
  1268. <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
  1269. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;.*foobar.*&quot;</span>
  1270. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
  1271. <span class="w"> </span><span class="nt">foo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bar</span>
  1272. <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">Unicode</span>
  1273. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Base64</span>
  1274. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1275. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1276. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
  1277. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
  1278. <span class="nt">status</span><span class="p">:</span>
  1279. <span class="w"> </span><span class="c1"># refreshTime is the time and date the external secret was fetched and</span>
  1280. <span class="w"> </span><span class="c1"># the target secret updated</span>
  1281. <span class="w"> </span><span class="nt">refreshTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span>
  1282. <span class="w"> </span><span class="c1"># Standard condition schema</span>
  1283. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  1284. <span class="w"> </span><span class="c1"># ExternalSecret ready condition indicates the secret is ready for use.</span>
  1285. <span class="w"> </span><span class="c1"># This is defined as:</span>
  1286. <span class="w"> </span><span class="c1"># - The target secret exists</span>
  1287. <span class="w"> </span><span class="c1"># - The target secret has been refreshed within the last refreshInterval</span>
  1288. <span class="w"> </span><span class="c1"># - The target secret content is up-to-date based on any target templates</span>
  1289. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Ready</span>
  1290. <span class="w"> </span><span class="nt">status</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;True&quot;</span><span class="w"> </span><span class="c1"># False if last refresh was not successful</span>
  1291. <span class="w"> </span><span class="nt">reason</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecretSynced&quot;</span>
  1292. <span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Secret</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">synced&quot;</span>
  1293. <span class="w"> </span><span class="nt">lastTransitionTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span>
  1294. </code></pre></div>
  1295. </article>
  1296. </div>
  1297. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1298. </div>
  1299. </main>
  1300. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1301. <footer class="md-footer">
  1302. <div class="md-footer-meta md-typeset">
  1303. <div class="md-footer-meta__inner md-grid">
  1304. <div class="md-copyright">
  1305. <div class="md-copyright__highlight">
  1306. &copy; 2024 The external-secrets Authors.<br/>
  1307. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1308. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1309. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1310. </div>
  1311. Made with
  1312. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1313. Material for MkDocs
  1314. </a>
  1315. </div>
  1316. </div>
  1317. </div>
  1318. </footer>
  1319. </div>
  1320. <div class="md-dialog" data-md-component="dialog">
  1321. <div class="md-dialog__inner md-typeset"></div>
  1322. </div>
  1323. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.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>
  1324. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  1325. </body>
  1326. </html>