index.html 87 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315
  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.6.14">
  10. <title>ExternalSecret - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.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]"),base=new URL("../.."),outdated=__md_get("__outdated",sessionStorage,base);!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.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.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.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.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/glossary/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Glossary
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/prerequisites/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. Prerequisites
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/getting-started/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Getting started
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/faq/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. FAQ
  227. </span>
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../../introduction/stability-support/" class="md-nav__link">
  232. <span class="md-ellipsis">
  233. Stability and Support
  234. </span>
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  239. <span class="md-ellipsis">
  240. Deprecation Policy
  241. </span>
  242. </a>
  243. </li>
  244. </ul>
  245. </nav>
  246. </li>
  247. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  248. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  249. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  250. <span class="md-ellipsis">
  251. API
  252. </span>
  253. <span class="md-nav__icon md-icon"></span>
  254. </label>
  255. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  256. <label class="md-nav__title" for="__nav_2">
  257. <span class="md-nav__icon md-icon"></span>
  258. API
  259. </label>
  260. <ul class="md-nav__list" data-md-scrollfix>
  261. <li class="md-nav__item">
  262. <a href="../components/" class="md-nav__link">
  263. <span class="md-ellipsis">
  264. Components
  265. </span>
  266. </a>
  267. </li>
  268. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2" checked>
  270. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  271. <span class="md-ellipsis">
  272. Core Resources
  273. </span>
  274. <span class="md-nav__icon md-icon"></span>
  275. </label>
  276. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="true">
  277. <label class="md-nav__title" for="__nav_2_2">
  278. <span class="md-nav__icon md-icon"></span>
  279. Core Resources
  280. </label>
  281. <ul class="md-nav__list" data-md-scrollfix>
  282. <li class="md-nav__item md-nav__item--active">
  283. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  284. <label class="md-nav__link md-nav__link--active" for="__toc">
  285. <span class="md-ellipsis">
  286. ExternalSecret
  287. </span>
  288. <span class="md-nav__icon md-icon"></span>
  289. </label>
  290. <a href="./" class="md-nav__link md-nav__link--active">
  291. <span class="md-ellipsis">
  292. ExternalSecret
  293. </span>
  294. </a>
  295. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  296. <label class="md-nav__title" for="__toc">
  297. <span class="md-nav__icon md-icon"></span>
  298. Table of contents
  299. </label>
  300. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  301. <li class="md-nav__item">
  302. <a href="#template" class="md-nav__link">
  303. <span class="md-ellipsis">
  304. Template
  305. </span>
  306. </a>
  307. </li>
  308. <li class="md-nav__item">
  309. <a href="#update-behavior-with-3-different-refresh-policies" class="md-nav__link">
  310. <span class="md-ellipsis">
  311. Update behavior with 3 different refresh policies
  312. </span>
  313. </a>
  314. <nav class="md-nav" aria-label="Update behavior with 3 different refresh policies">
  315. <ul class="md-nav__list">
  316. <li class="md-nav__item">
  317. <a href="#createdonce" class="md-nav__link">
  318. <span class="md-ellipsis">
  319. CreatedOnce
  320. </span>
  321. </a>
  322. </li>
  323. <li class="md-nav__item">
  324. <a href="#periodic" class="md-nav__link">
  325. <span class="md-ellipsis">
  326. Periodic
  327. </span>
  328. </a>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="#onchange" class="md-nav__link">
  332. <span class="md-ellipsis">
  333. OnChange
  334. </span>
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. <li class="md-nav__item">
  341. <a href="#manual-refresh" class="md-nav__link">
  342. <span class="md-ellipsis">
  343. Manual Refresh
  344. </span>
  345. </a>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="#features" class="md-nav__link">
  349. <span class="md-ellipsis">
  350. Features
  351. </span>
  352. </a>
  353. </li>
  354. <li class="md-nav__item">
  355. <a href="#example" class="md-nav__link">
  356. <span class="md-ellipsis">
  357. Example
  358. </span>
  359. </a>
  360. </li>
  361. </ul>
  362. </nav>
  363. </li>
  364. <li class="md-nav__item">
  365. <a href="../secretstore/" class="md-nav__link">
  366. <span class="md-ellipsis">
  367. SecretStore
  368. </span>
  369. </a>
  370. </li>
  371. <li class="md-nav__item">
  372. <a href="../clustersecretstore/" class="md-nav__link">
  373. <span class="md-ellipsis">
  374. ClusterSecretStore
  375. </span>
  376. </a>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="../clusterexternalsecret/" class="md-nav__link">
  380. <span class="md-ellipsis">
  381. ClusterExternalSecret
  382. </span>
  383. </a>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../clusterpushsecret/" class="md-nav__link">
  387. <span class="md-ellipsis">
  388. ClusterPushSecret
  389. </span>
  390. </a>
  391. </li>
  392. <li class="md-nav__item">
  393. <a href="../pushsecret/" class="md-nav__link">
  394. <span class="md-ellipsis">
  395. PushSecret
  396. </span>
  397. </a>
  398. </li>
  399. </ul>
  400. </nav>
  401. </li>
  402. <li class="md-nav__item md-nav__item--nested">
  403. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  404. <div class="md-nav__link md-nav__container">
  405. <a href="../generator/" class="md-nav__link ">
  406. <span class="md-ellipsis">
  407. Generators
  408. </span>
  409. </a>
  410. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  411. <span class="md-nav__icon md-icon"></span>
  412. </label>
  413. </div>
  414. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  415. <label class="md-nav__title" for="__nav_2_3">
  416. <span class="md-nav__icon md-icon"></span>
  417. Generators
  418. </label>
  419. <ul class="md-nav__list" data-md-scrollfix>
  420. <li class="md-nav__item">
  421. <a href="../generator/acr/" class="md-nav__link">
  422. <span class="md-ellipsis">
  423. Azure Container Registry
  424. </span>
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="../generator/ecr/" class="md-nav__link">
  429. <span class="md-ellipsis">
  430. AWS Elastic Container Registry
  431. </span>
  432. </a>
  433. </li>
  434. <li class="md-nav__item">
  435. <a href="../generator/sts/" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. AWS STS Session Token
  438. </span>
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../generator/cluster/" class="md-nav__link">
  443. <span class="md-ellipsis">
  444. Cluster Generator
  445. </span>
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../generator/gcr/" class="md-nav__link">
  450. <span class="md-ellipsis">
  451. Google Container Registry
  452. </span>
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../generator/quay/" class="md-nav__link">
  457. <span class="md-ellipsis">
  458. Quay
  459. </span>
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../generator/vault/" class="md-nav__link">
  464. <span class="md-ellipsis">
  465. Vault Dynamic Secret
  466. </span>
  467. </a>
  468. </li>
  469. <li class="md-nav__item">
  470. <a href="../generator/password/" class="md-nav__link">
  471. <span class="md-ellipsis">
  472. Password
  473. </span>
  474. </a>
  475. </li>
  476. <li class="md-nav__item">
  477. <a href="../generator/fake/" class="md-nav__link">
  478. <span class="md-ellipsis">
  479. Fake
  480. </span>
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="../generator/webhook/" class="md-nav__link">
  485. <span class="md-ellipsis">
  486. Webhook
  487. </span>
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../generator/github/" class="md-nav__link">
  492. <span class="md-ellipsis">
  493. Github
  494. </span>
  495. </a>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="../generator/uuid/" class="md-nav__link">
  499. <span class="md-ellipsis">
  500. UUID
  501. </span>
  502. </a>
  503. </li>
  504. </ul>
  505. </nav>
  506. </li>
  507. <li class="md-nav__item md-nav__item--nested">
  508. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  509. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  510. <span class="md-ellipsis">
  511. Reference Docs
  512. </span>
  513. <span class="md-nav__icon md-icon"></span>
  514. </label>
  515. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  516. <label class="md-nav__title" for="__nav_2_4">
  517. <span class="md-nav__icon md-icon"></span>
  518. Reference Docs
  519. </label>
  520. <ul class="md-nav__list" data-md-scrollfix>
  521. <li class="md-nav__item">
  522. <a href="../spec/" class="md-nav__link">
  523. <span class="md-ellipsis">
  524. API specification
  525. </span>
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../controller-options/" class="md-nav__link">
  530. <span class="md-ellipsis">
  531. Controller Options
  532. </span>
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../metrics/" class="md-nav__link">
  537. <span class="md-ellipsis">
  538. Metrics
  539. </span>
  540. </a>
  541. </li>
  542. </ul>
  543. </nav>
  544. </li>
  545. </ul>
  546. </nav>
  547. </li>
  548. <li class="md-nav__item md-nav__item--nested">
  549. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  550. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  551. <span class="md-ellipsis">
  552. Guides
  553. </span>
  554. <span class="md-nav__icon md-icon"></span>
  555. </label>
  556. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  557. <label class="md-nav__title" for="__nav_3">
  558. <span class="md-nav__icon md-icon"></span>
  559. Guides
  560. </label>
  561. <ul class="md-nav__list" data-md-scrollfix>
  562. <li class="md-nav__item">
  563. <a href="../../guides/introduction/" class="md-nav__link">
  564. <span class="md-ellipsis">
  565. Introduction
  566. </span>
  567. </a>
  568. </li>
  569. <li class="md-nav__item md-nav__item--nested">
  570. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  571. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  572. <span class="md-ellipsis">
  573. External Secrets
  574. </span>
  575. <span class="md-nav__icon md-icon"></span>
  576. </label>
  577. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  578. <label class="md-nav__title" for="__nav_3_2">
  579. <span class="md-nav__icon md-icon"></span>
  580. External Secrets
  581. </label>
  582. <ul class="md-nav__list" data-md-scrollfix>
  583. <li class="md-nav__item">
  584. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  585. <span class="md-ellipsis">
  586. Extract structured data
  587. </span>
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="../../guides/getallsecrets/" class="md-nav__link">
  592. <span class="md-ellipsis">
  593. Find Secrets by Name or Metadata
  594. </span>
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  599. <span class="md-ellipsis">
  600. Rewriting Keys
  601. </span>
  602. </a>
  603. </li>
  604. <li class="md-nav__item md-nav__item--nested">
  605. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  606. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  607. <span class="md-ellipsis">
  608. Advanced Templating
  609. </span>
  610. <span class="md-nav__icon md-icon"></span>
  611. </label>
  612. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  613. <label class="md-nav__title" for="__nav_3_2_4">
  614. <span class="md-nav__icon md-icon"></span>
  615. Advanced Templating
  616. </label>
  617. <ul class="md-nav__list" data-md-scrollfix>
  618. <li class="md-nav__item">
  619. <a href="../../guides/templating/" class="md-nav__link">
  620. <span class="md-ellipsis">
  621. v2
  622. </span>
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="../../guides/templating-v1/" class="md-nav__link">
  627. <span class="md-ellipsis">
  628. v1
  629. </span>
  630. </a>
  631. </li>
  632. </ul>
  633. </nav>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  637. <span class="md-ellipsis">
  638. Kubernetes Secret Types
  639. </span>
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  644. <span class="md-ellipsis">
  645. Lifecycle: ownership & deletion
  646. </span>
  647. </a>
  648. </li>
  649. <li class="md-nav__item">
  650. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  651. <span class="md-ellipsis">
  652. Decoding Strategies
  653. </span>
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../../guides/controller-class/" class="md-nav__link">
  658. <span class="md-ellipsis">
  659. Controller Classes
  660. </span>
  661. </a>
  662. </li>
  663. </ul>
  664. </nav>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="../../guides/generator/" class="md-nav__link">
  668. <span class="md-ellipsis">
  669. Generators
  670. </span>
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="../../guides/pushsecrets/" class="md-nav__link">
  675. <span class="md-ellipsis">
  676. Push Secrets
  677. </span>
  678. </a>
  679. </li>
  680. <li class="md-nav__item md-nav__item--nested">
  681. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  682. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  683. <span class="md-ellipsis">
  684. Operations
  685. </span>
  686. <span class="md-nav__icon md-icon"></span>
  687. </label>
  688. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  689. <label class="md-nav__title" for="__nav_3_5">
  690. <span class="md-nav__icon md-icon"></span>
  691. Operations
  692. </label>
  693. <ul class="md-nav__list" data-md-scrollfix>
  694. <li class="md-nav__item">
  695. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  696. <span class="md-ellipsis">
  697. Multi Tenancy
  698. </span>
  699. </a>
  700. </li>
  701. <li class="md-nav__item">
  702. <a href="../../guides/security-best-practices/" class="md-nav__link">
  703. <span class="md-ellipsis">
  704. Security Best Practices
  705. </span>
  706. </a>
  707. </li>
  708. <li class="md-nav__item">
  709. <a href="../../guides/threat-model/" class="md-nav__link">
  710. <span class="md-ellipsis">
  711. Threat Model
  712. </span>
  713. </a>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="../../guides/v1beta1/" class="md-nav__link">
  717. <span class="md-ellipsis">
  718. Upgrading to v1beta1
  719. </span>
  720. </a>
  721. </li>
  722. <li class="md-nav__item">
  723. <a href="../../guides/using-latest-image/" class="md-nav__link">
  724. <span class="md-ellipsis">
  725. Using Latest Image
  726. </span>
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  731. <span class="md-ellipsis">
  732. Disable Cluster Features
  733. </span>
  734. </a>
  735. </li>
  736. </ul>
  737. </nav>
  738. </li>
  739. <li class="md-nav__item md-nav__item--nested">
  740. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  741. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  742. <span class="md-ellipsis">
  743. Tooling
  744. </span>
  745. <span class="md-nav__icon md-icon"></span>
  746. </label>
  747. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  748. <label class="md-nav__title" for="__nav_3_6">
  749. <span class="md-nav__icon md-icon"></span>
  750. Tooling
  751. </label>
  752. <ul class="md-nav__list" data-md-scrollfix>
  753. <li class="md-nav__item">
  754. <a href="../../guides/using-esoctl-tool/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Using the esoctl tool
  757. </span>
  758. </a>
  759. </li>
  760. </ul>
  761. </nav>
  762. </li>
  763. </ul>
  764. </nav>
  765. </li>
  766. <li class="md-nav__item md-nav__item--nested">
  767. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  768. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  769. <span class="md-ellipsis">
  770. Provider
  771. </span>
  772. <span class="md-nav__icon md-icon"></span>
  773. </label>
  774. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  775. <label class="md-nav__title" for="__nav_4">
  776. <span class="md-nav__icon md-icon"></span>
  777. Provider
  778. </label>
  779. <ul class="md-nav__list" data-md-scrollfix>
  780. <li class="md-nav__item">
  781. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. AWS Secrets Manager
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. AWS Parameter Store
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. Azure Key Vault
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../../provider/beyondtrust/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. BeyondTrust
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. Bitwarden Secrets Manager
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="../../provider/chef/" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Chef
  819. </span>
  820. </a>
  821. </li>
  822. <li class="md-nav__item">
  823. <a href="../../provider/cloudru/" class="md-nav__link">
  824. <span class="md-ellipsis">
  825. Cloud.ru Secret Manager
  826. </span>
  827. </a>
  828. </li>
  829. <li class="md-nav__item">
  830. <a href="../../provider/conjur/" class="md-nav__link">
  831. <span class="md-ellipsis">
  832. CyberArk Conjur
  833. </span>
  834. </a>
  835. </li>
  836. <li class="md-nav__item">
  837. <a href="../../provider/device42/" class="md-nav__link">
  838. <span class="md-ellipsis">
  839. Device42
  840. </span>
  841. </a>
  842. </li>
  843. <li class="md-nav__item">
  844. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  845. <span class="md-ellipsis">
  846. Google Cloud Secret Manager
  847. </span>
  848. </a>
  849. </li>
  850. <li class="md-nav__item">
  851. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  852. <span class="md-ellipsis">
  853. HashiCorp Vault
  854. </span>
  855. </a>
  856. </li>
  857. <li class="md-nav__item">
  858. <a href="../../provider/kubernetes/" class="md-nav__link">
  859. <span class="md-ellipsis">
  860. Kubernetes
  861. </span>
  862. </a>
  863. </li>
  864. <li class="md-nav__item">
  865. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  866. <span class="md-ellipsis">
  867. IBM Secrets Manager
  868. </span>
  869. </a>
  870. </li>
  871. <li class="md-nav__item">
  872. <a href="../../provider/akeyless/" class="md-nav__link">
  873. <span class="md-ellipsis">
  874. Akeyless
  875. </span>
  876. </a>
  877. </li>
  878. <li class="md-nav__item">
  879. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Yandex Certificate Manager
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Yandex Lockbox
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../provider/alibaba/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. Alibaba Cloud
  896. </span>
  897. </a>
  898. </li>
  899. <li class="md-nav__item">
  900. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  901. <span class="md-ellipsis">
  902. GitLab Variables
  903. </span>
  904. </a>
  905. </li>
  906. <li class="md-nav__item">
  907. <a href="../../provider/github/" class="md-nav__link">
  908. <span class="md-ellipsis">
  909. Github Actions Secrets
  910. </span>
  911. </a>
  912. </li>
  913. <li class="md-nav__item">
  914. <a href="../../provider/oracle-vault/" class="md-nav__link">
  915. <span class="md-ellipsis">
  916. Oracle Vault
  917. </span>
  918. </a>
  919. </li>
  920. <li class="md-nav__item">
  921. <a href="../../provider/1password-automation/" class="md-nav__link">
  922. <span class="md-ellipsis">
  923. 1Password Connect Server
  924. </span>
  925. </a>
  926. </li>
  927. <li class="md-nav__item">
  928. <a href="../../provider/1password-sdk/" class="md-nav__link">
  929. <span class="md-ellipsis">
  930. 1Password SDK
  931. </span>
  932. </a>
  933. </li>
  934. <li class="md-nav__item">
  935. <a href="../../provider/webhook/" class="md-nav__link">
  936. <span class="md-ellipsis">
  937. Webhook
  938. </span>
  939. </a>
  940. </li>
  941. <li class="md-nav__item">
  942. <a href="../../provider/fake/" class="md-nav__link">
  943. <span class="md-ellipsis">
  944. Fake
  945. </span>
  946. </a>
  947. </li>
  948. <li class="md-nav__item">
  949. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  950. <span class="md-ellipsis">
  951. senhasegura DevOps Secrets Management (DSM)
  952. </span>
  953. </a>
  954. </li>
  955. <li class="md-nav__item">
  956. <a href="../../provider/doppler/" class="md-nav__link">
  957. <span class="md-ellipsis">
  958. Doppler
  959. </span>
  960. </a>
  961. </li>
  962. <li class="md-nav__item">
  963. <a href="../../provider/keeper-security/" class="md-nav__link">
  964. <span class="md-ellipsis">
  965. Keeper Security
  966. </span>
  967. </a>
  968. </li>
  969. <li class="md-nav__item">
  970. <a href="../../provider/cloak/" class="md-nav__link">
  971. <span class="md-ellipsis">
  972. Cloak End 2 End Encrypted Secrets
  973. </span>
  974. </a>
  975. </li>
  976. <li class="md-nav__item">
  977. <a href="../../provider/scaleway/" class="md-nav__link">
  978. <span class="md-ellipsis">
  979. Scaleway
  980. </span>
  981. </a>
  982. </li>
  983. <li class="md-nav__item">
  984. <a href="../../provider/delinea/" class="md-nav__link">
  985. <span class="md-ellipsis">
  986. Delinea
  987. </span>
  988. </a>
  989. </li>
  990. <li class="md-nav__item">
  991. <a href="../../provider/secretserver/" class="md-nav__link">
  992. <span class="md-ellipsis">
  993. Secret Server
  994. </span>
  995. </a>
  996. </li>
  997. <li class="md-nav__item">
  998. <a href="../../provider/passbolt/" class="md-nav__link">
  999. <span class="md-ellipsis">
  1000. Passbolt
  1001. </span>
  1002. </a>
  1003. </li>
  1004. <li class="md-nav__item">
  1005. <a href="../../provider/pulumi/" class="md-nav__link">
  1006. <span class="md-ellipsis">
  1007. Pulumi ESC
  1008. </span>
  1009. </a>
  1010. </li>
  1011. <li class="md-nav__item">
  1012. <a href="../../provider/onboardbase/" class="md-nav__link">
  1013. <span class="md-ellipsis">
  1014. Onboardbase
  1015. </span>
  1016. </a>
  1017. </li>
  1018. <li class="md-nav__item">
  1019. <a href="../../provider-passworddepot/" class="md-nav__link">
  1020. <span class="md-ellipsis">
  1021. Password Depot
  1022. </span>
  1023. </a>
  1024. </li>
  1025. <li class="md-nav__item">
  1026. <a href="../../provider/fortanix/" class="md-nav__link">
  1027. <span class="md-ellipsis">
  1028. Fortanix
  1029. </span>
  1030. </a>
  1031. </li>
  1032. <li class="md-nav__item">
  1033. <a href="../../provider/infisical/" class="md-nav__link">
  1034. <span class="md-ellipsis">
  1035. Infisical
  1036. </span>
  1037. </a>
  1038. </li>
  1039. <li class="md-nav__item">
  1040. <a href="../../provider/previder/" class="md-nav__link">
  1041. <span class="md-ellipsis">
  1042. Previder
  1043. </span>
  1044. </a>
  1045. </li>
  1046. <li class="md-nav__item">
  1047. <a href="../../provider/openbao/" class="md-nav__link">
  1048. <span class="md-ellipsis">
  1049. OpenBao
  1050. </span>
  1051. </a>
  1052. </li>
  1053. </ul>
  1054. </nav>
  1055. </li>
  1056. <li class="md-nav__item md-nav__item--nested">
  1057. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1058. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1059. <span class="md-ellipsis">
  1060. Examples
  1061. </span>
  1062. <span class="md-nav__icon md-icon"></span>
  1063. </label>
  1064. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1065. <label class="md-nav__title" for="__nav_5">
  1066. <span class="md-nav__icon md-icon"></span>
  1067. Examples
  1068. </label>
  1069. <ul class="md-nav__list" data-md-scrollfix>
  1070. <li class="md-nav__item">
  1071. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1072. <span class="md-ellipsis">
  1073. FluxCD
  1074. </span>
  1075. </a>
  1076. </li>
  1077. <li class="md-nav__item">
  1078. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1079. <span class="md-ellipsis">
  1080. Anchore Engine
  1081. </span>
  1082. </a>
  1083. </li>
  1084. <li class="md-nav__item">
  1085. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1086. <span class="md-ellipsis">
  1087. Jenkins
  1088. </span>
  1089. </a>
  1090. </li>
  1091. <li class="md-nav__item">
  1092. <a href="../../examples/bitwarden/" class="md-nav__link">
  1093. <span class="md-ellipsis">
  1094. Bitwarden
  1095. </span>
  1096. </a>
  1097. </li>
  1098. </ul>
  1099. </nav>
  1100. </li>
  1101. <li class="md-nav__item md-nav__item--nested">
  1102. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1103. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1104. <span class="md-ellipsis">
  1105. Community
  1106. </span>
  1107. <span class="md-nav__icon md-icon"></span>
  1108. </label>
  1109. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1110. <label class="md-nav__title" for="__nav_6">
  1111. <span class="md-nav__icon md-icon"></span>
  1112. Community
  1113. </label>
  1114. <ul class="md-nav__list" data-md-scrollfix>
  1115. <li class="md-nav__item md-nav__item--nested">
  1116. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1117. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1118. <span class="md-ellipsis">
  1119. Contributing
  1120. </span>
  1121. <span class="md-nav__icon md-icon"></span>
  1122. </label>
  1123. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1124. <label class="md-nav__title" for="__nav_6_1">
  1125. <span class="md-nav__icon md-icon"></span>
  1126. Contributing
  1127. </label>
  1128. <ul class="md-nav__list" data-md-scrollfix>
  1129. <li class="md-nav__item">
  1130. <a href="../../contributing/devguide/" class="md-nav__link">
  1131. <span class="md-ellipsis">
  1132. Developer guide
  1133. </span>
  1134. </a>
  1135. </li>
  1136. <li class="md-nav__item">
  1137. <a href="../../contributing/process/" class="md-nav__link">
  1138. <span class="md-ellipsis">
  1139. Contributing Process
  1140. </span>
  1141. </a>
  1142. </li>
  1143. <li class="md-nav__item">
  1144. <a href="../../contributing/release/" class="md-nav__link">
  1145. <span class="md-ellipsis">
  1146. Release Process
  1147. </span>
  1148. </a>
  1149. </li>
  1150. <li class="md-nav__item">
  1151. <a href="../../contributing/coc/" class="md-nav__link">
  1152. <span class="md-ellipsis">
  1153. Code of Conduct
  1154. </span>
  1155. </a>
  1156. </li>
  1157. <li class="md-nav__item">
  1158. <a href="../../contributing/calendar/" class="md-nav__link">
  1159. <span class="md-ellipsis">
  1160. Community meetings calendar
  1161. </span>
  1162. </a>
  1163. </li>
  1164. <li class="md-nav__item">
  1165. <a href="../../contributing/roadmap/" class="md-nav__link">
  1166. <span class="md-ellipsis">
  1167. Roadmap
  1168. </span>
  1169. </a>
  1170. </li>
  1171. </ul>
  1172. </nav>
  1173. </li>
  1174. <li class="md-nav__item md-nav__item--nested">
  1175. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1176. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1177. <span class="md-ellipsis">
  1178. External Resources
  1179. </span>
  1180. <span class="md-nav__icon md-icon"></span>
  1181. </label>
  1182. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1183. <label class="md-nav__title" for="__nav_6_2">
  1184. <span class="md-nav__icon md-icon"></span>
  1185. External Resources
  1186. </label>
  1187. <ul class="md-nav__list" data-md-scrollfix>
  1188. <li class="md-nav__item">
  1189. <a href="../../eso-talks/" class="md-nav__link">
  1190. <span class="md-ellipsis">
  1191. Talks
  1192. </span>
  1193. </a>
  1194. </li>
  1195. <li class="md-nav__item">
  1196. <a href="../../eso-demos/" class="md-nav__link">
  1197. <span class="md-ellipsis">
  1198. Demos
  1199. </span>
  1200. </a>
  1201. </li>
  1202. <li class="md-nav__item">
  1203. <a href="../../eso-blogs/" class="md-nav__link">
  1204. <span class="md-ellipsis">
  1205. Blogs
  1206. </span>
  1207. </a>
  1208. </li>
  1209. <li class="md-nav__item">
  1210. <a href="../../eso-tools/" class="md-nav__link">
  1211. <span class="md-ellipsis">
  1212. Tools
  1213. </span>
  1214. </a>
  1215. </li>
  1216. </ul>
  1217. </nav>
  1218. </li>
  1219. </ul>
  1220. </nav>
  1221. </li>
  1222. </ul>
  1223. </nav>
  1224. </div>
  1225. </div>
  1226. </div>
  1227. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1228. <div class="md-sidebar__scrollwrap">
  1229. <div class="md-sidebar__inner">
  1230. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1231. <label class="md-nav__title" for="__toc">
  1232. <span class="md-nav__icon md-icon"></span>
  1233. Table of contents
  1234. </label>
  1235. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1236. <li class="md-nav__item">
  1237. <a href="#template" class="md-nav__link">
  1238. <span class="md-ellipsis">
  1239. Template
  1240. </span>
  1241. </a>
  1242. </li>
  1243. <li class="md-nav__item">
  1244. <a href="#update-behavior-with-3-different-refresh-policies" class="md-nav__link">
  1245. <span class="md-ellipsis">
  1246. Update behavior with 3 different refresh policies
  1247. </span>
  1248. </a>
  1249. <nav class="md-nav" aria-label="Update behavior with 3 different refresh policies">
  1250. <ul class="md-nav__list">
  1251. <li class="md-nav__item">
  1252. <a href="#createdonce" class="md-nav__link">
  1253. <span class="md-ellipsis">
  1254. CreatedOnce
  1255. </span>
  1256. </a>
  1257. </li>
  1258. <li class="md-nav__item">
  1259. <a href="#periodic" class="md-nav__link">
  1260. <span class="md-ellipsis">
  1261. Periodic
  1262. </span>
  1263. </a>
  1264. </li>
  1265. <li class="md-nav__item">
  1266. <a href="#onchange" class="md-nav__link">
  1267. <span class="md-ellipsis">
  1268. OnChange
  1269. </span>
  1270. </a>
  1271. </li>
  1272. </ul>
  1273. </nav>
  1274. </li>
  1275. <li class="md-nav__item">
  1276. <a href="#manual-refresh" class="md-nav__link">
  1277. <span class="md-ellipsis">
  1278. Manual Refresh
  1279. </span>
  1280. </a>
  1281. </li>
  1282. <li class="md-nav__item">
  1283. <a href="#features" class="md-nav__link">
  1284. <span class="md-ellipsis">
  1285. Features
  1286. </span>
  1287. </a>
  1288. </li>
  1289. <li class="md-nav__item">
  1290. <a href="#example" class="md-nav__link">
  1291. <span class="md-ellipsis">
  1292. Example
  1293. </span>
  1294. </a>
  1295. </li>
  1296. </ul>
  1297. </nav>
  1298. </div>
  1299. </div>
  1300. </div>
  1301. <div class="md-content" data-md-component="content">
  1302. <article class="md-content__inner md-typeset">
  1303. <h1>ExternalSecret</h1>
  1304. <p>The <code>ExternalSecret</code> describes what data should be fetched, how the data should
  1305. be transformed and saved as a <code>Kind=Secret</code>:</p>
  1306. <ul>
  1307. <li>tells the operator what secrets should be synced by using <code>spec.data</code> to
  1308. explicitly sync individual keys or use <code>spec.dataFrom</code> to get <strong>all values</strong>
  1309. from the external API.</li>
  1310. <li>you can specify how the secret should look like by specifying a
  1311. <code>spec.target.template</code></li>
  1312. </ul>
  1313. <h2 id="template">Template</h2>
  1314. <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>
  1315. <h2 id="update-behavior-with-3-different-refresh-policies">Update behavior with 3 different refresh policies</h2>
  1316. <p>You can control how and when the <code>ExternalSecret</code> is refreshed by setting the <code>spec.refreshPolicy</code> field. If not specified, the default behavior is <code>Periodic</code>.</p>
  1317. <h3 id="createdonce">CreatedOnce</h3>
  1318. <p>With <code>refreshPolicy: CreatedOnce</code>, the controller will:
  1319. - Create the <code>Kind=Secret</code> only if it does not exist yet
  1320. - Never update the <code>Kind=Secret</code> afterwards if the source data changes
  1321. - Update/ Recreate the <code>Kind=Secret</code> if it gets changed/Deleted
  1322. - Useful for immutable credentials or when you want to manage updates manually</p>
  1323. <p>Example:
  1324. <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/v1</span>
  1325. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1326. <span class="nt">metadata</span><span class="p">:</span>
  1327. <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">example</span>
  1328. <span class="nt">spec</span><span class="p">:</span>
  1329. <span class="w"> </span><span class="nt">refreshPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">CreatedOnce</span>
  1330. <span class="w"> </span><span class="c1"># other fields...</span>
  1331. </code></pre></div></p>
  1332. <h3 id="periodic">Periodic</h3>
  1333. <p>With <code>refreshPolicy: Periodic</code> (the default behavior), the controller will:
  1334. - Create the <code>Kind=Secret</code> if it doesn't exist
  1335. - Update the <code>Kind=Secret</code> regularly based on the <code>spec.refreshInterval</code> duration
  1336. - When <code>spec.refreshInterval</code> is set to zero, it will only create the secret once and not update it afterward
  1337. - When <code>spec.refreshInterval</code> is set to a value greater than zero, the controller will update the <code>Kind=Secret</code> at the specified interval or when the <code>ExternalSecret</code> specification changes</p>
  1338. <p>Example:
  1339. <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/v1</span>
  1340. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1341. <span class="nt">metadata</span><span class="p">:</span>
  1342. <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">example</span>
  1343. <span class="nt">spec</span><span class="p">:</span>
  1344. <span class="w"> </span><span class="nt">refreshPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Periodic</span>
  1345. <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">1h</span><span class="w"> </span><span class="c1"># Update every hour</span>
  1346. <span class="w"> </span><span class="c1"># other fields...</span>
  1347. </code></pre></div></p>
  1348. <h3 id="onchange">OnChange</h3>
  1349. <p>With <code>refreshPolicy: OnChange</code>, the controller will:
  1350. - Create the <code>Kind=Secret</code> if it doesn't exist
  1351. - Update the <code>Kind=Secret</code> only when the <code>ExternalSecret</code>'s metadata or specification changes
  1352. - This policy is independent of the <code>refreshInterval</code> value
  1353. - Useful when you want to manually control when the secret is updated, by modifying the <code>ExternalSecret</code> resource</p>
  1354. <p>Example:
  1355. <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/v1</span>
  1356. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1357. <span class="nt">metadata</span><span class="p">:</span>
  1358. <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">example</span>
  1359. <span class="nt">spec</span><span class="p">:</span>
  1360. <span class="w"> </span><span class="nt">refreshPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">OnChange</span>
  1361. <span class="w"> </span><span class="c1"># other fields...</span>
  1362. </code></pre></div></p>
  1363. <h2 id="manual-refresh">Manual Refresh</h2>
  1364. <p>Regardless of the refresh policy, you can always manually trigger a refresh of the <code>Kind=Secret</code> by updating the annotations of the <code>ExternalSecret</code>:</p>
  1365. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  1366. </code></pre></div>
  1367. <h2 id="features">Features</h2>
  1368. <p>Individual features are described in the <a href="../../guides/introduction/">Guides section</a>:</p>
  1369. <ul>
  1370. <li><a href="../../guides/getallsecrets/">Find many secrets / Extract from structured data</a></li>
  1371. <li><a href="../../guides/templating/">Templating</a></li>
  1372. <li><a href="../../guides/generator/">Using Generators</a></li>
  1373. <li><a href="../../guides/ownership-deletion-policy/">Secret Ownership and Deletion</a></li>
  1374. <li><a href="../../guides/datafrom-rewrite/">Key Rewriting</a></li>
  1375. <li><a href="../../guides/decoding-strategy/">Decoding Strategy</a></li>
  1376. </ul>
  1377. <h2 id="example">Example</h2>
  1378. <p>Take a look at an annotated example to understand the design behind the
  1379. <code>ExternalSecret</code>.</p>
  1380. <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/v1</span>
  1381. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1382. <span class="nt">metadata</span><span class="p">:</span>
  1383. <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>
  1384. <span class="w"> </span><span class="c1"># labels and annotations are copied over to the</span>
  1385. <span class="w"> </span><span class="c1"># secret that will be created</span>
  1386. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1387. <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>
  1388. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1389. <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>
  1390. <span class="nt">spec</span><span class="p">:</span>
  1391. <span class="w"> </span><span class="c1"># Optional, SecretStoreRef defines the default SecretStore to use when fetching the secret data.</span>
  1392. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1393. <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>
  1394. <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>
  1395. <span class="w"> </span><span class="c1"># RefreshPolicy determines how the ExternalSecret should be refreshed.</span>
  1396. <span class="w"> </span><span class="c1"># - CreatedOnce: Creates the Secret only if it does not exist and does not update it afterward</span>
  1397. <span class="w"> </span><span class="c1"># - Periodic: (default) Synchronizes the Secret at intervals specified by refreshInterval</span>
  1398. <span class="w"> </span><span class="c1"># - OnChange: Only synchronizes when the ExternalSecret&#39;s metadata or specification changes</span>
  1399. <span class="w"> </span><span class="nt">refreshPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Periodic</span>
  1400. <span class="w"> </span><span class="c1"># RefreshInterval is the amount of time before the values reading again from the SecretStore provider</span>
  1401. <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>
  1402. <span class="w"> </span><span class="c1"># May be set to zero to fetch and create it once</span>
  1403. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1h&quot;</span>
  1404. <span class="w"> </span><span class="c1"># the target describes the secret that shall be created</span>
  1405. <span class="w"> </span><span class="c1"># there can only be one target per ExternalSecret</span>
  1406. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1407. <span class="w"> </span><span class="c1"># The secret name of the resource</span>
  1408. <span class="w"> </span><span class="c1"># Defaults to .metadata.name of the ExternalSecret</span>
  1409. <span class="w"> </span><span class="c1"># It is immutable</span>
  1410. <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>
  1411. <span class="w"> </span><span class="c1"># Specifies the ExternalSecret ownership details in the created Secret. Options:</span>
  1412. <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>
  1413. <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>
  1414. <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>
  1415. <span class="w"> </span><span class="c1"># - None: Does not create or update the Secret (reserved for future use with injector).</span>
  1416. <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>
  1417. <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>
  1418. <span class="w"> </span><span class="c1"># - Retain: (default) Retains the Secret if all Secret data fields have been deleted from the provider.</span>
  1419. <span class="w"> </span><span class="c1"># - Delete: Removes the Secret if all Secret data fields from the provider are deleted.</span>
  1420. <span class="w"> </span><span class="c1"># - Merge: Removes keys from the Secret but not the Secret itself.</span>
  1421. <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>
  1422. <span class="w"> </span><span class="c1"># Specify a blueprint for the resulting Kind=Secret</span>
  1423. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1424. <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>
  1425. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1426. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
  1427. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
  1428. <span class="w"> </span><span class="c1"># Use inline templates to construct your desired config file that contains your secret</span>
  1429. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1430. <span class="w"> </span><span class="nt">config.yml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1431. <span class="w"> </span><span class="no">database:</span>
  1432. <span class="w"> </span><span class="no">connection: postgres://{{ .username }}:{{ .password }}@{{ .database_host }}:5432/payments</span>
  1433. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span>
  1434. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span>
  1435. <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>
  1436. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1437. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1438. <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>
  1439. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1440. <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>
  1441. <span class="w"> </span><span class="c1"># Data defines the connection between the Kubernetes Secret keys and the Provider data</span>
  1442. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1443. <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>
  1444. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1445. <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>
  1446. <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>
  1447. <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>
  1448. <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>
  1449. <span class="w"> </span><span class="c1"># define the source of the secret. Can be a SecretStore or a Generator kind</span>
  1450. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1451. <span class="w"> </span><span class="c1"># point to a SecretStore that should be used to fetch a secret.</span>
  1452. <span class="w"> </span><span class="c1"># must be defined if no spec.secretStoreRef is defined.</span>
  1453. <span class="w"> </span><span class="nt">storeRef</span><span class="p">:</span>
  1454. <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>
  1455. <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>
  1456. <span class="w"> </span><span class="c1"># Used to fetch all properties from the Provider key</span>
  1457. <span class="w"> </span><span class="c1"># If multiple dataFrom are specified, secrets are merged in the specified order</span>
  1458. <span class="w"> </span><span class="c1"># Can be defined using sourceRef.generatorRef or extract / find</span>
  1459. <span class="w"> </span><span class="c1"># Both use cases are exemplified below</span>
  1460. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1461. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1462. <span class="w"> </span><span class="nt">generatorRef</span><span class="p">:</span>
  1463. <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>
  1464. <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>
  1465. <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>
  1466. <span class="w"> </span><span class="c1">#Or</span>
  1467. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1468. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1469. <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>
  1470. <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>
  1471. <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>
  1472. <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>
  1473. <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>
  1474. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1475. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1476. <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>
  1477. <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>
  1478. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span>
  1479. <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>
  1480. <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
  1481. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;.*foobar.*&quot;</span>
  1482. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
  1483. <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>
  1484. <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>
  1485. <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>
  1486. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1487. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1488. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
  1489. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
  1490. <span class="nt">status</span><span class="p">:</span>
  1491. <span class="w"> </span><span class="c1"># refreshTime is the time and date the external secret was fetched and</span>
  1492. <span class="w"> </span><span class="c1"># the target secret updated</span>
  1493. <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>
  1494. <span class="w"> </span><span class="c1"># Standard condition schema</span>
  1495. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  1496. <span class="w"> </span><span class="c1"># ExternalSecret ready condition indicates the secret is ready for use.</span>
  1497. <span class="w"> </span><span class="c1"># This is defined as:</span>
  1498. <span class="w"> </span><span class="c1"># - The target secret exists</span>
  1499. <span class="w"> </span><span class="c1"># - The target secret has been refreshed within the last refreshInterval</span>
  1500. <span class="w"> </span><span class="c1"># - The target secret content is up-to-date based on any target templates</span>
  1501. <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>
  1502. <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>
  1503. <span class="w"> </span><span class="nt">reason</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecretSynced&quot;</span>
  1504. <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>
  1505. <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>
  1506. </code></pre></div>
  1507. </article>
  1508. </div>
  1509. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1510. </div>
  1511. </main>
  1512. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1513. <footer class="md-footer">
  1514. <div class="md-footer-meta md-typeset">
  1515. <div class="md-footer-meta__inner md-grid">
  1516. <div class="md-copyright">
  1517. <div class="md-copyright__highlight">
  1518. &copy; 2025 The external-secrets Authors.<br/>
  1519. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1520. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1521. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1522. </div>
  1523. Made with
  1524. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1525. Material for MkDocs
  1526. </a>
  1527. </div>
  1528. </div>
  1529. </div>
  1530. </footer>
  1531. </div>
  1532. <div class="md-dialog" data-md-component="dialog">
  1533. <div class="md-dialog__inner md-typeset"></div>
  1534. </div>
  1535. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "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>
  1536. <script src="../../assets/javascripts/bundle.13a4f30d.min.js"></script>
  1537. </body>
  1538. </html>