index.html 130 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767
  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="../datafrom-rewrite/">
  7. <link rel="next" href="../templating-v1/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
  10. <title>v2 - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.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="#advanced-templating-v2" 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. v2
  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 7.1.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 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></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">
  127. <a href="../../api/components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item md-tabs__item--active">
  132. <a href="../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 7.1.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 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></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--nested">
  248. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  249. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  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="false">
  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="../../api/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--nested">
  269. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  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="false">
  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">
  283. <a href="../../api/externalsecret/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ExternalSecret
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/secretstore/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. SecretStore
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../api/clustersecretstore/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. ClusterSecretStore
  300. </span>
  301. </a>
  302. </li>
  303. <li class="md-nav__item">
  304. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  305. <span class="md-ellipsis">
  306. ClusterExternalSecret
  307. </span>
  308. </a>
  309. </li>
  310. <li class="md-nav__item">
  311. <a href="../../api/clusterpushsecret/" class="md-nav__link">
  312. <span class="md-ellipsis">
  313. ClusterPushSecret
  314. </span>
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../../api/pushsecret/" class="md-nav__link">
  319. <span class="md-ellipsis">
  320. PushSecret
  321. </span>
  322. </a>
  323. </li>
  324. </ul>
  325. </nav>
  326. </li>
  327. <li class="md-nav__item md-nav__item--nested">
  328. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  329. <div class="md-nav__link md-nav__container">
  330. <a href="../../api/generator/" class="md-nav__link ">
  331. <span class="md-ellipsis">
  332. Generators
  333. </span>
  334. </a>
  335. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  336. <span class="md-nav__icon md-icon"></span>
  337. </label>
  338. </div>
  339. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  340. <label class="md-nav__title" for="__nav_2_3">
  341. <span class="md-nav__icon md-icon"></span>
  342. Generators
  343. </label>
  344. <ul class="md-nav__list" data-md-scrollfix>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/acr/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Azure Container Registry
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/ecr/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. AWS Elastic Container Registry
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/sts/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. AWS STS Session Token
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/cloudsmith/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Cloudsmith
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/cluster/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Cluster Generator
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/gcr/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. Google Container Registry
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../../api/generator/quay/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. Quay
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../../api/generator/vault/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. Vault Dynamic Secret
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/generator/password/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Password
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../api/generator/fake/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. Fake
  412. </span>
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../api/generator/webhook/" class="md-nav__link">
  417. <span class="md-ellipsis">
  418. Webhook
  419. </span>
  420. </a>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../../api/generator/github/" class="md-nav__link">
  424. <span class="md-ellipsis">
  425. Github
  426. </span>
  427. </a>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="../../api/generator/uuid/" class="md-nav__link">
  431. <span class="md-ellipsis">
  432. UUID
  433. </span>
  434. </a>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../../api/generator/mfa/" class="md-nav__link">
  438. <span class="md-ellipsis">
  439. MFA
  440. </span>
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../api/generator/sshkey/" class="md-nav__link">
  445. <span class="md-ellipsis">
  446. SSHKey
  447. </span>
  448. </a>
  449. </li>
  450. </ul>
  451. </nav>
  452. </li>
  453. <li class="md-nav__item md-nav__item--nested">
  454. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  455. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  456. <span class="md-ellipsis">
  457. Reference Docs
  458. </span>
  459. <span class="md-nav__icon md-icon"></span>
  460. </label>
  461. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  462. <label class="md-nav__title" for="__nav_2_4">
  463. <span class="md-nav__icon md-icon"></span>
  464. Reference Docs
  465. </label>
  466. <ul class="md-nav__list" data-md-scrollfix>
  467. <li class="md-nav__item">
  468. <a href="../../api/spec/" class="md-nav__link">
  469. <span class="md-ellipsis">
  470. API specification
  471. </span>
  472. </a>
  473. </li>
  474. <li class="md-nav__item">
  475. <a href="../../api/controller-options/" class="md-nav__link">
  476. <span class="md-ellipsis">
  477. Controller Options
  478. </span>
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../../api/metrics/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. Metrics
  485. </span>
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../api/selectable-fields/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. Selectable Fields
  492. </span>
  493. </a>
  494. </li>
  495. </ul>
  496. </nav>
  497. </li>
  498. </ul>
  499. </nav>
  500. </li>
  501. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  502. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  503. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  504. <span class="md-ellipsis">
  505. Guides
  506. </span>
  507. <span class="md-nav__icon md-icon"></span>
  508. </label>
  509. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
  510. <label class="md-nav__title" for="__nav_3">
  511. <span class="md-nav__icon md-icon"></span>
  512. Guides
  513. </label>
  514. <ul class="md-nav__list" data-md-scrollfix>
  515. <li class="md-nav__item">
  516. <a href="../introduction/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. Introduction
  519. </span>
  520. </a>
  521. </li>
  522. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  523. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" checked>
  524. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  525. <span class="md-ellipsis">
  526. External Secrets
  527. </span>
  528. <span class="md-nav__icon md-icon"></span>
  529. </label>
  530. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="true">
  531. <label class="md-nav__title" for="__nav_3_2">
  532. <span class="md-nav__icon md-icon"></span>
  533. External Secrets
  534. </label>
  535. <ul class="md-nav__list" data-md-scrollfix>
  536. <li class="md-nav__item">
  537. <a href="../all-keys-one-secret/" class="md-nav__link">
  538. <span class="md-ellipsis">
  539. Extract structured data
  540. </span>
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../getallsecrets/" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. Find Secrets by Name or Metadata
  547. </span>
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../datafrom-rewrite/" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. Rewriting Keys
  554. </span>
  555. </a>
  556. </li>
  557. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  558. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_4" checked>
  559. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  560. <span class="md-ellipsis">
  561. Advanced Templating
  562. </span>
  563. <span class="md-nav__icon md-icon"></span>
  564. </label>
  565. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="true">
  566. <label class="md-nav__title" for="__nav_3_2_4">
  567. <span class="md-nav__icon md-icon"></span>
  568. Advanced Templating
  569. </label>
  570. <ul class="md-nav__list" data-md-scrollfix>
  571. <li class="md-nav__item md-nav__item--active">
  572. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  573. <label class="md-nav__link md-nav__link--active" for="__toc">
  574. <span class="md-ellipsis">
  575. v2
  576. </span>
  577. <span class="md-nav__icon md-icon"></span>
  578. </label>
  579. <a href="./" class="md-nav__link md-nav__link--active">
  580. <span class="md-ellipsis">
  581. v2
  582. </span>
  583. </a>
  584. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  585. <label class="md-nav__title" for="__toc">
  586. <span class="md-nav__icon md-icon"></span>
  587. Table of contents
  588. </label>
  589. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  590. <li class="md-nav__item">
  591. <a href="#helm" class="md-nav__link">
  592. <span class="md-ellipsis">
  593. Helm
  594. </span>
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="#examples" class="md-nav__link">
  599. <span class="md-ellipsis">
  600. Examples
  601. </span>
  602. </a>
  603. <nav class="md-nav" aria-label="Examples">
  604. <ul class="md-nav__list">
  605. <li class="md-nav__item">
  606. <a href="#mergepolicy" class="md-nav__link">
  607. <span class="md-ellipsis">
  608. MergePolicy
  609. </span>
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="#templatefrom" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. TemplateFrom
  616. </span>
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Extract Keys and Certificates from PKCS#12 Archive
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="#extract-from-jwk" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Extract from JWK
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="#filter-pem-blocks" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. Filter PEM blocks
  637. </span>
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="#rsa-decryption-data-from-provider" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. RSA Decryption Data From Provider
  644. </span>
  645. </a>
  646. </li>
  647. </ul>
  648. </nav>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="#templating-with-pushsecret" class="md-nav__link">
  652. <span class="md-ellipsis">
  653. Templating with PushSecret
  654. </span>
  655. </a>
  656. </li>
  657. <li class="md-nav__item">
  658. <a href="#helper-functions" class="md-nav__link">
  659. <span class="md-ellipsis">
  660. Helper functions
  661. </span>
  662. </a>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="#migrating-from-v1" class="md-nav__link">
  666. <span class="md-ellipsis">
  667. Migrating from v1
  668. </span>
  669. </a>
  670. <nav class="md-nav" aria-label="Migrating from v1">
  671. <ul class="md-nav__list">
  672. <li class="md-nav__item">
  673. <a href="#functions-removedreplaced" class="md-nav__link">
  674. <span class="md-ellipsis">
  675. Functions removed/replaced
  676. </span>
  677. </a>
  678. </li>
  679. </ul>
  680. </nav>
  681. </li>
  682. </ul>
  683. </nav>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../templating-v1/" class="md-nav__link">
  687. <span class="md-ellipsis">
  688. v1
  689. </span>
  690. </a>
  691. </li>
  692. </ul>
  693. </nav>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="../common-k8s-secret-types/" class="md-nav__link">
  697. <span class="md-ellipsis">
  698. Kubernetes Secret Types
  699. </span>
  700. </a>
  701. </li>
  702. <li class="md-nav__item">
  703. <a href="../ownership-deletion-policy/" class="md-nav__link">
  704. <span class="md-ellipsis">
  705. Lifecycle: ownership & deletion
  706. </span>
  707. </a>
  708. </li>
  709. <li class="md-nav__item">
  710. <a href="../decoding-strategy/" class="md-nav__link">
  711. <span class="md-ellipsis">
  712. Decoding Strategies
  713. </span>
  714. </a>
  715. </li>
  716. <li class="md-nav__item">
  717. <a href="../controller-class/" class="md-nav__link">
  718. <span class="md-ellipsis">
  719. Controller Classes
  720. </span>
  721. </a>
  722. </li>
  723. </ul>
  724. </nav>
  725. </li>
  726. <li class="md-nav__item">
  727. <a href="../targeting-custom-resources/" class="md-nav__link">
  728. <span class="md-ellipsis">
  729. Targeting Custom Resources
  730. </span>
  731. </a>
  732. </li>
  733. <li class="md-nav__item">
  734. <a href="../generator/" class="md-nav__link">
  735. <span class="md-ellipsis">
  736. Generators
  737. </span>
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="../pushsecrets/" class="md-nav__link">
  742. <span class="md-ellipsis">
  743. Push Secrets
  744. </span>
  745. </a>
  746. </li>
  747. <li class="md-nav__item md-nav__item--nested">
  748. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  749. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  750. <span class="md-ellipsis">
  751. Operations
  752. </span>
  753. <span class="md-nav__icon md-icon"></span>
  754. </label>
  755. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  756. <label class="md-nav__title" for="__nav_3_6">
  757. <span class="md-nav__icon md-icon"></span>
  758. Operations
  759. </label>
  760. <ul class="md-nav__list" data-md-scrollfix>
  761. <li class="md-nav__item">
  762. <a href="../multi-tenancy/" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. Multi Tenancy
  765. </span>
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../security-best-practices/" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Security Best Practices
  772. </span>
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="../threat-model/" class="md-nav__link">
  777. <span class="md-ellipsis">
  778. Threat Model
  779. </span>
  780. </a>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="../v1beta1/" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. Upgrading to v1beta1
  786. </span>
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="../using-latest-image/" class="md-nav__link">
  791. <span class="md-ellipsis">
  792. Using Latest Image
  793. </span>
  794. </a>
  795. </li>
  796. <li class="md-nav__item">
  797. <a href="../disable-cluster-features/" class="md-nav__link">
  798. <span class="md-ellipsis">
  799. Disable Cluster Features
  800. </span>
  801. </a>
  802. </li>
  803. </ul>
  804. </nav>
  805. </li>
  806. <li class="md-nav__item md-nav__item--nested">
  807. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_7" >
  808. <label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="0">
  809. <span class="md-ellipsis">
  810. Tooling
  811. </span>
  812. <span class="md-nav__icon md-icon"></span>
  813. </label>
  814. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
  815. <label class="md-nav__title" for="__nav_3_7">
  816. <span class="md-nav__icon md-icon"></span>
  817. Tooling
  818. </label>
  819. <ul class="md-nav__list" data-md-scrollfix>
  820. <li class="md-nav__item">
  821. <a href="../using-esoctl-tool/" class="md-nav__link">
  822. <span class="md-ellipsis">
  823. Using the esoctl tool
  824. </span>
  825. </a>
  826. </li>
  827. </ul>
  828. </nav>
  829. </li>
  830. </ul>
  831. </nav>
  832. </li>
  833. <li class="md-nav__item md-nav__item--nested">
  834. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  835. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  836. <span class="md-ellipsis">
  837. Provider
  838. </span>
  839. <span class="md-nav__icon md-icon"></span>
  840. </label>
  841. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  842. <label class="md-nav__title" for="__nav_4">
  843. <span class="md-nav__icon md-icon"></span>
  844. Provider
  845. </label>
  846. <ul class="md-nav__list" data-md-scrollfix>
  847. <li class="md-nav__item">
  848. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. AWS Secrets Manager
  851. </span>
  852. </a>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  856. <span class="md-ellipsis">
  857. AWS Parameter Store
  858. </span>
  859. </a>
  860. </li>
  861. <li class="md-nav__item">
  862. <a href="../../provider/aws-access/" class="md-nav__link">
  863. <span class="md-ellipsis">
  864. AWS Access
  865. </span>
  866. </a>
  867. </li>
  868. <li class="md-nav__item">
  869. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  870. <span class="md-ellipsis">
  871. Azure Key Vault
  872. </span>
  873. </a>
  874. </li>
  875. <li class="md-nav__item">
  876. <a href="../../provider/barbican/" class="md-nav__link">
  877. <span class="md-ellipsis">
  878. Barbican
  879. </span>
  880. </a>
  881. </li>
  882. <li class="md-nav__item">
  883. <a href="../../provider/beyondtrust/" class="md-nav__link">
  884. <span class="md-ellipsis">
  885. BeyondTrust
  886. </span>
  887. </a>
  888. </li>
  889. <li class="md-nav__item">
  890. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  891. <span class="md-ellipsis">
  892. Bitwarden Secrets Manager
  893. </span>
  894. </a>
  895. </li>
  896. <li class="md-nav__item">
  897. <a href="../../provider/chef/" class="md-nav__link">
  898. <span class="md-ellipsis">
  899. Chef
  900. </span>
  901. </a>
  902. </li>
  903. <li class="md-nav__item">
  904. <a href="../../provider/cloudru/" class="md-nav__link">
  905. <span class="md-ellipsis">
  906. Cloud.ru Secret Manager
  907. </span>
  908. </a>
  909. </li>
  910. <li class="md-nav__item">
  911. <a href="../../provider/conjur/" class="md-nav__link">
  912. <span class="md-ellipsis">
  913. CyberArk Conjur
  914. </span>
  915. </a>
  916. </li>
  917. <li class="md-nav__item">
  918. <a href="../../provider/device42/" class="md-nav__link">
  919. <span class="md-ellipsis">
  920. Device42
  921. </span>
  922. </a>
  923. </li>
  924. <li class="md-nav__item">
  925. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  926. <span class="md-ellipsis">
  927. Google Cloud Secret Manager
  928. </span>
  929. </a>
  930. </li>
  931. <li class="md-nav__item">
  932. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  933. <span class="md-ellipsis">
  934. HashiCorp Vault
  935. </span>
  936. </a>
  937. </li>
  938. <li class="md-nav__item">
  939. <a href="../../provider/kubernetes/" class="md-nav__link">
  940. <span class="md-ellipsis">
  941. Kubernetes
  942. </span>
  943. </a>
  944. </li>
  945. <li class="md-nav__item">
  946. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  947. <span class="md-ellipsis">
  948. IBM Secrets Manager
  949. </span>
  950. </a>
  951. </li>
  952. <li class="md-nav__item">
  953. <a href="../../provider/akeyless/" class="md-nav__link">
  954. <span class="md-ellipsis">
  955. Akeyless
  956. </span>
  957. </a>
  958. </li>
  959. <li class="md-nav__item">
  960. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  961. <span class="md-ellipsis">
  962. Yandex Certificate Manager
  963. </span>
  964. </a>
  965. </li>
  966. <li class="md-nav__item">
  967. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  968. <span class="md-ellipsis">
  969. Yandex Lockbox
  970. </span>
  971. </a>
  972. </li>
  973. <li class="md-nav__item">
  974. <a href="../../provider/alibaba/" class="md-nav__link">
  975. <span class="md-ellipsis">
  976. Alibaba Cloud
  977. </span>
  978. </a>
  979. </li>
  980. <li class="md-nav__item">
  981. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  982. <span class="md-ellipsis">
  983. GitLab Variables
  984. </span>
  985. </a>
  986. </li>
  987. <li class="md-nav__item">
  988. <a href="../../provider/github/" class="md-nav__link">
  989. <span class="md-ellipsis">
  990. Github Actions Secrets
  991. </span>
  992. </a>
  993. </li>
  994. <li class="md-nav__item">
  995. <a href="../../provider/oracle-vault/" class="md-nav__link">
  996. <span class="md-ellipsis">
  997. Oracle Vault
  998. </span>
  999. </a>
  1000. </li>
  1001. <li class="md-nav__item">
  1002. <a href="../../provider/1password-automation/" class="md-nav__link">
  1003. <span class="md-ellipsis">
  1004. 1Password Connect Server
  1005. </span>
  1006. </a>
  1007. </li>
  1008. <li class="md-nav__item">
  1009. <a href="../../provider/1password-sdk/" class="md-nav__link">
  1010. <span class="md-ellipsis">
  1011. 1Password SDK
  1012. </span>
  1013. </a>
  1014. </li>
  1015. <li class="md-nav__item">
  1016. <a href="../../provider/webhook/" class="md-nav__link">
  1017. <span class="md-ellipsis">
  1018. Webhook
  1019. </span>
  1020. </a>
  1021. </li>
  1022. <li class="md-nav__item">
  1023. <a href="../../provider/fake/" class="md-nav__link">
  1024. <span class="md-ellipsis">
  1025. Fake
  1026. </span>
  1027. </a>
  1028. </li>
  1029. <li class="md-nav__item">
  1030. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  1031. <span class="md-ellipsis">
  1032. senhasegura DevOps Secrets Management (DSM)
  1033. </span>
  1034. </a>
  1035. </li>
  1036. <li class="md-nav__item">
  1037. <a href="../../provider/doppler/" class="md-nav__link">
  1038. <span class="md-ellipsis">
  1039. Doppler
  1040. </span>
  1041. </a>
  1042. </li>
  1043. <li class="md-nav__item">
  1044. <a href="../../provider/keeper-security/" class="md-nav__link">
  1045. <span class="md-ellipsis">
  1046. Keeper Security
  1047. </span>
  1048. </a>
  1049. </li>
  1050. <li class="md-nav__item">
  1051. <a href="../../provider/cloak/" class="md-nav__link">
  1052. <span class="md-ellipsis">
  1053. Cloak End 2 End Encrypted Secrets
  1054. </span>
  1055. </a>
  1056. </li>
  1057. <li class="md-nav__item">
  1058. <a href="../../provider/scaleway/" class="md-nav__link">
  1059. <span class="md-ellipsis">
  1060. Scaleway
  1061. </span>
  1062. </a>
  1063. </li>
  1064. <li class="md-nav__item">
  1065. <a href="../../provider/delinea/" class="md-nav__link">
  1066. <span class="md-ellipsis">
  1067. Delinea
  1068. </span>
  1069. </a>
  1070. </li>
  1071. <li class="md-nav__item">
  1072. <a href="../../provider/secretserver/" class="md-nav__link">
  1073. <span class="md-ellipsis">
  1074. Secret Server
  1075. </span>
  1076. </a>
  1077. </li>
  1078. <li class="md-nav__item">
  1079. <a href="../../provider/passbolt/" class="md-nav__link">
  1080. <span class="md-ellipsis">
  1081. Passbolt
  1082. </span>
  1083. </a>
  1084. </li>
  1085. <li class="md-nav__item">
  1086. <a href="../../provider/pulumi/" class="md-nav__link">
  1087. <span class="md-ellipsis">
  1088. Pulumi ESC
  1089. </span>
  1090. </a>
  1091. </li>
  1092. <li class="md-nav__item">
  1093. <a href="../../provider/onboardbase/" class="md-nav__link">
  1094. <span class="md-ellipsis">
  1095. Onboardbase
  1096. </span>
  1097. </a>
  1098. </li>
  1099. <li class="md-nav__item">
  1100. <a href="../../provider-passworddepot/" class="md-nav__link">
  1101. <span class="md-ellipsis">
  1102. Password Depot
  1103. </span>
  1104. </a>
  1105. </li>
  1106. <li class="md-nav__item">
  1107. <a href="../../provider/fortanix/" class="md-nav__link">
  1108. <span class="md-ellipsis">
  1109. Fortanix
  1110. </span>
  1111. </a>
  1112. </li>
  1113. <li class="md-nav__item">
  1114. <a href="../../provider/infisical/" class="md-nav__link">
  1115. <span class="md-ellipsis">
  1116. Infisical
  1117. </span>
  1118. </a>
  1119. </li>
  1120. <li class="md-nav__item">
  1121. <a href="../../provider/previder/" class="md-nav__link">
  1122. <span class="md-ellipsis">
  1123. Previder
  1124. </span>
  1125. </a>
  1126. </li>
  1127. <li class="md-nav__item">
  1128. <a href="../../provider/openbao/" class="md-nav__link">
  1129. <span class="md-ellipsis">
  1130. OpenBao
  1131. </span>
  1132. </a>
  1133. </li>
  1134. <li class="md-nav__item">
  1135. <a href="../../provider/volcengine/" class="md-nav__link">
  1136. <span class="md-ellipsis">
  1137. Volcengine
  1138. </span>
  1139. </a>
  1140. </li>
  1141. <li class="md-nav__item">
  1142. <a href="../../provider/ngrok/" class="md-nav__link">
  1143. <span class="md-ellipsis">
  1144. ngrok
  1145. </span>
  1146. </a>
  1147. </li>
  1148. <li class="md-nav__item">
  1149. <a href="../../provider/devolutions-server/" class="md-nav__link">
  1150. <span class="md-ellipsis">
  1151. Devolutions Server
  1152. </span>
  1153. </a>
  1154. </li>
  1155. </ul>
  1156. </nav>
  1157. </li>
  1158. <li class="md-nav__item md-nav__item--nested">
  1159. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1160. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1161. <span class="md-ellipsis">
  1162. Examples
  1163. </span>
  1164. <span class="md-nav__icon md-icon"></span>
  1165. </label>
  1166. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1167. <label class="md-nav__title" for="__nav_5">
  1168. <span class="md-nav__icon md-icon"></span>
  1169. Examples
  1170. </label>
  1171. <ul class="md-nav__list" data-md-scrollfix>
  1172. <li class="md-nav__item">
  1173. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1174. <span class="md-ellipsis">
  1175. FluxCD
  1176. </span>
  1177. </a>
  1178. </li>
  1179. <li class="md-nav__item">
  1180. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1181. <span class="md-ellipsis">
  1182. Anchore Engine
  1183. </span>
  1184. </a>
  1185. </li>
  1186. <li class="md-nav__item">
  1187. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1188. <span class="md-ellipsis">
  1189. Jenkins
  1190. </span>
  1191. </a>
  1192. </li>
  1193. <li class="md-nav__item">
  1194. <a href="../../examples/bitwarden/" class="md-nav__link">
  1195. <span class="md-ellipsis">
  1196. Bitwarden
  1197. </span>
  1198. </a>
  1199. </li>
  1200. </ul>
  1201. </nav>
  1202. </li>
  1203. <li class="md-nav__item md-nav__item--nested">
  1204. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1205. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1206. <span class="md-ellipsis">
  1207. Community
  1208. </span>
  1209. <span class="md-nav__icon md-icon"></span>
  1210. </label>
  1211. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1212. <label class="md-nav__title" for="__nav_6">
  1213. <span class="md-nav__icon md-icon"></span>
  1214. Community
  1215. </label>
  1216. <ul class="md-nav__list" data-md-scrollfix>
  1217. <li class="md-nav__item md-nav__item--nested">
  1218. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1219. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1220. <span class="md-ellipsis">
  1221. Contributing
  1222. </span>
  1223. <span class="md-nav__icon md-icon"></span>
  1224. </label>
  1225. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1226. <label class="md-nav__title" for="__nav_6_1">
  1227. <span class="md-nav__icon md-icon"></span>
  1228. Contributing
  1229. </label>
  1230. <ul class="md-nav__list" data-md-scrollfix>
  1231. <li class="md-nav__item">
  1232. <a href="../../contributing/devguide/" class="md-nav__link">
  1233. <span class="md-ellipsis">
  1234. Developer guide
  1235. </span>
  1236. </a>
  1237. </li>
  1238. <li class="md-nav__item">
  1239. <a href="../../contributing/process/" class="md-nav__link">
  1240. <span class="md-ellipsis">
  1241. Contributing Process
  1242. </span>
  1243. </a>
  1244. </li>
  1245. <li class="md-nav__item">
  1246. <a href="../../contributing/release/" class="md-nav__link">
  1247. <span class="md-ellipsis">
  1248. Release Process
  1249. </span>
  1250. </a>
  1251. </li>
  1252. <li class="md-nav__item">
  1253. <a href="../../contributing/coc/" class="md-nav__link">
  1254. <span class="md-ellipsis">
  1255. Code of Conduct
  1256. </span>
  1257. </a>
  1258. </li>
  1259. <li class="md-nav__item">
  1260. <a href="../../contributing/calendar/" class="md-nav__link">
  1261. <span class="md-ellipsis">
  1262. Community meetings calendar
  1263. </span>
  1264. </a>
  1265. </li>
  1266. <li class="md-nav__item">
  1267. <a href="../../contributing/roadmap/" class="md-nav__link">
  1268. <span class="md-ellipsis">
  1269. Roadmap
  1270. </span>
  1271. </a>
  1272. </li>
  1273. <li class="md-nav__item">
  1274. <a href="../../contributing/burnout-mitigation/" class="md-nav__link">
  1275. <span class="md-ellipsis">
  1276. Burnout Prevention
  1277. </span>
  1278. </a>
  1279. </li>
  1280. <li class="md-nav__item">
  1281. <a href="../../contributing/llm-policy/" class="md-nav__link">
  1282. <span class="md-ellipsis">
  1283. LLM Policy
  1284. </span>
  1285. </a>
  1286. </li>
  1287. </ul>
  1288. </nav>
  1289. </li>
  1290. <li class="md-nav__item md-nav__item--nested">
  1291. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1292. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1293. <span class="md-ellipsis">
  1294. External Resources
  1295. </span>
  1296. <span class="md-nav__icon md-icon"></span>
  1297. </label>
  1298. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1299. <label class="md-nav__title" for="__nav_6_2">
  1300. <span class="md-nav__icon md-icon"></span>
  1301. External Resources
  1302. </label>
  1303. <ul class="md-nav__list" data-md-scrollfix>
  1304. <li class="md-nav__item">
  1305. <a href="../../eso-talks/" class="md-nav__link">
  1306. <span class="md-ellipsis">
  1307. Talks
  1308. </span>
  1309. </a>
  1310. </li>
  1311. <li class="md-nav__item">
  1312. <a href="../../eso-demos/" class="md-nav__link">
  1313. <span class="md-ellipsis">
  1314. Demos
  1315. </span>
  1316. </a>
  1317. </li>
  1318. <li class="md-nav__item">
  1319. <a href="../../eso-blogs/" class="md-nav__link">
  1320. <span class="md-ellipsis">
  1321. Blogs
  1322. </span>
  1323. </a>
  1324. </li>
  1325. <li class="md-nav__item">
  1326. <a href="../../eso-tools/" class="md-nav__link">
  1327. <span class="md-ellipsis">
  1328. Tools
  1329. </span>
  1330. </a>
  1331. </li>
  1332. </ul>
  1333. </nav>
  1334. </li>
  1335. </ul>
  1336. </nav>
  1337. </li>
  1338. </ul>
  1339. </nav>
  1340. </div>
  1341. </div>
  1342. </div>
  1343. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1344. <div class="md-sidebar__scrollwrap">
  1345. <div class="md-sidebar__inner">
  1346. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1347. <label class="md-nav__title" for="__toc">
  1348. <span class="md-nav__icon md-icon"></span>
  1349. Table of contents
  1350. </label>
  1351. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1352. <li class="md-nav__item">
  1353. <a href="#helm" class="md-nav__link">
  1354. <span class="md-ellipsis">
  1355. Helm
  1356. </span>
  1357. </a>
  1358. </li>
  1359. <li class="md-nav__item">
  1360. <a href="#examples" class="md-nav__link">
  1361. <span class="md-ellipsis">
  1362. Examples
  1363. </span>
  1364. </a>
  1365. <nav class="md-nav" aria-label="Examples">
  1366. <ul class="md-nav__list">
  1367. <li class="md-nav__item">
  1368. <a href="#mergepolicy" class="md-nav__link">
  1369. <span class="md-ellipsis">
  1370. MergePolicy
  1371. </span>
  1372. </a>
  1373. </li>
  1374. <li class="md-nav__item">
  1375. <a href="#templatefrom" class="md-nav__link">
  1376. <span class="md-ellipsis">
  1377. TemplateFrom
  1378. </span>
  1379. </a>
  1380. </li>
  1381. <li class="md-nav__item">
  1382. <a href="#extract-keys-and-certificates-from-pkcs12-archive" class="md-nav__link">
  1383. <span class="md-ellipsis">
  1384. Extract Keys and Certificates from PKCS#12 Archive
  1385. </span>
  1386. </a>
  1387. </li>
  1388. <li class="md-nav__item">
  1389. <a href="#extract-from-jwk" class="md-nav__link">
  1390. <span class="md-ellipsis">
  1391. Extract from JWK
  1392. </span>
  1393. </a>
  1394. </li>
  1395. <li class="md-nav__item">
  1396. <a href="#filter-pem-blocks" class="md-nav__link">
  1397. <span class="md-ellipsis">
  1398. Filter PEM blocks
  1399. </span>
  1400. </a>
  1401. </li>
  1402. <li class="md-nav__item">
  1403. <a href="#rsa-decryption-data-from-provider" class="md-nav__link">
  1404. <span class="md-ellipsis">
  1405. RSA Decryption Data From Provider
  1406. </span>
  1407. </a>
  1408. </li>
  1409. </ul>
  1410. </nav>
  1411. </li>
  1412. <li class="md-nav__item">
  1413. <a href="#templating-with-pushsecret" class="md-nav__link">
  1414. <span class="md-ellipsis">
  1415. Templating with PushSecret
  1416. </span>
  1417. </a>
  1418. </li>
  1419. <li class="md-nav__item">
  1420. <a href="#helper-functions" class="md-nav__link">
  1421. <span class="md-ellipsis">
  1422. Helper functions
  1423. </span>
  1424. </a>
  1425. </li>
  1426. <li class="md-nav__item">
  1427. <a href="#migrating-from-v1" class="md-nav__link">
  1428. <span class="md-ellipsis">
  1429. Migrating from v1
  1430. </span>
  1431. </a>
  1432. <nav class="md-nav" aria-label="Migrating from v1">
  1433. <ul class="md-nav__list">
  1434. <li class="md-nav__item">
  1435. <a href="#functions-removedreplaced" class="md-nav__link">
  1436. <span class="md-ellipsis">
  1437. Functions removed/replaced
  1438. </span>
  1439. </a>
  1440. </li>
  1441. </ul>
  1442. </nav>
  1443. </li>
  1444. </ul>
  1445. </nav>
  1446. </div>
  1447. </div>
  1448. </div>
  1449. <div class="md-content" data-md-component="content">
  1450. <article class="md-content__inner md-typeset">
  1451. <h1 id="advanced-templating-v2">Advanced Templating v2</h1>
  1452. <p>With External Secrets Operator you can transform the data from the external secret provider before it is stored as <code>Kind=Secret</code>. You can do this with the <code>Spec.Target.Template</code>.</p>
  1453. <p>Each data value is interpreted as a <a href="https://golang.org/pkg/text/template/">Go template</a>. Please note that referencing a non-existing key in the template will raise an error, instead of being suppressed.</p>
  1454. <div class="admonition note">
  1455. <p class="admonition-title">Note</p>
  1456. <p>Consider using camelcase when defining <strong>.'spec.data.secretkey'</strong>, example: serviceAccountToken</p>
  1457. <p>If your secret keys contain <strong><code>-</code> (dashes)</strong>, you will need to reference them using <strong><code>index</code></strong> </br>
  1458. Example: <strong><code>\{\{ index .data "service-account-token" \}\}</code></strong></p>
  1459. </div>
  1460. <h2 id="helm">Helm</h2>
  1461. <p>When installing ExternalSecrets via <code>helm</code>, the template must be escaped so that <code>helm</code> will not try to render it. The most straightforward way to accomplish this would be to use backticks (<a href="https://pkg.go.dev/text/template#hdr-Examples">raw string constants</a>):</p>
  1462. <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>
  1463. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1464. <span class="nt">metadata</span><span class="p">:</span>
  1465. <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">template</span>
  1466. <span class="nt">spec</span><span class="p">:</span>
  1467. <span class="w"> </span><span class="c1"># ...</span>
  1468. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1469. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1470. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1471. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1472. <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">admin</span>
  1473. <span class="w"> </span><span class="c1"># password: &quot;{{ .mysecret }}&quot; # If you are using plain manifests or gitops tools</span>
  1474. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">`{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">}}`</span><span class="nv"> </span><span class="s">}}&quot;</span><span class="w"> </span><span class="c1"># If you are using helm</span>
  1475. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1476. <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">mysecret</span>
  1477. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1478. <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">/credentials</span>
  1479. </code></pre></div>
  1480. <h2 id="examples">Examples</h2>
  1481. <p>You can use templates to inject your secrets into a configuration file that you mount into your pod:</p>
  1482. <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>
  1483. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1484. <span class="nt">metadata</span><span class="p">:</span>
  1485. <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">template</span>
  1486. <span class="nt">spec</span><span class="p">:</span>
  1487. <span class="w"> </span><span class="c1"># ...</span>
  1488. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1489. <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">secret-to-be-created</span>
  1490. <span class="w"> </span><span class="c1"># this is how the Kind=Secret will look like</span>
  1491. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1492. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1493. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1494. <span class="w"> </span><span class="c1"># multiline string</span>
  1495. <span class="w"> </span><span class="nt">config</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1496. <span class="w"> </span><span class="no">datasources:</span>
  1497. <span class="w"> </span><span class="no">- name: Graphite</span>
  1498. <span class="w"> </span><span class="no">type: graphite</span>
  1499. <span class="w"> </span><span class="no">access: proxy</span>
  1500. <span class="w"> </span><span class="no">url: http://localhost:8080</span>
  1501. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span>
  1502. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span>
  1503. <span class="w"> </span><span class="c1"># using replace function to rewrite secret</span>
  1504. <span class="w"> </span><span class="nt">connection</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;{{</span><span class="nv"> </span><span class="s">.dburl</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">replace</span><span class="nv"> </span><span class="s">&quot;postgres://&quot;</span><span class="nv"> </span><span class="s">&quot;postgresql://&quot;</span><span class="nv"> </span><span class="s">}}&#39;</span>
  1505. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1506. <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">user</span>
  1507. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1508. <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">/grafana/user</span>
  1509. <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">password</span>
  1510. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1511. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/grafana/password</span>
  1512. <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">dburl</span>
  1513. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1514. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/database/url</span>
  1515. </code></pre></div>
  1516. <p>Another example with two keys in the same secret:</p>
  1517. <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>
  1518. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1519. <span class="nt">metadata</span><span class="p">:</span>
  1520. <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">template</span>
  1521. <span class="nt">spec</span><span class="p">:</span>
  1522. <span class="w"> </span><span class="c1"># ...</span>
  1523. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1524. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1525. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1526. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1527. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
  1528. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">}}&quot;</span><span class="w"> </span><span class="c1"># If you are using plain manifests or gitops tools</span>
  1529. <span class="w"> </span><span class="c1"># password: &quot;{{ `{{ .mysecret }}` }}&quot; # If you are using templated tools like helm</span>
  1530. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1531. <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">mysecret</span>
  1532. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1533. <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">/credentials</span>
  1534. </code></pre></div>
  1535. <h3 id="mergepolicy">MergePolicy</h3>
  1536. <p>By default, the templating mechanism will not use any information available from the original <code>data</code> and <code>dataFrom</code> queries to the provider, and only keep the templated information. It is possible to change this behavior through the use of the <code>mergePolicy</code> field. <code>mergePolicy</code> currently accepts two values: <code>Replace</code> (the default) and <code>Merge</code>. When using <code>Merge</code>, <code>data</code> and <code>dataFrom</code> keys will also be embedded into the templated secret, having lower priority than the template outcome. See the example for more information:</p>
  1537. <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>
  1538. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1539. <span class="nt">metadata</span><span class="p">:</span>
  1540. <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">template</span>
  1541. <span class="nt">spec</span><span class="p">:</span>
  1542. <span class="w"> </span><span class="c1"># ...</span>
  1543. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1544. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1545. <span class="w"> </span><span class="nt">mergePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Merge</span>
  1546. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1547. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1548. <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">admin</span>
  1549. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.password</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">b64dec</span><span class="nv"> </span><span class="s">}}&quot;</span><span class="w"> </span><span class="c1"># Overwrites the password from the data call and use this output</span>
  1550. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1551. <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">password</span>
  1552. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1553. <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">/credentials/password</span>
  1554. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span><span class="w"> </span><span class="c1"># Preserves the username in the templated Secret</span>
  1555. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1556. <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">/credentials/username</span>
  1557. </code></pre></div>
  1558. <h3 id="templatefrom">TemplateFrom</h3>
  1559. <p>You do not have to define your templates inline in an ExternalSecret but you can pull <code>ConfigMaps</code> or other Secrets that contain a template. Consider the following example:</p>
  1560. <div class="highlight"><pre><span></span><code><span class="c1"># define your template in a config map</span>
  1561. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1562. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ConfigMap</span>
  1563. <span class="nt">metadata</span><span class="p">:</span>
  1564. <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">grafana-config-tpl</span>
  1565. <span class="nt">data</span><span class="p">:</span>
  1566. <span class="w"> </span><span class="nt">config.yaml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1567. <span class="w"> </span><span class="no">datasources:</span>
  1568. <span class="w"> </span><span class="no">- name: Graphite</span>
  1569. <span class="w"> </span><span class="no">type: graphite</span>
  1570. <span class="w"> </span><span class="no">access: proxy</span>
  1571. <span class="w"> </span><span class="no">url: &quot;{{ .uri }}&quot;</span>
  1572. <span class="w"> </span><span class="no">password: &quot;{{ .password }}&quot;</span>
  1573. <span class="w"> </span><span class="no">user: &quot;{{ .user }}&quot;</span>
  1574. <span class="w"> </span><span class="nt">templated</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1575. <span class="w"> </span><span class="no"># key and value templated</span>
  1576. <span class="w"> </span><span class="no">my-application-{{ .user}}: {{ .password | b64enc }}</span>
  1577. <span class="w"> </span><span class="no"># conditional keys</span>
  1578. <span class="w"> </span><span class="no">{{- if hasPrefix &quot;oci://&quot; .uri }}</span>
  1579. <span class="w"> </span><span class="no">enableOCI: true</span>
  1580. <span class="w"> </span><span class="no">{{- else }}</span>
  1581. <span class="w"> </span><span class="no">enableOCI: false</span>
  1582. <span class="w"> </span><span class="no">{{- end }}</span>
  1583. <span class="w"> </span><span class="no"># Fixed values</span>
  1584. <span class="w"> </span><span class="no">application-type: grafana</span>
  1585. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1586. <span class="w"> </span><span class="no">#dynamic timestamp generation</span>
  1587. <span class="w"> </span><span class="no">last-synced-for-user/{{ .user }}: {{ now }}</span>
  1588. <span class="nn">---</span>
  1589. <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>
  1590. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1591. <span class="nt">metadata</span><span class="p">:</span>
  1592. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-template-example</span>
  1593. <span class="nt">spec</span><span class="p">:</span>
  1594. <span class="w"> </span><span class="c1"># ...</span>
  1595. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1596. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-to-be-created</span>
  1597. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1598. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1599. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1600. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Data</span>
  1601. <span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1602. <span class="w"> </span><span class="c1"># name of the configmap to pull in</span>
  1603. <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">grafana-config-tpl</span>
  1604. <span class="w"> </span><span class="c1"># here you define the keys that should be used as template</span>
  1605. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1606. <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.yaml</span>
  1607. <span class="w"> </span><span class="nt">templateAs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Values</span>
  1608. <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">templated</span>
  1609. <span class="w"> </span><span class="nt">templateAs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">KeysAndValues</span>
  1610. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Annotations</span>
  1611. <span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1612. <span class="w"> </span><span class="c1"># name of the configmap to pull in</span>
  1613. <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">grafana-config-tpl</span>
  1614. <span class="w"> </span><span class="c1"># here you define the keys that should be used as template</span>
  1615. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1616. <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">annotations</span>
  1617. <span class="w"> </span><span class="nt">templateAs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">KeysAndValues</span>
  1618. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1619. <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">user</span>
  1620. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1621. <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">/grafana/user</span>
  1622. <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">password</span>
  1623. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1624. <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">/grafana/password</span>
  1625. <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">uri</span>
  1626. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1627. <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">/grafana/uri</span>
  1628. </code></pre></div>
  1629. <p><code>TemplateFrom</code> also gives you the ability to Target your template to the Secret's Annotations, Labels or the Data block. It also allows you to render the templated information as <code>Values</code> or as <code>KeysAndValues</code> through the <code>templateAs</code> configuration:</p>
  1630. <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>
  1631. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1632. <span class="nt">metadata</span><span class="p">:</span>
  1633. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-template-example</span>
  1634. <span class="nt">spec</span><span class="p">:</span>
  1635. <span class="w"> </span><span class="c1"># ...</span>
  1636. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1637. <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">secret-to-be-created</span>
  1638. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1639. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1640. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1641. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Annotations</span>
  1642. <span class="w"> </span><span class="nt">literal</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;last-sync-for-user/{{</span><span class="nv"> </span><span class="s">.user</span><span class="nv"> </span><span class="s">}}:</span><span class="nv"> </span><span class="s">{{</span><span class="nv"> </span><span class="s">.now</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1643. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1644. <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">user</span>
  1645. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1646. <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">/grafana/user</span>
  1647. <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">password</span>
  1648. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1649. <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">/grafana/password</span>
  1650. </code></pre></div>
  1651. <p>Lastly, <code>TemplateFrom</code> also supports adding <code>Literal</code> blocks for quick templating. These <code>Literal</code> blocks differ from <code>Template.Data</code> as they are rendered as a a <code>key:value</code> pair (while the <code>Template.Data</code>, you can only template the value).</p>
  1652. <p>See an example, how to produce a <code>htpasswd</code> file that can be used by an ingress-controller (for example: https://kubernetes.github.io/ingress-nginx/examples/auth/basic/) where the contents of the <code>htpasswd</code> file needs to be presented via the <code>auth</code> key. We use the <code>htpasswd</code> function to create a <code>bcrytped</code> hash of the password.</p>
  1653. <p>Suppose you have multiple key-value pairs within your provider secret like</p>
  1654. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1655. <span class="w"> </span><span class="nt">&quot;user1&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;password1&quot;</span><span class="p">,</span>
  1656. <span class="w"> </span><span class="nt">&quot;user2&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;password2&quot;</span><span class="p">,</span>
  1657. <span class="w"> </span><span class="err">...</span>
  1658. <span class="p">}</span>
  1659. </code></pre></div>
  1660. <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>
  1661. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1662. <span class="nt">metadata</span><span class="p">:</span>
  1663. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-template-example</span>
  1664. <span class="nt">spec</span><span class="p">:</span>
  1665. <span class="w"> </span><span class="c1"># ...</span>
  1666. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1667. <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">secret-to-be-created</span>
  1668. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1669. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1670. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1671. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Data</span>
  1672. <span class="w"> </span><span class="nt">literal</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|-</span>
  1673. <span class="w"> </span><span class="no">{{- $creds := list }}</span>
  1674. <span class="w"> </span><span class="no">{{- range $user, $pw := . }}</span>
  1675. <span class="w"> </span><span class="no">{{- $creds = append $creds (printf &quot;%s&quot; (htpasswd $user $pw)) }}</span>
  1676. <span class="w"> </span><span class="no">{{- end }}</span>
  1677. <span class="w"> </span><span class="no">auth: {{ $creds | join &quot;\n&quot; | quote }}</span>
  1678. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1679. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1680. <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">/ingress-controller/valid-users</span>
  1681. </code></pre></div>
  1682. <h3 id="extract-keys-and-certificates-from-pkcs12-archive">Extract Keys and Certificates from PKCS#12 Archive</h3>
  1683. <p>You can use pre-defined functions to extract data from your secrets. Here: extract keys and certificates from a PKCS#12 archive and store it as PEM.</p>
  1684. <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>
  1685. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1686. <span class="nt">metadata</span><span class="p">:</span>
  1687. <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">template</span>
  1688. <span class="nt">spec</span><span class="p">:</span>
  1689. <span class="w"> </span><span class="c1"># ...</span>
  1690. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1691. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1692. <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/tls</span>
  1693. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1694. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1695. <span class="w"> </span><span class="nt">tls.crt</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">pkcs12cert</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1696. <span class="w"> </span><span class="nt">tls.key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">pkcs12key</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1697. <span class="w"> </span><span class="c1"># if needed unlock the pkcs12 with the password</span>
  1698. <span class="w"> </span><span class="nt">tls.crt</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">pkcs12certPass</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">my-password&quot; }}&quot;</span>
  1699. </code></pre></div>
  1700. <h3 id="extract-from-jwk">Extract from JWK</h3>
  1701. <p>You can extract the public or private key parts of a JWK and use them as <a href="https://pkg.go.dev/crypto/x509#ParsePKCS8PrivateKey">PKCS#8</a> private key or PEM-encoded <a href="https://pkg.go.dev/crypto/x509#MarshalPKIXPublicKey">PKIX</a> public key.</p>
  1702. <p>A JWK looks similar to this:</p>
  1703. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1704. <span class="w"> </span><span class="nt">&quot;kty&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;RSA&quot;</span><span class="p">,</span>
  1705. <span class="w"> </span><span class="nt">&quot;kid&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cc34c0a0-bd5a-4a3c-a50d-a2a7db7643df&quot;</span><span class="p">,</span>
  1706. <span class="w"> </span><span class="nt">&quot;use&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;sig&quot;</span><span class="p">,</span>
  1707. <span class="w"> </span><span class="nt">&quot;n&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;pjdss...&quot;</span><span class="p">,</span>
  1708. <span class="w"> </span><span class="nt">&quot;e&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;AQAB&quot;</span>
  1709. <span class="w"> </span><span class="c1">// ...</span>
  1710. <span class="p">}</span>
  1711. </code></pre></div>
  1712. <p>And what you want may be a PEM-encoded public or private key portion of it. Take a look at this example on how to transform it into the desired format:</p>
  1713. <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>
  1714. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1715. <span class="nt">metadata</span><span class="p">:</span>
  1716. <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">template</span>
  1717. <span class="nt">spec</span><span class="p">:</span>
  1718. <span class="w"> </span><span class="c1"># ...</span>
  1719. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1720. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1721. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1722. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1723. <span class="w"> </span><span class="c1"># .myjwk is a json-encoded JWK string.</span>
  1724. <span class="w"> </span><span class="c1">#</span>
  1725. <span class="w"> </span><span class="c1"># this template will produce for jwk_pub a PEM encoded public key:</span>
  1726. <span class="w"> </span><span class="c1"># -----BEGIN PUBLIC KEY-----</span>
  1727. <span class="w"> </span><span class="c1"># MIIBI...</span>
  1728. <span class="w"> </span><span class="c1"># ...</span>
  1729. <span class="w"> </span><span class="c1"># ...AQAB</span>
  1730. <span class="w"> </span><span class="c1"># -----END PUBLIC KEY-----</span>
  1731. <span class="w"> </span><span class="nt">jwk_pub</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.myjwk</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">jwkPublicKeyPem</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1732. <span class="w"> </span><span class="c1"># private key is a pem-encoded PKCS#8 private key</span>
  1733. <span class="w"> </span><span class="nt">jwk_priv</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.myjwk</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">jwkPrivateKeyPem</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1734. </code></pre></div>
  1735. <h3 id="filter-pem-blocks">Filter PEM blocks</h3>
  1736. <p>Consider you have a secret that contains both a certificate and a private key encoded in PEM format and it is your goal to use only the certificate from that secret.</p>
  1737. <div class="highlight"><pre><span></span><code>-----BEGIN PRIVATE KEY-----
  1738. MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCvxGZOW4IXvGlh
  1739. . . .
  1740. m8JCpbJXDfSSVxKHgK1Siw4K6pnTsIA2e/Z+Ha2fvtocERjq7VQMAJFaIZSTKo9Q
  1741. JwwY+vj0yxWjyzHUzZB33tg=
  1742. -----END PRIVATE KEY-----
  1743. -----BEGIN CERTIFICATE-----
  1744. MIIDMDCCAhigAwIBAgIQabPaXuZCQaCg+eQAVptGGDANBgkqhkiG9w0BAQsFADAV
  1745. . . .
  1746. NtFUGA95RGN9s+pl6XY0YARPHf5O76ErC1OZtDTR5RdyQfcM+94gYZsexsXl0aQO
  1747. 9YD3Wg==
  1748. -----END CERTIFICATE-----
  1749. </code></pre></div>
  1750. <p>You can achieve that by using the <code>filterPEM</code> function to extract a specific type of PEM block from that secret. If multiple blocks of that type (here: <code>CERTIFICATE</code>) exist, all of them are returned in the order specified. To extract a specific type of PEM block, pass the type as a string argument to the filterPEM function. Take a look at this example of how to transform a secret which contains a private key and a certificate into the desired format:</p>
  1751. <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>
  1752. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1753. <span class="nt">metadata</span><span class="p">:</span>
  1754. <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">template</span>
  1755. <span class="nt">spec</span><span class="p">:</span>
  1756. <span class="w"> </span><span class="c1"># ...</span>
  1757. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1758. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1759. <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/tls</span>
  1760. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1761. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1762. <span class="w"> </span><span class="nt">tls.crt</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">filterPEM</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">CERTIFICATE&quot; }}&quot;</span>
  1763. <span class="w"> </span><span class="nt">tls.key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">filterPEM</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">PRIVATE KEY&quot; }}&quot;</span>
  1764. </code></pre></div>
  1765. <p>In case you have a secret that contains a (partial) certificate chain you can extract the <code>leaf</code>, <code>intermediate</code> or <code>root</code> certificate(s) using the <code>filterCertChain</code> function. See the following example on how to use the <code>filterPEM</code> and <code>filterCertChain</code> functions together to split the certificate chain into a <code>tls.crt</code> part only containing the leaf certificate and a <code>ca.crt</code> part with all the intermediate certificates.</p>
  1766. <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>
  1767. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1768. <span class="nt">metadata</span><span class="p">:</span>
  1769. <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">template</span>
  1770. <span class="nt">spec</span><span class="p">:</span>
  1771. <span class="w"> </span><span class="c1"># ...</span>
  1772. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1773. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1774. <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/tls</span>
  1775. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1776. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1777. <span class="w"> </span><span class="nt">ca.crt</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">filterPEM</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">CERTIFICATE&quot; | filterCertChain &quot;intermediate&quot; }}&quot;</span>
  1778. <span class="w"> </span><span class="nt">tls.crt</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">filterPEM</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">CERTIFICATE&quot; | filterCertChain &quot;leaf&quot; }}&quot;</span>
  1779. <span class="w"> </span><span class="nt">tls.key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.mysecret</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">filterPEM</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">PRIVATE KEY&quot; }}&quot;</span>
  1780. </code></pre></div>
  1781. <h3 id="rsa-decryption-data-from-provider">RSA Decryption Data From Provider</h3>
  1782. <p>When a provider returns RSA-encrypted values, you can decrypt them directly in the template using the <code>rsaDecrypt</code> functions (engine v2).
  1783. <code>rsaDecrypt</code> performs decryption with the private key passed through the pipeline: <code>&lt;privateKeyPEM | rsaDecrypt "&lt;SCHEME&gt;" "&lt;HASH&gt;" &lt;ciphertext&gt; &gt;</code>. <code>SCHEME</code> and <code>HASH</code> are strings (for example, <code>"RSA-OAEP"</code> and <code>"SHA1"</code>). The third argument must be the ciphertext in binary form.</p>
  1784. <p>Base64 handling: providers often return ciphertext as Base64. You can either:
  1785. - decode in the template with <code>b64dec</code> (for example: <code>(.password_encrypted_base64 | b64dec)</code>), or
  1786. - set <code>decodingStrategy: Base64</code> on the corresponding <code>spec.data.remoteRef</code> so the template receives binary data.</p>
  1787. <p>Prerequisites
  1788. - <code>spec.target.template.engineVersion: v2</code>.
  1789. - A valid RSA private key in PEM format without passphrase (from another reference in the same ExternalSecret).
  1790. - Ciphertext must match the key pair and the chosen algorithm/hash.</p>
  1791. <p>Full example:</p>
  1792. <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>
  1793. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1794. <span class="nt">metadata</span><span class="p">:</span>
  1795. <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">rsa-decrypt-template-v2</span>
  1796. <span class="nt">spec</span><span class="p">:</span>
  1797. <span class="w"> </span><span class="c1"># ...</span>
  1798. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1799. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1800. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1801. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1802. <span class="w"> </span><span class="c1"># Decrypt a binary ciphertext using a private key stored in a Kubernetes Secret.</span>
  1803. <span class="w"> </span><span class="c1"># rsaDecrypt(&quot;SCHEME&quot;, &quot;HASH&quot;, ciphertext, privateKeyPEM) decrypts the ciphertext (binary).</span>
  1804. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;{{</span><span class="nv"> </span><span class="s">rsaDecrypt</span><span class="nv"> </span><span class="s">&quot;RSA-OAEP&quot;</span><span class="nv"> </span><span class="s">&quot;SHA1&quot;</span><span class="nv"> </span><span class="s">.password_encrypted_binary</span><span class="nv"> </span><span class="s">.privatekey</span><span class="nv"> </span><span class="s">}}&#39;</span>
  1805. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1806. <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">privatekey</span>
  1807. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1808. <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">a-secretname-in-cluster</span>
  1809. <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">privatekey</span>
  1810. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1811. <span class="w"> </span><span class="nt">storeRef</span><span class="p">:</span>
  1812. <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>
  1813. <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">kubernetes</span><span class="w"> </span><span class="c1"># name of the k8s provider</span>
  1814. <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">password_encrypted_binary</span>
  1815. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1816. <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">/credentials/password_encrypted_binary</span>
  1817. <span class="w"> </span><span class="c1"># If ciphertext is Base64 encoded, either decode in-template (b64dec) or use decodingStrategy: Base64</span>
  1818. <span class="w"> </span><span class="c1"># Example (decode here -&gt; template receives binary):</span>
  1819. <span class="w"> </span><span class="c1"># - secretKey: password_encrypted_base64</span>
  1820. <span class="w"> </span><span class="c1"># remoteRef:</span>
  1821. <span class="w"> </span><span class="c1"># key: /credentials/password_encrypted_base64</span>
  1822. <span class="w"> </span><span class="c1"># decodingStrategy: Base64</span>
  1823. <span class="w"> </span><span class="c1"># ...</span>
  1824. </code></pre></div>
  1825. <p>Useful variations (included as comments in the example):
  1826. - Base64 decode in the template with <code>b64dec</code> or via <code>decodingStrategy: Base64</code> on <code>spec.data</code>.
  1827. - Use a private key available in the same ExternalSecret (for example: <code>( .private_key | rsaDecrypt ... )</code>).</p>
  1828. <p>Error notes
  1829. - Referencing a missing key in the template will fail rendering.
  1830. - If key/algorithm/hash do not match the ciphertext, decryption will fail and reconciliation will retry.</p>
  1831. <h2 id="templating-with-pushsecret">Templating with PushSecret</h2>
  1832. <p><code>PushSecret</code> templating is much like <code>ExternalSecrets</code> templating. In-fact under the hood, it's using the same data structure.
  1833. Which means, anything described in the above should be possible with push secret as well resulting in a templated secret
  1834. created at the provider.</p>
  1835. <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>
  1836. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1837. <span class="nt">metadata</span><span class="p">:</span>
  1838. <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">template</span>
  1839. <span class="nt">spec</span><span class="p">:</span>
  1840. <span class="w"> </span><span class="c1"># ...</span>
  1841. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1842. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1843. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1844. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.token</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">toString</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">upper</span><span class="nv"> </span><span class="s">}}</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">templated&quot;</span>
  1845. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1846. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1847. <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">token</span>
  1848. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1849. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create-secret-name</span>
  1850. <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">token</span>
  1851. </code></pre></div>
  1852. <h2 id="helper-functions">Helper functions</h2>
  1853. <div class="admonition info inline end">
  1854. <p class="admonition-title">Info</p>
  1855. <p>Note: we removed <code>env</code> and <code>expandenv</code> from sprig functions for security reasons.</p>
  1856. </div>
  1857. <p>We provide a couple of convenience functions that help you transform your secrets. This is useful when dealing with PKCS#12 archives or JSON Web Keys (JWK).</p>
  1858. <p>In addition to that you can use over 200+ <a href="http://masterminds.github.io/sprig/">sprig functions</a>. If you feel a function is missing or might be valuable feel free to open an issue and submit a <a href="../../contributing/process/#submitting-a-pull-request">pull request</a>.</p>
  1859. <p><br/></p>
  1860. <table>
  1861. <thead>
  1862. <tr>
  1863. <th>Function</th>
  1864. <th>Description</th>
  1865. </tr>
  1866. </thead>
  1867. <tbody>
  1868. <tr>
  1869. <td>pkcs12key</td>
  1870. <td>Extracts all private keys from a PKCS#12 archive and encodes them in <strong>PKCS#8 PEM</strong> format.</td>
  1871. </tr>
  1872. <tr>
  1873. <td>pkcs12keyPass</td>
  1874. <td>Same as <code>pkcs12key</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  1875. </tr>
  1876. <tr>
  1877. <td>pkcs12cert</td>
  1878. <td>Extracts all certificates from a PKCS#12 archive and orders them if possible. If disjunct or multiple leaf certs are provided they are returned as-is. <br/> Sort order: <code>leaf / intermediate(s) / root</code>.</td>
  1879. </tr>
  1880. <tr>
  1881. <td>pkcs12certPass</td>
  1882. <td>Same as <code>pkcs12cert</code>. Uses the provided password to decrypt the PKCS#12 archive.</td>
  1883. </tr>
  1884. <tr>
  1885. <td>pemToPkcs12</td>
  1886. <td>Takes a PEM encoded certificate and key and creates a base64 encoded PKCS#12 archive.</td>
  1887. </tr>
  1888. <tr>
  1889. <td>pemToPkcs12Pass</td>
  1890. <td>Same as <code>pemToPkcs12</code>. Uses the provided password to encrypt the PKCS#12 archive.</td>
  1891. </tr>
  1892. <tr>
  1893. <td>fullPemToPkcs12</td>
  1894. <td>Takes a PEM encoded certificates chain and key and creates a base64 encoded PKCS#12 archive.</td>
  1895. </tr>
  1896. <tr>
  1897. <td>fullPemToPkcs12Pass</td>
  1898. <td>Same as <code>fullPemToPkcs12</code>. Uses the provided password to encrypt the PKCS#12 archive.</td>
  1899. </tr>
  1900. <tr>
  1901. <td>pemTruststoreToPKCS12</td>
  1902. <td>Takes a PEM encoded certificates and creates a base64 encoded PKCS#12 archive.</td>
  1903. </tr>
  1904. <tr>
  1905. <td>pemTruststoreToPKCS12Pass</td>
  1906. <td>Same as <code>pemTruststoreToPKCS12</code>. Uses the provided password to encrypt the PKCS#12 archive.</td>
  1907. </tr>
  1908. <tr>
  1909. <td>filterPEM</td>
  1910. <td>Filters PEM blocks with a specific type from a list of PEM blocks.</td>
  1911. </tr>
  1912. <tr>
  1913. <td>filterCertChain</td>
  1914. <td>Filters PEM block(s) with a specific certificate type (<code>leaf</code>, <code>intermediate</code> or <code>root</code>) from a certificate chain of PEM blocks (PEM blocks with type <code>CERTIFICATE</code>).</td>
  1915. </tr>
  1916. <tr>
  1917. <td>jwkPublicKeyPem</td>
  1918. <td>Takes an json-serialized JWK and returns an PEM block of type <code>PUBLIC KEY</code> that contains the public key. <a href="https://golang.org/pkg/crypto/x509/#MarshalPKIXPublicKey">See here</a> for details.</td>
  1919. </tr>
  1920. <tr>
  1921. <td>jwkPrivateKeyPem</td>
  1922. <td>Takes an json-serialized JWK as <code>string</code> and returns an PEM block of type <code>PRIVATE KEY</code> that contains the private key in PKCS #8 format. <a href="https://golang.org/pkg/crypto/x509/#MarshalPKCS8PrivateKey">See here</a> for details.</td>
  1923. </tr>
  1924. <tr>
  1925. <td>rsaDecrypt</td>
  1926. <td>Decrypts RSA ciphertext using a PEM private key. Usage: <code>&lt;rsaDecrypt "SCHEME" "HASH" ciphertext privateKeyPEM&gt;</code> or <code>&lt;privateKeyPEM \| rsaDecrypt "SCHEME" "HASH" ciphertext&gt;</code>. <strong>SCHEME</strong>: supported values are <code>"None"</code> and <code>"RSA-OAEP"</code>. <strong>HASH</strong>: supported values are <code>"SHA1"</code> and <code>"SHA256"</code>. <strong>Ciphertext</strong> must be binary — use <code>b64dec</code> or <code>decodingStrategy: Base64</code> to convert Base64 payloads.</td>
  1927. </tr>
  1928. <tr>
  1929. <td>toYaml</td>
  1930. <td>Takes an interface, marshals it to yaml. It returns a string, even on marshal error (empty string).</td>
  1931. </tr>
  1932. <tr>
  1933. <td>fromYaml</td>
  1934. <td>Function converts a YAML document into a map[string]any.</td>
  1935. </tr>
  1936. </tbody>
  1937. </table>
  1938. <h2 id="migrating-from-v1">Migrating from v1</h2>
  1939. <p>If you are still using <code>v1alpha1</code>, You have to opt-in to use the new engine version by specifying <code>template.engineVersion=v2</code>:</p>
  1940. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  1941. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1942. <span class="nt">metadata</span><span class="p">:</span>
  1943. <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">secret</span>
  1944. <span class="nt">spec</span><span class="p">:</span>
  1945. <span class="w"> </span><span class="c1"># ...</span>
  1946. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1947. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1948. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1949. <span class="w"> </span><span class="c1"># ...</span>
  1950. </code></pre></div>
  1951. <p>The biggest change was that basically all function parameter types were changed from accepting/returning <code>[]byte</code> to <code>string</code>. This is relevant for you because now you don't need to specify <code>toString</code> all the time at the end of a template pipeline.</p>
  1952. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  1953. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1954. <span class="c1"># ...</span>
  1955. <span class="nt">spec</span><span class="p">:</span>
  1956. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1957. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1958. <span class="w"> </span><span class="nt">engineVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1959. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1960. <span class="w"> </span><span class="c1"># this used to be {{ .foobar | toString }}</span>
  1961. <span class="w"> </span><span class="nt">egg</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;new:</span><span class="nv"> </span><span class="s">{{</span><span class="nv"> </span><span class="s">.foobar</span><span class="nv"> </span><span class="s">}}&quot;</span>
  1962. </code></pre></div>
  1963. <h5 id="functions-removedreplaced">Functions removed/replaced</h5>
  1964. <ul>
  1965. <li><code>base64encode</code> was renamed to <code>b64enc</code>.</li>
  1966. <li><code>base64decode</code> was renamed to <code>b64dec</code>. Any errors that occur during decoding are silenced.</li>
  1967. <li><code>fromJSON</code> was renamed to <code>fromJson</code>. Any errors that occur during unmarshalling are silenced.</li>
  1968. <li><code>toJSON</code> was renamed to <code>toJson</code>. Any errors that occur during marshalling are silenced.</li>
  1969. <li><code>pkcs12key</code> and <code>pkcs12keyPass</code> encode the PKCS#8 key directly into PEM format. There is no need to call <code>pemPrivateKey</code> anymore. Also, these functions do extract all private keys from the PKCS#12 archive not just the first one.</li>
  1970. <li><code>pkcs12cert</code> and <code>pkcs12certPass</code> encode the certs directly into PEM format. There is no need to call <code>pemCertificate</code> anymore. These functions now <strong>extract all certificates</strong> from the PKCS#12 archive not just the first one.</li>
  1971. <li><code>toString</code> implementation was replaced by the <code>sprig</code> implementation and should be api-compatible.</li>
  1972. <li><code>toBytes</code> was removed.</li>
  1973. <li><code>pemPrivateKey</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  1974. <li><code>pemCertificate</code> was removed. It's now implemented within the <code>pkcs12*</code> functions.</li>
  1975. </ul>
  1976. </article>
  1977. </div>
  1978. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1979. </div>
  1980. </main>
  1981. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1982. <footer class="md-footer">
  1983. <div class="md-footer-meta md-typeset">
  1984. <div class="md-footer-meta__inner md-grid">
  1985. <div class="md-copyright">
  1986. <div class="md-copyright__highlight">
  1987. &copy; 2025 The external-secrets Authors.<br/>
  1988. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1989. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1990. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1991. </div>
  1992. Made with
  1993. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1994. Material for MkDocs
  1995. </a>
  1996. </div>
  1997. </div>
  1998. </div>
  1999. </footer>
  2000. </div>
  2001. <div class="md-dialog" data-md-component="dialog">
  2002. <div class="md-dialog__inner md-typeset"></div>
  2003. </div>
  2004. <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.2c215733.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>
  2005. <script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
  2006. </body>
  2007. </html>