index.html 119 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833
  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="../delinea/">
  7. <link rel="next" href="../passbolt/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
  10. <title>Secret Server - 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="#delinea-secret-serverplatform" 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. Secret Server
  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">
  132. <a href="../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item md-tabs__item--active">
  137. <a href="../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/grafana/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. Grafana
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../../api/generator/quay/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. Quay
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/generator/vault/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Vault Dynamic Secret
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../api/generator/password/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. Password
  412. </span>
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../api/generator/fake/" class="md-nav__link">
  417. <span class="md-ellipsis">
  418. Fake
  419. </span>
  420. </a>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../../api/generator/webhook/" class="md-nav__link">
  424. <span class="md-ellipsis">
  425. Webhook
  426. </span>
  427. </a>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="../../api/generator/github/" class="md-nav__link">
  431. <span class="md-ellipsis">
  432. Github
  433. </span>
  434. </a>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../../api/generator/uuid/" class="md-nav__link">
  438. <span class="md-ellipsis">
  439. UUID
  440. </span>
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../api/generator/mfa/" class="md-nav__link">
  445. <span class="md-ellipsis">
  446. MFA
  447. </span>
  448. </a>
  449. </li>
  450. <li class="md-nav__item">
  451. <a href="../../api/generator/sshkey/" class="md-nav__link">
  452. <span class="md-ellipsis">
  453. SSHKey
  454. </span>
  455. </a>
  456. </li>
  457. </ul>
  458. </nav>
  459. </li>
  460. <li class="md-nav__item md-nav__item--nested">
  461. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  462. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  463. <span class="md-ellipsis">
  464. Reference Docs
  465. </span>
  466. <span class="md-nav__icon md-icon"></span>
  467. </label>
  468. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  469. <label class="md-nav__title" for="__nav_2_4">
  470. <span class="md-nav__icon md-icon"></span>
  471. Reference Docs
  472. </label>
  473. <ul class="md-nav__list" data-md-scrollfix>
  474. <li class="md-nav__item">
  475. <a href="../../api/spec/" class="md-nav__link">
  476. <span class="md-ellipsis">
  477. API specification
  478. </span>
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../../api/controller-options/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. Controller Options
  485. </span>
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../api/metrics/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. Metrics
  492. </span>
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../api/selectable-fields/" class="md-nav__link">
  497. <span class="md-ellipsis">
  498. Selectable Fields
  499. </span>
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. </ul>
  506. </nav>
  507. </li>
  508. <li class="md-nav__item md-nav__item--nested">
  509. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  510. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  511. <span class="md-ellipsis">
  512. Guides
  513. </span>
  514. <span class="md-nav__icon md-icon"></span>
  515. </label>
  516. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  517. <label class="md-nav__title" for="__nav_3">
  518. <span class="md-nav__icon md-icon"></span>
  519. Guides
  520. </label>
  521. <ul class="md-nav__list" data-md-scrollfix>
  522. <li class="md-nav__item">
  523. <a href="../../guides/introduction/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. Introduction
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item md-nav__item--nested">
  530. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  531. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  532. <span class="md-ellipsis">
  533. External Secrets
  534. </span>
  535. <span class="md-nav__icon md-icon"></span>
  536. </label>
  537. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  538. <label class="md-nav__title" for="__nav_3_2">
  539. <span class="md-nav__icon md-icon"></span>
  540. External Secrets
  541. </label>
  542. <ul class="md-nav__list" data-md-scrollfix>
  543. <li class="md-nav__item">
  544. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. Extract structured data
  547. </span>
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../guides/getallsecrets/" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. Find Secrets by Name or Metadata
  554. </span>
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  559. <span class="md-ellipsis">
  560. Rewriting Keys
  561. </span>
  562. </a>
  563. </li>
  564. <li class="md-nav__item md-nav__item--nested">
  565. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  566. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  567. <span class="md-ellipsis">
  568. Advanced Templating
  569. </span>
  570. <span class="md-nav__icon md-icon"></span>
  571. </label>
  572. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  573. <label class="md-nav__title" for="__nav_3_2_4">
  574. <span class="md-nav__icon md-icon"></span>
  575. Advanced Templating
  576. </label>
  577. <ul class="md-nav__list" data-md-scrollfix>
  578. <li class="md-nav__item">
  579. <a href="../../guides/templating/" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. v2
  582. </span>
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../guides/templating-v1/" class="md-nav__link">
  587. <span class="md-ellipsis">
  588. v1
  589. </span>
  590. </a>
  591. </li>
  592. </ul>
  593. </nav>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. Kubernetes Secret Types
  599. </span>
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  604. <span class="md-ellipsis">
  605. Lifecycle: ownership & deletion
  606. </span>
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  611. <span class="md-ellipsis">
  612. Decoding Strategies
  613. </span>
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../../guides/controller-class/" class="md-nav__link">
  618. <span class="md-ellipsis">
  619. Controller Classes
  620. </span>
  621. </a>
  622. </li>
  623. </ul>
  624. </nav>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../guides/targeting-custom-resources/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Targeting Custom Resources
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../guides/generator/" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. Generators
  637. </span>
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../guides/pushsecrets/" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. Push Secrets
  644. </span>
  645. </a>
  646. </li>
  647. <li class="md-nav__item md-nav__item--nested">
  648. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  649. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  650. <span class="md-ellipsis">
  651. Operations
  652. </span>
  653. <span class="md-nav__icon md-icon"></span>
  654. </label>
  655. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  656. <label class="md-nav__title" for="__nav_3_6">
  657. <span class="md-nav__icon md-icon"></span>
  658. Operations
  659. </label>
  660. <ul class="md-nav__list" data-md-scrollfix>
  661. <li class="md-nav__item">
  662. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  663. <span class="md-ellipsis">
  664. Multi Tenancy
  665. </span>
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../guides/security-best-practices/" class="md-nav__link">
  670. <span class="md-ellipsis">
  671. Security Best Practices
  672. </span>
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../guides/threat-model/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. Threat Model
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../guides/v1beta1/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. Upgrading to v1beta1
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../guides/using-latest-image/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Using Latest Image
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. Disable Cluster Features
  700. </span>
  701. </a>
  702. </li>
  703. </ul>
  704. </nav>
  705. </li>
  706. <li class="md-nav__item md-nav__item--nested">
  707. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_7" >
  708. <label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="0">
  709. <span class="md-ellipsis">
  710. Tooling
  711. </span>
  712. <span class="md-nav__icon md-icon"></span>
  713. </label>
  714. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
  715. <label class="md-nav__title" for="__nav_3_7">
  716. <span class="md-nav__icon md-icon"></span>
  717. Tooling
  718. </label>
  719. <ul class="md-nav__list" data-md-scrollfix>
  720. <li class="md-nav__item">
  721. <a href="../../guides/using-esoctl-tool/" class="md-nav__link">
  722. <span class="md-ellipsis">
  723. Using the esoctl tool
  724. </span>
  725. </a>
  726. </li>
  727. </ul>
  728. </nav>
  729. </li>
  730. </ul>
  731. </nav>
  732. </li>
  733. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  734. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  735. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  736. <span class="md-ellipsis">
  737. Provider
  738. </span>
  739. <span class="md-nav__icon md-icon"></span>
  740. </label>
  741. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  742. <label class="md-nav__title" for="__nav_4">
  743. <span class="md-nav__icon md-icon"></span>
  744. Provider
  745. </label>
  746. <ul class="md-nav__list" data-md-scrollfix>
  747. <li class="md-nav__item">
  748. <a href="../aws-secrets-manager/" class="md-nav__link">
  749. <span class="md-ellipsis">
  750. AWS Secrets Manager
  751. </span>
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="../aws-parameter-store/" class="md-nav__link">
  756. <span class="md-ellipsis">
  757. AWS Parameter Store
  758. </span>
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../aws-access/" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. AWS Access
  765. </span>
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../azure-key-vault/" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Azure Key Vault
  772. </span>
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="../barbican/" class="md-nav__link">
  777. <span class="md-ellipsis">
  778. Barbican
  779. </span>
  780. </a>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="../beyondtrust/" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. BeyondTrust
  786. </span>
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  791. <span class="md-ellipsis">
  792. Bitwarden Secrets Manager
  793. </span>
  794. </a>
  795. </li>
  796. <li class="md-nav__item">
  797. <a href="../chef/" class="md-nav__link">
  798. <span class="md-ellipsis">
  799. Chef
  800. </span>
  801. </a>
  802. </li>
  803. <li class="md-nav__item">
  804. <a href="../cloudru/" class="md-nav__link">
  805. <span class="md-ellipsis">
  806. Cloud.ru Secret Manager
  807. </span>
  808. </a>
  809. </li>
  810. <li class="md-nav__item">
  811. <a href="../conjur/" class="md-nav__link">
  812. <span class="md-ellipsis">
  813. CyberArk Conjur
  814. </span>
  815. </a>
  816. </li>
  817. <li class="md-nav__item">
  818. <a href="../google-secrets-manager/" class="md-nav__link">
  819. <span class="md-ellipsis">
  820. Google Cloud Secret Manager
  821. </span>
  822. </a>
  823. </li>
  824. <li class="md-nav__item">
  825. <a href="../hashicorp-vault/" class="md-nav__link">
  826. <span class="md-ellipsis">
  827. HashiCorp Vault
  828. </span>
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="../kubernetes/" class="md-nav__link">
  833. <span class="md-ellipsis">
  834. Kubernetes
  835. </span>
  836. </a>
  837. </li>
  838. <li class="md-nav__item">
  839. <a href="../ibm-secrets-manager/" class="md-nav__link">
  840. <span class="md-ellipsis">
  841. IBM Secrets Manager
  842. </span>
  843. </a>
  844. </li>
  845. <li class="md-nav__item">
  846. <a href="../akeyless/" class="md-nav__link">
  847. <span class="md-ellipsis">
  848. Akeyless
  849. </span>
  850. </a>
  851. </li>
  852. <li class="md-nav__item">
  853. <a href="../yandex-certificate-manager/" class="md-nav__link">
  854. <span class="md-ellipsis">
  855. Yandex Certificate Manager
  856. </span>
  857. </a>
  858. </li>
  859. <li class="md-nav__item">
  860. <a href="../yandex-lockbox/" class="md-nav__link">
  861. <span class="md-ellipsis">
  862. Yandex Lockbox
  863. </span>
  864. </a>
  865. </li>
  866. <li class="md-nav__item">
  867. <a href="../gitlab-variables/" class="md-nav__link">
  868. <span class="md-ellipsis">
  869. GitLab Variables
  870. </span>
  871. </a>
  872. </li>
  873. <li class="md-nav__item">
  874. <a href="../github/" class="md-nav__link">
  875. <span class="md-ellipsis">
  876. Github Actions Secrets
  877. </span>
  878. </a>
  879. </li>
  880. <li class="md-nav__item">
  881. <a href="../oracle-vault/" class="md-nav__link">
  882. <span class="md-ellipsis">
  883. Oracle Vault
  884. </span>
  885. </a>
  886. </li>
  887. <li class="md-nav__item">
  888. <a href="../ovhcloud/" class="md-nav__link">
  889. <span class="md-ellipsis">
  890. OVHcloud
  891. </span>
  892. </a>
  893. </li>
  894. <li class="md-nav__item">
  895. <a href="../1password-automation/" class="md-nav__link">
  896. <span class="md-ellipsis">
  897. 1Password Connect Server
  898. </span>
  899. </a>
  900. </li>
  901. <li class="md-nav__item">
  902. <a href="../1password-sdk/" class="md-nav__link">
  903. <span class="md-ellipsis">
  904. 1Password SDK
  905. </span>
  906. </a>
  907. </li>
  908. <li class="md-nav__item">
  909. <a href="../webhook/" class="md-nav__link">
  910. <span class="md-ellipsis">
  911. Webhook
  912. </span>
  913. </a>
  914. </li>
  915. <li class="md-nav__item">
  916. <a href="../fake/" class="md-nav__link">
  917. <span class="md-ellipsis">
  918. Fake
  919. </span>
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="../senhasegura-dsm/" class="md-nav__link">
  924. <span class="md-ellipsis">
  925. senhasegura DevOps Secrets Management (DSM)
  926. </span>
  927. </a>
  928. </li>
  929. <li class="md-nav__item">
  930. <a href="../doppler/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. Doppler
  933. </span>
  934. </a>
  935. </li>
  936. <li class="md-nav__item">
  937. <a href="../keeper-security/" class="md-nav__link">
  938. <span class="md-ellipsis">
  939. Keeper Security
  940. </span>
  941. </a>
  942. </li>
  943. <li class="md-nav__item">
  944. <a href="../cloak/" class="md-nav__link">
  945. <span class="md-ellipsis">
  946. Cloak End 2 End Encrypted Secrets
  947. </span>
  948. </a>
  949. </li>
  950. <li class="md-nav__item">
  951. <a href="../scaleway/" class="md-nav__link">
  952. <span class="md-ellipsis">
  953. Scaleway
  954. </span>
  955. </a>
  956. </li>
  957. <li class="md-nav__item">
  958. <a href="../delinea/" class="md-nav__link">
  959. <span class="md-ellipsis">
  960. Delinea
  961. </span>
  962. </a>
  963. </li>
  964. <li class="md-nav__item md-nav__item--active">
  965. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  966. <label class="md-nav__link md-nav__link--active" for="__toc">
  967. <span class="md-ellipsis">
  968. Secret Server
  969. </span>
  970. <span class="md-nav__icon md-icon"></span>
  971. </label>
  972. <a href="./" class="md-nav__link md-nav__link--active">
  973. <span class="md-ellipsis">
  974. Secret Server
  975. </span>
  976. </a>
  977. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  978. <label class="md-nav__title" for="__toc">
  979. <span class="md-nav__icon md-icon"></span>
  980. Table of contents
  981. </label>
  982. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  983. <li class="md-nav__item">
  984. <a href="#creating-a-secretstore" class="md-nav__link">
  985. <span class="md-ellipsis">
  986. Creating a SecretStore
  987. </span>
  988. </a>
  989. </li>
  990. <li class="md-nav__item">
  991. <a href="#referencing-secrets" class="md-nav__link">
  992. <span class="md-ellipsis">
  993. Referencing Secrets
  994. </span>
  995. </a>
  996. </li>
  997. <li class="md-nav__item">
  998. <a href="#working-with-plain-text-itemvalue-fields" class="md-nav__link">
  999. <span class="md-ellipsis">
  1000. Working with Plain Text ItemValue Fields
  1001. </span>
  1002. </a>
  1003. <nav class="md-nav" aria-label="Working with Plain Text ItemValue Fields">
  1004. <ul class="md-nav__list">
  1005. <li class="md-nav__item">
  1006. <a href="#example-with-plain-text-password-field" class="md-nav__link">
  1007. <span class="md-ellipsis">
  1008. Example with Plain Text Password Field
  1009. </span>
  1010. </a>
  1011. </li>
  1012. </ul>
  1013. </nav>
  1014. </li>
  1015. <li class="md-nav__item">
  1016. <a href="#support-for-fetching-secrets-by-path" class="md-nav__link">
  1017. <span class="md-ellipsis">
  1018. Support for Fetching Secrets by Path
  1019. </span>
  1020. </a>
  1021. <nav class="md-nav" aria-label="Support for Fetching Secrets by Path">
  1022. <ul class="md-nav__list">
  1023. <li class="md-nav__item">
  1024. <a href="#example" class="md-nav__link">
  1025. <span class="md-ellipsis">
  1026. Example
  1027. </span>
  1028. </a>
  1029. </li>
  1030. <li class="md-nav__item">
  1031. <a href="#notes" class="md-nav__link">
  1032. <span class="md-ellipsis">
  1033. Notes:
  1034. </span>
  1035. </a>
  1036. </li>
  1037. </ul>
  1038. </nav>
  1039. </li>
  1040. <li class="md-nav__item">
  1041. <a href="#preparing-your-secret" class="md-nav__link">
  1042. <span class="md-ellipsis">
  1043. Preparing your secret
  1044. </span>
  1045. </a>
  1046. <nav class="md-nav" aria-label="Preparing your secret">
  1047. <ul class="md-nav__list">
  1048. <li class="md-nav__item">
  1049. <a href="#examples" class="md-nav__link">
  1050. <span class="md-ellipsis">
  1051. Examples
  1052. </span>
  1053. </a>
  1054. </li>
  1055. </ul>
  1056. </nav>
  1057. </li>
  1058. <li class="md-nav__item">
  1059. <a href="#referencing-secrets-by-field-name-or-slug" class="md-nav__link">
  1060. <span class="md-ellipsis">
  1061. Referencing Secrets by Field Name or Slug
  1062. </span>
  1063. </a>
  1064. <nav class="md-nav" aria-label="Referencing Secrets by Field Name or Slug">
  1065. <ul class="md-nav__list">
  1066. <li class="md-nav__item">
  1067. <a href="#examples_1" class="md-nav__link">
  1068. <span class="md-ellipsis">
  1069. Examples
  1070. </span>
  1071. </a>
  1072. </li>
  1073. </ul>
  1074. </nav>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="#pushing-secrets" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. Pushing Secrets
  1080. </span>
  1081. </a>
  1082. <nav class="md-nav" aria-label="Pushing Secrets">
  1083. <ul class="md-nav__list">
  1084. <li class="md-nav__item">
  1085. <a href="#remote-key-formats-for-pushsecret" class="md-nav__link">
  1086. <span class="md-ellipsis">
  1087. Remote Key Formats for PushSecret
  1088. </span>
  1089. </a>
  1090. </li>
  1091. <li class="md-nav__item">
  1092. <a href="#requirements-for-creating-new-secrets" class="md-nav__link">
  1093. <span class="md-ellipsis">
  1094. Requirements for Creating New Secrets
  1095. </span>
  1096. </a>
  1097. </li>
  1098. <li class="md-nav__item">
  1099. <a href="#updating-existing-secrets" class="md-nav__link">
  1100. <span class="md-ellipsis">
  1101. Updating Existing Secrets
  1102. </span>
  1103. </a>
  1104. </li>
  1105. <li class="md-nav__item">
  1106. <a href="#deletion-behavior" class="md-nav__link">
  1107. <span class="md-ellipsis">
  1108. Deletion Behavior
  1109. </span>
  1110. </a>
  1111. </li>
  1112. <li class="md-nav__item">
  1113. <a href="#pushing-without-a-property" class="md-nav__link">
  1114. <span class="md-ellipsis">
  1115. Pushing Without a Property
  1116. </span>
  1117. </a>
  1118. </li>
  1119. </ul>
  1120. </nav>
  1121. </li>
  1122. </ul>
  1123. </nav>
  1124. </li>
  1125. <li class="md-nav__item">
  1126. <a href="../passbolt/" class="md-nav__link">
  1127. <span class="md-ellipsis">
  1128. Passbolt
  1129. </span>
  1130. </a>
  1131. </li>
  1132. <li class="md-nav__item">
  1133. <a href="../pulumi/" class="md-nav__link">
  1134. <span class="md-ellipsis">
  1135. Pulumi ESC
  1136. </span>
  1137. </a>
  1138. </li>
  1139. <li class="md-nav__item">
  1140. <a href="../onboardbase/" class="md-nav__link">
  1141. <span class="md-ellipsis">
  1142. Onboardbase
  1143. </span>
  1144. </a>
  1145. </li>
  1146. <li class="md-nav__item">
  1147. <a href="../../provider-passworddepot/" class="md-nav__link">
  1148. <span class="md-ellipsis">
  1149. Password Depot
  1150. </span>
  1151. </a>
  1152. </li>
  1153. <li class="md-nav__item">
  1154. <a href="../fortanix/" class="md-nav__link">
  1155. <span class="md-ellipsis">
  1156. Fortanix
  1157. </span>
  1158. </a>
  1159. </li>
  1160. <li class="md-nav__item">
  1161. <a href="../infisical/" class="md-nav__link">
  1162. <span class="md-ellipsis">
  1163. Infisical
  1164. </span>
  1165. </a>
  1166. </li>
  1167. <li class="md-nav__item">
  1168. <a href="../previder/" class="md-nav__link">
  1169. <span class="md-ellipsis">
  1170. Previder
  1171. </span>
  1172. </a>
  1173. </li>
  1174. <li class="md-nav__item">
  1175. <a href="../openbao/" class="md-nav__link">
  1176. <span class="md-ellipsis">
  1177. OpenBao
  1178. </span>
  1179. </a>
  1180. </li>
  1181. <li class="md-nav__item">
  1182. <a href="../volcengine/" class="md-nav__link">
  1183. <span class="md-ellipsis">
  1184. Volcengine
  1185. </span>
  1186. </a>
  1187. </li>
  1188. <li class="md-nav__item">
  1189. <a href="../ngrok/" class="md-nav__link">
  1190. <span class="md-ellipsis">
  1191. ngrok
  1192. </span>
  1193. </a>
  1194. </li>
  1195. <li class="md-nav__item">
  1196. <a href="../devolutions-server/" class="md-nav__link">
  1197. <span class="md-ellipsis">
  1198. Devolutions Server
  1199. </span>
  1200. </a>
  1201. </li>
  1202. <li class="md-nav__item">
  1203. <a href="../nebius-mysterybox/" class="md-nav__link">
  1204. <span class="md-ellipsis">
  1205. Nebius MysteryBox
  1206. </span>
  1207. </a>
  1208. </li>
  1209. </ul>
  1210. </nav>
  1211. </li>
  1212. <li class="md-nav__item md-nav__item--nested">
  1213. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1214. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1215. <span class="md-ellipsis">
  1216. Examples
  1217. </span>
  1218. <span class="md-nav__icon md-icon"></span>
  1219. </label>
  1220. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1221. <label class="md-nav__title" for="__nav_5">
  1222. <span class="md-nav__icon md-icon"></span>
  1223. Examples
  1224. </label>
  1225. <ul class="md-nav__list" data-md-scrollfix>
  1226. <li class="md-nav__item">
  1227. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1228. <span class="md-ellipsis">
  1229. FluxCD
  1230. </span>
  1231. </a>
  1232. </li>
  1233. <li class="md-nav__item">
  1234. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1235. <span class="md-ellipsis">
  1236. Anchore Engine
  1237. </span>
  1238. </a>
  1239. </li>
  1240. <li class="md-nav__item">
  1241. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1242. <span class="md-ellipsis">
  1243. Jenkins
  1244. </span>
  1245. </a>
  1246. </li>
  1247. <li class="md-nav__item">
  1248. <a href="../../examples/bitwarden/" class="md-nav__link">
  1249. <span class="md-ellipsis">
  1250. Bitwarden
  1251. </span>
  1252. </a>
  1253. </li>
  1254. </ul>
  1255. </nav>
  1256. </li>
  1257. <li class="md-nav__item md-nav__item--nested">
  1258. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1259. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1260. <span class="md-ellipsis">
  1261. Community
  1262. </span>
  1263. <span class="md-nav__icon md-icon"></span>
  1264. </label>
  1265. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1266. <label class="md-nav__title" for="__nav_6">
  1267. <span class="md-nav__icon md-icon"></span>
  1268. Community
  1269. </label>
  1270. <ul class="md-nav__list" data-md-scrollfix>
  1271. <li class="md-nav__item md-nav__item--nested">
  1272. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1273. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1274. <span class="md-ellipsis">
  1275. Contributing
  1276. </span>
  1277. <span class="md-nav__icon md-icon"></span>
  1278. </label>
  1279. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1280. <label class="md-nav__title" for="__nav_6_1">
  1281. <span class="md-nav__icon md-icon"></span>
  1282. Contributing
  1283. </label>
  1284. <ul class="md-nav__list" data-md-scrollfix>
  1285. <li class="md-nav__item">
  1286. <a href="../../contributing/devguide/" class="md-nav__link">
  1287. <span class="md-ellipsis">
  1288. Developer guide
  1289. </span>
  1290. </a>
  1291. </li>
  1292. <li class="md-nav__item">
  1293. <a href="../../contributing/process/" class="md-nav__link">
  1294. <span class="md-ellipsis">
  1295. Contributing Process
  1296. </span>
  1297. </a>
  1298. </li>
  1299. <li class="md-nav__item">
  1300. <a href="../../contributing/release/" class="md-nav__link">
  1301. <span class="md-ellipsis">
  1302. Release Process
  1303. </span>
  1304. </a>
  1305. </li>
  1306. <li class="md-nav__item">
  1307. <a href="../../contributing/coc/" class="md-nav__link">
  1308. <span class="md-ellipsis">
  1309. Code of Conduct
  1310. </span>
  1311. </a>
  1312. </li>
  1313. <li class="md-nav__item">
  1314. <a href="../../contributing/calendar/" class="md-nav__link">
  1315. <span class="md-ellipsis">
  1316. Community meetings calendar
  1317. </span>
  1318. </a>
  1319. </li>
  1320. <li class="md-nav__item">
  1321. <a href="../../contributing/roadmap/" class="md-nav__link">
  1322. <span class="md-ellipsis">
  1323. Roadmap
  1324. </span>
  1325. </a>
  1326. </li>
  1327. <li class="md-nav__item">
  1328. <a href="../../contributing/burnout-mitigation/" class="md-nav__link">
  1329. <span class="md-ellipsis">
  1330. Burnout Prevention
  1331. </span>
  1332. </a>
  1333. </li>
  1334. <li class="md-nav__item">
  1335. <a href="../../contributing/llm-policy/" class="md-nav__link">
  1336. <span class="md-ellipsis">
  1337. LLM Policy
  1338. </span>
  1339. </a>
  1340. </li>
  1341. </ul>
  1342. </nav>
  1343. </li>
  1344. <li class="md-nav__item md-nav__item--nested">
  1345. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1346. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1347. <span class="md-ellipsis">
  1348. External Resources
  1349. </span>
  1350. <span class="md-nav__icon md-icon"></span>
  1351. </label>
  1352. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1353. <label class="md-nav__title" for="__nav_6_2">
  1354. <span class="md-nav__icon md-icon"></span>
  1355. External Resources
  1356. </label>
  1357. <ul class="md-nav__list" data-md-scrollfix>
  1358. <li class="md-nav__item">
  1359. <a href="../../eso-talks/" class="md-nav__link">
  1360. <span class="md-ellipsis">
  1361. Talks
  1362. </span>
  1363. </a>
  1364. </li>
  1365. <li class="md-nav__item">
  1366. <a href="../../eso-demos/" class="md-nav__link">
  1367. <span class="md-ellipsis">
  1368. Demos
  1369. </span>
  1370. </a>
  1371. </li>
  1372. <li class="md-nav__item">
  1373. <a href="../../eso-blogs/" class="md-nav__link">
  1374. <span class="md-ellipsis">
  1375. Blogs
  1376. </span>
  1377. </a>
  1378. </li>
  1379. <li class="md-nav__item">
  1380. <a href="../../eso-tools/" class="md-nav__link">
  1381. <span class="md-ellipsis">
  1382. Tools
  1383. </span>
  1384. </a>
  1385. </li>
  1386. </ul>
  1387. </nav>
  1388. </li>
  1389. </ul>
  1390. </nav>
  1391. </li>
  1392. </ul>
  1393. </nav>
  1394. </div>
  1395. </div>
  1396. </div>
  1397. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1398. <div class="md-sidebar__scrollwrap">
  1399. <div class="md-sidebar__inner">
  1400. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1401. <label class="md-nav__title" for="__toc">
  1402. <span class="md-nav__icon md-icon"></span>
  1403. Table of contents
  1404. </label>
  1405. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1406. <li class="md-nav__item">
  1407. <a href="#creating-a-secretstore" class="md-nav__link">
  1408. <span class="md-ellipsis">
  1409. Creating a SecretStore
  1410. </span>
  1411. </a>
  1412. </li>
  1413. <li class="md-nav__item">
  1414. <a href="#referencing-secrets" class="md-nav__link">
  1415. <span class="md-ellipsis">
  1416. Referencing Secrets
  1417. </span>
  1418. </a>
  1419. </li>
  1420. <li class="md-nav__item">
  1421. <a href="#working-with-plain-text-itemvalue-fields" class="md-nav__link">
  1422. <span class="md-ellipsis">
  1423. Working with Plain Text ItemValue Fields
  1424. </span>
  1425. </a>
  1426. <nav class="md-nav" aria-label="Working with Plain Text ItemValue Fields">
  1427. <ul class="md-nav__list">
  1428. <li class="md-nav__item">
  1429. <a href="#example-with-plain-text-password-field" class="md-nav__link">
  1430. <span class="md-ellipsis">
  1431. Example with Plain Text Password Field
  1432. </span>
  1433. </a>
  1434. </li>
  1435. </ul>
  1436. </nav>
  1437. </li>
  1438. <li class="md-nav__item">
  1439. <a href="#support-for-fetching-secrets-by-path" class="md-nav__link">
  1440. <span class="md-ellipsis">
  1441. Support for Fetching Secrets by Path
  1442. </span>
  1443. </a>
  1444. <nav class="md-nav" aria-label="Support for Fetching Secrets by Path">
  1445. <ul class="md-nav__list">
  1446. <li class="md-nav__item">
  1447. <a href="#example" class="md-nav__link">
  1448. <span class="md-ellipsis">
  1449. Example
  1450. </span>
  1451. </a>
  1452. </li>
  1453. <li class="md-nav__item">
  1454. <a href="#notes" class="md-nav__link">
  1455. <span class="md-ellipsis">
  1456. Notes:
  1457. </span>
  1458. </a>
  1459. </li>
  1460. </ul>
  1461. </nav>
  1462. </li>
  1463. <li class="md-nav__item">
  1464. <a href="#preparing-your-secret" class="md-nav__link">
  1465. <span class="md-ellipsis">
  1466. Preparing your secret
  1467. </span>
  1468. </a>
  1469. <nav class="md-nav" aria-label="Preparing your secret">
  1470. <ul class="md-nav__list">
  1471. <li class="md-nav__item">
  1472. <a href="#examples" class="md-nav__link">
  1473. <span class="md-ellipsis">
  1474. Examples
  1475. </span>
  1476. </a>
  1477. </li>
  1478. </ul>
  1479. </nav>
  1480. </li>
  1481. <li class="md-nav__item">
  1482. <a href="#referencing-secrets-by-field-name-or-slug" class="md-nav__link">
  1483. <span class="md-ellipsis">
  1484. Referencing Secrets by Field Name or Slug
  1485. </span>
  1486. </a>
  1487. <nav class="md-nav" aria-label="Referencing Secrets by Field Name or Slug">
  1488. <ul class="md-nav__list">
  1489. <li class="md-nav__item">
  1490. <a href="#examples_1" class="md-nav__link">
  1491. <span class="md-ellipsis">
  1492. Examples
  1493. </span>
  1494. </a>
  1495. </li>
  1496. </ul>
  1497. </nav>
  1498. </li>
  1499. <li class="md-nav__item">
  1500. <a href="#pushing-secrets" class="md-nav__link">
  1501. <span class="md-ellipsis">
  1502. Pushing Secrets
  1503. </span>
  1504. </a>
  1505. <nav class="md-nav" aria-label="Pushing Secrets">
  1506. <ul class="md-nav__list">
  1507. <li class="md-nav__item">
  1508. <a href="#remote-key-formats-for-pushsecret" class="md-nav__link">
  1509. <span class="md-ellipsis">
  1510. Remote Key Formats for PushSecret
  1511. </span>
  1512. </a>
  1513. </li>
  1514. <li class="md-nav__item">
  1515. <a href="#requirements-for-creating-new-secrets" class="md-nav__link">
  1516. <span class="md-ellipsis">
  1517. Requirements for Creating New Secrets
  1518. </span>
  1519. </a>
  1520. </li>
  1521. <li class="md-nav__item">
  1522. <a href="#updating-existing-secrets" class="md-nav__link">
  1523. <span class="md-ellipsis">
  1524. Updating Existing Secrets
  1525. </span>
  1526. </a>
  1527. </li>
  1528. <li class="md-nav__item">
  1529. <a href="#deletion-behavior" class="md-nav__link">
  1530. <span class="md-ellipsis">
  1531. Deletion Behavior
  1532. </span>
  1533. </a>
  1534. </li>
  1535. <li class="md-nav__item">
  1536. <a href="#pushing-without-a-property" class="md-nav__link">
  1537. <span class="md-ellipsis">
  1538. Pushing Without a Property
  1539. </span>
  1540. </a>
  1541. </li>
  1542. </ul>
  1543. </nav>
  1544. </li>
  1545. </ul>
  1546. </nav>
  1547. </div>
  1548. </div>
  1549. </div>
  1550. <div class="md-content" data-md-component="content">
  1551. <article class="md-content__inner md-typeset">
  1552. <h1 id="delinea-secret-serverplatform">Delinea Secret-Server/Platform</h1>
  1553. <p>For detailed information about configuring Kubernetes ESO with Secret Server and the Delinea Platform, see the https://docs.delinea.com/online-help/integrations/external-secrets/kubernetes-eso-secret-server.htm</p>
  1554. <h3 id="creating-a-secretstore">Creating a SecretStore</h3>
  1555. <p>You need a username, password and a fully qualified Secret-Server/Platform tenant URL to authenticate
  1556. i.e. <code>https://yourTenantName.secretservercloud.com</code> or <code>https://yourtenantname.delinea.app</code>.</p>
  1557. <p>Both username and password can be specified either directly in your <code>SecretStore</code> yaml config, or by referencing a kubernetes secret.</p>
  1558. <p>Both <code>username</code> and <code>password</code> can either be specified directly via the <code>value</code> field (example below)</p>
  1559. <blockquote>
  1560. <p>spec.provider.secretserver.username.value: "yourusername"<br />
  1561. spec.provider.secretserver.password.value: "yourpassword" <br /></p>
  1562. </blockquote>
  1563. <p>Or you can reference a kubernetes secret (password example below).</p>
  1564. <p><strong>Note:</strong> Use <code>https://yourtenantname.secretservercloud.com</code> for Secret Server or <code>https://yourtenantname.delinea.app</code> for Platform.
  1565. <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>
  1566. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1567. <span class="nt">metadata</span><span class="p">:</span>
  1568. <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-server-store</span>
  1569. <span class="nt">spec</span><span class="p">:</span>
  1570. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1571. <span class="w"> </span><span class="nt">secretserver</span><span class="p">:</span>
  1572. <span class="w"> </span><span class="nt">serverURL</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://yourtenantname.secretservercloud.com&quot;</span><span class="w"> </span><span class="c1"># or &quot;https://yourtenantname.delinea.app&quot; for Platform</span>
  1573. <span class="w"> </span><span class="nt">username</span><span class="p">:</span>
  1574. <span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;yourusername&quot;</span>
  1575. <span class="w"> </span><span class="nt">password</span><span class="p">:</span>
  1576. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1577. <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">&lt;NAME_OF_K8S_SECRET&gt;</span>
  1578. <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">&lt;KEY_IN_K8S_SECRET&gt;</span>
  1579. </code></pre></div></p>
  1580. <h3 id="referencing-secrets">Referencing Secrets</h3>
  1581. <p>Secrets can be referenced using four different key formats in the <code>remoteRef.key</code> field:</p>
  1582. <table>
  1583. <thead>
  1584. <tr>
  1585. <th>Format</th>
  1586. <th>Example</th>
  1587. <th>Description</th>
  1588. </tr>
  1589. </thead>
  1590. <tbody>
  1591. <tr>
  1592. <td>Secret ID</td>
  1593. <td><code>52622</code></td>
  1594. <td>Numeric ID of the secret. Always unambiguous.</td>
  1595. </tr>
  1596. <tr>
  1597. <td>Secret Name</td>
  1598. <td><code>my-secret</code></td>
  1599. <td>Name of the secret. If multiple secrets share the same name across different folders, the first match is returned.</td>
  1600. </tr>
  1601. <tr>
  1602. <td>Secret Path</td>
  1603. <td><code>/FolderName/SecretName</code></td>
  1604. <td>Full folder path including the secret name. Uniquely identifies a secret across folders.</td>
  1605. </tr>
  1606. <tr>
  1607. <td>Folder-scoped Name</td>
  1608. <td><code>folderId:73/my-secret</code></td>
  1609. <td>Name-based lookup scoped to a specific folder ID. Use this when multiple secrets share the same name in different folders and you need to target a specific one.</td>
  1610. </tr>
  1611. </tbody>
  1612. </table>
  1613. <p><strong>Notes:</strong></p>
  1614. <ul>
  1615. <li>If using the secret name or path, the name must not contain spaces or control characters.</li>
  1616. <li>Retrieving a specific version of a secret is not yet supported.</li>
  1617. <li>The <strong>folder-scoped name</strong> format (<code>folderId:&lt;id&gt;/&lt;name&gt;</code>) is particularly important when using <code>PushSecret</code> with <code>deletionPolicy: Delete</code>, because the deletion and existence-check operations need to identify the correct secret without access to metadata. See <a href="#pushing-secrets">Pushing Secrets</a> for details.</li>
  1618. </ul>
  1619. <p>Because all Secret-Server/Platform secrets are JSON objects, you must specify the <code>remoteRef.property</code>
  1620. in your ExternalSecret configuration.<br />
  1621. You can access nested values or arrays using <a href="https://github.com/tidwall/gjson/blob/master/SYNTAX.md">gjson syntax</a>.</p>
  1622. <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>
  1623. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1624. <span class="nt">metadata</span><span class="p">:</span>
  1625. <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-server-external-secret</span>
  1626. <span class="nt">spec</span><span class="p">:</span>
  1627. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h0m0s</span>
  1628. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1629. <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>
  1630. <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-server-store</span>
  1631. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1632. <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">SecretServerValue</span><span class="w"> </span><span class="c1">#&lt;SECRET_VALUE_RETURNED_HERE&gt;</span>
  1633. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1634. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;52622&quot;</span><span class="w"> </span><span class="c1">#&lt;SECRET_ID&gt;</span>
  1635. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;array.0.value&quot;</span><span class="w"> </span><span class="c1">#&lt;GJSON_PROPERTY&gt; * an empty property will return the entire secret</span>
  1636. </code></pre></div>
  1637. <h3 id="working-with-plain-text-itemvalue-fields">Working with Plain Text ItemValue Fields</h3>
  1638. <p>While Secret-Server/Platform always returns secrets in JSON format with an <code>Items</code> array structure, individual field values (stored in <code>ItemValue</code>) may contain plain text, passwords, URLs, or other non-JSON content.</p>
  1639. <p>When retrieving fields that contain plain text values, you can reference them directly by their <code>FieldName</code> or <code>Slug</code> without needing additional JSON parsing within the <code>ItemValue</code>.</p>
  1640. <h4 id="example-with-plain-text-password-field">Example with Plain Text Password Field</h4>
  1641. <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>
  1642. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1643. <span class="nt">metadata</span><span class="p">:</span>
  1644. <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-server-external-secret</span>
  1645. <span class="nt">spec</span><span class="p">:</span>
  1646. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h0m0s</span>
  1647. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1648. <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>
  1649. <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-server-store</span>
  1650. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1651. <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>
  1652. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1653. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;52622&quot;</span><span class="w"> </span><span class="c1"># Secret ID</span>
  1654. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;password&quot;</span><span class="w"> </span><span class="c1"># FieldName or Slug of the password field</span>
  1655. </code></pre></div>
  1656. <p>In this example, if the secret contains an Item with <code>FieldName: "Password"</code> or <code>Slug: "password"</code>, the plain text value stored in <code>ItemValue</code> is retrieved directly and stored under the key <code>password</code> in the Kubernetes Secret.</p>
  1657. <p>This approach works for any field type (text, password, URL, etc.) where the <code>ItemValue</code> contains simple content rather than nested JSON structures.</p>
  1658. <h3 id="support-for-fetching-secrets-by-path">Support for Fetching Secrets by Path</h3>
  1659. <p>In addition to retrieving secrets by ID or Name, the Secret-Server/Platform provider now supports fetching secrets by <strong>path</strong>.
  1660. This allows you to specify a secret’s folder hierarchy and name in the format:</p>
  1661. <blockquote>
  1662. <p>/FolderName/SecretName</p>
  1663. </blockquote>
  1664. <h4 id="example">Example</h4>
  1665. <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>
  1666. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1667. <span class="nt">metadata</span><span class="p">:</span>
  1668. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-server-external-secret</span>
  1669. <span class="nt">spec</span><span class="p">:</span>
  1670. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">15s</span>
  1671. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1672. <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>
  1673. <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-server-store</span>
  1674. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1675. <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">SecretServerValue</span><span class="w"> </span><span class="c1"># Key in the Kubernetes Secret</span>
  1676. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1677. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;/secretFolder/secretname&quot;</span><span class="w"> </span><span class="c1"># Path format: /&lt;Folder&gt;/&lt;SecretName&gt;</span>
  1678. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="w"> </span><span class="c1"># Optional: matched against field Slug/FieldName first, then gjson on Items.0.ItemValue as fallback</span>
  1679. </code></pre></div>
  1680. <h4 id="notes">Notes:</h4>
  1681. <p>The path must exactly match the folder and secret name in Secret-Server/Platform.
  1682. If multiple secrets with the same name exist in different folders, the path helps to uniquely identify the correct one.
  1683. You can still use property to match fields by Slug/FieldName, extract values from JSON-formatted secrets via gjson, or omit it to retrieve the entire secret.</p>
  1684. <h3 id="preparing-your-secret">Preparing your secret</h3>
  1685. <p>You can either retrieve your entire secret, match a field by its Slug or FieldName, or use a JSON formatted string
  1686. stored in your secret located at Items[0].ItemValue to retrieve a specific value using gjson syntax.<br />
  1687. See example JSON secret below.</p>
  1688. <h4 id="examples">Examples</h4>
  1689. <p>Using the json formatted secret below:</p>
  1690. <ul>
  1691. <li>Lookup a single top level property using secret ID.</li>
  1692. </ul>
  1693. <blockquote>
  1694. <p>spec.data.remoteRef.key = 52622 (id of the secret)<br />
  1695. spec.data.remoteRef.property = "user" (Items.0.ItemValue user attribute)<br />
  1696. returns: marktwain@hannibal.com</p>
  1697. </blockquote>
  1698. <ul>
  1699. <li>Lookup a nested property using secret name.</li>
  1700. </ul>
  1701. <blockquote>
  1702. <p>spec.data.remoteRef.key = "external-secret-testing" (name of the secret)<br />
  1703. spec.data.remoteRef.property = "books.1" (Items.0.ItemValue books.1 attribute)<br />
  1704. returns: huckleberryFinn</p>
  1705. </blockquote>
  1706. <ul>
  1707. <li>Lookup by secret ID (<em>secret name will work as well</em>) and return the entire secret.</li>
  1708. </ul>
  1709. <blockquote>
  1710. <p>spec.data.remoteRef.key = "52622" (id of the secret)<br />
  1711. spec.data.remoteRef.property = "" <br />
  1712. returns: The entire secret in JSON format as displayed below</p>
  1713. </blockquote>
  1714. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1715. <span class="w"> </span><span class="nt">&quot;Name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;external-secret-testing&quot;</span><span class="p">,</span>
  1716. <span class="w"> </span><span class="nt">&quot;FolderID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">73</span><span class="p">,</span>
  1717. <span class="w"> </span><span class="nt">&quot;ID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">52622</span><span class="p">,</span>
  1718. <span class="w"> </span><span class="nt">&quot;SiteID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
  1719. <span class="w"> </span><span class="nt">&quot;SecretTemplateID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">6098</span><span class="p">,</span>
  1720. <span class="w"> </span><span class="nt">&quot;SecretPolicyID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
  1721. <span class="w"> </span><span class="nt">&quot;PasswordTypeWebScriptID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
  1722. <span class="w"> </span><span class="nt">&quot;LauncherConnectAsSecretID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
  1723. <span class="w"> </span><span class="nt">&quot;CheckOutIntervalMinutes&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
  1724. <span class="w"> </span><span class="nt">&quot;Active&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
  1725. <span class="w"> </span><span class="nt">&quot;CheckedOut&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1726. <span class="w"> </span><span class="nt">&quot;CheckOutEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1727. <span class="w"> </span><span class="nt">&quot;AutoChangeEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1728. <span class="w"> </span><span class="nt">&quot;CheckOutChangePasswordEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1729. <span class="w"> </span><span class="nt">&quot;DelayIndexing&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1730. <span class="w"> </span><span class="nt">&quot;EnableInheritPermissions&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
  1731. <span class="w"> </span><span class="nt">&quot;EnableInheritSecretPolicy&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
  1732. <span class="w"> </span><span class="nt">&quot;ProxyEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1733. <span class="w"> </span><span class="nt">&quot;RequiresComment&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1734. <span class="w"> </span><span class="nt">&quot;SessionRecordingEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1735. <span class="w"> </span><span class="nt">&quot;WebLauncherRequiresIncognitoMode&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1736. <span class="w"> </span><span class="nt">&quot;Items&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1737. <span class="w"> </span><span class="p">{</span>
  1738. <span class="w"> </span><span class="nt">&quot;ItemID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">280265</span><span class="p">,</span>
  1739. <span class="w"> </span><span class="nt">&quot;FieldID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">439</span><span class="p">,</span>
  1740. <span class="w"> </span><span class="nt">&quot;FileAttachmentID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1741. <span class="w"> </span><span class="nt">&quot;FieldName&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Data&quot;</span><span class="p">,</span>
  1742. <span class="w"> </span><span class="nt">&quot;Slug&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;data&quot;</span><span class="p">,</span>
  1743. <span class="w"> </span><span class="nt">&quot;FieldDescription&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;json text field&quot;</span><span class="p">,</span>
  1744. <span class="w"> </span><span class="nt">&quot;Filename&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
  1745. <span class="w"> </span><span class="nt">&quot;ItemValue&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{ \&quot;user\&quot;: \&quot;marktwain@hannibal.com\&quot;, \&quot;occupation\&quot;: \&quot;author\&quot;,\&quot;books\&quot;:[ \&quot;tomSawyer\&quot;,\&quot;huckleberryFinn\&quot;,\&quot;Pudd&#39;nhead Wilson\&quot;] }&quot;</span><span class="p">,</span>
  1746. <span class="w"> </span><span class="nt">&quot;IsFile&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1747. <span class="w"> </span><span class="nt">&quot;IsNotes&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1748. <span class="w"> </span><span class="nt">&quot;IsPassword&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
  1749. <span class="w"> </span><span class="p">}</span>
  1750. <span class="w"> </span><span class="p">]</span>
  1751. <span class="p">}</span>
  1752. </code></pre></div>
  1753. <h3 id="referencing-secrets-by-field-name-or-slug">Referencing Secrets by Field Name or Slug</h3>
  1754. <p>When <code>property</code> is set, the provider first tries to match it against each field's <code>Slug</code> or <code>FieldName</code> and returns the corresponding <code>ItemValue</code>. This works for secrets with any number of fields. If no field matches, it falls back to treating the first field's <code>ItemValue</code> as JSON and extracting the property using gjson syntax (supporting nested paths like <code>"books.1"</code>).</p>
  1755. <h4 id="examples_1">Examples</h4>
  1756. <p>Using the json formatted secret below:</p>
  1757. <ul>
  1758. <li>Lookup a single top level property using secret ID.</li>
  1759. </ul>
  1760. <blockquote>
  1761. <p>spec.data.remoteRef.key = 4000 (id of the secret)<br />
  1762. spec.data.remoteRef.property = "Username" (Items.0.FieldName)<br />
  1763. returns: usernamevalue</p>
  1764. </blockquote>
  1765. <ul>
  1766. <li>Lookup a nested property using secret name.</li>
  1767. </ul>
  1768. <blockquote>
  1769. <p>spec.data.remoteRef.key = "Secretname" (name of the secret)<br />
  1770. spec.data.remoteRef.property = "password" (Items.1.slug)<br />
  1771. returns: passwordvalue</p>
  1772. </blockquote>
  1773. <ul>
  1774. <li>Lookup by secret ID (<em>secret name will work as well</em>) and return the entire secret.</li>
  1775. </ul>
  1776. <blockquote>
  1777. <p>spec.data.remoteRef.key = "4000" (id of the secret)<br />
  1778. returns: The entire secret in JSON format as displayed below</p>
  1779. </blockquote>
  1780. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1781. <span class="w"> </span><span class="nt">&quot;Name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Secretname&quot;</span><span class="p">,</span>
  1782. <span class="w"> </span><span class="nt">&quot;FolderID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1783. <span class="w"> </span><span class="nt">&quot;ID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4000</span><span class="p">,</span>
  1784. <span class="w"> </span><span class="nt">&quot;SiteID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1785. <span class="w"> </span><span class="nt">&quot;SecretTemplateID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1786. <span class="w"> </span><span class="nt">&quot;LauncherConnectAsSecretID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1787. <span class="w"> </span><span class="nt">&quot;CheckOutIntervalMinutes&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1788. <span class="w"> </span><span class="nt">&quot;Active&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1789. <span class="w"> </span><span class="nt">&quot;CheckedOut&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1790. <span class="w"> </span><span class="nt">&quot;CheckOutEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1791. <span class="w"> </span><span class="nt">&quot;AutoChangeEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1792. <span class="w"> </span><span class="nt">&quot;CheckOutChangePasswordEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1793. <span class="w"> </span><span class="nt">&quot;DelayIndexing&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1794. <span class="w"> </span><span class="nt">&quot;EnableInheritPermissions&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1795. <span class="w"> </span><span class="nt">&quot;EnableInheritSecretPolicy&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1796. <span class="w"> </span><span class="nt">&quot;ProxyEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1797. <span class="w"> </span><span class="nt">&quot;RequiresComment&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1798. <span class="w"> </span><span class="nt">&quot;SessionRecordingEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1799. <span class="w"> </span><span class="nt">&quot;WebLauncherRequiresIncognitoMode&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1800. <span class="w"> </span><span class="nt">&quot;Items&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1801. <span class="w"> </span><span class="p">{</span>
  1802. <span class="w"> </span><span class="nt">&quot;ItemID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1803. <span class="w"> </span><span class="nt">&quot;FieldID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1804. <span class="w"> </span><span class="nt">&quot;FileAttachmentID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1805. <span class="w"> </span><span class="nt">&quot;FieldName&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Username&quot;</span><span class="p">,</span>
  1806. <span class="w"> </span><span class="nt">&quot;Slug&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;username&quot;</span><span class="p">,</span>
  1807. <span class="w"> </span><span class="nt">&quot;FieldDescription&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
  1808. <span class="w"> </span><span class="nt">&quot;Filename&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
  1809. <span class="w"> </span><span class="nt">&quot;ItemValue&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;usernamevalue&quot;</span><span class="p">,</span>
  1810. <span class="w"> </span><span class="nt">&quot;IsFile&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1811. <span class="w"> </span><span class="nt">&quot;IsNotes&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1812. <span class="w"> </span><span class="nt">&quot;IsPassword&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
  1813. <span class="w"> </span><span class="p">},</span>
  1814. <span class="w"> </span><span class="p">{</span>
  1815. <span class="w"> </span><span class="nt">&quot;ItemID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1816. <span class="w"> </span><span class="nt">&quot;FieldID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1817. <span class="w"> </span><span class="nt">&quot;FileAttachmentID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1818. <span class="w"> </span><span class="nt">&quot;FieldName&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Password&quot;</span><span class="p">,</span>
  1819. <span class="w"> </span><span class="nt">&quot;Slug&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;password&quot;</span><span class="p">,</span>
  1820. <span class="w"> </span><span class="nt">&quot;FieldDescription&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
  1821. <span class="w"> </span><span class="nt">&quot;Filename&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
  1822. <span class="w"> </span><span class="nt">&quot;ItemValue&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;passwordvalue&quot;</span><span class="p">,</span>
  1823. <span class="w"> </span><span class="nt">&quot;IsFile&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1824. <span class="w"> </span><span class="nt">&quot;IsNotes&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1825. <span class="w"> </span><span class="nt">&quot;IsPassword&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
  1826. <span class="w"> </span><span class="p">}</span>
  1827. <span class="w"> </span><span class="p">]</span>
  1828. <span class="p">}</span>
  1829. </code></pre></div>
  1830. <h3 id="pushing-secrets">Pushing Secrets</h3>
  1831. <p>The Delinea Secret-Server/Platform provider supports pushing secrets from Kubernetes back to your Secret Server instance using the <code>PushSecret</code> resource. You can both create new secrets and update existing ones.</p>
  1832. <h4 id="remote-key-formats-for-pushsecret">Remote Key Formats for PushSecret</h4>
  1833. <p>When using <code>PushSecret</code>, the <code>remoteRef.remoteKey</code> field determines how the provider identifies
  1834. the target secret in Secret Server. The same key formats described in <a href="#referencing-secrets">Referencing Secrets</a> apply here:</p>
  1835. <table>
  1836. <thead>
  1837. <tr>
  1838. <th>Format</th>
  1839. <th>Example</th>
  1840. <th>When to Use</th>
  1841. </tr>
  1842. </thead>
  1843. <tbody>
  1844. <tr>
  1845. <td>Secret ID</td>
  1846. <td><code>52622</code></td>
  1847. <td>Updating an existing secret by its numeric ID.</td>
  1848. </tr>
  1849. <tr>
  1850. <td>Secret Name</td>
  1851. <td><code>my-secret</code></td>
  1852. <td>Simple environments where secret names are unique across all folders.</td>
  1853. </tr>
  1854. <tr>
  1855. <td>Secret Path</td>
  1856. <td><code>/FolderName/SecretName</code></td>
  1857. <td>When you know the full folder path of the secret.</td>
  1858. </tr>
  1859. <tr>
  1860. <td>Folder-scoped Name</td>
  1861. <td><code>folderId:73/my-secret</code></td>
  1862. <td><strong>Recommended for new secrets.</strong> Ensures all operations (push, delete, existence check) target the correct folder.</td>
  1863. </tr>
  1864. </tbody>
  1865. </table>
  1866. <p><strong>Why the folder-scoped name format matters:</strong></p>
  1867. <p>The <code>PushSecret</code> controller performs three distinct operations on secrets: <strong>push</strong> (create/update),
  1868. <strong>delete</strong>, and <strong>existence check</strong>. While the push operation has access to the <code>metadata</code> field
  1869. (which can carry a <code>folderId</code>), the delete and existence-check operations only receive the
  1870. <code>remoteKey</code> and <code>property</code> — they do <strong>not</strong> have access to metadata.</p>
  1871. <p>This means that if you use a plain secret name like <code>my-secret</code> and multiple secrets with that name
  1872. exist in different folders, the delete and existence-check operations cannot distinguish between them
  1873. and will act on the <strong>first match</strong> returned by the API.</p>
  1874. <p>By using the <code>folderId:&lt;id&gt;/&lt;name&gt;</code> format (e.g., <code>folderId:73/my-secret</code>), the folder ID is
  1875. encoded directly in the key and is available to <strong>all</strong> operations, ensuring consistent behavior.</p>
  1876. <p><strong>Precedence rule:</strong> If both a <code>folderId</code> in the <code>remoteKey</code> and a <code>folderId</code> in the metadata are
  1877. specified, the value from the <code>remoteKey</code> takes precedence for lookups. The metadata <code>folderId</code> and
  1878. <code>secretTemplateId</code> are still required when <strong>creating</strong> a new secret (they tell the API which folder
  1879. and template to use for the new secret).</p>
  1880. <h4 id="requirements-for-creating-new-secrets">Requirements for Creating New Secrets</h4>
  1881. <p>When creating a <strong>new</strong> secret in Secret Server, you must provide a <code>folderId</code> and a <code>secretTemplateId</code>. These are passed as <code>metadata</code> in the <code>PushSecret</code> spec:</p>
  1882. <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>
  1883. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1884. <span class="nt">metadata</span><span class="p">:</span>
  1885. <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">push-secret-example</span>
  1886. <span class="nt">spec</span><span class="p">:</span>
  1887. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span>
  1888. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
  1889. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-server-store</span>
  1890. <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>
  1891. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1892. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1893. <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-k8s-secret</span>
  1894. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1895. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1896. <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>
  1897. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1898. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;folderId:73/my-new-secret&quot;</span><span class="w"> </span><span class="c1"># Folder-scoped name ensures correct matching for all operations</span>
  1899. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span><span class="w"> </span><span class="c1"># Maps to the &#39;Username&#39; field/slug in Secret Server</span>
  1900. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1901. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubernetes.external-secrets.io/v1alpha1</span>
  1902. <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">PushSecretMetadata</span>
  1903. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1904. <span class="w"> </span><span class="nt">folderId</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">73</span><span class="w"> </span><span class="c1"># Required for new secrets: folder to create the secret in</span>
  1905. <span class="w"> </span><span class="nt">secretTemplateId</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6098</span><span class="w"> </span><span class="c1"># Required for new secrets: template to use</span>
  1906. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1907. <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>
  1908. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1909. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;folderId:73/my-new-secret&quot;</span>
  1910. <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">password</span><span class="w"> </span><span class="c1"># Maps to the &#39;Password&#39; field/slug in Secret Server</span>
  1911. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1912. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubernetes.external-secrets.io/v1alpha1</span>
  1913. <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">PushSecretMetadata</span>
  1914. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1915. <span class="w"> </span><span class="nt">folderId</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">73</span>
  1916. <span class="w"> </span><span class="nt">secretTemplateId</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6098</span>
  1917. </code></pre></div>
  1918. <blockquote>
  1919. <p><strong>Note:</strong> The <code>folderId</code> in the <code>remoteKey</code> (<code>folderId:73/...</code>) is used when <strong>looking up</strong> the
  1920. secret (for push, delete, and existence checks). The <code>folderId</code> and <code>secretTemplateId</code> in
  1921. <code>metadata</code> are used when <strong>creating</strong> a new secret via the Secret Server API.</p>
  1922. </blockquote>
  1923. <h4 id="updating-existing-secrets">Updating Existing Secrets</h4>
  1924. <p>When updating an existing secret, you do not strictly need the <code>folderId</code> or <code>secretTemplateId</code> metadata, as the provider will fetch the existing secret by its name or ID to update the corresponding fields.</p>
  1925. <p>However, if multiple secrets share the same name across different folders, you should use either the
  1926. <code>folderId:&lt;id&gt;/&lt;name&gt;</code> format, a path-based key, or a numeric ID to ensure the correct secret is
  1927. updated. Using a plain name will update the <strong>first match</strong> returned by the API.</p>
  1928. <h4 id="deletion-behavior">Deletion Behavior</h4>
  1929. <p>The <code>PushSecret</code> resource allows you to configure what happens to the remote secret in Secret Server when the <code>PushSecret</code> itself is deleted, via the <code>PushSecret.spec.deletionPolicy</code> field. Supported values are:</p>
  1930. <ul>
  1931. <li><code>Retain</code>: (Default) The remote secret is left intact in Secret Server when the <code>PushSecret</code> is deleted.</li>
  1932. <li><code>Delete</code>: The provider will attempt to delete the remote secret from Secret Server when the <code>PushSecret</code> is removed.</li>
  1933. </ul>
  1934. <p>When <code>Delete</code> is specified, the deletion operation is idempotent; if the secret has already been removed or cannot be found, the provider will safely ignore the error and proceed.</p>
  1935. <p><strong>Important:</strong> The deletion operation does <strong>not</strong> have access to <code>metadata</code>. If your Secret Server
  1936. has multiple secrets with the same name in different folders and you use <code>deletionPolicy: Delete</code>,
  1937. you <strong>must</strong> use a key format that uniquely identifies the secret — either <code>folderId:&lt;id&gt;/&lt;name&gt;</code>,
  1938. a full path (<code>/Folder/SecretName</code>), or a numeric ID. Using a plain name risks deleting the wrong
  1939. secret.</p>
  1940. <h4 id="pushing-without-a-property">Pushing Without a Property</h4>
  1941. <p>If you omit <code>property</code> from the <code>remoteRef</code>, the provider writes the value selected by <code>data.match.secretKey</code> (e.g., the content stored under the <code>config</code> key in your Kubernetes Secret) into the <strong>first</strong> field of the Secret Server secret. This is useful when your secret value is a single JSON payload that you want to store in a text field like <code>Data</code> or <code>Notes</code>.</p>
  1942. <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>
  1943. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1944. <span class="nt">metadata</span><span class="p">:</span>
  1945. <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">push-secret-json-example</span>
  1946. <span class="nt">spec</span><span class="p">:</span>
  1947. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span>
  1948. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
  1949. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-server-store</span>
  1950. <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>
  1951. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1952. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1953. <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-k8s-json-secret</span>
  1954. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1955. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1956. <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">config</span><span class="w"> </span><span class="c1"># The key in your k8s secret whose value will be pushed</span>
  1957. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1958. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;folderId:73/my-new-json-secret&quot;</span>
  1959. <span class="w"> </span><span class="c1"># property is omitted: the value is stored in the first template field</span>
  1960. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1961. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubernetes.external-secrets.io/v1alpha1</span>
  1962. <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">PushSecretMetadata</span>
  1963. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1964. <span class="w"> </span><span class="nt">folderId</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">73</span>
  1965. <span class="w"> </span><span class="nt">secretTemplateId</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6098</span>
  1966. </code></pre></div>
  1967. </article>
  1968. </div>
  1969. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1970. </div>
  1971. </main>
  1972. <img referrerpolicy="no-referrer-when-downgrade"
  1973. src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""
  1974. hidden />
  1975. <footer class="md-footer">
  1976. <div class="md-footer-meta md-typeset">
  1977. <div class="md-footer-meta__inner md-grid">
  1978. <div class="md-copyright">
  1979. <div class="md-copyright__highlight">
  1980. &copy; 2025 The external-secrets Authors.<br/>
  1981. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1982. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1983. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1984. </div>
  1985. Made with
  1986. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1987. Material for MkDocs
  1988. </a>
  1989. </div>
  1990. </div>
  1991. </div>
  1992. </footer>
  1993. </div>
  1994. <div class="md-dialog" data-md-component="dialog">
  1995. <div class="md-dialog__inner md-typeset"></div>
  1996. </div>
  1997. <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>
  1998. <script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
  1999. </body>
  2000. </html>