index.html 138 KB

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