index.html 235 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055
  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="../generator/uuid/">
  7. <link rel="next" href="../controller-options/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
  10. <title>API specification - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.6f8fc17f.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. </div>
  26. <div data-md-component="announce">
  27. </div>
  28. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  29. <aside class="md-banner md-banner--warning">
  30. <div class="md-banner__inner md-grid md-typeset">
  31. You're not viewing the latest version.
  32. <a href="../../..">
  33. <strong>Click here to go to latest.</strong>
  34. </a>
  35. </div>
  36. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  37. </aside>
  38. </div>
  39. <header class="md-header" data-md-component="header">
  40. <nav class="md-header__inner md-grid" aria-label="Header">
  41. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  42. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  43. </a>
  44. <label class="md-header__button md-icon" for="__drawer">
  45. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  46. </label>
  47. <div class="md-header__title" data-md-component="header-title">
  48. <div class="md-header__ellipsis">
  49. <div class="md-header__topic">
  50. <span class="md-ellipsis">
  51. External Secrets Operator
  52. </span>
  53. </div>
  54. <div class="md-header__topic" data-md-component="header-topic">
  55. <span class="md-ellipsis">
  56. API specification
  57. </span>
  58. </div>
  59. </div>
  60. </div>
  61. <form class="md-header__option" data-md-component="palette">
  62. <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">
  63. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  64. <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>
  65. </label>
  66. <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">
  67. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  68. <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>
  69. </label>
  70. </form>
  71. <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>
  72. <label class="md-header__button md-icon" for="__search">
  73. <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>
  74. </label>
  75. <div class="md-search" data-md-component="search" role="dialog">
  76. <label class="md-search__overlay" for="__search"></label>
  77. <div class="md-search__inner" role="search">
  78. <form class="md-search__form" name="search">
  79. <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>
  80. <label class="md-search__icon md-icon" for="__search">
  81. <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>
  82. <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>
  83. </label>
  84. <nav class="md-search__options" aria-label="Search">
  85. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  86. <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>
  87. </button>
  88. </nav>
  89. </form>
  90. <div class="md-search__output">
  91. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  92. <div class="md-search-result" data-md-component="search-result">
  93. <div class="md-search-result__meta">
  94. Initializing search
  95. </div>
  96. <ol class="md-search-result__list" role="presentation"></ol>
  97. </div>
  98. </div>
  99. </div>
  100. </div>
  101. </div>
  102. <div class="md-header__source">
  103. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  104. <div class="md-source__icon md-icon">
  105. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  106. </div>
  107. <div class="md-source__repository">
  108. External Secrets Operator
  109. </div>
  110. </a>
  111. </div>
  112. </nav>
  113. </header>
  114. <div class="md-container" data-md-component="container">
  115. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  116. <div class="md-grid">
  117. <ul class="md-tabs__list">
  118. <li class="md-tabs__item">
  119. <a href="../.." class="md-tabs__link">
  120. Introduction
  121. </a>
  122. </li>
  123. <li class="md-tabs__item md-tabs__item--active">
  124. <a href="../components/" class="md-tabs__link">
  125. API
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../guides/introduction/" class="md-tabs__link">
  130. Guides
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  135. Provider
  136. </a>
  137. </li>
  138. <li class="md-tabs__item">
  139. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  140. Examples
  141. </a>
  142. </li>
  143. <li class="md-tabs__item">
  144. <a href="../../contributing/devguide/" class="md-tabs__link">
  145. Community
  146. </a>
  147. </li>
  148. </ul>
  149. </div>
  150. </nav>
  151. <main class="md-main" data-md-component="main">
  152. <div class="md-main__inner md-grid">
  153. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  154. <div class="md-sidebar__scrollwrap">
  155. <div class="md-sidebar__inner">
  156. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  157. <label class="md-nav__title" for="__drawer">
  158. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  159. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  160. </a>
  161. External Secrets Operator
  162. </label>
  163. <div class="md-nav__source">
  164. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  165. <div class="md-source__icon md-icon">
  166. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  167. </div>
  168. <div class="md-source__repository">
  169. External Secrets Operator
  170. </div>
  171. </a>
  172. </div>
  173. <ul class="md-nav__list" data-md-scrollfix>
  174. <li class="md-nav__item md-nav__item--nested">
  175. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  176. <div class="md-nav__link md-nav__container">
  177. <a href="../.." class="md-nav__link ">
  178. <span class="md-ellipsis">
  179. Introduction
  180. </span>
  181. </a>
  182. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  183. <span class="md-nav__icon md-icon"></span>
  184. </label>
  185. </div>
  186. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  187. <label class="md-nav__title" for="__nav_1">
  188. <span class="md-nav__icon md-icon"></span>
  189. Introduction
  190. </label>
  191. <ul class="md-nav__list" data-md-scrollfix>
  192. <li class="md-nav__item">
  193. <a href="../../introduction/overview/" class="md-nav__link">
  194. <span class="md-ellipsis">
  195. Overview
  196. </span>
  197. </a>
  198. </li>
  199. <li class="md-nav__item">
  200. <a href="../../introduction/getting-started/" class="md-nav__link">
  201. <span class="md-ellipsis">
  202. Getting started
  203. </span>
  204. </a>
  205. </li>
  206. <li class="md-nav__item">
  207. <a href="../../introduction/faq/" class="md-nav__link">
  208. <span class="md-ellipsis">
  209. FAQ
  210. </span>
  211. </a>
  212. </li>
  213. <li class="md-nav__item">
  214. <a href="../../introduction/stability-support/" class="md-nav__link">
  215. <span class="md-ellipsis">
  216. Stability and Support
  217. </span>
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  222. <span class="md-ellipsis">
  223. Deprecation Policy
  224. </span>
  225. </a>
  226. </li>
  227. </ul>
  228. </nav>
  229. </li>
  230. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  231. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  232. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  233. <span class="md-ellipsis">
  234. API
  235. </span>
  236. <span class="md-nav__icon md-icon"></span>
  237. </label>
  238. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  239. <label class="md-nav__title" for="__nav_2">
  240. <span class="md-nav__icon md-icon"></span>
  241. API
  242. </label>
  243. <ul class="md-nav__list" data-md-scrollfix>
  244. <li class="md-nav__item">
  245. <a href="../components/" class="md-nav__link">
  246. <span class="md-ellipsis">
  247. Components
  248. </span>
  249. </a>
  250. </li>
  251. <li class="md-nav__item md-nav__item--nested">
  252. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  253. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  254. <span class="md-ellipsis">
  255. Core Resources
  256. </span>
  257. <span class="md-nav__icon md-icon"></span>
  258. </label>
  259. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  260. <label class="md-nav__title" for="__nav_2_2">
  261. <span class="md-nav__icon md-icon"></span>
  262. Core Resources
  263. </label>
  264. <ul class="md-nav__list" data-md-scrollfix>
  265. <li class="md-nav__item">
  266. <a href="../externalsecret/" class="md-nav__link">
  267. <span class="md-ellipsis">
  268. ExternalSecret
  269. </span>
  270. </a>
  271. </li>
  272. <li class="md-nav__item">
  273. <a href="../secretstore/" class="md-nav__link">
  274. <span class="md-ellipsis">
  275. SecretStore
  276. </span>
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../clustersecretstore/" class="md-nav__link">
  281. <span class="md-ellipsis">
  282. ClusterSecretStore
  283. </span>
  284. </a>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../clusterexternalsecret/" class="md-nav__link">
  288. <span class="md-ellipsis">
  289. ClusterExternalSecret
  290. </span>
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="../pushsecret/" class="md-nav__link">
  295. <span class="md-ellipsis">
  296. PushSecret
  297. </span>
  298. </a>
  299. </li>
  300. </ul>
  301. </nav>
  302. </li>
  303. <li class="md-nav__item md-nav__item--nested">
  304. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  305. <div class="md-nav__link md-nav__container">
  306. <a href="../generator/" class="md-nav__link ">
  307. <span class="md-ellipsis">
  308. Generators
  309. </span>
  310. </a>
  311. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  312. <span class="md-nav__icon md-icon"></span>
  313. </label>
  314. </div>
  315. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  316. <label class="md-nav__title" for="__nav_2_3">
  317. <span class="md-nav__icon md-icon"></span>
  318. Generators
  319. </label>
  320. <ul class="md-nav__list" data-md-scrollfix>
  321. <li class="md-nav__item">
  322. <a href="../generator/acr/" class="md-nav__link">
  323. <span class="md-ellipsis">
  324. Azure Container Registry
  325. </span>
  326. </a>
  327. </li>
  328. <li class="md-nav__item">
  329. <a href="../generator/ecr/" class="md-nav__link">
  330. <span class="md-ellipsis">
  331. AWS Elastic Container Registry
  332. </span>
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../generator/sts/" class="md-nav__link">
  337. <span class="md-ellipsis">
  338. AWS STS Session Token
  339. </span>
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="../generator/cluster/" class="md-nav__link">
  344. <span class="md-ellipsis">
  345. Cluster Generator
  346. </span>
  347. </a>
  348. </li>
  349. <li class="md-nav__item">
  350. <a href="../generator/gcr/" class="md-nav__link">
  351. <span class="md-ellipsis">
  352. Google Container Registry
  353. </span>
  354. </a>
  355. </li>
  356. <li class="md-nav__item">
  357. <a href="../generator/quay/" class="md-nav__link">
  358. <span class="md-ellipsis">
  359. Quay
  360. </span>
  361. </a>
  362. </li>
  363. <li class="md-nav__item">
  364. <a href="../generator/vault/" class="md-nav__link">
  365. <span class="md-ellipsis">
  366. Vault Dynamic Secret
  367. </span>
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../generator/password/" class="md-nav__link">
  372. <span class="md-ellipsis">
  373. Password
  374. </span>
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../generator/fake/" class="md-nav__link">
  379. <span class="md-ellipsis">
  380. Fake
  381. </span>
  382. </a>
  383. </li>
  384. <li class="md-nav__item">
  385. <a href="../generator/webhook/" class="md-nav__link">
  386. <span class="md-ellipsis">
  387. Webhook
  388. </span>
  389. </a>
  390. </li>
  391. <li class="md-nav__item">
  392. <a href="../generator/github/" class="md-nav__link">
  393. <span class="md-ellipsis">
  394. Github
  395. </span>
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="../generator/uuid/" class="md-nav__link">
  400. <span class="md-ellipsis">
  401. UUID
  402. </span>
  403. </a>
  404. </li>
  405. </ul>
  406. </nav>
  407. </li>
  408. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  409. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
  410. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  411. <span class="md-ellipsis">
  412. Reference Docs
  413. </span>
  414. <span class="md-nav__icon md-icon"></span>
  415. </label>
  416. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="true">
  417. <label class="md-nav__title" for="__nav_2_4">
  418. <span class="md-nav__icon md-icon"></span>
  419. Reference Docs
  420. </label>
  421. <ul class="md-nav__list" data-md-scrollfix>
  422. <li class="md-nav__item md-nav__item--active">
  423. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  424. <a href="./" class="md-nav__link md-nav__link--active">
  425. <span class="md-ellipsis">
  426. API specification
  427. </span>
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../controller-options/" class="md-nav__link">
  432. <span class="md-ellipsis">
  433. Controller Options
  434. </span>
  435. </a>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="../metrics/" class="md-nav__link">
  439. <span class="md-ellipsis">
  440. Metrics
  441. </span>
  442. </a>
  443. </li>
  444. </ul>
  445. </nav>
  446. </li>
  447. </ul>
  448. </nav>
  449. </li>
  450. <li class="md-nav__item md-nav__item--nested">
  451. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  452. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  453. <span class="md-ellipsis">
  454. Guides
  455. </span>
  456. <span class="md-nav__icon md-icon"></span>
  457. </label>
  458. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  459. <label class="md-nav__title" for="__nav_3">
  460. <span class="md-nav__icon md-icon"></span>
  461. Guides
  462. </label>
  463. <ul class="md-nav__list" data-md-scrollfix>
  464. <li class="md-nav__item">
  465. <a href="../../guides/introduction/" class="md-nav__link">
  466. <span class="md-ellipsis">
  467. Introduction
  468. </span>
  469. </a>
  470. </li>
  471. <li class="md-nav__item md-nav__item--nested">
  472. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  473. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  474. <span class="md-ellipsis">
  475. External Secrets
  476. </span>
  477. <span class="md-nav__icon md-icon"></span>
  478. </label>
  479. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  480. <label class="md-nav__title" for="__nav_3_2">
  481. <span class="md-nav__icon md-icon"></span>
  482. External Secrets
  483. </label>
  484. <ul class="md-nav__list" data-md-scrollfix>
  485. <li class="md-nav__item">
  486. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  487. <span class="md-ellipsis">
  488. Extract structured data
  489. </span>
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="../../guides/getallsecrets/" class="md-nav__link">
  494. <span class="md-ellipsis">
  495. Find Secrets by Name or Metadata
  496. </span>
  497. </a>
  498. </li>
  499. <li class="md-nav__item">
  500. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  501. <span class="md-ellipsis">
  502. Rewriting Keys
  503. </span>
  504. </a>
  505. </li>
  506. <li class="md-nav__item md-nav__item--nested">
  507. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  508. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  509. <span class="md-ellipsis">
  510. Advanced Templating
  511. </span>
  512. <span class="md-nav__icon md-icon"></span>
  513. </label>
  514. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  515. <label class="md-nav__title" for="__nav_3_2_4">
  516. <span class="md-nav__icon md-icon"></span>
  517. Advanced Templating
  518. </label>
  519. <ul class="md-nav__list" data-md-scrollfix>
  520. <li class="md-nav__item">
  521. <a href="../../guides/templating/" class="md-nav__link">
  522. <span class="md-ellipsis">
  523. v2
  524. </span>
  525. </a>
  526. </li>
  527. <li class="md-nav__item">
  528. <a href="../../guides/templating-v1/" class="md-nav__link">
  529. <span class="md-ellipsis">
  530. v1
  531. </span>
  532. </a>
  533. </li>
  534. </ul>
  535. </nav>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  539. <span class="md-ellipsis">
  540. Kubernetes Secret Types
  541. </span>
  542. </a>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  546. <span class="md-ellipsis">
  547. Lifecycle: ownership & deletion
  548. </span>
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  553. <span class="md-ellipsis">
  554. Decoding Strategies
  555. </span>
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../guides/controller-class/" class="md-nav__link">
  560. <span class="md-ellipsis">
  561. Controller Classes
  562. </span>
  563. </a>
  564. </li>
  565. </ul>
  566. </nav>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="../../guides/generator/" class="md-nav__link">
  570. <span class="md-ellipsis">
  571. Generators
  572. </span>
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../guides/pushsecrets/" class="md-nav__link">
  577. <span class="md-ellipsis">
  578. Push Secrets
  579. </span>
  580. </a>
  581. </li>
  582. <li class="md-nav__item md-nav__item--nested">
  583. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  584. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  585. <span class="md-ellipsis">
  586. Operations
  587. </span>
  588. <span class="md-nav__icon md-icon"></span>
  589. </label>
  590. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  591. <label class="md-nav__title" for="__nav_3_5">
  592. <span class="md-nav__icon md-icon"></span>
  593. Operations
  594. </label>
  595. <ul class="md-nav__list" data-md-scrollfix>
  596. <li class="md-nav__item">
  597. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  598. <span class="md-ellipsis">
  599. Multi Tenancy
  600. </span>
  601. </a>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="../../guides/security-best-practices/" class="md-nav__link">
  605. <span class="md-ellipsis">
  606. Security Best Practices
  607. </span>
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../../guides/threat-model/" class="md-nav__link">
  612. <span class="md-ellipsis">
  613. Threat Model
  614. </span>
  615. </a>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="../../guides/v1beta1/" class="md-nav__link">
  619. <span class="md-ellipsis">
  620. Upgrading to v1beta1
  621. </span>
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="../../guides/using-latest-image/" class="md-nav__link">
  626. <span class="md-ellipsis">
  627. Using Latest Image
  628. </span>
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  633. <span class="md-ellipsis">
  634. Disable Cluster Features
  635. </span>
  636. </a>
  637. </li>
  638. </ul>
  639. </nav>
  640. </li>
  641. </ul>
  642. </nav>
  643. </li>
  644. <li class="md-nav__item md-nav__item--nested">
  645. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  646. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  647. <span class="md-ellipsis">
  648. Provider
  649. </span>
  650. <span class="md-nav__icon md-icon"></span>
  651. </label>
  652. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  653. <label class="md-nav__title" for="__nav_4">
  654. <span class="md-nav__icon md-icon"></span>
  655. Provider
  656. </label>
  657. <ul class="md-nav__list" data-md-scrollfix>
  658. <li class="md-nav__item">
  659. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  660. <span class="md-ellipsis">
  661. AWS Secrets Manager
  662. </span>
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  667. <span class="md-ellipsis">
  668. AWS Parameter Store
  669. </span>
  670. </a>
  671. </li>
  672. <li class="md-nav__item">
  673. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  674. <span class="md-ellipsis">
  675. Azure Key Vault
  676. </span>
  677. </a>
  678. </li>
  679. <li class="md-nav__item">
  680. <a href="../../provider/beyondtrust/" class="md-nav__link">
  681. <span class="md-ellipsis">
  682. BeyondTrust
  683. </span>
  684. </a>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  688. <span class="md-ellipsis">
  689. Bitwarden Secrets Manager
  690. </span>
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="../../provider/chef/" class="md-nav__link">
  695. <span class="md-ellipsis">
  696. Chef
  697. </span>
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="../../provider/conjur/" class="md-nav__link">
  702. <span class="md-ellipsis">
  703. CyberArk Conjur
  704. </span>
  705. </a>
  706. </li>
  707. <li class="md-nav__item">
  708. <a href="../../provider/device42/" class="md-nav__link">
  709. <span class="md-ellipsis">
  710. Device42
  711. </span>
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  716. <span class="md-ellipsis">
  717. Google Cloud Secret Manager
  718. </span>
  719. </a>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  723. <span class="md-ellipsis">
  724. HashiCorp Vault
  725. </span>
  726. </a>
  727. </li>
  728. <li class="md-nav__item">
  729. <a href="../../provider/kubernetes/" class="md-nav__link">
  730. <span class="md-ellipsis">
  731. Kubernetes
  732. </span>
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  737. <span class="md-ellipsis">
  738. IBM Secrets Manager
  739. </span>
  740. </a>
  741. </li>
  742. <li class="md-nav__item">
  743. <a href="../../provider/akeyless/" class="md-nav__link">
  744. <span class="md-ellipsis">
  745. Akeyless
  746. </span>
  747. </a>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  751. <span class="md-ellipsis">
  752. Yandex Certificate Manager
  753. </span>
  754. </a>
  755. </li>
  756. <li class="md-nav__item">
  757. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  758. <span class="md-ellipsis">
  759. Yandex Lockbox
  760. </span>
  761. </a>
  762. </li>
  763. <li class="md-nav__item">
  764. <a href="../../provider/alibaba/" class="md-nav__link">
  765. <span class="md-ellipsis">
  766. Alibaba Cloud
  767. </span>
  768. </a>
  769. </li>
  770. <li class="md-nav__item">
  771. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  772. <span class="md-ellipsis">
  773. GitLab Variables
  774. </span>
  775. </a>
  776. </li>
  777. <li class="md-nav__item">
  778. <a href="../../provider/oracle-vault/" class="md-nav__link">
  779. <span class="md-ellipsis">
  780. Oracle Vault
  781. </span>
  782. </a>
  783. </li>
  784. <li class="md-nav__item">
  785. <a href="../../provider/1password-automation/" class="md-nav__link">
  786. <span class="md-ellipsis">
  787. 1Password Secrets Automation
  788. </span>
  789. </a>
  790. </li>
  791. <li class="md-nav__item">
  792. <a href="../../provider/webhook/" class="md-nav__link">
  793. <span class="md-ellipsis">
  794. Webhook
  795. </span>
  796. </a>
  797. </li>
  798. <li class="md-nav__item">
  799. <a href="../../provider/fake/" class="md-nav__link">
  800. <span class="md-ellipsis">
  801. Fake
  802. </span>
  803. </a>
  804. </li>
  805. <li class="md-nav__item">
  806. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  807. <span class="md-ellipsis">
  808. senhasegura DevOps Secrets Management (DSM)
  809. </span>
  810. </a>
  811. </li>
  812. <li class="md-nav__item">
  813. <a href="../../provider/doppler/" class="md-nav__link">
  814. <span class="md-ellipsis">
  815. Doppler
  816. </span>
  817. </a>
  818. </li>
  819. <li class="md-nav__item">
  820. <a href="../../provider/keeper-security/" class="md-nav__link">
  821. <span class="md-ellipsis">
  822. Keeper Security
  823. </span>
  824. </a>
  825. </li>
  826. <li class="md-nav__item">
  827. <a href="../../provider/cloak/" class="md-nav__link">
  828. <span class="md-ellipsis">
  829. Cloak End 2 End Encrypted Secrets
  830. </span>
  831. </a>
  832. </li>
  833. <li class="md-nav__item">
  834. <a href="../../provider/scaleway/" class="md-nav__link">
  835. <span class="md-ellipsis">
  836. Scaleway
  837. </span>
  838. </a>
  839. </li>
  840. <li class="md-nav__item">
  841. <a href="../../provider/delinea/" class="md-nav__link">
  842. <span class="md-ellipsis">
  843. Delinea
  844. </span>
  845. </a>
  846. </li>
  847. <li class="md-nav__item">
  848. <a href="../../provider/secretserver/" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. Secret Server
  851. </span>
  852. </a>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="../../provider/passbolt/" class="md-nav__link">
  856. <span class="md-ellipsis">
  857. Passbolt
  858. </span>
  859. </a>
  860. </li>
  861. <li class="md-nav__item">
  862. <a href="../../provider/pulumi/" class="md-nav__link">
  863. <span class="md-ellipsis">
  864. Pulumi ESC
  865. </span>
  866. </a>
  867. </li>
  868. <li class="md-nav__item">
  869. <a href="../../provider/onboardbase/" class="md-nav__link">
  870. <span class="md-ellipsis">
  871. Onboardbase
  872. </span>
  873. </a>
  874. </li>
  875. <li class="md-nav__item">
  876. <a href="../../provider-passworddepot/" class="md-nav__link">
  877. <span class="md-ellipsis">
  878. Password Depot
  879. </span>
  880. </a>
  881. </li>
  882. <li class="md-nav__item">
  883. <a href="../../provider/fortanix/" class="md-nav__link">
  884. <span class="md-ellipsis">
  885. Fortanix
  886. </span>
  887. </a>
  888. </li>
  889. <li class="md-nav__item">
  890. <a href="../../provider/infisical/" class="md-nav__link">
  891. <span class="md-ellipsis">
  892. Infisical
  893. </span>
  894. </a>
  895. </li>
  896. <li class="md-nav__item">
  897. <a href="../../provider/previder/" class="md-nav__link">
  898. <span class="md-ellipsis">
  899. Previder
  900. </span>
  901. </a>
  902. </li>
  903. </ul>
  904. </nav>
  905. </li>
  906. <li class="md-nav__item md-nav__item--nested">
  907. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  908. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  909. <span class="md-ellipsis">
  910. Examples
  911. </span>
  912. <span class="md-nav__icon md-icon"></span>
  913. </label>
  914. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  915. <label class="md-nav__title" for="__nav_5">
  916. <span class="md-nav__icon md-icon"></span>
  917. Examples
  918. </label>
  919. <ul class="md-nav__list" data-md-scrollfix>
  920. <li class="md-nav__item">
  921. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  922. <span class="md-ellipsis">
  923. FluxCD
  924. </span>
  925. </a>
  926. </li>
  927. <li class="md-nav__item">
  928. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  929. <span class="md-ellipsis">
  930. Anchore Engine
  931. </span>
  932. </a>
  933. </li>
  934. <li class="md-nav__item">
  935. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  936. <span class="md-ellipsis">
  937. Jenkins
  938. </span>
  939. </a>
  940. </li>
  941. <li class="md-nav__item">
  942. <a href="../../examples/bitwarden/" class="md-nav__link">
  943. <span class="md-ellipsis">
  944. BitWarden
  945. </span>
  946. </a>
  947. </li>
  948. </ul>
  949. </nav>
  950. </li>
  951. <li class="md-nav__item md-nav__item--nested">
  952. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  953. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  954. <span class="md-ellipsis">
  955. Community
  956. </span>
  957. <span class="md-nav__icon md-icon"></span>
  958. </label>
  959. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  960. <label class="md-nav__title" for="__nav_6">
  961. <span class="md-nav__icon md-icon"></span>
  962. Community
  963. </label>
  964. <ul class="md-nav__list" data-md-scrollfix>
  965. <li class="md-nav__item md-nav__item--nested">
  966. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  967. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  968. <span class="md-ellipsis">
  969. Contributing
  970. </span>
  971. <span class="md-nav__icon md-icon"></span>
  972. </label>
  973. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  974. <label class="md-nav__title" for="__nav_6_1">
  975. <span class="md-nav__icon md-icon"></span>
  976. Contributing
  977. </label>
  978. <ul class="md-nav__list" data-md-scrollfix>
  979. <li class="md-nav__item">
  980. <a href="../../contributing/devguide/" class="md-nav__link">
  981. <span class="md-ellipsis">
  982. Developer guide
  983. </span>
  984. </a>
  985. </li>
  986. <li class="md-nav__item">
  987. <a href="../../contributing/process/" class="md-nav__link">
  988. <span class="md-ellipsis">
  989. Contributing Process
  990. </span>
  991. </a>
  992. </li>
  993. <li class="md-nav__item">
  994. <a href="../../contributing/release/" class="md-nav__link">
  995. <span class="md-ellipsis">
  996. Release Process
  997. </span>
  998. </a>
  999. </li>
  1000. <li class="md-nav__item">
  1001. <a href="../../contributing/coc/" class="md-nav__link">
  1002. <span class="md-ellipsis">
  1003. Code of Conduct
  1004. </span>
  1005. </a>
  1006. </li>
  1007. <li class="md-nav__item">
  1008. <a href="../../contributing/roadmap/" class="md-nav__link">
  1009. <span class="md-ellipsis">
  1010. Roadmap
  1011. </span>
  1012. </a>
  1013. </li>
  1014. </ul>
  1015. </nav>
  1016. </li>
  1017. <li class="md-nav__item md-nav__item--nested">
  1018. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1019. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1020. <span class="md-ellipsis">
  1021. External Resources
  1022. </span>
  1023. <span class="md-nav__icon md-icon"></span>
  1024. </label>
  1025. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1026. <label class="md-nav__title" for="__nav_6_2">
  1027. <span class="md-nav__icon md-icon"></span>
  1028. External Resources
  1029. </label>
  1030. <ul class="md-nav__list" data-md-scrollfix>
  1031. <li class="md-nav__item">
  1032. <a href="../../eso-talks/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Talks
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="../../eso-demos/" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Demos
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="../../eso-blogs/" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Blogs
  1049. </span>
  1050. </a>
  1051. </li>
  1052. <li class="md-nav__item">
  1053. <a href="../../eso-tools/" class="md-nav__link">
  1054. <span class="md-ellipsis">
  1055. Tools
  1056. </span>
  1057. </a>
  1058. </li>
  1059. </ul>
  1060. </nav>
  1061. </li>
  1062. </ul>
  1063. </nav>
  1064. </li>
  1065. </ul>
  1066. </nav>
  1067. </div>
  1068. </div>
  1069. </div>
  1070. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1071. <div class="md-sidebar__scrollwrap">
  1072. <div class="md-sidebar__inner">
  1073. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1074. </nav>
  1075. </div>
  1076. </div>
  1077. </div>
  1078. <div class="md-content" data-md-component="content">
  1079. <article class="md-content__inner md-typeset">
  1080. <h1>API specification</h1>
  1081. <p>Packages:</p>
  1082. <ul>
  1083. <li>
  1084. <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
  1085. </li>
  1086. </ul>
  1087. <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
  1088. <p>
  1089. <p>Package v1beta1 contains resources for external-secrets</p>
  1090. </p>
  1091. <p>Resource Types:</p>
  1092. <ul></ul>
  1093. <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
  1094. </h3>
  1095. <p>
  1096. (<em>Appears on:</em>
  1097. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  1098. </p>
  1099. <p>
  1100. <p>AWSAuth tells the controller how to do authentication with aws.
  1101. Only one of secretRef or jwt can be specified.
  1102. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  1103. </p>
  1104. <table>
  1105. <thead>
  1106. <tr>
  1107. <th>Field</th>
  1108. <th>Description</th>
  1109. </tr>
  1110. </thead>
  1111. <tbody>
  1112. <tr>
  1113. <td>
  1114. <code>secretRef</code></br>
  1115. <em>
  1116. <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
  1117. AWSAuthSecretRef
  1118. </a>
  1119. </em>
  1120. </td>
  1121. <td>
  1122. <em>(Optional)</em>
  1123. </td>
  1124. </tr>
  1125. <tr>
  1126. <td>
  1127. <code>jwt</code></br>
  1128. <em>
  1129. <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
  1130. AWSJWTAuth
  1131. </a>
  1132. </em>
  1133. </td>
  1134. <td>
  1135. <em>(Optional)</em>
  1136. </td>
  1137. </tr>
  1138. </tbody>
  1139. </table>
  1140. <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
  1141. </h3>
  1142. <p>
  1143. (<em>Appears on:</em>
  1144. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  1145. </p>
  1146. <p>
  1147. <p>AWSAuthSecretRef holds secret references for AWS credentials
  1148. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  1149. </p>
  1150. <table>
  1151. <thead>
  1152. <tr>
  1153. <th>Field</th>
  1154. <th>Description</th>
  1155. </tr>
  1156. </thead>
  1157. <tbody>
  1158. <tr>
  1159. <td>
  1160. <code>accessKeyIDSecretRef</code></br>
  1161. <em>
  1162. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1163. External Secrets meta/v1.SecretKeySelector
  1164. </a>
  1165. </em>
  1166. </td>
  1167. <td>
  1168. <p>The AccessKeyID is used for authentication</p>
  1169. </td>
  1170. </tr>
  1171. <tr>
  1172. <td>
  1173. <code>secretAccessKeySecretRef</code></br>
  1174. <em>
  1175. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1176. External Secrets meta/v1.SecretKeySelector
  1177. </a>
  1178. </em>
  1179. </td>
  1180. <td>
  1181. <p>The SecretAccessKey is used for authentication</p>
  1182. </td>
  1183. </tr>
  1184. <tr>
  1185. <td>
  1186. <code>sessionTokenSecretRef</code></br>
  1187. <em>
  1188. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1189. External Secrets meta/v1.SecretKeySelector
  1190. </a>
  1191. </em>
  1192. </td>
  1193. <td>
  1194. <p>The SessionToken used for authentication
  1195. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  1196. see: <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html">https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html</a></p>
  1197. </td>
  1198. </tr>
  1199. </tbody>
  1200. </table>
  1201. <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
  1202. </h3>
  1203. <p>
  1204. (<em>Appears on:</em>
  1205. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  1206. </p>
  1207. <p>
  1208. <p>Authenticate against AWS using service account tokens.</p>
  1209. </p>
  1210. <table>
  1211. <thead>
  1212. <tr>
  1213. <th>Field</th>
  1214. <th>Description</th>
  1215. </tr>
  1216. </thead>
  1217. <tbody>
  1218. <tr>
  1219. <td>
  1220. <code>serviceAccountRef</code></br>
  1221. <em>
  1222. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1223. External Secrets meta/v1.ServiceAccountSelector
  1224. </a>
  1225. </em>
  1226. </td>
  1227. <td>
  1228. </td>
  1229. </tr>
  1230. </tbody>
  1231. </table>
  1232. <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
  1233. </h3>
  1234. <p>
  1235. (<em>Appears on:</em>
  1236. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1237. </p>
  1238. <p>
  1239. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  1240. </p>
  1241. <table>
  1242. <thead>
  1243. <tr>
  1244. <th>Field</th>
  1245. <th>Description</th>
  1246. </tr>
  1247. </thead>
  1248. <tbody>
  1249. <tr>
  1250. <td>
  1251. <code>service</code></br>
  1252. <em>
  1253. <a href="#external-secrets.io/v1beta1.AWSServiceType">
  1254. AWSServiceType
  1255. </a>
  1256. </em>
  1257. </td>
  1258. <td>
  1259. <p>Service defines which service should be used to fetch the secrets</p>
  1260. </td>
  1261. </tr>
  1262. <tr>
  1263. <td>
  1264. <code>auth</code></br>
  1265. <em>
  1266. <a href="#external-secrets.io/v1beta1.AWSAuth">
  1267. AWSAuth
  1268. </a>
  1269. </em>
  1270. </td>
  1271. <td>
  1272. <em>(Optional)</em>
  1273. <p>Auth defines the information necessary to authenticate against AWS
  1274. if not set aws sdk will infer credentials from your environment
  1275. see: <a href="https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials">https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials</a></p>
  1276. </td>
  1277. </tr>
  1278. <tr>
  1279. <td>
  1280. <code>role</code></br>
  1281. <em>
  1282. string
  1283. </em>
  1284. </td>
  1285. <td>
  1286. <em>(Optional)</em>
  1287. <p>Role is a Role ARN which the provider will assume</p>
  1288. </td>
  1289. </tr>
  1290. <tr>
  1291. <td>
  1292. <code>region</code></br>
  1293. <em>
  1294. string
  1295. </em>
  1296. </td>
  1297. <td>
  1298. <p>AWS Region to be used for the provider</p>
  1299. </td>
  1300. </tr>
  1301. <tr>
  1302. <td>
  1303. <code>additionalRoles</code></br>
  1304. <em>
  1305. []string
  1306. </em>
  1307. </td>
  1308. <td>
  1309. <em>(Optional)</em>
  1310. <p>AdditionalRoles is a chained list of Role ARNs which the provider will sequentially assume before assuming the Role</p>
  1311. </td>
  1312. </tr>
  1313. <tr>
  1314. <td>
  1315. <code>externalID</code></br>
  1316. <em>
  1317. string
  1318. </em>
  1319. </td>
  1320. <td>
  1321. <p>AWS External ID set on assumed IAM roles</p>
  1322. </td>
  1323. </tr>
  1324. <tr>
  1325. <td>
  1326. <code>sessionTags</code></br>
  1327. <em>
  1328. <a href="#external-secrets.io/v1beta1.*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag">
  1329. []*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag
  1330. </a>
  1331. </em>
  1332. </td>
  1333. <td>
  1334. <em>(Optional)</em>
  1335. <p>AWS STS assume role session tags</p>
  1336. </td>
  1337. </tr>
  1338. <tr>
  1339. <td>
  1340. <code>secretsManager</code></br>
  1341. <em>
  1342. <a href="#external-secrets.io/v1beta1.SecretsManager">
  1343. SecretsManager
  1344. </a>
  1345. </em>
  1346. </td>
  1347. <td>
  1348. <em>(Optional)</em>
  1349. <p>SecretsManager defines how the provider behaves when interacting with AWS SecretsManager</p>
  1350. </td>
  1351. </tr>
  1352. <tr>
  1353. <td>
  1354. <code>transitiveTagKeys</code></br>
  1355. <em>
  1356. []*string
  1357. </em>
  1358. </td>
  1359. <td>
  1360. <em>(Optional)</em>
  1361. <p>AWS STS assume role transitive session tags. Required when multiple rules are used with the provider</p>
  1362. </td>
  1363. </tr>
  1364. <tr>
  1365. <td>
  1366. <code>prefix</code></br>
  1367. <em>
  1368. string
  1369. </em>
  1370. </td>
  1371. <td>
  1372. <em>(Optional)</em>
  1373. <p>Prefix adds a prefix to all retrieved values.</p>
  1374. </td>
  1375. </tr>
  1376. </tbody>
  1377. </table>
  1378. <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
  1379. (<code>string</code> alias)</p></h3>
  1380. <p>
  1381. (<em>Appears on:</em>
  1382. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  1383. </p>
  1384. <p>
  1385. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  1386. </p>
  1387. <table>
  1388. <thead>
  1389. <tr>
  1390. <th>Value</th>
  1391. <th>Description</th>
  1392. </tr>
  1393. </thead>
  1394. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  1395. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore service.
  1396. see: <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html">https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html</a></p>
  1397. </td>
  1398. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  1399. <td><p>AWSServiceSecretsManager is the AWS SecretsManager service.
  1400. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</a></p>
  1401. </td>
  1402. </tr></tbody>
  1403. </table>
  1404. <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
  1405. </h3>
  1406. <p>
  1407. (<em>Appears on:</em>
  1408. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
  1409. </p>
  1410. <p>
  1411. </p>
  1412. <table>
  1413. <thead>
  1414. <tr>
  1415. <th>Field</th>
  1416. <th>Description</th>
  1417. </tr>
  1418. </thead>
  1419. <tbody>
  1420. <tr>
  1421. <td>
  1422. <code>secretRef</code></br>
  1423. <em>
  1424. <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
  1425. AkeylessAuthSecretRef
  1426. </a>
  1427. </em>
  1428. </td>
  1429. <td>
  1430. <em>(Optional)</em>
  1431. <p>Reference to a Secret that contains the details
  1432. to authenticate with Akeyless.</p>
  1433. </td>
  1434. </tr>
  1435. <tr>
  1436. <td>
  1437. <code>kubernetesAuth</code></br>
  1438. <em>
  1439. <a href="#external-secrets.io/v1beta1.AkeylessKubernetesAuth">
  1440. AkeylessKubernetesAuth
  1441. </a>
  1442. </em>
  1443. </td>
  1444. <td>
  1445. <em>(Optional)</em>
  1446. <p>Kubernetes authenticates with Akeyless by passing the ServiceAccount
  1447. token stored in the named Secret resource.</p>
  1448. </td>
  1449. </tr>
  1450. </tbody>
  1451. </table>
  1452. <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  1453. </h3>
  1454. <p>
  1455. (<em>Appears on:</em>
  1456. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1457. </p>
  1458. <p>
  1459. <p>AkeylessAuthSecretRef
  1460. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  1461. </p>
  1462. <table>
  1463. <thead>
  1464. <tr>
  1465. <th>Field</th>
  1466. <th>Description</th>
  1467. </tr>
  1468. </thead>
  1469. <tbody>
  1470. <tr>
  1471. <td>
  1472. <code>accessID</code></br>
  1473. <em>
  1474. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1475. External Secrets meta/v1.SecretKeySelector
  1476. </a>
  1477. </em>
  1478. </td>
  1479. <td>
  1480. <p>The SecretAccessID is used for authentication</p>
  1481. </td>
  1482. </tr>
  1483. <tr>
  1484. <td>
  1485. <code>accessType</code></br>
  1486. <em>
  1487. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1488. External Secrets meta/v1.SecretKeySelector
  1489. </a>
  1490. </em>
  1491. </td>
  1492. <td>
  1493. </td>
  1494. </tr>
  1495. <tr>
  1496. <td>
  1497. <code>accessTypeParam</code></br>
  1498. <em>
  1499. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1500. External Secrets meta/v1.SecretKeySelector
  1501. </a>
  1502. </em>
  1503. </td>
  1504. <td>
  1505. </td>
  1506. </tr>
  1507. </tbody>
  1508. </table>
  1509. <h3 id="external-secrets.io/v1beta1.AkeylessKubernetesAuth">AkeylessKubernetesAuth
  1510. </h3>
  1511. <p>
  1512. (<em>Appears on:</em>
  1513. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1514. </p>
  1515. <p>
  1516. <p>Authenticate with Kubernetes ServiceAccount token stored.</p>
  1517. </p>
  1518. <table>
  1519. <thead>
  1520. <tr>
  1521. <th>Field</th>
  1522. <th>Description</th>
  1523. </tr>
  1524. </thead>
  1525. <tbody>
  1526. <tr>
  1527. <td>
  1528. <code>accessID</code></br>
  1529. <em>
  1530. string
  1531. </em>
  1532. </td>
  1533. <td>
  1534. <p>the Akeyless Kubernetes auth-method access-id</p>
  1535. </td>
  1536. </tr>
  1537. <tr>
  1538. <td>
  1539. <code>k8sConfName</code></br>
  1540. <em>
  1541. string
  1542. </em>
  1543. </td>
  1544. <td>
  1545. <p>Kubernetes-auth configuration name in Akeyless-Gateway</p>
  1546. </td>
  1547. </tr>
  1548. <tr>
  1549. <td>
  1550. <code>serviceAccountRef</code></br>
  1551. <em>
  1552. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1553. External Secrets meta/v1.ServiceAccountSelector
  1554. </a>
  1555. </em>
  1556. </td>
  1557. <td>
  1558. <em>(Optional)</em>
  1559. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  1560. If the service account is specified, the service account secret token JWT will be used
  1561. for authenticating with Akeyless. If the service account selector is not supplied,
  1562. the secretRef will be used instead.</p>
  1563. </td>
  1564. </tr>
  1565. <tr>
  1566. <td>
  1567. <code>secretRef</code></br>
  1568. <em>
  1569. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1570. External Secrets meta/v1.SecretKeySelector
  1571. </a>
  1572. </em>
  1573. </td>
  1574. <td>
  1575. <em>(Optional)</em>
  1576. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  1577. for authenticating with Akeyless. If a name is specified without a key,
  1578. <code>token</code> is the default. If one is not specified, the one bound to
  1579. the controller will be used.</p>
  1580. </td>
  1581. </tr>
  1582. </tbody>
  1583. </table>
  1584. <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
  1585. </h3>
  1586. <p>
  1587. (<em>Appears on:</em>
  1588. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1589. </p>
  1590. <p>
  1591. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  1592. </p>
  1593. <table>
  1594. <thead>
  1595. <tr>
  1596. <th>Field</th>
  1597. <th>Description</th>
  1598. </tr>
  1599. </thead>
  1600. <tbody>
  1601. <tr>
  1602. <td>
  1603. <code>akeylessGWApiURL</code></br>
  1604. <em>
  1605. string
  1606. </em>
  1607. </td>
  1608. <td>
  1609. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  1610. </td>
  1611. </tr>
  1612. <tr>
  1613. <td>
  1614. <code>authSecretRef</code></br>
  1615. <em>
  1616. <a href="#external-secrets.io/v1beta1.AkeylessAuth">
  1617. AkeylessAuth
  1618. </a>
  1619. </em>
  1620. </td>
  1621. <td>
  1622. <p>Auth configures how the operator authenticates with Akeyless.</p>
  1623. </td>
  1624. </tr>
  1625. <tr>
  1626. <td>
  1627. <code>caBundle</code></br>
  1628. <em>
  1629. []byte
  1630. </em>
  1631. </td>
  1632. <td>
  1633. <em>(Optional)</em>
  1634. <p>PEM/base64 encoded CA bundle used to validate Akeyless Gateway certificate. Only used
  1635. if the AkeylessGWApiURL URL is using HTTPS protocol. If not set the system root certificates
  1636. are used to validate the TLS connection.</p>
  1637. </td>
  1638. </tr>
  1639. <tr>
  1640. <td>
  1641. <code>caProvider</code></br>
  1642. <em>
  1643. <a href="#external-secrets.io/v1beta1.CAProvider">
  1644. CAProvider
  1645. </a>
  1646. </em>
  1647. </td>
  1648. <td>
  1649. <em>(Optional)</em>
  1650. <p>The provider for the CA bundle to use to validate Akeyless Gateway certificate.</p>
  1651. </td>
  1652. </tr>
  1653. </tbody>
  1654. </table>
  1655. <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
  1656. </h3>
  1657. <p>
  1658. (<em>Appears on:</em>
  1659. <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
  1660. </p>
  1661. <p>
  1662. <p>AlibabaAuth contains a secretRef for credentials.</p>
  1663. </p>
  1664. <table>
  1665. <thead>
  1666. <tr>
  1667. <th>Field</th>
  1668. <th>Description</th>
  1669. </tr>
  1670. </thead>
  1671. <tbody>
  1672. <tr>
  1673. <td>
  1674. <code>secretRef</code></br>
  1675. <em>
  1676. <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
  1677. AlibabaAuthSecretRef
  1678. </a>
  1679. </em>
  1680. </td>
  1681. <td>
  1682. <em>(Optional)</em>
  1683. </td>
  1684. </tr>
  1685. <tr>
  1686. <td>
  1687. <code>rrsa</code></br>
  1688. <em>
  1689. <a href="#external-secrets.io/v1beta1.AlibabaRRSAAuth">
  1690. AlibabaRRSAAuth
  1691. </a>
  1692. </em>
  1693. </td>
  1694. <td>
  1695. <em>(Optional)</em>
  1696. </td>
  1697. </tr>
  1698. </tbody>
  1699. </table>
  1700. <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  1701. </h3>
  1702. <p>
  1703. (<em>Appears on:</em>
  1704. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1705. </p>
  1706. <p>
  1707. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  1708. </p>
  1709. <table>
  1710. <thead>
  1711. <tr>
  1712. <th>Field</th>
  1713. <th>Description</th>
  1714. </tr>
  1715. </thead>
  1716. <tbody>
  1717. <tr>
  1718. <td>
  1719. <code>accessKeyIDSecretRef</code></br>
  1720. <em>
  1721. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1722. External Secrets meta/v1.SecretKeySelector
  1723. </a>
  1724. </em>
  1725. </td>
  1726. <td>
  1727. <p>The AccessKeyID is used for authentication</p>
  1728. </td>
  1729. </tr>
  1730. <tr>
  1731. <td>
  1732. <code>accessKeySecretSecretRef</code></br>
  1733. <em>
  1734. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1735. External Secrets meta/v1.SecretKeySelector
  1736. </a>
  1737. </em>
  1738. </td>
  1739. <td>
  1740. <p>The AccessKeySecret is used for authentication</p>
  1741. </td>
  1742. </tr>
  1743. </tbody>
  1744. </table>
  1745. <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
  1746. </h3>
  1747. <p>
  1748. (<em>Appears on:</em>
  1749. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1750. </p>
  1751. <p>
  1752. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  1753. </p>
  1754. <table>
  1755. <thead>
  1756. <tr>
  1757. <th>Field</th>
  1758. <th>Description</th>
  1759. </tr>
  1760. </thead>
  1761. <tbody>
  1762. <tr>
  1763. <td>
  1764. <code>auth</code></br>
  1765. <em>
  1766. <a href="#external-secrets.io/v1beta1.AlibabaAuth">
  1767. AlibabaAuth
  1768. </a>
  1769. </em>
  1770. </td>
  1771. <td>
  1772. </td>
  1773. </tr>
  1774. <tr>
  1775. <td>
  1776. <code>regionID</code></br>
  1777. <em>
  1778. string
  1779. </em>
  1780. </td>
  1781. <td>
  1782. <p>Alibaba Region to be used for the provider</p>
  1783. </td>
  1784. </tr>
  1785. </tbody>
  1786. </table>
  1787. <h3 id="external-secrets.io/v1beta1.AlibabaRRSAAuth">AlibabaRRSAAuth
  1788. </h3>
  1789. <p>
  1790. (<em>Appears on:</em>
  1791. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1792. </p>
  1793. <p>
  1794. <p>Authenticate against Alibaba using RRSA.</p>
  1795. </p>
  1796. <table>
  1797. <thead>
  1798. <tr>
  1799. <th>Field</th>
  1800. <th>Description</th>
  1801. </tr>
  1802. </thead>
  1803. <tbody>
  1804. <tr>
  1805. <td>
  1806. <code>oidcProviderArn</code></br>
  1807. <em>
  1808. string
  1809. </em>
  1810. </td>
  1811. <td>
  1812. </td>
  1813. </tr>
  1814. <tr>
  1815. <td>
  1816. <code>oidcTokenFilePath</code></br>
  1817. <em>
  1818. string
  1819. </em>
  1820. </td>
  1821. <td>
  1822. </td>
  1823. </tr>
  1824. <tr>
  1825. <td>
  1826. <code>roleArn</code></br>
  1827. <em>
  1828. string
  1829. </em>
  1830. </td>
  1831. <td>
  1832. </td>
  1833. </tr>
  1834. <tr>
  1835. <td>
  1836. <code>sessionName</code></br>
  1837. <em>
  1838. string
  1839. </em>
  1840. </td>
  1841. <td>
  1842. </td>
  1843. </tr>
  1844. </tbody>
  1845. </table>
  1846. <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
  1847. (<code>string</code> alias)</p></h3>
  1848. <p>
  1849. (<em>Appears on:</em>
  1850. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1851. </p>
  1852. <p>
  1853. <p>AuthType describes how to authenticate to the Azure Keyvault
  1854. Only one of the following auth types may be specified.
  1855. If none of the following auth type is specified, the default one
  1856. is ServicePrincipal.</p>
  1857. </p>
  1858. <table>
  1859. <thead>
  1860. <tr>
  1861. <th>Value</th>
  1862. <th>Description</th>
  1863. </tr>
  1864. </thead>
  1865. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  1866. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.</p>
  1867. </td>
  1868. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  1869. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  1870. </td>
  1871. </tr><tr><td><p>&#34;WorkloadIdentity&#34;</p></td>
  1872. <td><p>Using Workload Identity service accounts to authenticate.</p>
  1873. </td>
  1874. </tr></tbody>
  1875. </table>
  1876. <h3 id="external-secrets.io/v1beta1.AzureEnvironmentType">AzureEnvironmentType
  1877. (<code>string</code> alias)</p></h3>
  1878. <p>
  1879. (<em>Appears on:</em>
  1880. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1881. </p>
  1882. <p>
  1883. <p>AzureEnvironmentType specifies the Azure cloud environment endpoints to use for
  1884. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  1885. The following endpoints are available, also see here: <a href="https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152">https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152</a>
  1886. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  1887. </p>
  1888. <table>
  1889. <thead>
  1890. <tr>
  1891. <th>Value</th>
  1892. <th>Description</th>
  1893. </tr>
  1894. </thead>
  1895. <tbody><tr><td><p>&#34;ChinaCloud&#34;</p></td>
  1896. <td></td>
  1897. </tr><tr><td><p>&#34;GermanCloud&#34;</p></td>
  1898. <td></td>
  1899. </tr><tr><td><p>&#34;PublicCloud&#34;</p></td>
  1900. <td></td>
  1901. </tr><tr><td><p>&#34;USGovernmentCloud&#34;</p></td>
  1902. <td></td>
  1903. </tr></tbody>
  1904. </table>
  1905. <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
  1906. </h3>
  1907. <p>
  1908. (<em>Appears on:</em>
  1909. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1910. </p>
  1911. <p>
  1912. <p>Configuration used to authenticate with Azure.</p>
  1913. </p>
  1914. <table>
  1915. <thead>
  1916. <tr>
  1917. <th>Field</th>
  1918. <th>Description</th>
  1919. </tr>
  1920. </thead>
  1921. <tbody>
  1922. <tr>
  1923. <td>
  1924. <code>clientId</code></br>
  1925. <em>
  1926. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1927. External Secrets meta/v1.SecretKeySelector
  1928. </a>
  1929. </em>
  1930. </td>
  1931. <td>
  1932. <em>(Optional)</em>
  1933. <p>The Azure clientId of the service principle or managed identity used for authentication.</p>
  1934. </td>
  1935. </tr>
  1936. <tr>
  1937. <td>
  1938. <code>tenantId</code></br>
  1939. <em>
  1940. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1941. External Secrets meta/v1.SecretKeySelector
  1942. </a>
  1943. </em>
  1944. </td>
  1945. <td>
  1946. <em>(Optional)</em>
  1947. <p>The Azure tenantId of the managed identity used for authentication.</p>
  1948. </td>
  1949. </tr>
  1950. <tr>
  1951. <td>
  1952. <code>clientSecret</code></br>
  1953. <em>
  1954. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1955. External Secrets meta/v1.SecretKeySelector
  1956. </a>
  1957. </em>
  1958. </td>
  1959. <td>
  1960. <em>(Optional)</em>
  1961. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  1962. </td>
  1963. </tr>
  1964. <tr>
  1965. <td>
  1966. <code>clientCertificate</code></br>
  1967. <em>
  1968. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1969. External Secrets meta/v1.SecretKeySelector
  1970. </a>
  1971. </em>
  1972. </td>
  1973. <td>
  1974. <em>(Optional)</em>
  1975. <p>The Azure ClientCertificate of the service principle used for authentication.</p>
  1976. </td>
  1977. </tr>
  1978. </tbody>
  1979. </table>
  1980. <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
  1981. </h3>
  1982. <p>
  1983. (<em>Appears on:</em>
  1984. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1985. </p>
  1986. <p>
  1987. <p>Configures an store to sync secrets using Azure KV.</p>
  1988. </p>
  1989. <table>
  1990. <thead>
  1991. <tr>
  1992. <th>Field</th>
  1993. <th>Description</th>
  1994. </tr>
  1995. </thead>
  1996. <tbody>
  1997. <tr>
  1998. <td>
  1999. <code>authType</code></br>
  2000. <em>
  2001. <a href="#external-secrets.io/v1beta1.AzureAuthType">
  2002. AzureAuthType
  2003. </a>
  2004. </em>
  2005. </td>
  2006. <td>
  2007. <em>(Optional)</em>
  2008. <p>Auth type defines how to authenticate to the keyvault service.
  2009. Valid values are:
  2010. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  2011. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  2012. </td>
  2013. </tr>
  2014. <tr>
  2015. <td>
  2016. <code>vaultUrl</code></br>
  2017. <em>
  2018. string
  2019. </em>
  2020. </td>
  2021. <td>
  2022. <p>Vault Url from which the secrets to be fetched from.</p>
  2023. </td>
  2024. </tr>
  2025. <tr>
  2026. <td>
  2027. <code>tenantId</code></br>
  2028. <em>
  2029. string
  2030. </em>
  2031. </td>
  2032. <td>
  2033. <em>(Optional)</em>
  2034. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.</p>
  2035. </td>
  2036. </tr>
  2037. <tr>
  2038. <td>
  2039. <code>environmentType</code></br>
  2040. <em>
  2041. <a href="#external-secrets.io/v1beta1.AzureEnvironmentType">
  2042. AzureEnvironmentType
  2043. </a>
  2044. </em>
  2045. </td>
  2046. <td>
  2047. <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
  2048. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  2049. The following endpoints are available, also see here: <a href="https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152">https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152</a>
  2050. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  2051. </td>
  2052. </tr>
  2053. <tr>
  2054. <td>
  2055. <code>authSecretRef</code></br>
  2056. <em>
  2057. <a href="#external-secrets.io/v1beta1.AzureKVAuth">
  2058. AzureKVAuth
  2059. </a>
  2060. </em>
  2061. </td>
  2062. <td>
  2063. <em>(Optional)</em>
  2064. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.</p>
  2065. </td>
  2066. </tr>
  2067. <tr>
  2068. <td>
  2069. <code>serviceAccountRef</code></br>
  2070. <em>
  2071. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  2072. External Secrets meta/v1.ServiceAccountSelector
  2073. </a>
  2074. </em>
  2075. </td>
  2076. <td>
  2077. <em>(Optional)</em>
  2078. <p>ServiceAccountRef specified the service account
  2079. that should be used when authenticating with WorkloadIdentity.</p>
  2080. </td>
  2081. </tr>
  2082. <tr>
  2083. <td>
  2084. <code>identityId</code></br>
  2085. <em>
  2086. string
  2087. </em>
  2088. </td>
  2089. <td>
  2090. <em>(Optional)</em>
  2091. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  2092. </td>
  2093. </tr>
  2094. </tbody>
  2095. </table>
  2096. <h3 id="external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">BeyondTrustProviderSecretRef
  2097. </h3>
  2098. <p>
  2099. (<em>Appears on:</em>
  2100. <a href="#external-secrets.io/v1beta1.BeyondtrustAuth">BeyondtrustAuth</a>)
  2101. </p>
  2102. <p>
  2103. </p>
  2104. <table>
  2105. <thead>
  2106. <tr>
  2107. <th>Field</th>
  2108. <th>Description</th>
  2109. </tr>
  2110. </thead>
  2111. <tbody>
  2112. <tr>
  2113. <td>
  2114. <code>value</code></br>
  2115. <em>
  2116. string
  2117. </em>
  2118. </td>
  2119. <td>
  2120. <em>(Optional)</em>
  2121. <p>Value can be specified directly to set a value without using a secret.</p>
  2122. </td>
  2123. </tr>
  2124. <tr>
  2125. <td>
  2126. <code>secretRef</code></br>
  2127. <em>
  2128. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2129. External Secrets meta/v1.SecretKeySelector
  2130. </a>
  2131. </em>
  2132. </td>
  2133. <td>
  2134. <em>(Optional)</em>
  2135. <p>SecretRef references a key in a secret that will be used as value.</p>
  2136. </td>
  2137. </tr>
  2138. </tbody>
  2139. </table>
  2140. <h3 id="external-secrets.io/v1beta1.BeyondtrustAuth">BeyondtrustAuth
  2141. </h3>
  2142. <p>
  2143. (<em>Appears on:</em>
  2144. <a href="#external-secrets.io/v1beta1.BeyondtrustProvider">BeyondtrustProvider</a>)
  2145. </p>
  2146. <p>
  2147. <p>Configures a store to sync secrets using BeyondTrust Password Safe.</p>
  2148. </p>
  2149. <table>
  2150. <thead>
  2151. <tr>
  2152. <th>Field</th>
  2153. <th>Description</th>
  2154. </tr>
  2155. </thead>
  2156. <tbody>
  2157. <tr>
  2158. <td>
  2159. <code>apiKey</code></br>
  2160. <em>
  2161. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2162. BeyondTrustProviderSecretRef
  2163. </a>
  2164. </em>
  2165. </td>
  2166. <td>
  2167. <p>APIKey If not provided then ClientID/ClientSecret become required.</p>
  2168. </td>
  2169. </tr>
  2170. <tr>
  2171. <td>
  2172. <code>clientId</code></br>
  2173. <em>
  2174. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2175. BeyondTrustProviderSecretRef
  2176. </a>
  2177. </em>
  2178. </td>
  2179. <td>
  2180. <p>ClientID is the API OAuth Client ID.</p>
  2181. </td>
  2182. </tr>
  2183. <tr>
  2184. <td>
  2185. <code>clientSecret</code></br>
  2186. <em>
  2187. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2188. BeyondTrustProviderSecretRef
  2189. </a>
  2190. </em>
  2191. </td>
  2192. <td>
  2193. <p>ClientSecret is the API OAuth Client Secret.</p>
  2194. </td>
  2195. </tr>
  2196. <tr>
  2197. <td>
  2198. <code>certificate</code></br>
  2199. <em>
  2200. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2201. BeyondTrustProviderSecretRef
  2202. </a>
  2203. </em>
  2204. </td>
  2205. <td>
  2206. <p>Certificate (cert.pem) for use when authenticating with an OAuth client Id using a Client Certificate.</p>
  2207. </td>
  2208. </tr>
  2209. <tr>
  2210. <td>
  2211. <code>certificateKey</code></br>
  2212. <em>
  2213. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2214. BeyondTrustProviderSecretRef
  2215. </a>
  2216. </em>
  2217. </td>
  2218. <td>
  2219. <p>Certificate private key (key.pem). For use when authenticating with an OAuth client Id</p>
  2220. </td>
  2221. </tr>
  2222. </tbody>
  2223. </table>
  2224. <h3 id="external-secrets.io/v1beta1.BeyondtrustProvider">BeyondtrustProvider
  2225. </h3>
  2226. <p>
  2227. (<em>Appears on:</em>
  2228. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2229. </p>
  2230. <p>
  2231. </p>
  2232. <table>
  2233. <thead>
  2234. <tr>
  2235. <th>Field</th>
  2236. <th>Description</th>
  2237. </tr>
  2238. </thead>
  2239. <tbody>
  2240. <tr>
  2241. <td>
  2242. <code>auth</code></br>
  2243. <em>
  2244. <a href="#external-secrets.io/v1beta1.BeyondtrustAuth">
  2245. BeyondtrustAuth
  2246. </a>
  2247. </em>
  2248. </td>
  2249. <td>
  2250. <p>Auth configures how the operator authenticates with Beyondtrust.</p>
  2251. </td>
  2252. </tr>
  2253. <tr>
  2254. <td>
  2255. <code>server</code></br>
  2256. <em>
  2257. <a href="#external-secrets.io/v1beta1.BeyondtrustServer">
  2258. BeyondtrustServer
  2259. </a>
  2260. </em>
  2261. </td>
  2262. <td>
  2263. <p>Auth configures how API server works.</p>
  2264. </td>
  2265. </tr>
  2266. </tbody>
  2267. </table>
  2268. <h3 id="external-secrets.io/v1beta1.BeyondtrustServer">BeyondtrustServer
  2269. </h3>
  2270. <p>
  2271. (<em>Appears on:</em>
  2272. <a href="#external-secrets.io/v1beta1.BeyondtrustProvider">BeyondtrustProvider</a>)
  2273. </p>
  2274. <p>
  2275. <p>Configures a store to sync secrets using BeyondTrust Password Safe.</p>
  2276. </p>
  2277. <table>
  2278. <thead>
  2279. <tr>
  2280. <th>Field</th>
  2281. <th>Description</th>
  2282. </tr>
  2283. </thead>
  2284. <tbody>
  2285. <tr>
  2286. <td>
  2287. <code>apiUrl</code></br>
  2288. <em>
  2289. string
  2290. </em>
  2291. </td>
  2292. <td>
  2293. </td>
  2294. </tr>
  2295. <tr>
  2296. <td>
  2297. <code>retrievalType</code></br>
  2298. <em>
  2299. string
  2300. </em>
  2301. </td>
  2302. <td>
  2303. <p>The secret retrieval type. SECRET = Secrets Safe (credential, text, file). MANAGED_ACCOUNT = Password Safe account associated with a system.</p>
  2304. </td>
  2305. </tr>
  2306. <tr>
  2307. <td>
  2308. <code>separator</code></br>
  2309. <em>
  2310. string
  2311. </em>
  2312. </td>
  2313. <td>
  2314. <p>A character that separates the folder names.</p>
  2315. </td>
  2316. </tr>
  2317. <tr>
  2318. <td>
  2319. <code>verifyCA</code></br>
  2320. <em>
  2321. bool
  2322. </em>
  2323. </td>
  2324. <td>
  2325. </td>
  2326. </tr>
  2327. <tr>
  2328. <td>
  2329. <code>clientTimeOutSeconds</code></br>
  2330. <em>
  2331. int
  2332. </em>
  2333. </td>
  2334. <td>
  2335. <p>Timeout specifies a time limit for requests made by this Client. The timeout includes connection time, any redirects, and reading the response body. Defaults to 45 seconds.</p>
  2336. </td>
  2337. </tr>
  2338. </tbody>
  2339. </table>
  2340. <h3 id="external-secrets.io/v1beta1.BitwardenSecretsManagerAuth">BitwardenSecretsManagerAuth
  2341. </h3>
  2342. <p>
  2343. (<em>Appears on:</em>
  2344. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider</a>)
  2345. </p>
  2346. <p>
  2347. <p>BitwardenSecretsManagerAuth contains the ref to the secret that contains the machine account token.</p>
  2348. </p>
  2349. <table>
  2350. <thead>
  2351. <tr>
  2352. <th>Field</th>
  2353. <th>Description</th>
  2354. </tr>
  2355. </thead>
  2356. <tbody>
  2357. <tr>
  2358. <td>
  2359. <code>secretRef</code></br>
  2360. <em>
  2361. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerSecretRef">
  2362. BitwardenSecretsManagerSecretRef
  2363. </a>
  2364. </em>
  2365. </td>
  2366. <td>
  2367. </td>
  2368. </tr>
  2369. </tbody>
  2370. </table>
  2371. <h3 id="external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider
  2372. </h3>
  2373. <p>
  2374. (<em>Appears on:</em>
  2375. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2376. </p>
  2377. <p>
  2378. <p>BitwardenSecretsManagerProvider configures a store to sync secrets with a Bitwarden Secrets Manager instance.</p>
  2379. </p>
  2380. <table>
  2381. <thead>
  2382. <tr>
  2383. <th>Field</th>
  2384. <th>Description</th>
  2385. </tr>
  2386. </thead>
  2387. <tbody>
  2388. <tr>
  2389. <td>
  2390. <code>apiURL</code></br>
  2391. <em>
  2392. string
  2393. </em>
  2394. </td>
  2395. <td>
  2396. </td>
  2397. </tr>
  2398. <tr>
  2399. <td>
  2400. <code>identityURL</code></br>
  2401. <em>
  2402. string
  2403. </em>
  2404. </td>
  2405. <td>
  2406. </td>
  2407. </tr>
  2408. <tr>
  2409. <td>
  2410. <code>bitwardenServerSDKURL</code></br>
  2411. <em>
  2412. string
  2413. </em>
  2414. </td>
  2415. <td>
  2416. </td>
  2417. </tr>
  2418. <tr>
  2419. <td>
  2420. <code>caBundle</code></br>
  2421. <em>
  2422. string
  2423. </em>
  2424. </td>
  2425. <td>
  2426. <em>(Optional)</em>
  2427. <p>Base64 encoded certificate for the bitwarden server sdk. The sdk MUST run with HTTPS to make sure no MITM attack
  2428. can be performed.</p>
  2429. </td>
  2430. </tr>
  2431. <tr>
  2432. <td>
  2433. <code>caProvider</code></br>
  2434. <em>
  2435. <a href="#external-secrets.io/v1beta1.CAProvider">
  2436. CAProvider
  2437. </a>
  2438. </em>
  2439. </td>
  2440. <td>
  2441. <em>(Optional)</em>
  2442. <p>see: <a href="https://external-secrets.io/latest/spec/#external-secrets.io/v1alpha1.CAProvider">https://external-secrets.io/latest/spec/#external-secrets.io/v1alpha1.CAProvider</a></p>
  2443. </td>
  2444. </tr>
  2445. <tr>
  2446. <td>
  2447. <code>organizationID</code></br>
  2448. <em>
  2449. string
  2450. </em>
  2451. </td>
  2452. <td>
  2453. <p>OrganizationID determines which organization this secret store manages.</p>
  2454. </td>
  2455. </tr>
  2456. <tr>
  2457. <td>
  2458. <code>projectID</code></br>
  2459. <em>
  2460. string
  2461. </em>
  2462. </td>
  2463. <td>
  2464. <p>ProjectID determines which project this secret store manages.</p>
  2465. </td>
  2466. </tr>
  2467. <tr>
  2468. <td>
  2469. <code>auth</code></br>
  2470. <em>
  2471. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerAuth">
  2472. BitwardenSecretsManagerAuth
  2473. </a>
  2474. </em>
  2475. </td>
  2476. <td>
  2477. <p>Auth configures how secret-manager authenticates with a bitwarden machine account instance.
  2478. Make sure that the token being used has permissions on the given secret.</p>
  2479. </td>
  2480. </tr>
  2481. </tbody>
  2482. </table>
  2483. <h3 id="external-secrets.io/v1beta1.BitwardenSecretsManagerSecretRef">BitwardenSecretsManagerSecretRef
  2484. </h3>
  2485. <p>
  2486. (<em>Appears on:</em>
  2487. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerAuth">BitwardenSecretsManagerAuth</a>)
  2488. </p>
  2489. <p>
  2490. <p>BitwardenSecretsManagerSecretRef contains the credential ref to the bitwarden instance.</p>
  2491. </p>
  2492. <table>
  2493. <thead>
  2494. <tr>
  2495. <th>Field</th>
  2496. <th>Description</th>
  2497. </tr>
  2498. </thead>
  2499. <tbody>
  2500. <tr>
  2501. <td>
  2502. <code>credentials</code></br>
  2503. <em>
  2504. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2505. External Secrets meta/v1.SecretKeySelector
  2506. </a>
  2507. </em>
  2508. </td>
  2509. <td>
  2510. <p>AccessToken used for the bitwarden instance.</p>
  2511. </td>
  2512. </tr>
  2513. </tbody>
  2514. </table>
  2515. <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
  2516. </h3>
  2517. <p>
  2518. (<em>Appears on:</em>
  2519. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>,
  2520. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider</a>,
  2521. <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>,
  2522. <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
  2523. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  2524. </p>
  2525. <p>
  2526. <p>Used to provide custom certificate authority (CA) certificates
  2527. for a secret store. The CAProvider points to a Secret or ConfigMap resource
  2528. that contains a PEM-encoded certificate.</p>
  2529. </p>
  2530. <table>
  2531. <thead>
  2532. <tr>
  2533. <th>Field</th>
  2534. <th>Description</th>
  2535. </tr>
  2536. </thead>
  2537. <tbody>
  2538. <tr>
  2539. <td>
  2540. <code>type</code></br>
  2541. <em>
  2542. <a href="#external-secrets.io/v1beta1.CAProviderType">
  2543. CAProviderType
  2544. </a>
  2545. </em>
  2546. </td>
  2547. <td>
  2548. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  2549. </td>
  2550. </tr>
  2551. <tr>
  2552. <td>
  2553. <code>name</code></br>
  2554. <em>
  2555. string
  2556. </em>
  2557. </td>
  2558. <td>
  2559. <p>The name of the object located at the provider type.</p>
  2560. </td>
  2561. </tr>
  2562. <tr>
  2563. <td>
  2564. <code>key</code></br>
  2565. <em>
  2566. string
  2567. </em>
  2568. </td>
  2569. <td>
  2570. <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
  2571. </td>
  2572. </tr>
  2573. <tr>
  2574. <td>
  2575. <code>namespace</code></br>
  2576. <em>
  2577. string
  2578. </em>
  2579. </td>
  2580. <td>
  2581. <em>(Optional)</em>
  2582. <p>The namespace the Provider type is in.
  2583. Can only be defined when used in a ClusterSecretStore.</p>
  2584. </td>
  2585. </tr>
  2586. </tbody>
  2587. </table>
  2588. <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
  2589. (<code>string</code> alias)</p></h3>
  2590. <p>
  2591. (<em>Appears on:</em>
  2592. <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
  2593. </p>
  2594. <p>
  2595. </p>
  2596. <table>
  2597. <thead>
  2598. <tr>
  2599. <th>Value</th>
  2600. <th>Description</th>
  2601. </tr>
  2602. </thead>
  2603. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  2604. <td></td>
  2605. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  2606. <td></td>
  2607. </tr></tbody>
  2608. </table>
  2609. <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
  2610. </h3>
  2611. <p>
  2612. (<em>Appears on:</em>
  2613. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  2614. </p>
  2615. <p>
  2616. </p>
  2617. <table>
  2618. <thead>
  2619. <tr>
  2620. <th>Field</th>
  2621. <th>Description</th>
  2622. </tr>
  2623. </thead>
  2624. <tbody>
  2625. <tr>
  2626. <td>
  2627. <code>clientCert</code></br>
  2628. <em>
  2629. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2630. External Secrets meta/v1.SecretKeySelector
  2631. </a>
  2632. </em>
  2633. </td>
  2634. <td>
  2635. </td>
  2636. </tr>
  2637. <tr>
  2638. <td>
  2639. <code>clientKey</code></br>
  2640. <em>
  2641. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2642. External Secrets meta/v1.SecretKeySelector
  2643. </a>
  2644. </em>
  2645. </td>
  2646. <td>
  2647. </td>
  2648. </tr>
  2649. </tbody>
  2650. </table>
  2651. <h3 id="external-secrets.io/v1beta1.ChefAuth">ChefAuth
  2652. </h3>
  2653. <p>
  2654. (<em>Appears on:</em>
  2655. <a href="#external-secrets.io/v1beta1.ChefProvider">ChefProvider</a>)
  2656. </p>
  2657. <p>
  2658. <p>ChefAuth contains a secretRef for credentials.</p>
  2659. </p>
  2660. <table>
  2661. <thead>
  2662. <tr>
  2663. <th>Field</th>
  2664. <th>Description</th>
  2665. </tr>
  2666. </thead>
  2667. <tbody>
  2668. <tr>
  2669. <td>
  2670. <code>secretRef</code></br>
  2671. <em>
  2672. <a href="#external-secrets.io/v1beta1.ChefAuthSecretRef">
  2673. ChefAuthSecretRef
  2674. </a>
  2675. </em>
  2676. </td>
  2677. <td>
  2678. </td>
  2679. </tr>
  2680. </tbody>
  2681. </table>
  2682. <h3 id="external-secrets.io/v1beta1.ChefAuthSecretRef">ChefAuthSecretRef
  2683. </h3>
  2684. <p>
  2685. (<em>Appears on:</em>
  2686. <a href="#external-secrets.io/v1beta1.ChefAuth">ChefAuth</a>)
  2687. </p>
  2688. <p>
  2689. <p>ChefAuthSecretRef holds secret references for chef server login credentials.</p>
  2690. </p>
  2691. <table>
  2692. <thead>
  2693. <tr>
  2694. <th>Field</th>
  2695. <th>Description</th>
  2696. </tr>
  2697. </thead>
  2698. <tbody>
  2699. <tr>
  2700. <td>
  2701. <code>privateKeySecretRef</code></br>
  2702. <em>
  2703. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2704. External Secrets meta/v1.SecretKeySelector
  2705. </a>
  2706. </em>
  2707. </td>
  2708. <td>
  2709. <p>SecretKey is the Signing Key in PEM format, used for authentication.</p>
  2710. </td>
  2711. </tr>
  2712. </tbody>
  2713. </table>
  2714. <h3 id="external-secrets.io/v1beta1.ChefProvider">ChefProvider
  2715. </h3>
  2716. <p>
  2717. (<em>Appears on:</em>
  2718. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2719. </p>
  2720. <p>
  2721. <p>ChefProvider configures a store to sync secrets using basic chef server connection credentials.</p>
  2722. </p>
  2723. <table>
  2724. <thead>
  2725. <tr>
  2726. <th>Field</th>
  2727. <th>Description</th>
  2728. </tr>
  2729. </thead>
  2730. <tbody>
  2731. <tr>
  2732. <td>
  2733. <code>auth</code></br>
  2734. <em>
  2735. <a href="#external-secrets.io/v1beta1.ChefAuth">
  2736. ChefAuth
  2737. </a>
  2738. </em>
  2739. </td>
  2740. <td>
  2741. <p>Auth defines the information necessary to authenticate against chef Server</p>
  2742. </td>
  2743. </tr>
  2744. <tr>
  2745. <td>
  2746. <code>username</code></br>
  2747. <em>
  2748. string
  2749. </em>
  2750. </td>
  2751. <td>
  2752. <p>UserName should be the user ID on the chef server</p>
  2753. </td>
  2754. </tr>
  2755. <tr>
  2756. <td>
  2757. <code>serverUrl</code></br>
  2758. <em>
  2759. string
  2760. </em>
  2761. </td>
  2762. <td>
  2763. <p>ServerURL is the chef server URL used to connect to. If using orgs you should include your org in the url and terminate the url with a &ldquo;/&rdquo;</p>
  2764. </td>
  2765. </tr>
  2766. </tbody>
  2767. </table>
  2768. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
  2769. </h3>
  2770. <p>
  2771. <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
  2772. </p>
  2773. <table>
  2774. <thead>
  2775. <tr>
  2776. <th>Field</th>
  2777. <th>Description</th>
  2778. </tr>
  2779. </thead>
  2780. <tbody>
  2781. <tr>
  2782. <td>
  2783. <code>metadata</code></br>
  2784. <em>
  2785. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  2786. Kubernetes meta/v1.ObjectMeta
  2787. </a>
  2788. </em>
  2789. </td>
  2790. <td>
  2791. Refer to the Kubernetes API documentation for the fields of the
  2792. <code>metadata</code> field.
  2793. </td>
  2794. </tr>
  2795. <tr>
  2796. <td>
  2797. <code>spec</code></br>
  2798. <em>
  2799. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
  2800. ClusterExternalSecretSpec
  2801. </a>
  2802. </em>
  2803. </td>
  2804. <td>
  2805. <br/>
  2806. <br/>
  2807. <table>
  2808. <tr>
  2809. <td>
  2810. <code>externalSecretSpec</code></br>
  2811. <em>
  2812. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  2813. ExternalSecretSpec
  2814. </a>
  2815. </em>
  2816. </td>
  2817. <td>
  2818. <p>The spec for the ExternalSecrets to be created</p>
  2819. </td>
  2820. </tr>
  2821. <tr>
  2822. <td>
  2823. <code>externalSecretName</code></br>
  2824. <em>
  2825. string
  2826. </em>
  2827. </td>
  2828. <td>
  2829. <em>(Optional)</em>
  2830. <p>The name of the external secrets to be created.
  2831. Defaults to the name of the ClusterExternalSecret</p>
  2832. </td>
  2833. </tr>
  2834. <tr>
  2835. <td>
  2836. <code>externalSecretMetadata</code></br>
  2837. <em>
  2838. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
  2839. ExternalSecretMetadata
  2840. </a>
  2841. </em>
  2842. </td>
  2843. <td>
  2844. <em>(Optional)</em>
  2845. <p>The metadata of the external secrets to be created</p>
  2846. </td>
  2847. </tr>
  2848. <tr>
  2849. <td>
  2850. <code>namespaceSelector</code></br>
  2851. <em>
  2852. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  2853. Kubernetes meta/v1.LabelSelector
  2854. </a>
  2855. </em>
  2856. </td>
  2857. <td>
  2858. <em>(Optional)</em>
  2859. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.
  2860. Deprecated: Use NamespaceSelectors instead.</p>
  2861. </td>
  2862. </tr>
  2863. <tr>
  2864. <td>
  2865. <code>namespaceSelectors</code></br>
  2866. <em>
  2867. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
  2868. []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
  2869. </a>
  2870. </em>
  2871. </td>
  2872. <td>
  2873. <em>(Optional)</em>
  2874. <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
  2875. </td>
  2876. </tr>
  2877. <tr>
  2878. <td>
  2879. <code>namespaces</code></br>
  2880. <em>
  2881. []string
  2882. </em>
  2883. </td>
  2884. <td>
  2885. <em>(Optional)</em>
  2886. <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelectors ends up choosing.</p>
  2887. </td>
  2888. </tr>
  2889. <tr>
  2890. <td>
  2891. <code>refreshTime</code></br>
  2892. <em>
  2893. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  2894. Kubernetes meta/v1.Duration
  2895. </a>
  2896. </em>
  2897. </td>
  2898. <td>
  2899. <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
  2900. </td>
  2901. </tr>
  2902. </table>
  2903. </td>
  2904. </tr>
  2905. <tr>
  2906. <td>
  2907. <code>status</code></br>
  2908. <em>
  2909. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
  2910. ClusterExternalSecretStatus
  2911. </a>
  2912. </em>
  2913. </td>
  2914. <td>
  2915. </td>
  2916. </tr>
  2917. </tbody>
  2918. </table>
  2919. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
  2920. (<code>string</code> alias)</p></h3>
  2921. <p>
  2922. (<em>Appears on:</em>
  2923. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
  2924. </p>
  2925. <p>
  2926. </p>
  2927. <table>
  2928. <thead>
  2929. <tr>
  2930. <th>Value</th>
  2931. <th>Description</th>
  2932. </tr>
  2933. </thead>
  2934. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  2935. <td></td>
  2936. </tr></tbody>
  2937. </table>
  2938. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
  2939. </h3>
  2940. <p>
  2941. (<em>Appears on:</em>
  2942. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  2943. </p>
  2944. <p>
  2945. <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it&rsquo;s reason.</p>
  2946. </p>
  2947. <table>
  2948. <thead>
  2949. <tr>
  2950. <th>Field</th>
  2951. <th>Description</th>
  2952. </tr>
  2953. </thead>
  2954. <tbody>
  2955. <tr>
  2956. <td>
  2957. <code>namespace</code></br>
  2958. <em>
  2959. string
  2960. </em>
  2961. </td>
  2962. <td>
  2963. <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
  2964. </td>
  2965. </tr>
  2966. <tr>
  2967. <td>
  2968. <code>reason</code></br>
  2969. <em>
  2970. string
  2971. </em>
  2972. </td>
  2973. <td>
  2974. <em>(Optional)</em>
  2975. <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
  2976. </td>
  2977. </tr>
  2978. </tbody>
  2979. </table>
  2980. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
  2981. </h3>
  2982. <p>
  2983. (<em>Appears on:</em>
  2984. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  2985. </p>
  2986. <p>
  2987. <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
  2988. </p>
  2989. <table>
  2990. <thead>
  2991. <tr>
  2992. <th>Field</th>
  2993. <th>Description</th>
  2994. </tr>
  2995. </thead>
  2996. <tbody>
  2997. <tr>
  2998. <td>
  2999. <code>externalSecretSpec</code></br>
  3000. <em>
  3001. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  3002. ExternalSecretSpec
  3003. </a>
  3004. </em>
  3005. </td>
  3006. <td>
  3007. <p>The spec for the ExternalSecrets to be created</p>
  3008. </td>
  3009. </tr>
  3010. <tr>
  3011. <td>
  3012. <code>externalSecretName</code></br>
  3013. <em>
  3014. string
  3015. </em>
  3016. </td>
  3017. <td>
  3018. <em>(Optional)</em>
  3019. <p>The name of the external secrets to be created.
  3020. Defaults to the name of the ClusterExternalSecret</p>
  3021. </td>
  3022. </tr>
  3023. <tr>
  3024. <td>
  3025. <code>externalSecretMetadata</code></br>
  3026. <em>
  3027. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
  3028. ExternalSecretMetadata
  3029. </a>
  3030. </em>
  3031. </td>
  3032. <td>
  3033. <em>(Optional)</em>
  3034. <p>The metadata of the external secrets to be created</p>
  3035. </td>
  3036. </tr>
  3037. <tr>
  3038. <td>
  3039. <code>namespaceSelector</code></br>
  3040. <em>
  3041. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  3042. Kubernetes meta/v1.LabelSelector
  3043. </a>
  3044. </em>
  3045. </td>
  3046. <td>
  3047. <em>(Optional)</em>
  3048. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.
  3049. Deprecated: Use NamespaceSelectors instead.</p>
  3050. </td>
  3051. </tr>
  3052. <tr>
  3053. <td>
  3054. <code>namespaceSelectors</code></br>
  3055. <em>
  3056. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
  3057. []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
  3058. </a>
  3059. </em>
  3060. </td>
  3061. <td>
  3062. <em>(Optional)</em>
  3063. <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
  3064. </td>
  3065. </tr>
  3066. <tr>
  3067. <td>
  3068. <code>namespaces</code></br>
  3069. <em>
  3070. []string
  3071. </em>
  3072. </td>
  3073. <td>
  3074. <em>(Optional)</em>
  3075. <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelectors ends up choosing.</p>
  3076. </td>
  3077. </tr>
  3078. <tr>
  3079. <td>
  3080. <code>refreshTime</code></br>
  3081. <em>
  3082. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  3083. Kubernetes meta/v1.Duration
  3084. </a>
  3085. </em>
  3086. </td>
  3087. <td>
  3088. <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
  3089. </td>
  3090. </tr>
  3091. </tbody>
  3092. </table>
  3093. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
  3094. </h3>
  3095. <p>
  3096. (<em>Appears on:</em>
  3097. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  3098. </p>
  3099. <p>
  3100. <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
  3101. </p>
  3102. <table>
  3103. <thead>
  3104. <tr>
  3105. <th>Field</th>
  3106. <th>Description</th>
  3107. </tr>
  3108. </thead>
  3109. <tbody>
  3110. <tr>
  3111. <td>
  3112. <code>externalSecretName</code></br>
  3113. <em>
  3114. string
  3115. </em>
  3116. </td>
  3117. <td>
  3118. <p>ExternalSecretName is the name of the ExternalSecrets created by the ClusterExternalSecret</p>
  3119. </td>
  3120. </tr>
  3121. <tr>
  3122. <td>
  3123. <code>failedNamespaces</code></br>
  3124. <em>
  3125. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
  3126. []ClusterExternalSecretNamespaceFailure
  3127. </a>
  3128. </em>
  3129. </td>
  3130. <td>
  3131. <em>(Optional)</em>
  3132. <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
  3133. </td>
  3134. </tr>
  3135. <tr>
  3136. <td>
  3137. <code>provisionedNamespaces</code></br>
  3138. <em>
  3139. []string
  3140. </em>
  3141. </td>
  3142. <td>
  3143. <em>(Optional)</em>
  3144. <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
  3145. </td>
  3146. </tr>
  3147. <tr>
  3148. <td>
  3149. <code>conditions</code></br>
  3150. <em>
  3151. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
  3152. []ClusterExternalSecretStatusCondition
  3153. </a>
  3154. </em>
  3155. </td>
  3156. <td>
  3157. <em>(Optional)</em>
  3158. </td>
  3159. </tr>
  3160. </tbody>
  3161. </table>
  3162. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
  3163. </h3>
  3164. <p>
  3165. (<em>Appears on:</em>
  3166. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  3167. </p>
  3168. <p>
  3169. </p>
  3170. <table>
  3171. <thead>
  3172. <tr>
  3173. <th>Field</th>
  3174. <th>Description</th>
  3175. </tr>
  3176. </thead>
  3177. <tbody>
  3178. <tr>
  3179. <td>
  3180. <code>type</code></br>
  3181. <em>
  3182. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
  3183. ClusterExternalSecretConditionType
  3184. </a>
  3185. </em>
  3186. </td>
  3187. <td>
  3188. </td>
  3189. </tr>
  3190. <tr>
  3191. <td>
  3192. <code>status</code></br>
  3193. <em>
  3194. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  3195. Kubernetes core/v1.ConditionStatus
  3196. </a>
  3197. </em>
  3198. </td>
  3199. <td>
  3200. </td>
  3201. </tr>
  3202. <tr>
  3203. <td>
  3204. <code>message</code></br>
  3205. <em>
  3206. string
  3207. </em>
  3208. </td>
  3209. <td>
  3210. <em>(Optional)</em>
  3211. </td>
  3212. </tr>
  3213. </tbody>
  3214. </table>
  3215. <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
  3216. </h3>
  3217. <p>
  3218. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  3219. </p>
  3220. <table>
  3221. <thead>
  3222. <tr>
  3223. <th>Field</th>
  3224. <th>Description</th>
  3225. </tr>
  3226. </thead>
  3227. <tbody>
  3228. <tr>
  3229. <td>
  3230. <code>metadata</code></br>
  3231. <em>
  3232. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  3233. Kubernetes meta/v1.ObjectMeta
  3234. </a>
  3235. </em>
  3236. </td>
  3237. <td>
  3238. Refer to the Kubernetes API documentation for the fields of the
  3239. <code>metadata</code> field.
  3240. </td>
  3241. </tr>
  3242. <tr>
  3243. <td>
  3244. <code>spec</code></br>
  3245. <em>
  3246. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  3247. SecretStoreSpec
  3248. </a>
  3249. </em>
  3250. </td>
  3251. <td>
  3252. <br/>
  3253. <br/>
  3254. <table>
  3255. <tr>
  3256. <td>
  3257. <code>controller</code></br>
  3258. <em>
  3259. string
  3260. </em>
  3261. </td>
  3262. <td>
  3263. <em>(Optional)</em>
  3264. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  3265. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  3266. </td>
  3267. </tr>
  3268. <tr>
  3269. <td>
  3270. <code>provider</code></br>
  3271. <em>
  3272. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  3273. SecretStoreProvider
  3274. </a>
  3275. </em>
  3276. </td>
  3277. <td>
  3278. <p>Used to configure the provider. Only one provider may be set</p>
  3279. </td>
  3280. </tr>
  3281. <tr>
  3282. <td>
  3283. <code>retrySettings</code></br>
  3284. <em>
  3285. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  3286. SecretStoreRetrySettings
  3287. </a>
  3288. </em>
  3289. </td>
  3290. <td>
  3291. <em>(Optional)</em>
  3292. <p>Used to configure http retries if failed</p>
  3293. </td>
  3294. </tr>
  3295. <tr>
  3296. <td>
  3297. <code>refreshInterval</code></br>
  3298. <em>
  3299. int
  3300. </em>
  3301. </td>
  3302. <td>
  3303. <em>(Optional)</em>
  3304. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  3305. </td>
  3306. </tr>
  3307. <tr>
  3308. <td>
  3309. <code>conditions</code></br>
  3310. <em>
  3311. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  3312. []ClusterSecretStoreCondition
  3313. </a>
  3314. </em>
  3315. </td>
  3316. <td>
  3317. <em>(Optional)</em>
  3318. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  3319. </td>
  3320. </tr>
  3321. </table>
  3322. </td>
  3323. </tr>
  3324. <tr>
  3325. <td>
  3326. <code>status</code></br>
  3327. <em>
  3328. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  3329. SecretStoreStatus
  3330. </a>
  3331. </em>
  3332. </td>
  3333. <td>
  3334. </td>
  3335. </tr>
  3336. </tbody>
  3337. </table>
  3338. <h3 id="external-secrets.io/v1beta1.ClusterSecretStoreCondition">ClusterSecretStoreCondition
  3339. </h3>
  3340. <p>
  3341. (<em>Appears on:</em>
  3342. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  3343. </p>
  3344. <p>
  3345. <p>ClusterSecretStoreCondition describes a condition by which to choose namespaces to process ExternalSecrets in
  3346. for a ClusterSecretStore instance.</p>
  3347. </p>
  3348. <table>
  3349. <thead>
  3350. <tr>
  3351. <th>Field</th>
  3352. <th>Description</th>
  3353. </tr>
  3354. </thead>
  3355. <tbody>
  3356. <tr>
  3357. <td>
  3358. <code>namespaceSelector</code></br>
  3359. <em>
  3360. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  3361. Kubernetes meta/v1.LabelSelector
  3362. </a>
  3363. </em>
  3364. </td>
  3365. <td>
  3366. <em>(Optional)</em>
  3367. <p>Choose namespace using a labelSelector</p>
  3368. </td>
  3369. </tr>
  3370. <tr>
  3371. <td>
  3372. <code>namespaces</code></br>
  3373. <em>
  3374. []string
  3375. </em>
  3376. </td>
  3377. <td>
  3378. <em>(Optional)</em>
  3379. <p>Choose namespaces by name</p>
  3380. </td>
  3381. </tr>
  3382. <tr>
  3383. <td>
  3384. <code>namespaceRegexes</code></br>
  3385. <em>
  3386. []string
  3387. </em>
  3388. </td>
  3389. <td>
  3390. <em>(Optional)</em>
  3391. <p>Choose namespaces by using regex matching</p>
  3392. </td>
  3393. </tr>
  3394. </tbody>
  3395. </table>
  3396. <h3 id="external-secrets.io/v1beta1.ConjurAPIKey">ConjurAPIKey
  3397. </h3>
  3398. <p>
  3399. (<em>Appears on:</em>
  3400. <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
  3401. </p>
  3402. <p>
  3403. </p>
  3404. <table>
  3405. <thead>
  3406. <tr>
  3407. <th>Field</th>
  3408. <th>Description</th>
  3409. </tr>
  3410. </thead>
  3411. <tbody>
  3412. <tr>
  3413. <td>
  3414. <code>account</code></br>
  3415. <em>
  3416. string
  3417. </em>
  3418. </td>
  3419. <td>
  3420. </td>
  3421. </tr>
  3422. <tr>
  3423. <td>
  3424. <code>userRef</code></br>
  3425. <em>
  3426. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3427. External Secrets meta/v1.SecretKeySelector
  3428. </a>
  3429. </em>
  3430. </td>
  3431. <td>
  3432. </td>
  3433. </tr>
  3434. <tr>
  3435. <td>
  3436. <code>apiKeyRef</code></br>
  3437. <em>
  3438. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3439. External Secrets meta/v1.SecretKeySelector
  3440. </a>
  3441. </em>
  3442. </td>
  3443. <td>
  3444. </td>
  3445. </tr>
  3446. </tbody>
  3447. </table>
  3448. <h3 id="external-secrets.io/v1beta1.ConjurAuth">ConjurAuth
  3449. </h3>
  3450. <p>
  3451. (<em>Appears on:</em>
  3452. <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>)
  3453. </p>
  3454. <p>
  3455. </p>
  3456. <table>
  3457. <thead>
  3458. <tr>
  3459. <th>Field</th>
  3460. <th>Description</th>
  3461. </tr>
  3462. </thead>
  3463. <tbody>
  3464. <tr>
  3465. <td>
  3466. <code>apikey</code></br>
  3467. <em>
  3468. <a href="#external-secrets.io/v1beta1.ConjurAPIKey">
  3469. ConjurAPIKey
  3470. </a>
  3471. </em>
  3472. </td>
  3473. <td>
  3474. <em>(Optional)</em>
  3475. </td>
  3476. </tr>
  3477. <tr>
  3478. <td>
  3479. <code>jwt</code></br>
  3480. <em>
  3481. <a href="#external-secrets.io/v1beta1.ConjurJWT">
  3482. ConjurJWT
  3483. </a>
  3484. </em>
  3485. </td>
  3486. <td>
  3487. <em>(Optional)</em>
  3488. </td>
  3489. </tr>
  3490. </tbody>
  3491. </table>
  3492. <h3 id="external-secrets.io/v1beta1.ConjurJWT">ConjurJWT
  3493. </h3>
  3494. <p>
  3495. (<em>Appears on:</em>
  3496. <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
  3497. </p>
  3498. <p>
  3499. </p>
  3500. <table>
  3501. <thead>
  3502. <tr>
  3503. <th>Field</th>
  3504. <th>Description</th>
  3505. </tr>
  3506. </thead>
  3507. <tbody>
  3508. <tr>
  3509. <td>
  3510. <code>account</code></br>
  3511. <em>
  3512. string
  3513. </em>
  3514. </td>
  3515. <td>
  3516. </td>
  3517. </tr>
  3518. <tr>
  3519. <td>
  3520. <code>serviceID</code></br>
  3521. <em>
  3522. string
  3523. </em>
  3524. </td>
  3525. <td>
  3526. <p>The conjur authn jwt webservice id</p>
  3527. </td>
  3528. </tr>
  3529. <tr>
  3530. <td>
  3531. <code>hostId</code></br>
  3532. <em>
  3533. string
  3534. </em>
  3535. </td>
  3536. <td>
  3537. <em>(Optional)</em>
  3538. <p>Optional HostID for JWT authentication. This may be used depending
  3539. on how the Conjur JWT authenticator policy is configured.</p>
  3540. </td>
  3541. </tr>
  3542. <tr>
  3543. <td>
  3544. <code>secretRef</code></br>
  3545. <em>
  3546. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3547. External Secrets meta/v1.SecretKeySelector
  3548. </a>
  3549. </em>
  3550. </td>
  3551. <td>
  3552. <em>(Optional)</em>
  3553. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  3554. authenticate with Conjur using the JWT authentication method.</p>
  3555. </td>
  3556. </tr>
  3557. <tr>
  3558. <td>
  3559. <code>serviceAccountRef</code></br>
  3560. <em>
  3561. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  3562. External Secrets meta/v1.ServiceAccountSelector
  3563. </a>
  3564. </em>
  3565. </td>
  3566. <td>
  3567. <em>(Optional)</em>
  3568. <p>Optional ServiceAccountRef specifies the Kubernetes service account for which to request
  3569. a token for with the <code>TokenRequest</code> API.</p>
  3570. </td>
  3571. </tr>
  3572. </tbody>
  3573. </table>
  3574. <h3 id="external-secrets.io/v1beta1.ConjurProvider">ConjurProvider
  3575. </h3>
  3576. <p>
  3577. (<em>Appears on:</em>
  3578. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3579. </p>
  3580. <p>
  3581. </p>
  3582. <table>
  3583. <thead>
  3584. <tr>
  3585. <th>Field</th>
  3586. <th>Description</th>
  3587. </tr>
  3588. </thead>
  3589. <tbody>
  3590. <tr>
  3591. <td>
  3592. <code>url</code></br>
  3593. <em>
  3594. string
  3595. </em>
  3596. </td>
  3597. <td>
  3598. </td>
  3599. </tr>
  3600. <tr>
  3601. <td>
  3602. <code>caBundle</code></br>
  3603. <em>
  3604. string
  3605. </em>
  3606. </td>
  3607. <td>
  3608. <em>(Optional)</em>
  3609. </td>
  3610. </tr>
  3611. <tr>
  3612. <td>
  3613. <code>caProvider</code></br>
  3614. <em>
  3615. <a href="#external-secrets.io/v1beta1.CAProvider">
  3616. CAProvider
  3617. </a>
  3618. </em>
  3619. </td>
  3620. <td>
  3621. <em>(Optional)</em>
  3622. </td>
  3623. </tr>
  3624. <tr>
  3625. <td>
  3626. <code>auth</code></br>
  3627. <em>
  3628. <a href="#external-secrets.io/v1beta1.ConjurAuth">
  3629. ConjurAuth
  3630. </a>
  3631. </em>
  3632. </td>
  3633. <td>
  3634. </td>
  3635. </tr>
  3636. </tbody>
  3637. </table>
  3638. <h3 id="external-secrets.io/v1beta1.DelineaProvider">DelineaProvider
  3639. </h3>
  3640. <p>
  3641. (<em>Appears on:</em>
  3642. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3643. </p>
  3644. <p>
  3645. <p>See <a href="https://github.com/DelineaXPM/dsv-sdk-go/blob/main/vault/vault.go">https://github.com/DelineaXPM/dsv-sdk-go/blob/main/vault/vault.go</a>.</p>
  3646. </p>
  3647. <table>
  3648. <thead>
  3649. <tr>
  3650. <th>Field</th>
  3651. <th>Description</th>
  3652. </tr>
  3653. </thead>
  3654. <tbody>
  3655. <tr>
  3656. <td>
  3657. <code>clientId</code></br>
  3658. <em>
  3659. <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
  3660. DelineaProviderSecretRef
  3661. </a>
  3662. </em>
  3663. </td>
  3664. <td>
  3665. <p>ClientID is the non-secret part of the credential.</p>
  3666. </td>
  3667. </tr>
  3668. <tr>
  3669. <td>
  3670. <code>clientSecret</code></br>
  3671. <em>
  3672. <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
  3673. DelineaProviderSecretRef
  3674. </a>
  3675. </em>
  3676. </td>
  3677. <td>
  3678. <p>ClientSecret is the secret part of the credential.</p>
  3679. </td>
  3680. </tr>
  3681. <tr>
  3682. <td>
  3683. <code>tenant</code></br>
  3684. <em>
  3685. string
  3686. </em>
  3687. </td>
  3688. <td>
  3689. <p>Tenant is the chosen hostname / site name.</p>
  3690. </td>
  3691. </tr>
  3692. <tr>
  3693. <td>
  3694. <code>urlTemplate</code></br>
  3695. <em>
  3696. string
  3697. </em>
  3698. </td>
  3699. <td>
  3700. <em>(Optional)</em>
  3701. <p>URLTemplate
  3702. If unset, defaults to &ldquo;https://%s.secretsvaultcloud.%s/v1/%s%s&rdquo;.</p>
  3703. </td>
  3704. </tr>
  3705. <tr>
  3706. <td>
  3707. <code>tld</code></br>
  3708. <em>
  3709. string
  3710. </em>
  3711. </td>
  3712. <td>
  3713. <em>(Optional)</em>
  3714. <p>TLD is based on the server location that was chosen during provisioning.
  3715. If unset, defaults to &ldquo;com&rdquo;.</p>
  3716. </td>
  3717. </tr>
  3718. </tbody>
  3719. </table>
  3720. <h3 id="external-secrets.io/v1beta1.DelineaProviderSecretRef">DelineaProviderSecretRef
  3721. </h3>
  3722. <p>
  3723. (<em>Appears on:</em>
  3724. <a href="#external-secrets.io/v1beta1.DelineaProvider">DelineaProvider</a>)
  3725. </p>
  3726. <p>
  3727. </p>
  3728. <table>
  3729. <thead>
  3730. <tr>
  3731. <th>Field</th>
  3732. <th>Description</th>
  3733. </tr>
  3734. </thead>
  3735. <tbody>
  3736. <tr>
  3737. <td>
  3738. <code>value</code></br>
  3739. <em>
  3740. string
  3741. </em>
  3742. </td>
  3743. <td>
  3744. <em>(Optional)</em>
  3745. <p>Value can be specified directly to set a value without using a secret.</p>
  3746. </td>
  3747. </tr>
  3748. <tr>
  3749. <td>
  3750. <code>secretRef</code></br>
  3751. <em>
  3752. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3753. External Secrets meta/v1.SecretKeySelector
  3754. </a>
  3755. </em>
  3756. </td>
  3757. <td>
  3758. <em>(Optional)</em>
  3759. <p>SecretRef references a key in a secret that will be used as value.</p>
  3760. </td>
  3761. </tr>
  3762. </tbody>
  3763. </table>
  3764. <h3 id="external-secrets.io/v1beta1.Device42Auth">Device42Auth
  3765. </h3>
  3766. <p>
  3767. (<em>Appears on:</em>
  3768. <a href="#external-secrets.io/v1beta1.Device42Provider">Device42Provider</a>)
  3769. </p>
  3770. <p>
  3771. </p>
  3772. <table>
  3773. <thead>
  3774. <tr>
  3775. <th>Field</th>
  3776. <th>Description</th>
  3777. </tr>
  3778. </thead>
  3779. <tbody>
  3780. <tr>
  3781. <td>
  3782. <code>secretRef</code></br>
  3783. <em>
  3784. <a href="#external-secrets.io/v1beta1.Device42SecretRef">
  3785. Device42SecretRef
  3786. </a>
  3787. </em>
  3788. </td>
  3789. <td>
  3790. </td>
  3791. </tr>
  3792. </tbody>
  3793. </table>
  3794. <h3 id="external-secrets.io/v1beta1.Device42Provider">Device42Provider
  3795. </h3>
  3796. <p>
  3797. (<em>Appears on:</em>
  3798. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3799. </p>
  3800. <p>
  3801. <p>Device42Provider configures a store to sync secrets with a Device42 instance.</p>
  3802. </p>
  3803. <table>
  3804. <thead>
  3805. <tr>
  3806. <th>Field</th>
  3807. <th>Description</th>
  3808. </tr>
  3809. </thead>
  3810. <tbody>
  3811. <tr>
  3812. <td>
  3813. <code>host</code></br>
  3814. <em>
  3815. string
  3816. </em>
  3817. </td>
  3818. <td>
  3819. <p>URL configures the Device42 instance URL.</p>
  3820. </td>
  3821. </tr>
  3822. <tr>
  3823. <td>
  3824. <code>auth</code></br>
  3825. <em>
  3826. <a href="#external-secrets.io/v1beta1.Device42Auth">
  3827. Device42Auth
  3828. </a>
  3829. </em>
  3830. </td>
  3831. <td>
  3832. <p>Auth configures how secret-manager authenticates with a Device42 instance.</p>
  3833. </td>
  3834. </tr>
  3835. </tbody>
  3836. </table>
  3837. <h3 id="external-secrets.io/v1beta1.Device42SecretRef">Device42SecretRef
  3838. </h3>
  3839. <p>
  3840. (<em>Appears on:</em>
  3841. <a href="#external-secrets.io/v1beta1.Device42Auth">Device42Auth</a>)
  3842. </p>
  3843. <p>
  3844. </p>
  3845. <table>
  3846. <thead>
  3847. <tr>
  3848. <th>Field</th>
  3849. <th>Description</th>
  3850. </tr>
  3851. </thead>
  3852. <tbody>
  3853. <tr>
  3854. <td>
  3855. <code>credentials</code></br>
  3856. <em>
  3857. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3858. External Secrets meta/v1.SecretKeySelector
  3859. </a>
  3860. </em>
  3861. </td>
  3862. <td>
  3863. <em>(Optional)</em>
  3864. <p>Username / Password is used for authentication.</p>
  3865. </td>
  3866. </tr>
  3867. </tbody>
  3868. </table>
  3869. <h3 id="external-secrets.io/v1beta1.DopplerAuth">DopplerAuth
  3870. </h3>
  3871. <p>
  3872. (<em>Appears on:</em>
  3873. <a href="#external-secrets.io/v1beta1.DopplerProvider">DopplerProvider</a>)
  3874. </p>
  3875. <p>
  3876. </p>
  3877. <table>
  3878. <thead>
  3879. <tr>
  3880. <th>Field</th>
  3881. <th>Description</th>
  3882. </tr>
  3883. </thead>
  3884. <tbody>
  3885. <tr>
  3886. <td>
  3887. <code>secretRef</code></br>
  3888. <em>
  3889. <a href="#external-secrets.io/v1beta1.DopplerAuthSecretRef">
  3890. DopplerAuthSecretRef
  3891. </a>
  3892. </em>
  3893. </td>
  3894. <td>
  3895. </td>
  3896. </tr>
  3897. </tbody>
  3898. </table>
  3899. <h3 id="external-secrets.io/v1beta1.DopplerAuthSecretRef">DopplerAuthSecretRef
  3900. </h3>
  3901. <p>
  3902. (<em>Appears on:</em>
  3903. <a href="#external-secrets.io/v1beta1.DopplerAuth">DopplerAuth</a>)
  3904. </p>
  3905. <p>
  3906. </p>
  3907. <table>
  3908. <thead>
  3909. <tr>
  3910. <th>Field</th>
  3911. <th>Description</th>
  3912. </tr>
  3913. </thead>
  3914. <tbody>
  3915. <tr>
  3916. <td>
  3917. <code>dopplerToken</code></br>
  3918. <em>
  3919. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3920. External Secrets meta/v1.SecretKeySelector
  3921. </a>
  3922. </em>
  3923. </td>
  3924. <td>
  3925. <p>The DopplerToken is used for authentication.
  3926. See <a href="https://docs.doppler.com/reference/api#authentication">https://docs.doppler.com/reference/api#authentication</a> for auth token types.
  3927. The Key attribute defaults to dopplerToken if not specified.</p>
  3928. </td>
  3929. </tr>
  3930. </tbody>
  3931. </table>
  3932. <h3 id="external-secrets.io/v1beta1.DopplerProvider">DopplerProvider
  3933. </h3>
  3934. <p>
  3935. (<em>Appears on:</em>
  3936. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3937. </p>
  3938. <p>
  3939. <p>DopplerProvider configures a store to sync secrets using the Doppler provider.
  3940. Project and Config are required if not using a Service Token.</p>
  3941. </p>
  3942. <table>
  3943. <thead>
  3944. <tr>
  3945. <th>Field</th>
  3946. <th>Description</th>
  3947. </tr>
  3948. </thead>
  3949. <tbody>
  3950. <tr>
  3951. <td>
  3952. <code>auth</code></br>
  3953. <em>
  3954. <a href="#external-secrets.io/v1beta1.DopplerAuth">
  3955. DopplerAuth
  3956. </a>
  3957. </em>
  3958. </td>
  3959. <td>
  3960. <p>Auth configures how the Operator authenticates with the Doppler API</p>
  3961. </td>
  3962. </tr>
  3963. <tr>
  3964. <td>
  3965. <code>project</code></br>
  3966. <em>
  3967. string
  3968. </em>
  3969. </td>
  3970. <td>
  3971. <em>(Optional)</em>
  3972. <p>Doppler project (required if not using a Service Token)</p>
  3973. </td>
  3974. </tr>
  3975. <tr>
  3976. <td>
  3977. <code>config</code></br>
  3978. <em>
  3979. string
  3980. </em>
  3981. </td>
  3982. <td>
  3983. <em>(Optional)</em>
  3984. <p>Doppler config (required if not using a Service Token)</p>
  3985. </td>
  3986. </tr>
  3987. <tr>
  3988. <td>
  3989. <code>nameTransformer</code></br>
  3990. <em>
  3991. string
  3992. </em>
  3993. </td>
  3994. <td>
  3995. <em>(Optional)</em>
  3996. <p>Environment variable compatible name transforms that change secret names to a different format</p>
  3997. </td>
  3998. </tr>
  3999. <tr>
  4000. <td>
  4001. <code>format</code></br>
  4002. <em>
  4003. string
  4004. </em>
  4005. </td>
  4006. <td>
  4007. <em>(Optional)</em>
  4008. <p>Format enables the downloading of secrets as a file (string)</p>
  4009. </td>
  4010. </tr>
  4011. </tbody>
  4012. </table>
  4013. <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
  4014. </h3>
  4015. <p>
  4016. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  4017. </p>
  4018. <table>
  4019. <thead>
  4020. <tr>
  4021. <th>Field</th>
  4022. <th>Description</th>
  4023. </tr>
  4024. </thead>
  4025. <tbody>
  4026. <tr>
  4027. <td>
  4028. <code>metadata</code></br>
  4029. <em>
  4030. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  4031. Kubernetes meta/v1.ObjectMeta
  4032. </a>
  4033. </em>
  4034. </td>
  4035. <td>
  4036. Refer to the Kubernetes API documentation for the fields of the
  4037. <code>metadata</code> field.
  4038. </td>
  4039. </tr>
  4040. <tr>
  4041. <td>
  4042. <code>spec</code></br>
  4043. <em>
  4044. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  4045. ExternalSecretSpec
  4046. </a>
  4047. </em>
  4048. </td>
  4049. <td>
  4050. <br/>
  4051. <br/>
  4052. <table>
  4053. <tr>
  4054. <td>
  4055. <code>secretStoreRef</code></br>
  4056. <em>
  4057. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  4058. SecretStoreRef
  4059. </a>
  4060. </em>
  4061. </td>
  4062. <td>
  4063. <em>(Optional)</em>
  4064. </td>
  4065. </tr>
  4066. <tr>
  4067. <td>
  4068. <code>target</code></br>
  4069. <em>
  4070. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  4071. ExternalSecretTarget
  4072. </a>
  4073. </em>
  4074. </td>
  4075. <td>
  4076. <em>(Optional)</em>
  4077. </td>
  4078. </tr>
  4079. <tr>
  4080. <td>
  4081. <code>refreshInterval</code></br>
  4082. <em>
  4083. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  4084. Kubernetes meta/v1.Duration
  4085. </a>
  4086. </em>
  4087. </td>
  4088. <td>
  4089. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider,
  4090. specified as Golang Duration strings.
  4091. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  4092. Example values: &ldquo;1h&rdquo;, &ldquo;2h30m&rdquo;, &ldquo;5d&rdquo;, &ldquo;10s&rdquo;
  4093. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  4094. </td>
  4095. </tr>
  4096. <tr>
  4097. <td>
  4098. <code>data</code></br>
  4099. <em>
  4100. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  4101. []ExternalSecretData
  4102. </a>
  4103. </em>
  4104. </td>
  4105. <td>
  4106. <em>(Optional)</em>
  4107. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  4108. </td>
  4109. </tr>
  4110. <tr>
  4111. <td>
  4112. <code>dataFrom</code></br>
  4113. <em>
  4114. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  4115. []ExternalSecretDataFromRemoteRef
  4116. </a>
  4117. </em>
  4118. </td>
  4119. <td>
  4120. <em>(Optional)</em>
  4121. <p>DataFrom is used to fetch all properties from a specific Provider data
  4122. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  4123. </td>
  4124. </tr>
  4125. </table>
  4126. </td>
  4127. </tr>
  4128. <tr>
  4129. <td>
  4130. <code>status</code></br>
  4131. <em>
  4132. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
  4133. ExternalSecretStatus
  4134. </a>
  4135. </em>
  4136. </td>
  4137. <td>
  4138. </td>
  4139. </tr>
  4140. </tbody>
  4141. </table>
  4142. <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
  4143. (<code>string</code> alias)</p></h3>
  4144. <p>
  4145. (<em>Appears on:</em>
  4146. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  4147. </p>
  4148. <p>
  4149. </p>
  4150. <table>
  4151. <thead>
  4152. <tr>
  4153. <th>Value</th>
  4154. <th>Description</th>
  4155. </tr>
  4156. </thead>
  4157. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  4158. <td></td>
  4159. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  4160. <td></td>
  4161. </tr></tbody>
  4162. </table>
  4163. <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
  4164. (<code>string</code> alias)</p></h3>
  4165. <p>
  4166. (<em>Appears on:</em>
  4167. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  4168. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  4169. </p>
  4170. <p>
  4171. </p>
  4172. <table>
  4173. <thead>
  4174. <tr>
  4175. <th>Value</th>
  4176. <th>Description</th>
  4177. </tr>
  4178. </thead>
  4179. <tbody><tr><td><p>&#34;Default&#34;</p></td>
  4180. <td></td>
  4181. </tr><tr><td><p>&#34;Unicode&#34;</p></td>
  4182. <td></td>
  4183. </tr></tbody>
  4184. </table>
  4185. <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  4186. (<code>string</code> alias)</p></h3>
  4187. <p>
  4188. (<em>Appears on:</em>
  4189. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  4190. </p>
  4191. <p>
  4192. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  4193. </p>
  4194. <table>
  4195. <thead>
  4196. <tr>
  4197. <th>Value</th>
  4198. <th>Description</th>
  4199. </tr>
  4200. </thead>
  4201. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  4202. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  4203. </td>
  4204. </tr><tr><td><p>&#34;None&#34;</p></td>
  4205. <td><p>None does not create a Secret (future use with injector).</p>
  4206. </td>
  4207. </tr><tr><td><p>&#34;Orphan&#34;</p></td>
  4208. <td><p>Orphan creates the Secret and does not set the ownerReference.
  4209. I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
  4210. </td>
  4211. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  4212. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  4213. </td>
  4214. </tr></tbody>
  4215. </table>
  4216. <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
  4217. </h3>
  4218. <p>
  4219. (<em>Appears on:</em>
  4220. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  4221. </p>
  4222. <p>
  4223. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  4224. </p>
  4225. <table>
  4226. <thead>
  4227. <tr>
  4228. <th>Field</th>
  4229. <th>Description</th>
  4230. </tr>
  4231. </thead>
  4232. <tbody>
  4233. <tr>
  4234. <td>
  4235. <code>secretKey</code></br>
  4236. <em>
  4237. string
  4238. </em>
  4239. </td>
  4240. <td>
  4241. <p>The key in the Kubernetes Secret to store the value.</p>
  4242. </td>
  4243. </tr>
  4244. <tr>
  4245. <td>
  4246. <code>remoteRef</code></br>
  4247. <em>
  4248. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  4249. ExternalSecretDataRemoteRef
  4250. </a>
  4251. </em>
  4252. </td>
  4253. <td>
  4254. <p>RemoteRef points to the remote secret and defines
  4255. which secret (version/property/..) to fetch.</p>
  4256. </td>
  4257. </tr>
  4258. <tr>
  4259. <td>
  4260. <code>sourceRef</code></br>
  4261. <em>
  4262. <a href="#external-secrets.io/v1beta1.StoreSourceRef">
  4263. StoreSourceRef
  4264. </a>
  4265. </em>
  4266. </td>
  4267. <td>
  4268. <p>SourceRef allows you to override the source
  4269. from which the value will be pulled.</p>
  4270. </td>
  4271. </tr>
  4272. </tbody>
  4273. </table>
  4274. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
  4275. </h3>
  4276. <p>
  4277. (<em>Appears on:</em>
  4278. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  4279. </p>
  4280. <p>
  4281. </p>
  4282. <table>
  4283. <thead>
  4284. <tr>
  4285. <th>Field</th>
  4286. <th>Description</th>
  4287. </tr>
  4288. </thead>
  4289. <tbody>
  4290. <tr>
  4291. <td>
  4292. <code>extract</code></br>
  4293. <em>
  4294. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  4295. ExternalSecretDataRemoteRef
  4296. </a>
  4297. </em>
  4298. </td>
  4299. <td>
  4300. <em>(Optional)</em>
  4301. <p>Used to extract multiple key/value pairs from one secret
  4302. Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  4303. </td>
  4304. </tr>
  4305. <tr>
  4306. <td>
  4307. <code>find</code></br>
  4308. <em>
  4309. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
  4310. ExternalSecretFind
  4311. </a>
  4312. </em>
  4313. </td>
  4314. <td>
  4315. <em>(Optional)</em>
  4316. <p>Used to find secrets based on tags or regular expressions
  4317. Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  4318. </td>
  4319. </tr>
  4320. <tr>
  4321. <td>
  4322. <code>rewrite</code></br>
  4323. <em>
  4324. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">
  4325. []ExternalSecretRewrite
  4326. </a>
  4327. </em>
  4328. </td>
  4329. <td>
  4330. <em>(Optional)</em>
  4331. <p>Used to rewrite secret Keys after getting them from the secret Provider
  4332. Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)</p>
  4333. </td>
  4334. </tr>
  4335. <tr>
  4336. <td>
  4337. <code>sourceRef</code></br>
  4338. <em>
  4339. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">
  4340. StoreGeneratorSourceRef
  4341. </a>
  4342. </em>
  4343. </td>
  4344. <td>
  4345. <p>SourceRef points to a store or generator
  4346. which contains secret values ready to use.
  4347. Use this in combination with Extract or Find pull values out of
  4348. a specific SecretStore.
  4349. When sourceRef points to a generator Extract or Find is not supported.
  4350. The generator returns a static map of values</p>
  4351. </td>
  4352. </tr>
  4353. </tbody>
  4354. </table>
  4355. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  4356. </h3>
  4357. <p>
  4358. (<em>Appears on:</em>
  4359. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  4360. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  4361. </p>
  4362. <p>
  4363. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  4364. </p>
  4365. <table>
  4366. <thead>
  4367. <tr>
  4368. <th>Field</th>
  4369. <th>Description</th>
  4370. </tr>
  4371. </thead>
  4372. <tbody>
  4373. <tr>
  4374. <td>
  4375. <code>key</code></br>
  4376. <em>
  4377. string
  4378. </em>
  4379. </td>
  4380. <td>
  4381. <p>Key is the key used in the Provider, mandatory</p>
  4382. </td>
  4383. </tr>
  4384. <tr>
  4385. <td>
  4386. <code>metadataPolicy</code></br>
  4387. <em>
  4388. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">
  4389. ExternalSecretMetadataPolicy
  4390. </a>
  4391. </em>
  4392. </td>
  4393. <td>
  4394. <em>(Optional)</em>
  4395. <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
  4396. </td>
  4397. </tr>
  4398. <tr>
  4399. <td>
  4400. <code>property</code></br>
  4401. <em>
  4402. string
  4403. </em>
  4404. </td>
  4405. <td>
  4406. <em>(Optional)</em>
  4407. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  4408. </td>
  4409. </tr>
  4410. <tr>
  4411. <td>
  4412. <code>version</code></br>
  4413. <em>
  4414. string
  4415. </em>
  4416. </td>
  4417. <td>
  4418. <em>(Optional)</em>
  4419. <p>Used to select a specific version of the Provider value, if supported</p>
  4420. </td>
  4421. </tr>
  4422. <tr>
  4423. <td>
  4424. <code>conversionStrategy</code></br>
  4425. <em>
  4426. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  4427. ExternalSecretConversionStrategy
  4428. </a>
  4429. </em>
  4430. </td>
  4431. <td>
  4432. <em>(Optional)</em>
  4433. <p>Used to define a conversion Strategy</p>
  4434. </td>
  4435. </tr>
  4436. <tr>
  4437. <td>
  4438. <code>decodingStrategy</code></br>
  4439. <em>
  4440. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  4441. ExternalSecretDecodingStrategy
  4442. </a>
  4443. </em>
  4444. </td>
  4445. <td>
  4446. <em>(Optional)</em>
  4447. <p>Used to define a decoding Strategy</p>
  4448. </td>
  4449. </tr>
  4450. </tbody>
  4451. </table>
  4452. <h3 id="external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
  4453. (<code>string</code> alias)</p></h3>
  4454. <p>
  4455. (<em>Appears on:</em>
  4456. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  4457. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  4458. </p>
  4459. <p>
  4460. </p>
  4461. <table>
  4462. <thead>
  4463. <tr>
  4464. <th>Value</th>
  4465. <th>Description</th>
  4466. </tr>
  4467. </thead>
  4468. <tbody><tr><td><p>&#34;Auto&#34;</p></td>
  4469. <td></td>
  4470. </tr><tr><td><p>&#34;Base64&#34;</p></td>
  4471. <td></td>
  4472. </tr><tr><td><p>&#34;Base64URL&#34;</p></td>
  4473. <td></td>
  4474. </tr><tr><td><p>&#34;None&#34;</p></td>
  4475. <td></td>
  4476. </tr></tbody>
  4477. </table>
  4478. <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
  4479. (<code>string</code> alias)</p></h3>
  4480. <p>
  4481. (<em>Appears on:</em>
  4482. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  4483. </p>
  4484. <p>
  4485. <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
  4486. </p>
  4487. <table>
  4488. <thead>
  4489. <tr>
  4490. <th>Value</th>
  4491. <th>Description</th>
  4492. </tr>
  4493. </thead>
  4494. <tbody><tr><td><p>&#34;Delete&#34;</p></td>
  4495. <td><p>Delete deletes the secret if all provider secrets are deleted.
  4496. If a secret gets deleted on the provider side and is not accessible
  4497. anymore this is not considered an error and the ExternalSecret
  4498. does not go into SecretSyncedError status.</p>
  4499. </td>
  4500. </tr><tr><td><p>&#34;Merge&#34;</p></td>
  4501. <td><p>Merge removes keys in the secret, but not the secret itself.
  4502. If a secret gets deleted on the provider side and is not accessible
  4503. anymore this is not considered an error and the ExternalSecret
  4504. does not go into SecretSyncedError status.</p>
  4505. </td>
  4506. </tr><tr><td><p>&#34;Retain&#34;</p></td>
  4507. <td><p>Retain will retain the secret if all provider secrets have been deleted.
  4508. If a provider secret does not exist the ExternalSecret gets into the
  4509. SecretSyncedError status.</p>
  4510. </td>
  4511. </tr></tbody>
  4512. </table>
  4513. <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
  4514. </h3>
  4515. <p>
  4516. (<em>Appears on:</em>
  4517. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  4518. </p>
  4519. <p>
  4520. </p>
  4521. <table>
  4522. <thead>
  4523. <tr>
  4524. <th>Field</th>
  4525. <th>Description</th>
  4526. </tr>
  4527. </thead>
  4528. <tbody>
  4529. <tr>
  4530. <td>
  4531. <code>path</code></br>
  4532. <em>
  4533. string
  4534. </em>
  4535. </td>
  4536. <td>
  4537. <em>(Optional)</em>
  4538. <p>A root path to start the find operations.</p>
  4539. </td>
  4540. </tr>
  4541. <tr>
  4542. <td>
  4543. <code>name</code></br>
  4544. <em>
  4545. <a href="#external-secrets.io/v1beta1.FindName">
  4546. FindName
  4547. </a>
  4548. </em>
  4549. </td>
  4550. <td>
  4551. <em>(Optional)</em>
  4552. <p>Finds secrets based on the name.</p>
  4553. </td>
  4554. </tr>
  4555. <tr>
  4556. <td>
  4557. <code>tags</code></br>
  4558. <em>
  4559. map[string]string
  4560. </em>
  4561. </td>
  4562. <td>
  4563. <em>(Optional)</em>
  4564. <p>Find secrets based on tags.</p>
  4565. </td>
  4566. </tr>
  4567. <tr>
  4568. <td>
  4569. <code>conversionStrategy</code></br>
  4570. <em>
  4571. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  4572. ExternalSecretConversionStrategy
  4573. </a>
  4574. </em>
  4575. </td>
  4576. <td>
  4577. <em>(Optional)</em>
  4578. <p>Used to define a conversion Strategy</p>
  4579. </td>
  4580. </tr>
  4581. <tr>
  4582. <td>
  4583. <code>decodingStrategy</code></br>
  4584. <em>
  4585. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  4586. ExternalSecretDecodingStrategy
  4587. </a>
  4588. </em>
  4589. </td>
  4590. <td>
  4591. <em>(Optional)</em>
  4592. <p>Used to define a decoding Strategy</p>
  4593. </td>
  4594. </tr>
  4595. </tbody>
  4596. </table>
  4597. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadata">ExternalSecretMetadata
  4598. </h3>
  4599. <p>
  4600. (<em>Appears on:</em>
  4601. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>)
  4602. </p>
  4603. <p>
  4604. <p>ExternalSecretMetadata defines metadata fields for the ExternalSecret generated by the ClusterExternalSecret.</p>
  4605. </p>
  4606. <table>
  4607. <thead>
  4608. <tr>
  4609. <th>Field</th>
  4610. <th>Description</th>
  4611. </tr>
  4612. </thead>
  4613. <tbody>
  4614. <tr>
  4615. <td>
  4616. <code>annotations</code></br>
  4617. <em>
  4618. map[string]string
  4619. </em>
  4620. </td>
  4621. <td>
  4622. <em>(Optional)</em>
  4623. </td>
  4624. </tr>
  4625. <tr>
  4626. <td>
  4627. <code>labels</code></br>
  4628. <em>
  4629. map[string]string
  4630. </em>
  4631. </td>
  4632. <td>
  4633. <em>(Optional)</em>
  4634. </td>
  4635. </tr>
  4636. </tbody>
  4637. </table>
  4638. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
  4639. (<code>string</code> alias)</p></h3>
  4640. <p>
  4641. (<em>Appears on:</em>
  4642. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
  4643. </p>
  4644. <p>
  4645. </p>
  4646. <table>
  4647. <thead>
  4648. <tr>
  4649. <th>Value</th>
  4650. <th>Description</th>
  4651. </tr>
  4652. </thead>
  4653. <tbody><tr><td><p>&#34;Fetch&#34;</p></td>
  4654. <td></td>
  4655. </tr><tr><td><p>&#34;None&#34;</p></td>
  4656. <td></td>
  4657. </tr></tbody>
  4658. </table>
  4659. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite
  4660. </h3>
  4661. <p>
  4662. (<em>Appears on:</em>
  4663. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  4664. </p>
  4665. <p>
  4666. </p>
  4667. <table>
  4668. <thead>
  4669. <tr>
  4670. <th>Field</th>
  4671. <th>Description</th>
  4672. </tr>
  4673. </thead>
  4674. <tbody>
  4675. <tr>
  4676. <td>
  4677. <code>regexp</code></br>
  4678. <em>
  4679. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">
  4680. ExternalSecretRewriteRegexp
  4681. </a>
  4682. </em>
  4683. </td>
  4684. <td>
  4685. <em>(Optional)</em>
  4686. <p>Used to rewrite with regular expressions.
  4687. The resulting key will be the output of a regexp.ReplaceAll operation.</p>
  4688. </td>
  4689. </tr>
  4690. <tr>
  4691. <td>
  4692. <code>transform</code></br>
  4693. <em>
  4694. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteTransform">
  4695. ExternalSecretRewriteTransform
  4696. </a>
  4697. </em>
  4698. </td>
  4699. <td>
  4700. <em>(Optional)</em>
  4701. <p>Used to apply string transformation on the secrets.
  4702. The resulting key will be the output of the template applied by the operation.</p>
  4703. </td>
  4704. </tr>
  4705. </tbody>
  4706. </table>
  4707. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">ExternalSecretRewriteRegexp
  4708. </h3>
  4709. <p>
  4710. (<em>Appears on:</em>
  4711. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  4712. </p>
  4713. <p>
  4714. </p>
  4715. <table>
  4716. <thead>
  4717. <tr>
  4718. <th>Field</th>
  4719. <th>Description</th>
  4720. </tr>
  4721. </thead>
  4722. <tbody>
  4723. <tr>
  4724. <td>
  4725. <code>source</code></br>
  4726. <em>
  4727. string
  4728. </em>
  4729. </td>
  4730. <td>
  4731. <p>Used to define the regular expression of a re.Compiler.</p>
  4732. </td>
  4733. </tr>
  4734. <tr>
  4735. <td>
  4736. <code>target</code></br>
  4737. <em>
  4738. string
  4739. </em>
  4740. </td>
  4741. <td>
  4742. <p>Used to define the target pattern of a ReplaceAll operation.</p>
  4743. </td>
  4744. </tr>
  4745. </tbody>
  4746. </table>
  4747. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteTransform">ExternalSecretRewriteTransform
  4748. </h3>
  4749. <p>
  4750. (<em>Appears on:</em>
  4751. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  4752. </p>
  4753. <p>
  4754. </p>
  4755. <table>
  4756. <thead>
  4757. <tr>
  4758. <th>Field</th>
  4759. <th>Description</th>
  4760. </tr>
  4761. </thead>
  4762. <tbody>
  4763. <tr>
  4764. <td>
  4765. <code>template</code></br>
  4766. <em>
  4767. string
  4768. </em>
  4769. </td>
  4770. <td>
  4771. <p>Used to define the template to apply on the secret name.
  4772. <code>.value</code> will specify the secret name in the template.</p>
  4773. </td>
  4774. </tr>
  4775. </tbody>
  4776. </table>
  4777. <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
  4778. </h3>
  4779. <p>
  4780. (<em>Appears on:</em>
  4781. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
  4782. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  4783. </p>
  4784. <p>
  4785. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  4786. </p>
  4787. <table>
  4788. <thead>
  4789. <tr>
  4790. <th>Field</th>
  4791. <th>Description</th>
  4792. </tr>
  4793. </thead>
  4794. <tbody>
  4795. <tr>
  4796. <td>
  4797. <code>secretStoreRef</code></br>
  4798. <em>
  4799. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  4800. SecretStoreRef
  4801. </a>
  4802. </em>
  4803. </td>
  4804. <td>
  4805. <em>(Optional)</em>
  4806. </td>
  4807. </tr>
  4808. <tr>
  4809. <td>
  4810. <code>target</code></br>
  4811. <em>
  4812. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  4813. ExternalSecretTarget
  4814. </a>
  4815. </em>
  4816. </td>
  4817. <td>
  4818. <em>(Optional)</em>
  4819. </td>
  4820. </tr>
  4821. <tr>
  4822. <td>
  4823. <code>refreshInterval</code></br>
  4824. <em>
  4825. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  4826. Kubernetes meta/v1.Duration
  4827. </a>
  4828. </em>
  4829. </td>
  4830. <td>
  4831. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider,
  4832. specified as Golang Duration strings.
  4833. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  4834. Example values: &ldquo;1h&rdquo;, &ldquo;2h30m&rdquo;, &ldquo;5d&rdquo;, &ldquo;10s&rdquo;
  4835. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  4836. </td>
  4837. </tr>
  4838. <tr>
  4839. <td>
  4840. <code>data</code></br>
  4841. <em>
  4842. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  4843. []ExternalSecretData
  4844. </a>
  4845. </em>
  4846. </td>
  4847. <td>
  4848. <em>(Optional)</em>
  4849. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  4850. </td>
  4851. </tr>
  4852. <tr>
  4853. <td>
  4854. <code>dataFrom</code></br>
  4855. <em>
  4856. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  4857. []ExternalSecretDataFromRemoteRef
  4858. </a>
  4859. </em>
  4860. </td>
  4861. <td>
  4862. <em>(Optional)</em>
  4863. <p>DataFrom is used to fetch all properties from a specific Provider data
  4864. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  4865. </td>
  4866. </tr>
  4867. </tbody>
  4868. </table>
  4869. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
  4870. </h3>
  4871. <p>
  4872. (<em>Appears on:</em>
  4873. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  4874. </p>
  4875. <p>
  4876. </p>
  4877. <table>
  4878. <thead>
  4879. <tr>
  4880. <th>Field</th>
  4881. <th>Description</th>
  4882. </tr>
  4883. </thead>
  4884. <tbody>
  4885. <tr>
  4886. <td>
  4887. <code>refreshTime</code></br>
  4888. <em>
  4889. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  4890. Kubernetes meta/v1.Time
  4891. </a>
  4892. </em>
  4893. </td>
  4894. <td>
  4895. <p>refreshTime is the time and date the external secret was fetched and
  4896. the target secret updated</p>
  4897. </td>
  4898. </tr>
  4899. <tr>
  4900. <td>
  4901. <code>syncedResourceVersion</code></br>
  4902. <em>
  4903. string
  4904. </em>
  4905. </td>
  4906. <td>
  4907. <p>SyncedResourceVersion keeps track of the last synced version</p>
  4908. </td>
  4909. </tr>
  4910. <tr>
  4911. <td>
  4912. <code>conditions</code></br>
  4913. <em>
  4914. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
  4915. []ExternalSecretStatusCondition
  4916. </a>
  4917. </em>
  4918. </td>
  4919. <td>
  4920. <em>(Optional)</em>
  4921. </td>
  4922. </tr>
  4923. <tr>
  4924. <td>
  4925. <code>binding</code></br>
  4926. <em>
  4927. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
  4928. Kubernetes core/v1.LocalObjectReference
  4929. </a>
  4930. </em>
  4931. </td>
  4932. <td>
  4933. <p>Binding represents a servicebinding.io Provisioned Service reference to the secret</p>
  4934. </td>
  4935. </tr>
  4936. </tbody>
  4937. </table>
  4938. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  4939. </h3>
  4940. <p>
  4941. (<em>Appears on:</em>
  4942. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
  4943. </p>
  4944. <p>
  4945. </p>
  4946. <table>
  4947. <thead>
  4948. <tr>
  4949. <th>Field</th>
  4950. <th>Description</th>
  4951. </tr>
  4952. </thead>
  4953. <tbody>
  4954. <tr>
  4955. <td>
  4956. <code>type</code></br>
  4957. <em>
  4958. <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
  4959. ExternalSecretConditionType
  4960. </a>
  4961. </em>
  4962. </td>
  4963. <td>
  4964. </td>
  4965. </tr>
  4966. <tr>
  4967. <td>
  4968. <code>status</code></br>
  4969. <em>
  4970. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  4971. Kubernetes core/v1.ConditionStatus
  4972. </a>
  4973. </em>
  4974. </td>
  4975. <td>
  4976. </td>
  4977. </tr>
  4978. <tr>
  4979. <td>
  4980. <code>reason</code></br>
  4981. <em>
  4982. string
  4983. </em>
  4984. </td>
  4985. <td>
  4986. <em>(Optional)</em>
  4987. </td>
  4988. </tr>
  4989. <tr>
  4990. <td>
  4991. <code>message</code></br>
  4992. <em>
  4993. string
  4994. </em>
  4995. </td>
  4996. <td>
  4997. <em>(Optional)</em>
  4998. </td>
  4999. </tr>
  5000. <tr>
  5001. <td>
  5002. <code>lastTransitionTime</code></br>
  5003. <em>
  5004. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  5005. Kubernetes meta/v1.Time
  5006. </a>
  5007. </em>
  5008. </td>
  5009. <td>
  5010. <em>(Optional)</em>
  5011. </td>
  5012. </tr>
  5013. </tbody>
  5014. </table>
  5015. <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
  5016. </h3>
  5017. <p>
  5018. (<em>Appears on:</em>
  5019. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  5020. </p>
  5021. <p>
  5022. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  5023. There can be only one target per ExternalSecret.</p>
  5024. </p>
  5025. <table>
  5026. <thead>
  5027. <tr>
  5028. <th>Field</th>
  5029. <th>Description</th>
  5030. </tr>
  5031. </thead>
  5032. <tbody>
  5033. <tr>
  5034. <td>
  5035. <code>name</code></br>
  5036. <em>
  5037. string
  5038. </em>
  5039. </td>
  5040. <td>
  5041. <em>(Optional)</em>
  5042. <p>The name of the Secret resource to be managed.
  5043. Defaults to the .metadata.name of the ExternalSecret resource</p>
  5044. </td>
  5045. </tr>
  5046. <tr>
  5047. <td>
  5048. <code>creationPolicy</code></br>
  5049. <em>
  5050. <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
  5051. ExternalSecretCreationPolicy
  5052. </a>
  5053. </em>
  5054. </td>
  5055. <td>
  5056. <em>(Optional)</em>
  5057. <p>CreationPolicy defines rules on how to create the resulting Secret.
  5058. Defaults to &ldquo;Owner&rdquo;</p>
  5059. </td>
  5060. </tr>
  5061. <tr>
  5062. <td>
  5063. <code>deletionPolicy</code></br>
  5064. <em>
  5065. <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
  5066. ExternalSecretDeletionPolicy
  5067. </a>
  5068. </em>
  5069. </td>
  5070. <td>
  5071. <em>(Optional)</em>
  5072. <p>DeletionPolicy defines rules on how to delete the resulting Secret.
  5073. Defaults to &ldquo;Retain&rdquo;</p>
  5074. </td>
  5075. </tr>
  5076. <tr>
  5077. <td>
  5078. <code>template</code></br>
  5079. <em>
  5080. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
  5081. ExternalSecretTemplate
  5082. </a>
  5083. </em>
  5084. </td>
  5085. <td>
  5086. <em>(Optional)</em>
  5087. <p>Template defines a blueprint for the created Secret resource.</p>
  5088. </td>
  5089. </tr>
  5090. <tr>
  5091. <td>
  5092. <code>immutable</code></br>
  5093. <em>
  5094. bool
  5095. </em>
  5096. </td>
  5097. <td>
  5098. <em>(Optional)</em>
  5099. <p>Immutable defines if the final secret will be immutable</p>
  5100. </td>
  5101. </tr>
  5102. </tbody>
  5103. </table>
  5104. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
  5105. </h3>
  5106. <p>
  5107. (<em>Appears on:</em>
  5108. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  5109. </p>
  5110. <p>
  5111. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  5112. we can not use native corev1.Secret, it will have empty ObjectMeta values: <a href="https://github.com/kubernetes-sigs/controller-tools/issues/448">https://github.com/kubernetes-sigs/controller-tools/issues/448</a></p>
  5113. </p>
  5114. <table>
  5115. <thead>
  5116. <tr>
  5117. <th>Field</th>
  5118. <th>Description</th>
  5119. </tr>
  5120. </thead>
  5121. <tbody>
  5122. <tr>
  5123. <td>
  5124. <code>type</code></br>
  5125. <em>
  5126. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secrettype-v1-core">
  5127. Kubernetes core/v1.SecretType
  5128. </a>
  5129. </em>
  5130. </td>
  5131. <td>
  5132. <em>(Optional)</em>
  5133. </td>
  5134. </tr>
  5135. <tr>
  5136. <td>
  5137. <code>engineVersion</code></br>
  5138. <em>
  5139. <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
  5140. TemplateEngineVersion
  5141. </a>
  5142. </em>
  5143. </td>
  5144. <td>
  5145. <p>EngineVersion specifies the template engine version
  5146. that should be used to compile/execute the
  5147. template specified in .data and .templateFrom[].</p>
  5148. </td>
  5149. </tr>
  5150. <tr>
  5151. <td>
  5152. <code>metadata</code></br>
  5153. <em>
  5154. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
  5155. ExternalSecretTemplateMetadata
  5156. </a>
  5157. </em>
  5158. </td>
  5159. <td>
  5160. <em>(Optional)</em>
  5161. </td>
  5162. </tr>
  5163. <tr>
  5164. <td>
  5165. <code>mergePolicy</code></br>
  5166. <em>
  5167. <a href="#external-secrets.io/v1beta1.TemplateMergePolicy">
  5168. TemplateMergePolicy
  5169. </a>
  5170. </em>
  5171. </td>
  5172. <td>
  5173. </td>
  5174. </tr>
  5175. <tr>
  5176. <td>
  5177. <code>data</code></br>
  5178. <em>
  5179. map[string]string
  5180. </em>
  5181. </td>
  5182. <td>
  5183. <em>(Optional)</em>
  5184. </td>
  5185. </tr>
  5186. <tr>
  5187. <td>
  5188. <code>templateFrom</code></br>
  5189. <em>
  5190. <a href="#external-secrets.io/v1beta1.TemplateFrom">
  5191. []TemplateFrom
  5192. </a>
  5193. </em>
  5194. </td>
  5195. <td>
  5196. <em>(Optional)</em>
  5197. </td>
  5198. </tr>
  5199. </tbody>
  5200. </table>
  5201. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  5202. </h3>
  5203. <p>
  5204. (<em>Appears on:</em>
  5205. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  5206. </p>
  5207. <p>
  5208. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  5209. </p>
  5210. <table>
  5211. <thead>
  5212. <tr>
  5213. <th>Field</th>
  5214. <th>Description</th>
  5215. </tr>
  5216. </thead>
  5217. <tbody>
  5218. <tr>
  5219. <td>
  5220. <code>annotations</code></br>
  5221. <em>
  5222. map[string]string
  5223. </em>
  5224. </td>
  5225. <td>
  5226. <em>(Optional)</em>
  5227. </td>
  5228. </tr>
  5229. <tr>
  5230. <td>
  5231. <code>labels</code></br>
  5232. <em>
  5233. map[string]string
  5234. </em>
  5235. </td>
  5236. <td>
  5237. <em>(Optional)</em>
  5238. </td>
  5239. </tr>
  5240. </tbody>
  5241. </table>
  5242. <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
  5243. </h3>
  5244. <p>
  5245. </p>
  5246. <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
  5247. </h3>
  5248. <p>
  5249. (<em>Appears on:</em>
  5250. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5251. </p>
  5252. <p>
  5253. <p>FakeProvider configures a fake provider that returns static values.</p>
  5254. </p>
  5255. <table>
  5256. <thead>
  5257. <tr>
  5258. <th>Field</th>
  5259. <th>Description</th>
  5260. </tr>
  5261. </thead>
  5262. <tbody>
  5263. <tr>
  5264. <td>
  5265. <code>data</code></br>
  5266. <em>
  5267. <a href="#external-secrets.io/v1beta1.FakeProviderData">
  5268. []FakeProviderData
  5269. </a>
  5270. </em>
  5271. </td>
  5272. <td>
  5273. </td>
  5274. </tr>
  5275. </tbody>
  5276. </table>
  5277. <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
  5278. </h3>
  5279. <p>
  5280. (<em>Appears on:</em>
  5281. <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
  5282. </p>
  5283. <p>
  5284. </p>
  5285. <table>
  5286. <thead>
  5287. <tr>
  5288. <th>Field</th>
  5289. <th>Description</th>
  5290. </tr>
  5291. </thead>
  5292. <tbody>
  5293. <tr>
  5294. <td>
  5295. <code>key</code></br>
  5296. <em>
  5297. string
  5298. </em>
  5299. </td>
  5300. <td>
  5301. </td>
  5302. </tr>
  5303. <tr>
  5304. <td>
  5305. <code>value</code></br>
  5306. <em>
  5307. string
  5308. </em>
  5309. </td>
  5310. <td>
  5311. </td>
  5312. </tr>
  5313. <tr>
  5314. <td>
  5315. <code>valueMap</code></br>
  5316. <em>
  5317. map[string]string
  5318. </em>
  5319. </td>
  5320. <td>
  5321. <p>Deprecated: ValueMap is deprecated and is intended to be removed in the future, use the <code>value</code> field instead.</p>
  5322. </td>
  5323. </tr>
  5324. <tr>
  5325. <td>
  5326. <code>version</code></br>
  5327. <em>
  5328. string
  5329. </em>
  5330. </td>
  5331. <td>
  5332. </td>
  5333. </tr>
  5334. </tbody>
  5335. </table>
  5336. <h3 id="external-secrets.io/v1beta1.FindName">FindName
  5337. </h3>
  5338. <p>
  5339. (<em>Appears on:</em>
  5340. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  5341. </p>
  5342. <p>
  5343. </p>
  5344. <table>
  5345. <thead>
  5346. <tr>
  5347. <th>Field</th>
  5348. <th>Description</th>
  5349. </tr>
  5350. </thead>
  5351. <tbody>
  5352. <tr>
  5353. <td>
  5354. <code>regexp</code></br>
  5355. <em>
  5356. string
  5357. </em>
  5358. </td>
  5359. <td>
  5360. <em>(Optional)</em>
  5361. <p>Finds secrets base</p>
  5362. </td>
  5363. </tr>
  5364. </tbody>
  5365. </table>
  5366. <h3 id="external-secrets.io/v1beta1.FortanixProvider">FortanixProvider
  5367. </h3>
  5368. <p>
  5369. (<em>Appears on:</em>
  5370. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5371. </p>
  5372. <p>
  5373. </p>
  5374. <table>
  5375. <thead>
  5376. <tr>
  5377. <th>Field</th>
  5378. <th>Description</th>
  5379. </tr>
  5380. </thead>
  5381. <tbody>
  5382. <tr>
  5383. <td>
  5384. <code>apiUrl</code></br>
  5385. <em>
  5386. string
  5387. </em>
  5388. </td>
  5389. <td>
  5390. <p>APIURL is the URL of SDKMS API. Defaults to <code>sdkms.fortanix.com</code>.</p>
  5391. </td>
  5392. </tr>
  5393. <tr>
  5394. <td>
  5395. <code>apiKey</code></br>
  5396. <em>
  5397. <a href="#external-secrets.io/v1beta1.FortanixProviderSecretRef">
  5398. FortanixProviderSecretRef
  5399. </a>
  5400. </em>
  5401. </td>
  5402. <td>
  5403. <p>APIKey is the API token to access SDKMS Applications.</p>
  5404. </td>
  5405. </tr>
  5406. </tbody>
  5407. </table>
  5408. <h3 id="external-secrets.io/v1beta1.FortanixProviderSecretRef">FortanixProviderSecretRef
  5409. </h3>
  5410. <p>
  5411. (<em>Appears on:</em>
  5412. <a href="#external-secrets.io/v1beta1.FortanixProvider">FortanixProvider</a>)
  5413. </p>
  5414. <p>
  5415. </p>
  5416. <table>
  5417. <thead>
  5418. <tr>
  5419. <th>Field</th>
  5420. <th>Description</th>
  5421. </tr>
  5422. </thead>
  5423. <tbody>
  5424. <tr>
  5425. <td>
  5426. <code>secretRef</code></br>
  5427. <em>
  5428. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5429. External Secrets meta/v1.SecretKeySelector
  5430. </a>
  5431. </em>
  5432. </td>
  5433. <td>
  5434. <p>SecretRef is a reference to a secret containing the SDKMS API Key.</p>
  5435. </td>
  5436. </tr>
  5437. </tbody>
  5438. </table>
  5439. <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
  5440. </h3>
  5441. <p>
  5442. (<em>Appears on:</em>
  5443. <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
  5444. </p>
  5445. <p>
  5446. </p>
  5447. <table>
  5448. <thead>
  5449. <tr>
  5450. <th>Field</th>
  5451. <th>Description</th>
  5452. </tr>
  5453. </thead>
  5454. <tbody>
  5455. <tr>
  5456. <td>
  5457. <code>secretRef</code></br>
  5458. <em>
  5459. <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
  5460. GCPSMAuthSecretRef
  5461. </a>
  5462. </em>
  5463. </td>
  5464. <td>
  5465. <em>(Optional)</em>
  5466. </td>
  5467. </tr>
  5468. <tr>
  5469. <td>
  5470. <code>workloadIdentity</code></br>
  5471. <em>
  5472. <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
  5473. GCPWorkloadIdentity
  5474. </a>
  5475. </em>
  5476. </td>
  5477. <td>
  5478. <em>(Optional)</em>
  5479. </td>
  5480. </tr>
  5481. </tbody>
  5482. </table>
  5483. <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  5484. </h3>
  5485. <p>
  5486. (<em>Appears on:</em>
  5487. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  5488. </p>
  5489. <p>
  5490. </p>
  5491. <table>
  5492. <thead>
  5493. <tr>
  5494. <th>Field</th>
  5495. <th>Description</th>
  5496. </tr>
  5497. </thead>
  5498. <tbody>
  5499. <tr>
  5500. <td>
  5501. <code>secretAccessKeySecretRef</code></br>
  5502. <em>
  5503. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5504. External Secrets meta/v1.SecretKeySelector
  5505. </a>
  5506. </em>
  5507. </td>
  5508. <td>
  5509. <em>(Optional)</em>
  5510. <p>The SecretAccessKey is used for authentication</p>
  5511. </td>
  5512. </tr>
  5513. </tbody>
  5514. </table>
  5515. <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
  5516. </h3>
  5517. <p>
  5518. (<em>Appears on:</em>
  5519. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5520. </p>
  5521. <p>
  5522. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  5523. </p>
  5524. <table>
  5525. <thead>
  5526. <tr>
  5527. <th>Field</th>
  5528. <th>Description</th>
  5529. </tr>
  5530. </thead>
  5531. <tbody>
  5532. <tr>
  5533. <td>
  5534. <code>auth</code></br>
  5535. <em>
  5536. <a href="#external-secrets.io/v1beta1.GCPSMAuth">
  5537. GCPSMAuth
  5538. </a>
  5539. </em>
  5540. </td>
  5541. <td>
  5542. <em>(Optional)</em>
  5543. <p>Auth defines the information necessary to authenticate against GCP</p>
  5544. </td>
  5545. </tr>
  5546. <tr>
  5547. <td>
  5548. <code>projectID</code></br>
  5549. <em>
  5550. string
  5551. </em>
  5552. </td>
  5553. <td>
  5554. <p>ProjectID project where secret is located</p>
  5555. </td>
  5556. </tr>
  5557. <tr>
  5558. <td>
  5559. <code>location</code></br>
  5560. <em>
  5561. string
  5562. </em>
  5563. </td>
  5564. <td>
  5565. <p>Location optionally defines a location for a secret</p>
  5566. </td>
  5567. </tr>
  5568. </tbody>
  5569. </table>
  5570. <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
  5571. </h3>
  5572. <p>
  5573. (<em>Appears on:</em>
  5574. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  5575. </p>
  5576. <p>
  5577. </p>
  5578. <table>
  5579. <thead>
  5580. <tr>
  5581. <th>Field</th>
  5582. <th>Description</th>
  5583. </tr>
  5584. </thead>
  5585. <tbody>
  5586. <tr>
  5587. <td>
  5588. <code>serviceAccountRef</code></br>
  5589. <em>
  5590. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  5591. External Secrets meta/v1.ServiceAccountSelector
  5592. </a>
  5593. </em>
  5594. </td>
  5595. <td>
  5596. </td>
  5597. </tr>
  5598. <tr>
  5599. <td>
  5600. <code>clusterLocation</code></br>
  5601. <em>
  5602. string
  5603. </em>
  5604. </td>
  5605. <td>
  5606. </td>
  5607. </tr>
  5608. <tr>
  5609. <td>
  5610. <code>clusterName</code></br>
  5611. <em>
  5612. string
  5613. </em>
  5614. </td>
  5615. <td>
  5616. </td>
  5617. </tr>
  5618. <tr>
  5619. <td>
  5620. <code>clusterProjectID</code></br>
  5621. <em>
  5622. string
  5623. </em>
  5624. </td>
  5625. <td>
  5626. </td>
  5627. </tr>
  5628. </tbody>
  5629. </table>
  5630. <h3 id="external-secrets.io/v1beta1.GeneratorRef">GeneratorRef
  5631. </h3>
  5632. <p>
  5633. (<em>Appears on:</em>
  5634. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
  5635. <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
  5636. </p>
  5637. <p>
  5638. <p>GeneratorRef points to a generator custom resource.</p>
  5639. </p>
  5640. <table>
  5641. <thead>
  5642. <tr>
  5643. <th>Field</th>
  5644. <th>Description</th>
  5645. </tr>
  5646. </thead>
  5647. <tbody>
  5648. <tr>
  5649. <td>
  5650. <code>apiVersion</code></br>
  5651. <em>
  5652. string
  5653. </em>
  5654. </td>
  5655. <td>
  5656. <p>Specify the apiVersion of the generator resource</p>
  5657. </td>
  5658. </tr>
  5659. <tr>
  5660. <td>
  5661. <code>kind</code></br>
  5662. <em>
  5663. string
  5664. </em>
  5665. </td>
  5666. <td>
  5667. <p>Specify the Kind of the generator resource</p>
  5668. </td>
  5669. </tr>
  5670. <tr>
  5671. <td>
  5672. <code>name</code></br>
  5673. <em>
  5674. string
  5675. </em>
  5676. </td>
  5677. <td>
  5678. <p>Specify the name of the generator resource</p>
  5679. </td>
  5680. </tr>
  5681. </tbody>
  5682. </table>
  5683. <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
  5684. </h3>
  5685. <p>
  5686. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  5687. or a namespaced SecretStore.</p>
  5688. </p>
  5689. <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
  5690. </h3>
  5691. <p>
  5692. </p>
  5693. <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
  5694. </h3>
  5695. <p>
  5696. (<em>Appears on:</em>
  5697. <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
  5698. </p>
  5699. <p>
  5700. </p>
  5701. <table>
  5702. <thead>
  5703. <tr>
  5704. <th>Field</th>
  5705. <th>Description</th>
  5706. </tr>
  5707. </thead>
  5708. <tbody>
  5709. <tr>
  5710. <td>
  5711. <code>SecretRef</code></br>
  5712. <em>
  5713. <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
  5714. GitlabSecretRef
  5715. </a>
  5716. </em>
  5717. </td>
  5718. <td>
  5719. </td>
  5720. </tr>
  5721. </tbody>
  5722. </table>
  5723. <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
  5724. </h3>
  5725. <p>
  5726. (<em>Appears on:</em>
  5727. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5728. </p>
  5729. <p>
  5730. <p>Configures a store to sync secrets with a GitLab instance.</p>
  5731. </p>
  5732. <table>
  5733. <thead>
  5734. <tr>
  5735. <th>Field</th>
  5736. <th>Description</th>
  5737. </tr>
  5738. </thead>
  5739. <tbody>
  5740. <tr>
  5741. <td>
  5742. <code>url</code></br>
  5743. <em>
  5744. string
  5745. </em>
  5746. </td>
  5747. <td>
  5748. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  5749. </td>
  5750. </tr>
  5751. <tr>
  5752. <td>
  5753. <code>auth</code></br>
  5754. <em>
  5755. <a href="#external-secrets.io/v1beta1.GitlabAuth">
  5756. GitlabAuth
  5757. </a>
  5758. </em>
  5759. </td>
  5760. <td>
  5761. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  5762. </td>
  5763. </tr>
  5764. <tr>
  5765. <td>
  5766. <code>projectID</code></br>
  5767. <em>
  5768. string
  5769. </em>
  5770. </td>
  5771. <td>
  5772. <p>ProjectID specifies a project where secrets are located.</p>
  5773. </td>
  5774. </tr>
  5775. <tr>
  5776. <td>
  5777. <code>inheritFromGroups</code></br>
  5778. <em>
  5779. bool
  5780. </em>
  5781. </td>
  5782. <td>
  5783. <p>InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.</p>
  5784. </td>
  5785. </tr>
  5786. <tr>
  5787. <td>
  5788. <code>groupIDs</code></br>
  5789. <em>
  5790. []string
  5791. </em>
  5792. </td>
  5793. <td>
  5794. <p>GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.</p>
  5795. </td>
  5796. </tr>
  5797. <tr>
  5798. <td>
  5799. <code>environment</code></br>
  5800. <em>
  5801. string
  5802. </em>
  5803. </td>
  5804. <td>
  5805. <p>Environment environment_scope of gitlab CI/CD variables (Please see <a href="https://docs.gitlab.com/ee/ci/environments/#create-a-static-environment">https://docs.gitlab.com/ee/ci/environments/#create-a-static-environment</a> on how to create environments)</p>
  5806. </td>
  5807. </tr>
  5808. </tbody>
  5809. </table>
  5810. <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
  5811. </h3>
  5812. <p>
  5813. (<em>Appears on:</em>
  5814. <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
  5815. </p>
  5816. <p>
  5817. </p>
  5818. <table>
  5819. <thead>
  5820. <tr>
  5821. <th>Field</th>
  5822. <th>Description</th>
  5823. </tr>
  5824. </thead>
  5825. <tbody>
  5826. <tr>
  5827. <td>
  5828. <code>accessToken</code></br>
  5829. <em>
  5830. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5831. External Secrets meta/v1.SecretKeySelector
  5832. </a>
  5833. </em>
  5834. </td>
  5835. <td>
  5836. <p>AccessToken is used for authentication.</p>
  5837. </td>
  5838. </tr>
  5839. </tbody>
  5840. </table>
  5841. <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
  5842. </h3>
  5843. <p>
  5844. (<em>Appears on:</em>
  5845. <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
  5846. </p>
  5847. <p>
  5848. </p>
  5849. <table>
  5850. <thead>
  5851. <tr>
  5852. <th>Field</th>
  5853. <th>Description</th>
  5854. </tr>
  5855. </thead>
  5856. <tbody>
  5857. <tr>
  5858. <td>
  5859. <code>secretRef</code></br>
  5860. <em>
  5861. <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
  5862. IBMAuthSecretRef
  5863. </a>
  5864. </em>
  5865. </td>
  5866. <td>
  5867. </td>
  5868. </tr>
  5869. <tr>
  5870. <td>
  5871. <code>containerAuth</code></br>
  5872. <em>
  5873. <a href="#external-secrets.io/v1beta1.IBMAuthContainerAuth">
  5874. IBMAuthContainerAuth
  5875. </a>
  5876. </em>
  5877. </td>
  5878. <td>
  5879. </td>
  5880. </tr>
  5881. </tbody>
  5882. </table>
  5883. <h3 id="external-secrets.io/v1beta1.IBMAuthContainerAuth">IBMAuthContainerAuth
  5884. </h3>
  5885. <p>
  5886. (<em>Appears on:</em>
  5887. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  5888. </p>
  5889. <p>
  5890. <p>IBM Container-based auth with IAM Trusted Profile.</p>
  5891. </p>
  5892. <table>
  5893. <thead>
  5894. <tr>
  5895. <th>Field</th>
  5896. <th>Description</th>
  5897. </tr>
  5898. </thead>
  5899. <tbody>
  5900. <tr>
  5901. <td>
  5902. <code>profile</code></br>
  5903. <em>
  5904. string
  5905. </em>
  5906. </td>
  5907. <td>
  5908. <p>the IBM Trusted Profile</p>
  5909. </td>
  5910. </tr>
  5911. <tr>
  5912. <td>
  5913. <code>tokenLocation</code></br>
  5914. <em>
  5915. string
  5916. </em>
  5917. </td>
  5918. <td>
  5919. <p>Location the token is mounted on the pod</p>
  5920. </td>
  5921. </tr>
  5922. <tr>
  5923. <td>
  5924. <code>iamEndpoint</code></br>
  5925. <em>
  5926. string
  5927. </em>
  5928. </td>
  5929. <td>
  5930. </td>
  5931. </tr>
  5932. </tbody>
  5933. </table>
  5934. <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
  5935. </h3>
  5936. <p>
  5937. (<em>Appears on:</em>
  5938. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  5939. </p>
  5940. <p>
  5941. </p>
  5942. <table>
  5943. <thead>
  5944. <tr>
  5945. <th>Field</th>
  5946. <th>Description</th>
  5947. </tr>
  5948. </thead>
  5949. <tbody>
  5950. <tr>
  5951. <td>
  5952. <code>secretApiKeySecretRef</code></br>
  5953. <em>
  5954. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5955. External Secrets meta/v1.SecretKeySelector
  5956. </a>
  5957. </em>
  5958. </td>
  5959. <td>
  5960. <p>The SecretAccessKey is used for authentication</p>
  5961. </td>
  5962. </tr>
  5963. </tbody>
  5964. </table>
  5965. <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
  5966. </h3>
  5967. <p>
  5968. (<em>Appears on:</em>
  5969. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5970. </p>
  5971. <p>
  5972. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  5973. backend.</p>
  5974. </p>
  5975. <table>
  5976. <thead>
  5977. <tr>
  5978. <th>Field</th>
  5979. <th>Description</th>
  5980. </tr>
  5981. </thead>
  5982. <tbody>
  5983. <tr>
  5984. <td>
  5985. <code>auth</code></br>
  5986. <em>
  5987. <a href="#external-secrets.io/v1beta1.IBMAuth">
  5988. IBMAuth
  5989. </a>
  5990. </em>
  5991. </td>
  5992. <td>
  5993. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  5994. </td>
  5995. </tr>
  5996. <tr>
  5997. <td>
  5998. <code>serviceUrl</code></br>
  5999. <em>
  6000. string
  6001. </em>
  6002. </td>
  6003. <td>
  6004. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  6005. </td>
  6006. </tr>
  6007. </tbody>
  6008. </table>
  6009. <h3 id="external-secrets.io/v1beta1.InfisicalAuth">InfisicalAuth
  6010. </h3>
  6011. <p>
  6012. (<em>Appears on:</em>
  6013. <a href="#external-secrets.io/v1beta1.InfisicalProvider">InfisicalProvider</a>)
  6014. </p>
  6015. <p>
  6016. </p>
  6017. <table>
  6018. <thead>
  6019. <tr>
  6020. <th>Field</th>
  6021. <th>Description</th>
  6022. </tr>
  6023. </thead>
  6024. <tbody>
  6025. <tr>
  6026. <td>
  6027. <code>universalAuthCredentials</code></br>
  6028. <em>
  6029. <a href="#external-secrets.io/v1beta1.UniversalAuthCredentials">
  6030. UniversalAuthCredentials
  6031. </a>
  6032. </em>
  6033. </td>
  6034. <td>
  6035. <em>(Optional)</em>
  6036. </td>
  6037. </tr>
  6038. </tbody>
  6039. </table>
  6040. <h3 id="external-secrets.io/v1beta1.InfisicalProvider">InfisicalProvider
  6041. </h3>
  6042. <p>
  6043. (<em>Appears on:</em>
  6044. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6045. </p>
  6046. <p>
  6047. <p>InfisicalProvider configures a store to sync secrets using the Infisical provider.</p>
  6048. </p>
  6049. <table>
  6050. <thead>
  6051. <tr>
  6052. <th>Field</th>
  6053. <th>Description</th>
  6054. </tr>
  6055. </thead>
  6056. <tbody>
  6057. <tr>
  6058. <td>
  6059. <code>auth</code></br>
  6060. <em>
  6061. <a href="#external-secrets.io/v1beta1.InfisicalAuth">
  6062. InfisicalAuth
  6063. </a>
  6064. </em>
  6065. </td>
  6066. <td>
  6067. <p>Auth configures how the Operator authenticates with the Infisical API</p>
  6068. </td>
  6069. </tr>
  6070. <tr>
  6071. <td>
  6072. <code>secretsScope</code></br>
  6073. <em>
  6074. <a href="#external-secrets.io/v1beta1.MachineIdentityScopeInWorkspace">
  6075. MachineIdentityScopeInWorkspace
  6076. </a>
  6077. </em>
  6078. </td>
  6079. <td>
  6080. </td>
  6081. </tr>
  6082. <tr>
  6083. <td>
  6084. <code>hostAPI</code></br>
  6085. <em>
  6086. string
  6087. </em>
  6088. </td>
  6089. <td>
  6090. <em>(Optional)</em>
  6091. </td>
  6092. </tr>
  6093. </tbody>
  6094. </table>
  6095. <h3 id="external-secrets.io/v1beta1.KeeperSecurityProvider">KeeperSecurityProvider
  6096. </h3>
  6097. <p>
  6098. (<em>Appears on:</em>
  6099. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6100. </p>
  6101. <p>
  6102. <p>KeeperSecurityProvider Configures a store to sync secrets using Keeper Security.</p>
  6103. </p>
  6104. <table>
  6105. <thead>
  6106. <tr>
  6107. <th>Field</th>
  6108. <th>Description</th>
  6109. </tr>
  6110. </thead>
  6111. <tbody>
  6112. <tr>
  6113. <td>
  6114. <code>authRef</code></br>
  6115. <em>
  6116. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6117. External Secrets meta/v1.SecretKeySelector
  6118. </a>
  6119. </em>
  6120. </td>
  6121. <td>
  6122. </td>
  6123. </tr>
  6124. <tr>
  6125. <td>
  6126. <code>folderID</code></br>
  6127. <em>
  6128. string
  6129. </em>
  6130. </td>
  6131. <td>
  6132. </td>
  6133. </tr>
  6134. </tbody>
  6135. </table>
  6136. <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
  6137. </h3>
  6138. <p>
  6139. (<em>Appears on:</em>
  6140. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  6141. </p>
  6142. <p>
  6143. </p>
  6144. <table>
  6145. <thead>
  6146. <tr>
  6147. <th>Field</th>
  6148. <th>Description</th>
  6149. </tr>
  6150. </thead>
  6151. <tbody>
  6152. <tr>
  6153. <td>
  6154. <code>cert</code></br>
  6155. <em>
  6156. <a href="#external-secrets.io/v1beta1.CertAuth">
  6157. CertAuth
  6158. </a>
  6159. </em>
  6160. </td>
  6161. <td>
  6162. <em>(Optional)</em>
  6163. <p>has both clientCert and clientKey as secretKeySelector</p>
  6164. </td>
  6165. </tr>
  6166. <tr>
  6167. <td>
  6168. <code>token</code></br>
  6169. <em>
  6170. <a href="#external-secrets.io/v1beta1.TokenAuth">
  6171. TokenAuth
  6172. </a>
  6173. </em>
  6174. </td>
  6175. <td>
  6176. <em>(Optional)</em>
  6177. <p>use static token to authenticate with</p>
  6178. </td>
  6179. </tr>
  6180. <tr>
  6181. <td>
  6182. <code>serviceAccount</code></br>
  6183. <em>
  6184. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  6185. External Secrets meta/v1.ServiceAccountSelector
  6186. </a>
  6187. </em>
  6188. </td>
  6189. <td>
  6190. <em>(Optional)</em>
  6191. <p>points to a service account that should be used for authentication</p>
  6192. </td>
  6193. </tr>
  6194. </tbody>
  6195. </table>
  6196. <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
  6197. </h3>
  6198. <p>
  6199. (<em>Appears on:</em>
  6200. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6201. </p>
  6202. <p>
  6203. <p>Configures a store to sync secrets with a Kubernetes instance.</p>
  6204. </p>
  6205. <table>
  6206. <thead>
  6207. <tr>
  6208. <th>Field</th>
  6209. <th>Description</th>
  6210. </tr>
  6211. </thead>
  6212. <tbody>
  6213. <tr>
  6214. <td>
  6215. <code>server</code></br>
  6216. <em>
  6217. <a href="#external-secrets.io/v1beta1.KubernetesServer">
  6218. KubernetesServer
  6219. </a>
  6220. </em>
  6221. </td>
  6222. <td>
  6223. <em>(Optional)</em>
  6224. <p>configures the Kubernetes server Address.</p>
  6225. </td>
  6226. </tr>
  6227. <tr>
  6228. <td>
  6229. <code>auth</code></br>
  6230. <em>
  6231. <a href="#external-secrets.io/v1beta1.KubernetesAuth">
  6232. KubernetesAuth
  6233. </a>
  6234. </em>
  6235. </td>
  6236. <td>
  6237. <em>(Optional)</em>
  6238. <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
  6239. </td>
  6240. </tr>
  6241. <tr>
  6242. <td>
  6243. <code>authRef</code></br>
  6244. <em>
  6245. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6246. External Secrets meta/v1.SecretKeySelector
  6247. </a>
  6248. </em>
  6249. </td>
  6250. <td>
  6251. <em>(Optional)</em>
  6252. <p>A reference to a secret that contains the auth information.</p>
  6253. </td>
  6254. </tr>
  6255. <tr>
  6256. <td>
  6257. <code>remoteNamespace</code></br>
  6258. <em>
  6259. string
  6260. </em>
  6261. </td>
  6262. <td>
  6263. <em>(Optional)</em>
  6264. <p>Remote namespace to fetch the secrets from</p>
  6265. </td>
  6266. </tr>
  6267. </tbody>
  6268. </table>
  6269. <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
  6270. </h3>
  6271. <p>
  6272. (<em>Appears on:</em>
  6273. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  6274. </p>
  6275. <p>
  6276. </p>
  6277. <table>
  6278. <thead>
  6279. <tr>
  6280. <th>Field</th>
  6281. <th>Description</th>
  6282. </tr>
  6283. </thead>
  6284. <tbody>
  6285. <tr>
  6286. <td>
  6287. <code>url</code></br>
  6288. <em>
  6289. string
  6290. </em>
  6291. </td>
  6292. <td>
  6293. <em>(Optional)</em>
  6294. <p>configures the Kubernetes server Address.</p>
  6295. </td>
  6296. </tr>
  6297. <tr>
  6298. <td>
  6299. <code>caBundle</code></br>
  6300. <em>
  6301. []byte
  6302. </em>
  6303. </td>
  6304. <td>
  6305. <em>(Optional)</em>
  6306. <p>CABundle is a base64-encoded CA certificate</p>
  6307. </td>
  6308. </tr>
  6309. <tr>
  6310. <td>
  6311. <code>caProvider</code></br>
  6312. <em>
  6313. <a href="#external-secrets.io/v1beta1.CAProvider">
  6314. CAProvider
  6315. </a>
  6316. </em>
  6317. </td>
  6318. <td>
  6319. <em>(Optional)</em>
  6320. <p>see: <a href="https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider">https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider</a></p>
  6321. </td>
  6322. </tr>
  6323. </tbody>
  6324. </table>
  6325. <h3 id="external-secrets.io/v1beta1.MachineIdentityScopeInWorkspace">MachineIdentityScopeInWorkspace
  6326. </h3>
  6327. <p>
  6328. (<em>Appears on:</em>
  6329. <a href="#external-secrets.io/v1beta1.InfisicalProvider">InfisicalProvider</a>)
  6330. </p>
  6331. <p>
  6332. </p>
  6333. <table>
  6334. <thead>
  6335. <tr>
  6336. <th>Field</th>
  6337. <th>Description</th>
  6338. </tr>
  6339. </thead>
  6340. <tbody>
  6341. <tr>
  6342. <td>
  6343. <code>secretsPath</code></br>
  6344. <em>
  6345. string
  6346. </em>
  6347. </td>
  6348. <td>
  6349. <em>(Optional)</em>
  6350. </td>
  6351. </tr>
  6352. <tr>
  6353. <td>
  6354. <code>recursive</code></br>
  6355. <em>
  6356. bool
  6357. </em>
  6358. </td>
  6359. <td>
  6360. <em>(Optional)</em>
  6361. </td>
  6362. </tr>
  6363. <tr>
  6364. <td>
  6365. <code>environmentSlug</code></br>
  6366. <em>
  6367. string
  6368. </em>
  6369. </td>
  6370. <td>
  6371. </td>
  6372. </tr>
  6373. <tr>
  6374. <td>
  6375. <code>projectSlug</code></br>
  6376. <em>
  6377. string
  6378. </em>
  6379. </td>
  6380. <td>
  6381. </td>
  6382. </tr>
  6383. </tbody>
  6384. </table>
  6385. <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
  6386. </h3>
  6387. <p>
  6388. <p>NoSecretError shall be returned when a GetSecret can not find the
  6389. desired secret. This is used for deletionPolicy.</p>
  6390. </p>
  6391. <h3 id="external-secrets.io/v1beta1.NotModifiedError">NotModifiedError
  6392. </h3>
  6393. <p>
  6394. <p>NotModifiedError to signal that the webhook received no changes,
  6395. and it should just return without doing anything.</p>
  6396. </p>
  6397. <h3 id="external-secrets.io/v1beta1.OnboardbaseAuthSecretRef">OnboardbaseAuthSecretRef
  6398. </h3>
  6399. <p>
  6400. (<em>Appears on:</em>
  6401. <a href="#external-secrets.io/v1beta1.OnboardbaseProvider">OnboardbaseProvider</a>)
  6402. </p>
  6403. <p>
  6404. <p>OnboardbaseAuthSecretRef holds secret references for onboardbase API Key credentials.</p>
  6405. </p>
  6406. <table>
  6407. <thead>
  6408. <tr>
  6409. <th>Field</th>
  6410. <th>Description</th>
  6411. </tr>
  6412. </thead>
  6413. <tbody>
  6414. <tr>
  6415. <td>
  6416. <code>apiKeyRef</code></br>
  6417. <em>
  6418. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6419. External Secrets meta/v1.SecretKeySelector
  6420. </a>
  6421. </em>
  6422. </td>
  6423. <td>
  6424. <p>OnboardbaseAPIKey is the APIKey generated by an admin account.
  6425. It is used to recognize and authorize access to a project and environment within onboardbase</p>
  6426. </td>
  6427. </tr>
  6428. <tr>
  6429. <td>
  6430. <code>passcodeRef</code></br>
  6431. <em>
  6432. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6433. External Secrets meta/v1.SecretKeySelector
  6434. </a>
  6435. </em>
  6436. </td>
  6437. <td>
  6438. <p>OnboardbasePasscode is the passcode attached to the API Key</p>
  6439. </td>
  6440. </tr>
  6441. </tbody>
  6442. </table>
  6443. <h3 id="external-secrets.io/v1beta1.OnboardbaseProvider">OnboardbaseProvider
  6444. </h3>
  6445. <p>
  6446. (<em>Appears on:</em>
  6447. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6448. </p>
  6449. <p>
  6450. <p>OnboardbaseProvider configures a store to sync secrets using the Onboardbase provider.
  6451. Project and Config are required if not using a Service Token.</p>
  6452. </p>
  6453. <table>
  6454. <thead>
  6455. <tr>
  6456. <th>Field</th>
  6457. <th>Description</th>
  6458. </tr>
  6459. </thead>
  6460. <tbody>
  6461. <tr>
  6462. <td>
  6463. <code>auth</code></br>
  6464. <em>
  6465. <a href="#external-secrets.io/v1beta1.OnboardbaseAuthSecretRef">
  6466. OnboardbaseAuthSecretRef
  6467. </a>
  6468. </em>
  6469. </td>
  6470. <td>
  6471. <p>Auth configures how the Operator authenticates with the Onboardbase API</p>
  6472. </td>
  6473. </tr>
  6474. <tr>
  6475. <td>
  6476. <code>apiHost</code></br>
  6477. <em>
  6478. string
  6479. </em>
  6480. </td>
  6481. <td>
  6482. <p>APIHost use this to configure the host url for the API for selfhosted installation, default is <a href="https://public.onboardbase.com/api/v1/">https://public.onboardbase.com/api/v1/</a></p>
  6483. </td>
  6484. </tr>
  6485. <tr>
  6486. <td>
  6487. <code>project</code></br>
  6488. <em>
  6489. string
  6490. </em>
  6491. </td>
  6492. <td>
  6493. <p>Project is an onboardbase project that the secrets should be pulled from</p>
  6494. </td>
  6495. </tr>
  6496. <tr>
  6497. <td>
  6498. <code>environment</code></br>
  6499. <em>
  6500. string
  6501. </em>
  6502. </td>
  6503. <td>
  6504. <p>Environment is the name of an environmnent within a project to pull the secrets from</p>
  6505. </td>
  6506. </tr>
  6507. </tbody>
  6508. </table>
  6509. <h3 id="external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth
  6510. </h3>
  6511. <p>
  6512. (<em>Appears on:</em>
  6513. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider</a>)
  6514. </p>
  6515. <p>
  6516. <p>OnePasswordAuth contains a secretRef for credentials.</p>
  6517. </p>
  6518. <table>
  6519. <thead>
  6520. <tr>
  6521. <th>Field</th>
  6522. <th>Description</th>
  6523. </tr>
  6524. </thead>
  6525. <tbody>
  6526. <tr>
  6527. <td>
  6528. <code>secretRef</code></br>
  6529. <em>
  6530. <a href="#external-secrets.io/v1beta1.OnePasswordAuthSecretRef">
  6531. OnePasswordAuthSecretRef
  6532. </a>
  6533. </em>
  6534. </td>
  6535. <td>
  6536. </td>
  6537. </tr>
  6538. </tbody>
  6539. </table>
  6540. <h3 id="external-secrets.io/v1beta1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
  6541. </h3>
  6542. <p>
  6543. (<em>Appears on:</em>
  6544. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth</a>)
  6545. </p>
  6546. <p>
  6547. <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
  6548. </p>
  6549. <table>
  6550. <thead>
  6551. <tr>
  6552. <th>Field</th>
  6553. <th>Description</th>
  6554. </tr>
  6555. </thead>
  6556. <tbody>
  6557. <tr>
  6558. <td>
  6559. <code>connectTokenSecretRef</code></br>
  6560. <em>
  6561. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6562. External Secrets meta/v1.SecretKeySelector
  6563. </a>
  6564. </em>
  6565. </td>
  6566. <td>
  6567. <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
  6568. </td>
  6569. </tr>
  6570. </tbody>
  6571. </table>
  6572. <h3 id="external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider
  6573. </h3>
  6574. <p>
  6575. (<em>Appears on:</em>
  6576. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6577. </p>
  6578. <p>
  6579. <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
  6580. </p>
  6581. <table>
  6582. <thead>
  6583. <tr>
  6584. <th>Field</th>
  6585. <th>Description</th>
  6586. </tr>
  6587. </thead>
  6588. <tbody>
  6589. <tr>
  6590. <td>
  6591. <code>auth</code></br>
  6592. <em>
  6593. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">
  6594. OnePasswordAuth
  6595. </a>
  6596. </em>
  6597. </td>
  6598. <td>
  6599. <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
  6600. </td>
  6601. </tr>
  6602. <tr>
  6603. <td>
  6604. <code>connectHost</code></br>
  6605. <em>
  6606. string
  6607. </em>
  6608. </td>
  6609. <td>
  6610. <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
  6611. </td>
  6612. </tr>
  6613. <tr>
  6614. <td>
  6615. <code>vaults</code></br>
  6616. <em>
  6617. map[string]int
  6618. </em>
  6619. </td>
  6620. <td>
  6621. <p>Vaults defines which OnePassword vaults to search in which order</p>
  6622. </td>
  6623. </tr>
  6624. </tbody>
  6625. </table>
  6626. <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
  6627. </h3>
  6628. <p>
  6629. (<em>Appears on:</em>
  6630. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  6631. </p>
  6632. <p>
  6633. </p>
  6634. <table>
  6635. <thead>
  6636. <tr>
  6637. <th>Field</th>
  6638. <th>Description</th>
  6639. </tr>
  6640. </thead>
  6641. <tbody>
  6642. <tr>
  6643. <td>
  6644. <code>tenancy</code></br>
  6645. <em>
  6646. string
  6647. </em>
  6648. </td>
  6649. <td>
  6650. <p>Tenancy is the tenancy OCID where user is located.</p>
  6651. </td>
  6652. </tr>
  6653. <tr>
  6654. <td>
  6655. <code>user</code></br>
  6656. <em>
  6657. string
  6658. </em>
  6659. </td>
  6660. <td>
  6661. <p>User is an access OCID specific to the account.</p>
  6662. </td>
  6663. </tr>
  6664. <tr>
  6665. <td>
  6666. <code>secretRef</code></br>
  6667. <em>
  6668. <a href="#external-secrets.io/v1beta1.OracleSecretRef">
  6669. OracleSecretRef
  6670. </a>
  6671. </em>
  6672. </td>
  6673. <td>
  6674. <p>SecretRef to pass through sensitive information.</p>
  6675. </td>
  6676. </tr>
  6677. </tbody>
  6678. </table>
  6679. <h3 id="external-secrets.io/v1beta1.OraclePrincipalType">OraclePrincipalType
  6680. (<code>string</code> alias)</p></h3>
  6681. <p>
  6682. (<em>Appears on:</em>
  6683. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  6684. </p>
  6685. <p>
  6686. </p>
  6687. <table>
  6688. <thead>
  6689. <tr>
  6690. <th>Value</th>
  6691. <th>Description</th>
  6692. </tr>
  6693. </thead>
  6694. <tbody><tr><td><p>&#34;InstancePrincipal&#34;</p></td>
  6695. <td><p>InstancePrincipal represents a instance principal.</p>
  6696. </td>
  6697. </tr><tr><td><p>&#34;UserPrincipal&#34;</p></td>
  6698. <td><p>UserPrincipal represents a user principal.</p>
  6699. </td>
  6700. </tr><tr><td><p>&#34;Workload&#34;</p></td>
  6701. <td><p>WorkloadPrincipal represents a workload principal.</p>
  6702. </td>
  6703. </tr></tbody>
  6704. </table>
  6705. <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
  6706. </h3>
  6707. <p>
  6708. (<em>Appears on:</em>
  6709. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6710. </p>
  6711. <p>
  6712. <p>Configures an store to sync secrets using a Oracle Vault
  6713. backend.</p>
  6714. </p>
  6715. <table>
  6716. <thead>
  6717. <tr>
  6718. <th>Field</th>
  6719. <th>Description</th>
  6720. </tr>
  6721. </thead>
  6722. <tbody>
  6723. <tr>
  6724. <td>
  6725. <code>region</code></br>
  6726. <em>
  6727. string
  6728. </em>
  6729. </td>
  6730. <td>
  6731. <p>Region is the region where vault is located.</p>
  6732. </td>
  6733. </tr>
  6734. <tr>
  6735. <td>
  6736. <code>vault</code></br>
  6737. <em>
  6738. string
  6739. </em>
  6740. </td>
  6741. <td>
  6742. <p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
  6743. </td>
  6744. </tr>
  6745. <tr>
  6746. <td>
  6747. <code>compartment</code></br>
  6748. <em>
  6749. string
  6750. </em>
  6751. </td>
  6752. <td>
  6753. <em>(Optional)</em>
  6754. <p>Compartment is the vault compartment OCID.
  6755. Required for PushSecret</p>
  6756. </td>
  6757. </tr>
  6758. <tr>
  6759. <td>
  6760. <code>encryptionKey</code></br>
  6761. <em>
  6762. string
  6763. </em>
  6764. </td>
  6765. <td>
  6766. <em>(Optional)</em>
  6767. <p>EncryptionKey is the OCID of the encryption key within the vault.
  6768. Required for PushSecret</p>
  6769. </td>
  6770. </tr>
  6771. <tr>
  6772. <td>
  6773. <code>principalType</code></br>
  6774. <em>
  6775. <a href="#external-secrets.io/v1beta1.OraclePrincipalType">
  6776. OraclePrincipalType
  6777. </a>
  6778. </em>
  6779. </td>
  6780. <td>
  6781. <em>(Optional)</em>
  6782. <p>The type of principal to use for authentication. If left blank, the Auth struct will
  6783. determine the principal type. This optional field must be specified if using
  6784. workload identity.</p>
  6785. </td>
  6786. </tr>
  6787. <tr>
  6788. <td>
  6789. <code>auth</code></br>
  6790. <em>
  6791. <a href="#external-secrets.io/v1beta1.OracleAuth">
  6792. OracleAuth
  6793. </a>
  6794. </em>
  6795. </td>
  6796. <td>
  6797. <em>(Optional)</em>
  6798. <p>Auth configures how secret-manager authenticates with the Oracle Vault.
  6799. If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
  6800. </td>
  6801. </tr>
  6802. <tr>
  6803. <td>
  6804. <code>serviceAccountRef</code></br>
  6805. <em>
  6806. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  6807. External Secrets meta/v1.ServiceAccountSelector
  6808. </a>
  6809. </em>
  6810. </td>
  6811. <td>
  6812. <em>(Optional)</em>
  6813. <p>ServiceAccountRef specified the service account
  6814. that should be used when authenticating with WorkloadIdentity.</p>
  6815. </td>
  6816. </tr>
  6817. </tbody>
  6818. </table>
  6819. <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
  6820. </h3>
  6821. <p>
  6822. (<em>Appears on:</em>
  6823. <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
  6824. </p>
  6825. <p>
  6826. </p>
  6827. <table>
  6828. <thead>
  6829. <tr>
  6830. <th>Field</th>
  6831. <th>Description</th>
  6832. </tr>
  6833. </thead>
  6834. <tbody>
  6835. <tr>
  6836. <td>
  6837. <code>privatekey</code></br>
  6838. <em>
  6839. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6840. External Secrets meta/v1.SecretKeySelector
  6841. </a>
  6842. </em>
  6843. </td>
  6844. <td>
  6845. <p>PrivateKey is the user&rsquo;s API Signing Key in PEM format, used for authentication.</p>
  6846. </td>
  6847. </tr>
  6848. <tr>
  6849. <td>
  6850. <code>fingerprint</code></br>
  6851. <em>
  6852. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6853. External Secrets meta/v1.SecretKeySelector
  6854. </a>
  6855. </em>
  6856. </td>
  6857. <td>
  6858. <p>Fingerprint is the fingerprint of the API private key.</p>
  6859. </td>
  6860. </tr>
  6861. </tbody>
  6862. </table>
  6863. <h3 id="external-secrets.io/v1beta1.PassboltAuth">PassboltAuth
  6864. </h3>
  6865. <p>
  6866. (<em>Appears on:</em>
  6867. <a href="#external-secrets.io/v1beta1.PassboltProvider">PassboltProvider</a>)
  6868. </p>
  6869. <p>
  6870. <p>Passbolt contains a secretRef for the passbolt credentials.</p>
  6871. </p>
  6872. <table>
  6873. <thead>
  6874. <tr>
  6875. <th>Field</th>
  6876. <th>Description</th>
  6877. </tr>
  6878. </thead>
  6879. <tbody>
  6880. <tr>
  6881. <td>
  6882. <code>passwordSecretRef</code></br>
  6883. <em>
  6884. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6885. External Secrets meta/v1.SecretKeySelector
  6886. </a>
  6887. </em>
  6888. </td>
  6889. <td>
  6890. </td>
  6891. </tr>
  6892. <tr>
  6893. <td>
  6894. <code>privateKeySecretRef</code></br>
  6895. <em>
  6896. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6897. External Secrets meta/v1.SecretKeySelector
  6898. </a>
  6899. </em>
  6900. </td>
  6901. <td>
  6902. </td>
  6903. </tr>
  6904. </tbody>
  6905. </table>
  6906. <h3 id="external-secrets.io/v1beta1.PassboltProvider">PassboltProvider
  6907. </h3>
  6908. <p>
  6909. (<em>Appears on:</em>
  6910. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6911. </p>
  6912. <p>
  6913. </p>
  6914. <table>
  6915. <thead>
  6916. <tr>
  6917. <th>Field</th>
  6918. <th>Description</th>
  6919. </tr>
  6920. </thead>
  6921. <tbody>
  6922. <tr>
  6923. <td>
  6924. <code>auth</code></br>
  6925. <em>
  6926. <a href="#external-secrets.io/v1beta1.PassboltAuth">
  6927. PassboltAuth
  6928. </a>
  6929. </em>
  6930. </td>
  6931. <td>
  6932. <p>Auth defines the information necessary to authenticate against Passbolt Server</p>
  6933. </td>
  6934. </tr>
  6935. <tr>
  6936. <td>
  6937. <code>host</code></br>
  6938. <em>
  6939. string
  6940. </em>
  6941. </td>
  6942. <td>
  6943. <p>Host defines the Passbolt Server to connect to</p>
  6944. </td>
  6945. </tr>
  6946. </tbody>
  6947. </table>
  6948. <h3 id="external-secrets.io/v1beta1.PasswordDepotAuth">PasswordDepotAuth
  6949. </h3>
  6950. <p>
  6951. (<em>Appears on:</em>
  6952. <a href="#external-secrets.io/v1beta1.PasswordDepotProvider">PasswordDepotProvider</a>)
  6953. </p>
  6954. <p>
  6955. </p>
  6956. <table>
  6957. <thead>
  6958. <tr>
  6959. <th>Field</th>
  6960. <th>Description</th>
  6961. </tr>
  6962. </thead>
  6963. <tbody>
  6964. <tr>
  6965. <td>
  6966. <code>secretRef</code></br>
  6967. <em>
  6968. <a href="#external-secrets.io/v1beta1.PasswordDepotSecretRef">
  6969. PasswordDepotSecretRef
  6970. </a>
  6971. </em>
  6972. </td>
  6973. <td>
  6974. </td>
  6975. </tr>
  6976. </tbody>
  6977. </table>
  6978. <h3 id="external-secrets.io/v1beta1.PasswordDepotProvider">PasswordDepotProvider
  6979. </h3>
  6980. <p>
  6981. (<em>Appears on:</em>
  6982. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6983. </p>
  6984. <p>
  6985. <p>Configures a store to sync secrets with a Password Depot instance.</p>
  6986. </p>
  6987. <table>
  6988. <thead>
  6989. <tr>
  6990. <th>Field</th>
  6991. <th>Description</th>
  6992. </tr>
  6993. </thead>
  6994. <tbody>
  6995. <tr>
  6996. <td>
  6997. <code>host</code></br>
  6998. <em>
  6999. string
  7000. </em>
  7001. </td>
  7002. <td>
  7003. <p>URL configures the Password Depot instance URL.</p>
  7004. </td>
  7005. </tr>
  7006. <tr>
  7007. <td>
  7008. <code>database</code></br>
  7009. <em>
  7010. string
  7011. </em>
  7012. </td>
  7013. <td>
  7014. <p>Database to use as source</p>
  7015. </td>
  7016. </tr>
  7017. <tr>
  7018. <td>
  7019. <code>auth</code></br>
  7020. <em>
  7021. <a href="#external-secrets.io/v1beta1.PasswordDepotAuth">
  7022. PasswordDepotAuth
  7023. </a>
  7024. </em>
  7025. </td>
  7026. <td>
  7027. <p>Auth configures how secret-manager authenticates with a Password Depot instance.</p>
  7028. </td>
  7029. </tr>
  7030. </tbody>
  7031. </table>
  7032. <h3 id="external-secrets.io/v1beta1.PasswordDepotSecretRef">PasswordDepotSecretRef
  7033. </h3>
  7034. <p>
  7035. (<em>Appears on:</em>
  7036. <a href="#external-secrets.io/v1beta1.PasswordDepotAuth">PasswordDepotAuth</a>)
  7037. </p>
  7038. <p>
  7039. </p>
  7040. <table>
  7041. <thead>
  7042. <tr>
  7043. <th>Field</th>
  7044. <th>Description</th>
  7045. </tr>
  7046. </thead>
  7047. <tbody>
  7048. <tr>
  7049. <td>
  7050. <code>credentials</code></br>
  7051. <em>
  7052. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7053. External Secrets meta/v1.SecretKeySelector
  7054. </a>
  7055. </em>
  7056. </td>
  7057. <td>
  7058. <em>(Optional)</em>
  7059. <p>Username / Password is used for authentication.</p>
  7060. </td>
  7061. </tr>
  7062. </tbody>
  7063. </table>
  7064. <h3 id="external-secrets.io/v1beta1.PreviderAuth">PreviderAuth
  7065. </h3>
  7066. <p>
  7067. (<em>Appears on:</em>
  7068. <a href="#external-secrets.io/v1beta1.PreviderProvider">PreviderProvider</a>)
  7069. </p>
  7070. <p>
  7071. <p>PreviderAuth contains a secretRef for credentials.</p>
  7072. </p>
  7073. <table>
  7074. <thead>
  7075. <tr>
  7076. <th>Field</th>
  7077. <th>Description</th>
  7078. </tr>
  7079. </thead>
  7080. <tbody>
  7081. <tr>
  7082. <td>
  7083. <code>secretRef</code></br>
  7084. <em>
  7085. <a href="#external-secrets.io/v1beta1.PreviderAuthSecretRef">
  7086. PreviderAuthSecretRef
  7087. </a>
  7088. </em>
  7089. </td>
  7090. <td>
  7091. <em>(Optional)</em>
  7092. </td>
  7093. </tr>
  7094. </tbody>
  7095. </table>
  7096. <h3 id="external-secrets.io/v1beta1.PreviderAuthSecretRef">PreviderAuthSecretRef
  7097. </h3>
  7098. <p>
  7099. (<em>Appears on:</em>
  7100. <a href="#external-secrets.io/v1beta1.PreviderAuth">PreviderAuth</a>)
  7101. </p>
  7102. <p>
  7103. <p>PreviderAuthSecretRef holds secret references for Previder Vault credentials.</p>
  7104. </p>
  7105. <table>
  7106. <thead>
  7107. <tr>
  7108. <th>Field</th>
  7109. <th>Description</th>
  7110. </tr>
  7111. </thead>
  7112. <tbody>
  7113. <tr>
  7114. <td>
  7115. <code>accessToken</code></br>
  7116. <em>
  7117. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7118. External Secrets meta/v1.SecretKeySelector
  7119. </a>
  7120. </em>
  7121. </td>
  7122. <td>
  7123. <p>The AccessToken is used for authentication</p>
  7124. </td>
  7125. </tr>
  7126. </tbody>
  7127. </table>
  7128. <h3 id="external-secrets.io/v1beta1.PreviderProvider">PreviderProvider
  7129. </h3>
  7130. <p>
  7131. (<em>Appears on:</em>
  7132. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  7133. </p>
  7134. <p>
  7135. <p>PreviderProvider configures a store to sync secrets using the Previder Secret Manager provider.</p>
  7136. </p>
  7137. <table>
  7138. <thead>
  7139. <tr>
  7140. <th>Field</th>
  7141. <th>Description</th>
  7142. </tr>
  7143. </thead>
  7144. <tbody>
  7145. <tr>
  7146. <td>
  7147. <code>auth</code></br>
  7148. <em>
  7149. <a href="#external-secrets.io/v1beta1.PreviderAuth">
  7150. PreviderAuth
  7151. </a>
  7152. </em>
  7153. </td>
  7154. <td>
  7155. </td>
  7156. </tr>
  7157. <tr>
  7158. <td>
  7159. <code>baseUri</code></br>
  7160. <em>
  7161. string
  7162. </em>
  7163. </td>
  7164. <td>
  7165. <em>(Optional)</em>
  7166. </td>
  7167. </tr>
  7168. </tbody>
  7169. </table>
  7170. <h3 id="external-secrets.io/v1beta1.Provider">Provider
  7171. </h3>
  7172. <p>
  7173. <p>Provider is a common interface for interacting with secret backends.</p>
  7174. </p>
  7175. <h3 id="external-secrets.io/v1beta1.PulumiProvider">PulumiProvider
  7176. </h3>
  7177. <p>
  7178. (<em>Appears on:</em>
  7179. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  7180. </p>
  7181. <p>
  7182. </p>
  7183. <table>
  7184. <thead>
  7185. <tr>
  7186. <th>Field</th>
  7187. <th>Description</th>
  7188. </tr>
  7189. </thead>
  7190. <tbody>
  7191. <tr>
  7192. <td>
  7193. <code>apiUrl</code></br>
  7194. <em>
  7195. string
  7196. </em>
  7197. </td>
  7198. <td>
  7199. <p>APIURL is the URL of the Pulumi API.</p>
  7200. </td>
  7201. </tr>
  7202. <tr>
  7203. <td>
  7204. <code>accessToken</code></br>
  7205. <em>
  7206. <a href="#external-secrets.io/v1beta1.PulumiProviderSecretRef">
  7207. PulumiProviderSecretRef
  7208. </a>
  7209. </em>
  7210. </td>
  7211. <td>
  7212. <p>AccessToken is the access tokens to sign in to the Pulumi Cloud Console.</p>
  7213. </td>
  7214. </tr>
  7215. <tr>
  7216. <td>
  7217. <code>organization</code></br>
  7218. <em>
  7219. string
  7220. </em>
  7221. </td>
  7222. <td>
  7223. <p>Organization are a space to collaborate on shared projects and stacks.
  7224. To create a new organization, visit <a href="https://app.pulumi.com/">https://app.pulumi.com/</a> and click &ldquo;New Organization&rdquo;.</p>
  7225. </td>
  7226. </tr>
  7227. <tr>
  7228. <td>
  7229. <code>project</code></br>
  7230. <em>
  7231. string
  7232. </em>
  7233. </td>
  7234. <td>
  7235. <p>Project is the name of the Pulumi ESC project the environment belongs to.</p>
  7236. </td>
  7237. </tr>
  7238. <tr>
  7239. <td>
  7240. <code>environment</code></br>
  7241. <em>
  7242. string
  7243. </em>
  7244. </td>
  7245. <td>
  7246. <p>Environment are YAML documents composed of static key-value pairs, programmatic expressions,
  7247. dynamically retrieved values from supported providers including all major clouds,
  7248. and other Pulumi ESC environments.
  7249. To create a new environment, visit <a href="https://www.pulumi.com/docs/esc/environments/">https://www.pulumi.com/docs/esc/environments/</a> for more information.</p>
  7250. </td>
  7251. </tr>
  7252. </tbody>
  7253. </table>
  7254. <h3 id="external-secrets.io/v1beta1.PulumiProviderSecretRef">PulumiProviderSecretRef
  7255. </h3>
  7256. <p>
  7257. (<em>Appears on:</em>
  7258. <a href="#external-secrets.io/v1beta1.PulumiProvider">PulumiProvider</a>)
  7259. </p>
  7260. <p>
  7261. </p>
  7262. <table>
  7263. <thead>
  7264. <tr>
  7265. <th>Field</th>
  7266. <th>Description</th>
  7267. </tr>
  7268. </thead>
  7269. <tbody>
  7270. <tr>
  7271. <td>
  7272. <code>secretRef</code></br>
  7273. <em>
  7274. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7275. External Secrets meta/v1.SecretKeySelector
  7276. </a>
  7277. </em>
  7278. </td>
  7279. <td>
  7280. <p>SecretRef is a reference to a secret containing the Pulumi API token.</p>
  7281. </td>
  7282. </tr>
  7283. </tbody>
  7284. </table>
  7285. <h3 id="external-secrets.io/v1beta1.PushSecretData">PushSecretData
  7286. </h3>
  7287. <p>
  7288. <p>PushSecretData is an interface to allow using v1alpha1.PushSecretData content in Provider registered in v1beta1.</p>
  7289. </p>
  7290. <h3 id="external-secrets.io/v1beta1.PushSecretRemoteRef">PushSecretRemoteRef
  7291. </h3>
  7292. <p>
  7293. <p>PushSecretRemoteRef is an interface to allow using v1alpha1.PushSecretRemoteRef in Provider registered in v1beta1.</p>
  7294. </p>
  7295. <h3 id="external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider
  7296. </h3>
  7297. <p>
  7298. (<em>Appears on:</em>
  7299. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  7300. </p>
  7301. <p>
  7302. </p>
  7303. <table>
  7304. <thead>
  7305. <tr>
  7306. <th>Field</th>
  7307. <th>Description</th>
  7308. </tr>
  7309. </thead>
  7310. <tbody>
  7311. <tr>
  7312. <td>
  7313. <code>apiUrl</code></br>
  7314. <em>
  7315. string
  7316. </em>
  7317. </td>
  7318. <td>
  7319. <em>(Optional)</em>
  7320. <p>APIURL is the url of the api to use. Defaults to <a href="https://api.scaleway.com">https://api.scaleway.com</a></p>
  7321. </td>
  7322. </tr>
  7323. <tr>
  7324. <td>
  7325. <code>region</code></br>
  7326. <em>
  7327. string
  7328. </em>
  7329. </td>
  7330. <td>
  7331. <p>Region where your secrets are located: <a href="https://developers.scaleway.com/en/quickstart/#region-and-zone">https://developers.scaleway.com/en/quickstart/#region-and-zone</a></p>
  7332. </td>
  7333. </tr>
  7334. <tr>
  7335. <td>
  7336. <code>projectId</code></br>
  7337. <em>
  7338. string
  7339. </em>
  7340. </td>
  7341. <td>
  7342. <p>ProjectID is the id of your project, which you can find in the console: <a href="https://console.scaleway.com/project/settings">https://console.scaleway.com/project/settings</a></p>
  7343. </td>
  7344. </tr>
  7345. <tr>
  7346. <td>
  7347. <code>accessKey</code></br>
  7348. <em>
  7349. <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
  7350. ScalewayProviderSecretRef
  7351. </a>
  7352. </em>
  7353. </td>
  7354. <td>
  7355. <p>AccessKey is the non-secret part of the api key.</p>
  7356. </td>
  7357. </tr>
  7358. <tr>
  7359. <td>
  7360. <code>secretKey</code></br>
  7361. <em>
  7362. <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
  7363. ScalewayProviderSecretRef
  7364. </a>
  7365. </em>
  7366. </td>
  7367. <td>
  7368. <p>SecretKey is the non-secret part of the api key.</p>
  7369. </td>
  7370. </tr>
  7371. </tbody>
  7372. </table>
  7373. <h3 id="external-secrets.io/v1beta1.ScalewayProviderSecretRef">ScalewayProviderSecretRef
  7374. </h3>
  7375. <p>
  7376. (<em>Appears on:</em>
  7377. <a href="#external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider</a>)
  7378. </p>
  7379. <p>
  7380. </p>
  7381. <table>
  7382. <thead>
  7383. <tr>
  7384. <th>Field</th>
  7385. <th>Description</th>
  7386. </tr>
  7387. </thead>
  7388. <tbody>
  7389. <tr>
  7390. <td>
  7391. <code>value</code></br>
  7392. <em>
  7393. string
  7394. </em>
  7395. </td>
  7396. <td>
  7397. <em>(Optional)</em>
  7398. <p>Value can be specified directly to set a value without using a secret.</p>
  7399. </td>
  7400. </tr>
  7401. <tr>
  7402. <td>
  7403. <code>secretRef</code></br>
  7404. <em>
  7405. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7406. External Secrets meta/v1.SecretKeySelector
  7407. </a>
  7408. </em>
  7409. </td>
  7410. <td>
  7411. <em>(Optional)</em>
  7412. <p>SecretRef references a key in a secret that will be used as value.</p>
  7413. </td>
  7414. </tr>
  7415. </tbody>
  7416. </table>
  7417. <h3 id="external-secrets.io/v1beta1.SecretServerProvider">SecretServerProvider
  7418. </h3>
  7419. <p>
  7420. (<em>Appears on:</em>
  7421. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  7422. </p>
  7423. <p>
  7424. <p>See <a href="https://github.com/DelineaXPM/tss-sdk-go/blob/main/server/server.go">https://github.com/DelineaXPM/tss-sdk-go/blob/main/server/server.go</a>.</p>
  7425. </p>
  7426. <table>
  7427. <thead>
  7428. <tr>
  7429. <th>Field</th>
  7430. <th>Description</th>
  7431. </tr>
  7432. </thead>
  7433. <tbody>
  7434. <tr>
  7435. <td>
  7436. <code>username</code></br>
  7437. <em>
  7438. <a href="#external-secrets.io/v1beta1.SecretServerProviderRef">
  7439. SecretServerProviderRef
  7440. </a>
  7441. </em>
  7442. </td>
  7443. <td>
  7444. <p>Username is the secret server account username.</p>
  7445. </td>
  7446. </tr>
  7447. <tr>
  7448. <td>
  7449. <code>password</code></br>
  7450. <em>
  7451. <a href="#external-secrets.io/v1beta1.SecretServerProviderRef">
  7452. SecretServerProviderRef
  7453. </a>
  7454. </em>
  7455. </td>
  7456. <td>
  7457. <p>Password is the secret server account password.</p>
  7458. </td>
  7459. </tr>
  7460. <tr>
  7461. <td>
  7462. <code>serverURL</code></br>
  7463. <em>
  7464. string
  7465. </em>
  7466. </td>
  7467. <td>
  7468. <p>ServerURL
  7469. URL to your secret server installation</p>
  7470. </td>
  7471. </tr>
  7472. </tbody>
  7473. </table>
  7474. <h3 id="external-secrets.io/v1beta1.SecretServerProviderRef">SecretServerProviderRef
  7475. </h3>
  7476. <p>
  7477. (<em>Appears on:</em>
  7478. <a href="#external-secrets.io/v1beta1.SecretServerProvider">SecretServerProvider</a>)
  7479. </p>
  7480. <p>
  7481. </p>
  7482. <table>
  7483. <thead>
  7484. <tr>
  7485. <th>Field</th>
  7486. <th>Description</th>
  7487. </tr>
  7488. </thead>
  7489. <tbody>
  7490. <tr>
  7491. <td>
  7492. <code>value</code></br>
  7493. <em>
  7494. string
  7495. </em>
  7496. </td>
  7497. <td>
  7498. <em>(Optional)</em>
  7499. <p>Value can be specified directly to set a value without using a secret.</p>
  7500. </td>
  7501. </tr>
  7502. <tr>
  7503. <td>
  7504. <code>secretRef</code></br>
  7505. <em>
  7506. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7507. External Secrets meta/v1.SecretKeySelector
  7508. </a>
  7509. </em>
  7510. </td>
  7511. <td>
  7512. <em>(Optional)</em>
  7513. <p>SecretRef references a key in a secret that will be used as value.</p>
  7514. </td>
  7515. </tr>
  7516. </tbody>
  7517. </table>
  7518. <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
  7519. </h3>
  7520. <p>
  7521. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  7522. </p>
  7523. <table>
  7524. <thead>
  7525. <tr>
  7526. <th>Field</th>
  7527. <th>Description</th>
  7528. </tr>
  7529. </thead>
  7530. <tbody>
  7531. <tr>
  7532. <td>
  7533. <code>metadata</code></br>
  7534. <em>
  7535. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  7536. Kubernetes meta/v1.ObjectMeta
  7537. </a>
  7538. </em>
  7539. </td>
  7540. <td>
  7541. Refer to the Kubernetes API documentation for the fields of the
  7542. <code>metadata</code> field.
  7543. </td>
  7544. </tr>
  7545. <tr>
  7546. <td>
  7547. <code>spec</code></br>
  7548. <em>
  7549. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  7550. SecretStoreSpec
  7551. </a>
  7552. </em>
  7553. </td>
  7554. <td>
  7555. <br/>
  7556. <br/>
  7557. <table>
  7558. <tr>
  7559. <td>
  7560. <code>controller</code></br>
  7561. <em>
  7562. string
  7563. </em>
  7564. </td>
  7565. <td>
  7566. <em>(Optional)</em>
  7567. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  7568. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  7569. </td>
  7570. </tr>
  7571. <tr>
  7572. <td>
  7573. <code>provider</code></br>
  7574. <em>
  7575. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  7576. SecretStoreProvider
  7577. </a>
  7578. </em>
  7579. </td>
  7580. <td>
  7581. <p>Used to configure the provider. Only one provider may be set</p>
  7582. </td>
  7583. </tr>
  7584. <tr>
  7585. <td>
  7586. <code>retrySettings</code></br>
  7587. <em>
  7588. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  7589. SecretStoreRetrySettings
  7590. </a>
  7591. </em>
  7592. </td>
  7593. <td>
  7594. <em>(Optional)</em>
  7595. <p>Used to configure http retries if failed</p>
  7596. </td>
  7597. </tr>
  7598. <tr>
  7599. <td>
  7600. <code>refreshInterval</code></br>
  7601. <em>
  7602. int
  7603. </em>
  7604. </td>
  7605. <td>
  7606. <em>(Optional)</em>
  7607. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  7608. </td>
  7609. </tr>
  7610. <tr>
  7611. <td>
  7612. <code>conditions</code></br>
  7613. <em>
  7614. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  7615. []ClusterSecretStoreCondition
  7616. </a>
  7617. </em>
  7618. </td>
  7619. <td>
  7620. <em>(Optional)</em>
  7621. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  7622. </td>
  7623. </tr>
  7624. </table>
  7625. </td>
  7626. </tr>
  7627. <tr>
  7628. <td>
  7629. <code>status</code></br>
  7630. <em>
  7631. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  7632. SecretStoreStatus
  7633. </a>
  7634. </em>
  7635. </td>
  7636. <td>
  7637. </td>
  7638. </tr>
  7639. </tbody>
  7640. </table>
  7641. <h3 id="external-secrets.io/v1beta1.SecretStoreCapabilities">SecretStoreCapabilities
  7642. (<code>string</code> alias)</p></h3>
  7643. <p>
  7644. (<em>Appears on:</em>
  7645. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  7646. </p>
  7647. <p>
  7648. <p>SecretStoreCapabilities defines the possible operations a SecretStore can do.</p>
  7649. </p>
  7650. <table>
  7651. <thead>
  7652. <tr>
  7653. <th>Value</th>
  7654. <th>Description</th>
  7655. </tr>
  7656. </thead>
  7657. <tbody><tr><td><p>&#34;ReadOnly&#34;</p></td>
  7658. <td></td>
  7659. </tr><tr><td><p>&#34;ReadWrite&#34;</p></td>
  7660. <td></td>
  7661. </tr><tr><td><p>&#34;WriteOnly&#34;</p></td>
  7662. <td></td>
  7663. </tr></tbody>
  7664. </table>
  7665. <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
  7666. (<code>string</code> alias)</p></h3>
  7667. <p>
  7668. (<em>Appears on:</em>
  7669. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  7670. </p>
  7671. <p>
  7672. </p>
  7673. <table>
  7674. <thead>
  7675. <tr>
  7676. <th>Value</th>
  7677. <th>Description</th>
  7678. </tr>
  7679. </thead>
  7680. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  7681. <td></td>
  7682. </tr></tbody>
  7683. </table>
  7684. <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
  7685. </h3>
  7686. <p>
  7687. (<em>Appears on:</em>
  7688. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  7689. </p>
  7690. <p>
  7691. <p>SecretStoreProvider contains the provider-specific configuration.</p>
  7692. </p>
  7693. <table>
  7694. <thead>
  7695. <tr>
  7696. <th>Field</th>
  7697. <th>Description</th>
  7698. </tr>
  7699. </thead>
  7700. <tbody>
  7701. <tr>
  7702. <td>
  7703. <code>aws</code></br>
  7704. <em>
  7705. <a href="#external-secrets.io/v1beta1.AWSProvider">
  7706. AWSProvider
  7707. </a>
  7708. </em>
  7709. </td>
  7710. <td>
  7711. <em>(Optional)</em>
  7712. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  7713. </td>
  7714. </tr>
  7715. <tr>
  7716. <td>
  7717. <code>azurekv</code></br>
  7718. <em>
  7719. <a href="#external-secrets.io/v1beta1.AzureKVProvider">
  7720. AzureKVProvider
  7721. </a>
  7722. </em>
  7723. </td>
  7724. <td>
  7725. <em>(Optional)</em>
  7726. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  7727. </td>
  7728. </tr>
  7729. <tr>
  7730. <td>
  7731. <code>akeyless</code></br>
  7732. <em>
  7733. <a href="#external-secrets.io/v1beta1.AkeylessProvider">
  7734. AkeylessProvider
  7735. </a>
  7736. </em>
  7737. </td>
  7738. <td>
  7739. <em>(Optional)</em>
  7740. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  7741. </td>
  7742. </tr>
  7743. <tr>
  7744. <td>
  7745. <code>bitwardensecretsmanager</code></br>
  7746. <em>
  7747. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">
  7748. BitwardenSecretsManagerProvider
  7749. </a>
  7750. </em>
  7751. </td>
  7752. <td>
  7753. <em>(Optional)</em>
  7754. <p>BitwardenSecretsManager configures this store to sync secrets using BitwardenSecretsManager provider</p>
  7755. </td>
  7756. </tr>
  7757. <tr>
  7758. <td>
  7759. <code>vault</code></br>
  7760. <em>
  7761. <a href="#external-secrets.io/v1beta1.VaultProvider">
  7762. VaultProvider
  7763. </a>
  7764. </em>
  7765. </td>
  7766. <td>
  7767. <em>(Optional)</em>
  7768. <p>Vault configures this store to sync secrets using Hashi provider</p>
  7769. </td>
  7770. </tr>
  7771. <tr>
  7772. <td>
  7773. <code>gcpsm</code></br>
  7774. <em>
  7775. <a href="#external-secrets.io/v1beta1.GCPSMProvider">
  7776. GCPSMProvider
  7777. </a>
  7778. </em>
  7779. </td>
  7780. <td>
  7781. <em>(Optional)</em>
  7782. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  7783. </td>
  7784. </tr>
  7785. <tr>
  7786. <td>
  7787. <code>oracle</code></br>
  7788. <em>
  7789. <a href="#external-secrets.io/v1beta1.OracleProvider">
  7790. OracleProvider
  7791. </a>
  7792. </em>
  7793. </td>
  7794. <td>
  7795. <em>(Optional)</em>
  7796. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  7797. </td>
  7798. </tr>
  7799. <tr>
  7800. <td>
  7801. <code>ibm</code></br>
  7802. <em>
  7803. <a href="#external-secrets.io/v1beta1.IBMProvider">
  7804. IBMProvider
  7805. </a>
  7806. </em>
  7807. </td>
  7808. <td>
  7809. <em>(Optional)</em>
  7810. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  7811. </td>
  7812. </tr>
  7813. <tr>
  7814. <td>
  7815. <code>yandexcertificatemanager</code></br>
  7816. <em>
  7817. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">
  7818. YandexCertificateManagerProvider
  7819. </a>
  7820. </em>
  7821. </td>
  7822. <td>
  7823. <em>(Optional)</em>
  7824. <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
  7825. </td>
  7826. </tr>
  7827. <tr>
  7828. <td>
  7829. <code>yandexlockbox</code></br>
  7830. <em>
  7831. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
  7832. YandexLockboxProvider
  7833. </a>
  7834. </em>
  7835. </td>
  7836. <td>
  7837. <em>(Optional)</em>
  7838. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  7839. </td>
  7840. </tr>
  7841. <tr>
  7842. <td>
  7843. <code>gitlab</code></br>
  7844. <em>
  7845. <a href="#external-secrets.io/v1beta1.GitlabProvider">
  7846. GitlabProvider
  7847. </a>
  7848. </em>
  7849. </td>
  7850. <td>
  7851. <em>(Optional)</em>
  7852. <p>GitLab configures this store to sync secrets using GitLab Variables provider</p>
  7853. </td>
  7854. </tr>
  7855. <tr>
  7856. <td>
  7857. <code>alibaba</code></br>
  7858. <em>
  7859. <a href="#external-secrets.io/v1beta1.AlibabaProvider">
  7860. AlibabaProvider
  7861. </a>
  7862. </em>
  7863. </td>
  7864. <td>
  7865. <em>(Optional)</em>
  7866. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  7867. </td>
  7868. </tr>
  7869. <tr>
  7870. <td>
  7871. <code>onepassword</code></br>
  7872. <em>
  7873. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">
  7874. OnePasswordProvider
  7875. </a>
  7876. </em>
  7877. </td>
  7878. <td>
  7879. <em>(Optional)</em>
  7880. <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
  7881. </td>
  7882. </tr>
  7883. <tr>
  7884. <td>
  7885. <code>webhook</code></br>
  7886. <em>
  7887. <a href="#external-secrets.io/v1beta1.WebhookProvider">
  7888. WebhookProvider
  7889. </a>
  7890. </em>
  7891. </td>
  7892. <td>
  7893. <em>(Optional)</em>
  7894. <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
  7895. </td>
  7896. </tr>
  7897. <tr>
  7898. <td>
  7899. <code>kubernetes</code></br>
  7900. <em>
  7901. <a href="#external-secrets.io/v1beta1.KubernetesProvider">
  7902. KubernetesProvider
  7903. </a>
  7904. </em>
  7905. </td>
  7906. <td>
  7907. <em>(Optional)</em>
  7908. <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
  7909. </td>
  7910. </tr>
  7911. <tr>
  7912. <td>
  7913. <code>fake</code></br>
  7914. <em>
  7915. <a href="#external-secrets.io/v1beta1.FakeProvider">
  7916. FakeProvider
  7917. </a>
  7918. </em>
  7919. </td>
  7920. <td>
  7921. <em>(Optional)</em>
  7922. <p>Fake configures a store with static key/value pairs</p>
  7923. </td>
  7924. </tr>
  7925. <tr>
  7926. <td>
  7927. <code>senhasegura</code></br>
  7928. <em>
  7929. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">
  7930. SenhaseguraProvider
  7931. </a>
  7932. </em>
  7933. </td>
  7934. <td>
  7935. <em>(Optional)</em>
  7936. <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
  7937. </td>
  7938. </tr>
  7939. <tr>
  7940. <td>
  7941. <code>scaleway</code></br>
  7942. <em>
  7943. <a href="#external-secrets.io/v1beta1.ScalewayProvider">
  7944. ScalewayProvider
  7945. </a>
  7946. </em>
  7947. </td>
  7948. <td>
  7949. <em>(Optional)</em>
  7950. <p>Scaleway</p>
  7951. </td>
  7952. </tr>
  7953. <tr>
  7954. <td>
  7955. <code>doppler</code></br>
  7956. <em>
  7957. <a href="#external-secrets.io/v1beta1.DopplerProvider">
  7958. DopplerProvider
  7959. </a>
  7960. </em>
  7961. </td>
  7962. <td>
  7963. <em>(Optional)</em>
  7964. <p>Doppler configures this store to sync secrets using the Doppler provider</p>
  7965. </td>
  7966. </tr>
  7967. <tr>
  7968. <td>
  7969. <code>previder</code></br>
  7970. <em>
  7971. <a href="#external-secrets.io/v1beta1.PreviderProvider">
  7972. PreviderProvider
  7973. </a>
  7974. </em>
  7975. </td>
  7976. <td>
  7977. <em>(Optional)</em>
  7978. <p>Previder configures this store to sync secrets using the Previder provider</p>
  7979. </td>
  7980. </tr>
  7981. <tr>
  7982. <td>
  7983. <code>onboardbase</code></br>
  7984. <em>
  7985. <a href="#external-secrets.io/v1beta1.OnboardbaseProvider">
  7986. OnboardbaseProvider
  7987. </a>
  7988. </em>
  7989. </td>
  7990. <td>
  7991. <em>(Optional)</em>
  7992. <p>Onboardbase configures this store to sync secrets using the Onboardbase provider</p>
  7993. </td>
  7994. </tr>
  7995. <tr>
  7996. <td>
  7997. <code>keepersecurity</code></br>
  7998. <em>
  7999. <a href="#external-secrets.io/v1beta1.KeeperSecurityProvider">
  8000. KeeperSecurityProvider
  8001. </a>
  8002. </em>
  8003. </td>
  8004. <td>
  8005. <em>(Optional)</em>
  8006. <p>KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider</p>
  8007. </td>
  8008. </tr>
  8009. <tr>
  8010. <td>
  8011. <code>conjur</code></br>
  8012. <em>
  8013. <a href="#external-secrets.io/v1beta1.ConjurProvider">
  8014. ConjurProvider
  8015. </a>
  8016. </em>
  8017. </td>
  8018. <td>
  8019. <em>(Optional)</em>
  8020. <p>Conjur configures this store to sync secrets using conjur provider</p>
  8021. </td>
  8022. </tr>
  8023. <tr>
  8024. <td>
  8025. <code>delinea</code></br>
  8026. <em>
  8027. <a href="#external-secrets.io/v1beta1.DelineaProvider">
  8028. DelineaProvider
  8029. </a>
  8030. </em>
  8031. </td>
  8032. <td>
  8033. <em>(Optional)</em>
  8034. <p>Delinea DevOps Secrets Vault
  8035. <a href="https://docs.delinea.com/online-help/products/devops-secrets-vault/current">https://docs.delinea.com/online-help/products/devops-secrets-vault/current</a></p>
  8036. </td>
  8037. </tr>
  8038. <tr>
  8039. <td>
  8040. <code>secretserver</code></br>
  8041. <em>
  8042. <a href="#external-secrets.io/v1beta1.SecretServerProvider">
  8043. SecretServerProvider
  8044. </a>
  8045. </em>
  8046. </td>
  8047. <td>
  8048. <em>(Optional)</em>
  8049. <p>SecretServer configures this store to sync secrets using SecretServer provider
  8050. <a href="https://docs.delinea.com/online-help/secret-server/start.htm">https://docs.delinea.com/online-help/secret-server/start.htm</a></p>
  8051. </td>
  8052. </tr>
  8053. <tr>
  8054. <td>
  8055. <code>chef</code></br>
  8056. <em>
  8057. <a href="#external-secrets.io/v1beta1.ChefProvider">
  8058. ChefProvider
  8059. </a>
  8060. </em>
  8061. </td>
  8062. <td>
  8063. <em>(Optional)</em>
  8064. <p>Chef configures this store to sync secrets with chef server</p>
  8065. </td>
  8066. </tr>
  8067. <tr>
  8068. <td>
  8069. <code>pulumi</code></br>
  8070. <em>
  8071. <a href="#external-secrets.io/v1beta1.PulumiProvider">
  8072. PulumiProvider
  8073. </a>
  8074. </em>
  8075. </td>
  8076. <td>
  8077. <em>(Optional)</em>
  8078. <p>Pulumi configures this store to sync secrets using the Pulumi provider</p>
  8079. </td>
  8080. </tr>
  8081. <tr>
  8082. <td>
  8083. <code>fortanix</code></br>
  8084. <em>
  8085. <a href="#external-secrets.io/v1beta1.FortanixProvider">
  8086. FortanixProvider
  8087. </a>
  8088. </em>
  8089. </td>
  8090. <td>
  8091. <em>(Optional)</em>
  8092. <p>Fortanix configures this store to sync secrets using the Fortanix provider</p>
  8093. </td>
  8094. </tr>
  8095. <tr>
  8096. <td>
  8097. <code>passworddepot</code></br>
  8098. <em>
  8099. <a href="#external-secrets.io/v1beta1.PasswordDepotProvider">
  8100. PasswordDepotProvider
  8101. </a>
  8102. </em>
  8103. </td>
  8104. <td>
  8105. <em>(Optional)</em>
  8106. </td>
  8107. </tr>
  8108. <tr>
  8109. <td>
  8110. <code>passbolt</code></br>
  8111. <em>
  8112. <a href="#external-secrets.io/v1beta1.PassboltProvider">
  8113. PassboltProvider
  8114. </a>
  8115. </em>
  8116. </td>
  8117. <td>
  8118. <em>(Optional)</em>
  8119. </td>
  8120. </tr>
  8121. <tr>
  8122. <td>
  8123. <code>device42</code></br>
  8124. <em>
  8125. <a href="#external-secrets.io/v1beta1.Device42Provider">
  8126. Device42Provider
  8127. </a>
  8128. </em>
  8129. </td>
  8130. <td>
  8131. <em>(Optional)</em>
  8132. <p>Device42 configures this store to sync secrets using the Device42 provider</p>
  8133. </td>
  8134. </tr>
  8135. <tr>
  8136. <td>
  8137. <code>infisical</code></br>
  8138. <em>
  8139. <a href="#external-secrets.io/v1beta1.InfisicalProvider">
  8140. InfisicalProvider
  8141. </a>
  8142. </em>
  8143. </td>
  8144. <td>
  8145. <em>(Optional)</em>
  8146. <p>Infisical configures this store to sync secrets using the Infisical provider</p>
  8147. </td>
  8148. </tr>
  8149. <tr>
  8150. <td>
  8151. <code>beyondtrust</code></br>
  8152. <em>
  8153. <a href="#external-secrets.io/v1beta1.BeyondtrustProvider">
  8154. BeyondtrustProvider
  8155. </a>
  8156. </em>
  8157. </td>
  8158. <td>
  8159. <em>(Optional)</em>
  8160. <p>Beyondtrust configures this store to sync secrets using Password Safe provider.</p>
  8161. </td>
  8162. </tr>
  8163. </tbody>
  8164. </table>
  8165. <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
  8166. </h3>
  8167. <p>
  8168. (<em>Appears on:</em>
  8169. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>,
  8170. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
  8171. <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
  8172. </p>
  8173. <p>
  8174. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  8175. </p>
  8176. <table>
  8177. <thead>
  8178. <tr>
  8179. <th>Field</th>
  8180. <th>Description</th>
  8181. </tr>
  8182. </thead>
  8183. <tbody>
  8184. <tr>
  8185. <td>
  8186. <code>name</code></br>
  8187. <em>
  8188. string
  8189. </em>
  8190. </td>
  8191. <td>
  8192. <p>Name of the SecretStore resource</p>
  8193. </td>
  8194. </tr>
  8195. <tr>
  8196. <td>
  8197. <code>kind</code></br>
  8198. <em>
  8199. string
  8200. </em>
  8201. </td>
  8202. <td>
  8203. <em>(Optional)</em>
  8204. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  8205. Defaults to <code>SecretStore</code></p>
  8206. </td>
  8207. </tr>
  8208. </tbody>
  8209. </table>
  8210. <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
  8211. </h3>
  8212. <p>
  8213. (<em>Appears on:</em>
  8214. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  8215. </p>
  8216. <p>
  8217. </p>
  8218. <table>
  8219. <thead>
  8220. <tr>
  8221. <th>Field</th>
  8222. <th>Description</th>
  8223. </tr>
  8224. </thead>
  8225. <tbody>
  8226. <tr>
  8227. <td>
  8228. <code>maxRetries</code></br>
  8229. <em>
  8230. int32
  8231. </em>
  8232. </td>
  8233. <td>
  8234. </td>
  8235. </tr>
  8236. <tr>
  8237. <td>
  8238. <code>retryInterval</code></br>
  8239. <em>
  8240. string
  8241. </em>
  8242. </td>
  8243. <td>
  8244. </td>
  8245. </tr>
  8246. </tbody>
  8247. </table>
  8248. <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
  8249. </h3>
  8250. <p>
  8251. (<em>Appears on:</em>
  8252. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  8253. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  8254. </p>
  8255. <p>
  8256. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  8257. </p>
  8258. <table>
  8259. <thead>
  8260. <tr>
  8261. <th>Field</th>
  8262. <th>Description</th>
  8263. </tr>
  8264. </thead>
  8265. <tbody>
  8266. <tr>
  8267. <td>
  8268. <code>controller</code></br>
  8269. <em>
  8270. string
  8271. </em>
  8272. </td>
  8273. <td>
  8274. <em>(Optional)</em>
  8275. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  8276. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  8277. </td>
  8278. </tr>
  8279. <tr>
  8280. <td>
  8281. <code>provider</code></br>
  8282. <em>
  8283. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  8284. SecretStoreProvider
  8285. </a>
  8286. </em>
  8287. </td>
  8288. <td>
  8289. <p>Used to configure the provider. Only one provider may be set</p>
  8290. </td>
  8291. </tr>
  8292. <tr>
  8293. <td>
  8294. <code>retrySettings</code></br>
  8295. <em>
  8296. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  8297. SecretStoreRetrySettings
  8298. </a>
  8299. </em>
  8300. </td>
  8301. <td>
  8302. <em>(Optional)</em>
  8303. <p>Used to configure http retries if failed</p>
  8304. </td>
  8305. </tr>
  8306. <tr>
  8307. <td>
  8308. <code>refreshInterval</code></br>
  8309. <em>
  8310. int
  8311. </em>
  8312. </td>
  8313. <td>
  8314. <em>(Optional)</em>
  8315. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  8316. </td>
  8317. </tr>
  8318. <tr>
  8319. <td>
  8320. <code>conditions</code></br>
  8321. <em>
  8322. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  8323. []ClusterSecretStoreCondition
  8324. </a>
  8325. </em>
  8326. </td>
  8327. <td>
  8328. <em>(Optional)</em>
  8329. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  8330. </td>
  8331. </tr>
  8332. </tbody>
  8333. </table>
  8334. <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
  8335. </h3>
  8336. <p>
  8337. (<em>Appears on:</em>
  8338. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  8339. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  8340. </p>
  8341. <p>
  8342. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  8343. </p>
  8344. <table>
  8345. <thead>
  8346. <tr>
  8347. <th>Field</th>
  8348. <th>Description</th>
  8349. </tr>
  8350. </thead>
  8351. <tbody>
  8352. <tr>
  8353. <td>
  8354. <code>conditions</code></br>
  8355. <em>
  8356. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
  8357. []SecretStoreStatusCondition
  8358. </a>
  8359. </em>
  8360. </td>
  8361. <td>
  8362. <em>(Optional)</em>
  8363. </td>
  8364. </tr>
  8365. <tr>
  8366. <td>
  8367. <code>capabilities</code></br>
  8368. <em>
  8369. <a href="#external-secrets.io/v1beta1.SecretStoreCapabilities">
  8370. SecretStoreCapabilities
  8371. </a>
  8372. </em>
  8373. </td>
  8374. <td>
  8375. <em>(Optional)</em>
  8376. </td>
  8377. </tr>
  8378. </tbody>
  8379. </table>
  8380. <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
  8381. </h3>
  8382. <p>
  8383. (<em>Appears on:</em>
  8384. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  8385. </p>
  8386. <p>
  8387. </p>
  8388. <table>
  8389. <thead>
  8390. <tr>
  8391. <th>Field</th>
  8392. <th>Description</th>
  8393. </tr>
  8394. </thead>
  8395. <tbody>
  8396. <tr>
  8397. <td>
  8398. <code>type</code></br>
  8399. <em>
  8400. <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
  8401. SecretStoreConditionType
  8402. </a>
  8403. </em>
  8404. </td>
  8405. <td>
  8406. </td>
  8407. </tr>
  8408. <tr>
  8409. <td>
  8410. <code>status</code></br>
  8411. <em>
  8412. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  8413. Kubernetes core/v1.ConditionStatus
  8414. </a>
  8415. </em>
  8416. </td>
  8417. <td>
  8418. </td>
  8419. </tr>
  8420. <tr>
  8421. <td>
  8422. <code>reason</code></br>
  8423. <em>
  8424. string
  8425. </em>
  8426. </td>
  8427. <td>
  8428. <em>(Optional)</em>
  8429. </td>
  8430. </tr>
  8431. <tr>
  8432. <td>
  8433. <code>message</code></br>
  8434. <em>
  8435. string
  8436. </em>
  8437. </td>
  8438. <td>
  8439. <em>(Optional)</em>
  8440. </td>
  8441. </tr>
  8442. <tr>
  8443. <td>
  8444. <code>lastTransitionTime</code></br>
  8445. <em>
  8446. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  8447. Kubernetes meta/v1.Time
  8448. </a>
  8449. </em>
  8450. </td>
  8451. <td>
  8452. <em>(Optional)</em>
  8453. </td>
  8454. </tr>
  8455. </tbody>
  8456. </table>
  8457. <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
  8458. </h3>
  8459. <p>
  8460. <p>SecretsClient provides access to secrets.</p>
  8461. </p>
  8462. <h3 id="external-secrets.io/v1beta1.SecretsManager">SecretsManager
  8463. </h3>
  8464. <p>
  8465. (<em>Appears on:</em>
  8466. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  8467. </p>
  8468. <p>
  8469. <p>SecretsManager defines how the provider behaves when interacting with AWS
  8470. SecretsManager. Some of these settings are only applicable to controlling how
  8471. secrets are deleted, and hence only apply to PushSecret (and only when
  8472. deletionPolicy is set to Delete).</p>
  8473. </p>
  8474. <table>
  8475. <thead>
  8476. <tr>
  8477. <th>Field</th>
  8478. <th>Description</th>
  8479. </tr>
  8480. </thead>
  8481. <tbody>
  8482. <tr>
  8483. <td>
  8484. <code>forceDeleteWithoutRecovery</code></br>
  8485. <em>
  8486. bool
  8487. </em>
  8488. </td>
  8489. <td>
  8490. <em>(Optional)</em>
  8491. <p>Specifies whether to delete the secret without any recovery window. You
  8492. can&rsquo;t use both this parameter and RecoveryWindowInDays in the same call.
  8493. If you don&rsquo;t use either, then by default Secrets Manager uses a 30 day
  8494. recovery window.
  8495. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery">https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery</a></p>
  8496. </td>
  8497. </tr>
  8498. <tr>
  8499. <td>
  8500. <code>recoveryWindowInDays</code></br>
  8501. <em>
  8502. int64
  8503. </em>
  8504. </td>
  8505. <td>
  8506. <em>(Optional)</em>
  8507. <p>The number of days from 7 to 30 that Secrets Manager waits before
  8508. permanently deleting the secret. You can&rsquo;t use both this parameter and
  8509. ForceDeleteWithoutRecovery in the same call. If you don&rsquo;t use either,
  8510. then by default Secrets Manager uses a 30 day recovery window.
  8511. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays">https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays</a></p>
  8512. </td>
  8513. </tr>
  8514. </tbody>
  8515. </table>
  8516. <h3 id="external-secrets.io/v1beta1.SenhaseguraAuth">SenhaseguraAuth
  8517. </h3>
  8518. <p>
  8519. (<em>Appears on:</em>
  8520. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  8521. </p>
  8522. <p>
  8523. <p>SenhaseguraAuth tells the controller how to do auth in senhasegura.</p>
  8524. </p>
  8525. <table>
  8526. <thead>
  8527. <tr>
  8528. <th>Field</th>
  8529. <th>Description</th>
  8530. </tr>
  8531. </thead>
  8532. <tbody>
  8533. <tr>
  8534. <td>
  8535. <code>clientId</code></br>
  8536. <em>
  8537. string
  8538. </em>
  8539. </td>
  8540. <td>
  8541. </td>
  8542. </tr>
  8543. <tr>
  8544. <td>
  8545. <code>clientSecretSecretRef</code></br>
  8546. <em>
  8547. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8548. External Secrets meta/v1.SecretKeySelector
  8549. </a>
  8550. </em>
  8551. </td>
  8552. <td>
  8553. </td>
  8554. </tr>
  8555. </tbody>
  8556. </table>
  8557. <h3 id="external-secrets.io/v1beta1.SenhaseguraModuleType">SenhaseguraModuleType
  8558. (<code>string</code> alias)</p></h3>
  8559. <p>
  8560. (<em>Appears on:</em>
  8561. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  8562. </p>
  8563. <p>
  8564. <p>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets</p>
  8565. </p>
  8566. <table>
  8567. <thead>
  8568. <tr>
  8569. <th>Value</th>
  8570. <th>Description</th>
  8571. </tr>
  8572. </thead>
  8573. <tbody><tr><td><p>&#34;DSM&#34;</p></td>
  8574. <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
  8575. see: https://senhasegura.com/devops
  8576. </code></pre>
  8577. </td>
  8578. </tr></tbody>
  8579. </table>
  8580. <h3 id="external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider
  8581. </h3>
  8582. <p>
  8583. (<em>Appears on:</em>
  8584. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  8585. </p>
  8586. <p>
  8587. <p>SenhaseguraProvider setup a store to sync secrets with senhasegura.</p>
  8588. </p>
  8589. <table>
  8590. <thead>
  8591. <tr>
  8592. <th>Field</th>
  8593. <th>Description</th>
  8594. </tr>
  8595. </thead>
  8596. <tbody>
  8597. <tr>
  8598. <td>
  8599. <code>url</code></br>
  8600. <em>
  8601. string
  8602. </em>
  8603. </td>
  8604. <td>
  8605. <p>URL of senhasegura</p>
  8606. </td>
  8607. </tr>
  8608. <tr>
  8609. <td>
  8610. <code>module</code></br>
  8611. <em>
  8612. <a href="#external-secrets.io/v1beta1.SenhaseguraModuleType">
  8613. SenhaseguraModuleType
  8614. </a>
  8615. </em>
  8616. </td>
  8617. <td>
  8618. <p>Module defines which senhasegura module should be used to get secrets</p>
  8619. </td>
  8620. </tr>
  8621. <tr>
  8622. <td>
  8623. <code>auth</code></br>
  8624. <em>
  8625. <a href="#external-secrets.io/v1beta1.SenhaseguraAuth">
  8626. SenhaseguraAuth
  8627. </a>
  8628. </em>
  8629. </td>
  8630. <td>
  8631. <p>Auth defines parameters to authenticate in senhasegura</p>
  8632. </td>
  8633. </tr>
  8634. <tr>
  8635. <td>
  8636. <code>ignoreSslCertificate</code></br>
  8637. <em>
  8638. bool
  8639. </em>
  8640. </td>
  8641. <td>
  8642. <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
  8643. </td>
  8644. </tr>
  8645. </tbody>
  8646. </table>
  8647. <h3 id="external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef
  8648. </h3>
  8649. <p>
  8650. (<em>Appears on:</em>
  8651. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  8652. </p>
  8653. <p>
  8654. <p>StoreGeneratorSourceRef allows you to override the source
  8655. from which the secret will be pulled from.
  8656. You can define at maximum one property.</p>
  8657. </p>
  8658. <table>
  8659. <thead>
  8660. <tr>
  8661. <th>Field</th>
  8662. <th>Description</th>
  8663. </tr>
  8664. </thead>
  8665. <tbody>
  8666. <tr>
  8667. <td>
  8668. <code>storeRef</code></br>
  8669. <em>
  8670. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  8671. SecretStoreRef
  8672. </a>
  8673. </em>
  8674. </td>
  8675. <td>
  8676. <em>(Optional)</em>
  8677. </td>
  8678. </tr>
  8679. <tr>
  8680. <td>
  8681. <code>generatorRef</code></br>
  8682. <em>
  8683. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  8684. GeneratorRef
  8685. </a>
  8686. </em>
  8687. </td>
  8688. <td>
  8689. <em>(Optional)</em>
  8690. <p>GeneratorRef points to a generator custom resource.</p>
  8691. </td>
  8692. </tr>
  8693. </tbody>
  8694. </table>
  8695. <h3 id="external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef
  8696. </h3>
  8697. <p>
  8698. (<em>Appears on:</em>
  8699. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>)
  8700. </p>
  8701. <p>
  8702. <p>StoreSourceRef allows you to override the SecretStore source
  8703. from which the secret will be pulled from.
  8704. You can define at maximum one property.</p>
  8705. </p>
  8706. <table>
  8707. <thead>
  8708. <tr>
  8709. <th>Field</th>
  8710. <th>Description</th>
  8711. </tr>
  8712. </thead>
  8713. <tbody>
  8714. <tr>
  8715. <td>
  8716. <code>storeRef</code></br>
  8717. <em>
  8718. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  8719. SecretStoreRef
  8720. </a>
  8721. </em>
  8722. </td>
  8723. <td>
  8724. <em>(Optional)</em>
  8725. </td>
  8726. </tr>
  8727. <tr>
  8728. <td>
  8729. <code>generatorRef</code></br>
  8730. <em>
  8731. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  8732. GeneratorRef
  8733. </a>
  8734. </em>
  8735. </td>
  8736. <td>
  8737. <p>GeneratorRef points to a generator custom resource.</p>
  8738. <p>Deprecated: The generatorRef is not implemented in .data[].
  8739. this will be removed with v1.</p>
  8740. </td>
  8741. </tr>
  8742. </tbody>
  8743. </table>
  8744. <h3 id="external-secrets.io/v1beta1.Tag">Tag
  8745. </h3>
  8746. <p>
  8747. </p>
  8748. <table>
  8749. <thead>
  8750. <tr>
  8751. <th>Field</th>
  8752. <th>Description</th>
  8753. </tr>
  8754. </thead>
  8755. <tbody>
  8756. <tr>
  8757. <td>
  8758. <code>key</code></br>
  8759. <em>
  8760. string
  8761. </em>
  8762. </td>
  8763. <td>
  8764. </td>
  8765. </tr>
  8766. <tr>
  8767. <td>
  8768. <code>value</code></br>
  8769. <em>
  8770. string
  8771. </em>
  8772. </td>
  8773. <td>
  8774. </td>
  8775. </tr>
  8776. </tbody>
  8777. </table>
  8778. <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
  8779. (<code>string</code> alias)</p></h3>
  8780. <p>
  8781. (<em>Appears on:</em>
  8782. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  8783. </p>
  8784. <p>
  8785. </p>
  8786. <table>
  8787. <thead>
  8788. <tr>
  8789. <th>Value</th>
  8790. <th>Description</th>
  8791. </tr>
  8792. </thead>
  8793. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  8794. <td></td>
  8795. </tr><tr><td><p>&#34;v2&#34;</p></td>
  8796. <td></td>
  8797. </tr></tbody>
  8798. </table>
  8799. <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
  8800. </h3>
  8801. <p>
  8802. (<em>Appears on:</em>
  8803. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  8804. </p>
  8805. <p>
  8806. </p>
  8807. <table>
  8808. <thead>
  8809. <tr>
  8810. <th>Field</th>
  8811. <th>Description</th>
  8812. </tr>
  8813. </thead>
  8814. <tbody>
  8815. <tr>
  8816. <td>
  8817. <code>configMap</code></br>
  8818. <em>
  8819. <a href="#external-secrets.io/v1beta1.TemplateRef">
  8820. TemplateRef
  8821. </a>
  8822. </em>
  8823. </td>
  8824. <td>
  8825. </td>
  8826. </tr>
  8827. <tr>
  8828. <td>
  8829. <code>secret</code></br>
  8830. <em>
  8831. <a href="#external-secrets.io/v1beta1.TemplateRef">
  8832. TemplateRef
  8833. </a>
  8834. </em>
  8835. </td>
  8836. <td>
  8837. </td>
  8838. </tr>
  8839. <tr>
  8840. <td>
  8841. <code>target</code></br>
  8842. <em>
  8843. <a href="#external-secrets.io/v1beta1.TemplateTarget">
  8844. TemplateTarget
  8845. </a>
  8846. </em>
  8847. </td>
  8848. <td>
  8849. <em>(Optional)</em>
  8850. </td>
  8851. </tr>
  8852. <tr>
  8853. <td>
  8854. <code>literal</code></br>
  8855. <em>
  8856. string
  8857. </em>
  8858. </td>
  8859. <td>
  8860. <em>(Optional)</em>
  8861. </td>
  8862. </tr>
  8863. </tbody>
  8864. </table>
  8865. <h3 id="external-secrets.io/v1beta1.TemplateMergePolicy">TemplateMergePolicy
  8866. (<code>string</code> alias)</p></h3>
  8867. <p>
  8868. (<em>Appears on:</em>
  8869. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  8870. </p>
  8871. <p>
  8872. </p>
  8873. <table>
  8874. <thead>
  8875. <tr>
  8876. <th>Value</th>
  8877. <th>Description</th>
  8878. </tr>
  8879. </thead>
  8880. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  8881. <td></td>
  8882. </tr><tr><td><p>&#34;Replace&#34;</p></td>
  8883. <td></td>
  8884. </tr></tbody>
  8885. </table>
  8886. <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
  8887. </h3>
  8888. <p>
  8889. (<em>Appears on:</em>
  8890. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  8891. </p>
  8892. <p>
  8893. </p>
  8894. <table>
  8895. <thead>
  8896. <tr>
  8897. <th>Field</th>
  8898. <th>Description</th>
  8899. </tr>
  8900. </thead>
  8901. <tbody>
  8902. <tr>
  8903. <td>
  8904. <code>name</code></br>
  8905. <em>
  8906. string
  8907. </em>
  8908. </td>
  8909. <td>
  8910. <p>The name of the ConfigMap/Secret resource</p>
  8911. </td>
  8912. </tr>
  8913. <tr>
  8914. <td>
  8915. <code>items</code></br>
  8916. <em>
  8917. <a href="#external-secrets.io/v1beta1.TemplateRefItem">
  8918. []TemplateRefItem
  8919. </a>
  8920. </em>
  8921. </td>
  8922. <td>
  8923. <p>A list of keys in the ConfigMap/Secret to use as templates for Secret data</p>
  8924. </td>
  8925. </tr>
  8926. </tbody>
  8927. </table>
  8928. <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
  8929. </h3>
  8930. <p>
  8931. (<em>Appears on:</em>
  8932. <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
  8933. </p>
  8934. <p>
  8935. </p>
  8936. <table>
  8937. <thead>
  8938. <tr>
  8939. <th>Field</th>
  8940. <th>Description</th>
  8941. </tr>
  8942. </thead>
  8943. <tbody>
  8944. <tr>
  8945. <td>
  8946. <code>key</code></br>
  8947. <em>
  8948. string
  8949. </em>
  8950. </td>
  8951. <td>
  8952. <p>A key in the ConfigMap/Secret</p>
  8953. </td>
  8954. </tr>
  8955. <tr>
  8956. <td>
  8957. <code>templateAs</code></br>
  8958. <em>
  8959. <a href="#external-secrets.io/v1beta1.TemplateScope">
  8960. TemplateScope
  8961. </a>
  8962. </em>
  8963. </td>
  8964. <td>
  8965. </td>
  8966. </tr>
  8967. </tbody>
  8968. </table>
  8969. <h3 id="external-secrets.io/v1beta1.TemplateScope">TemplateScope
  8970. (<code>string</code> alias)</p></h3>
  8971. <p>
  8972. (<em>Appears on:</em>
  8973. <a href="#external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem</a>)
  8974. </p>
  8975. <p>
  8976. </p>
  8977. <table>
  8978. <thead>
  8979. <tr>
  8980. <th>Value</th>
  8981. <th>Description</th>
  8982. </tr>
  8983. </thead>
  8984. <tbody><tr><td><p>&#34;KeysAndValues&#34;</p></td>
  8985. <td></td>
  8986. </tr><tr><td><p>&#34;Values&#34;</p></td>
  8987. <td></td>
  8988. </tr></tbody>
  8989. </table>
  8990. <h3 id="external-secrets.io/v1beta1.TemplateTarget">TemplateTarget
  8991. (<code>string</code> alias)</p></h3>
  8992. <p>
  8993. (<em>Appears on:</em>
  8994. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  8995. </p>
  8996. <p>
  8997. </p>
  8998. <table>
  8999. <thead>
  9000. <tr>
  9001. <th>Value</th>
  9002. <th>Description</th>
  9003. </tr>
  9004. </thead>
  9005. <tbody><tr><td><p>&#34;Annotations&#34;</p></td>
  9006. <td></td>
  9007. </tr><tr><td><p>&#34;Data&#34;</p></td>
  9008. <td></td>
  9009. </tr><tr><td><p>&#34;Labels&#34;</p></td>
  9010. <td></td>
  9011. </tr></tbody>
  9012. </table>
  9013. <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
  9014. </h3>
  9015. <p>
  9016. (<em>Appears on:</em>
  9017. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  9018. </p>
  9019. <p>
  9020. </p>
  9021. <table>
  9022. <thead>
  9023. <tr>
  9024. <th>Field</th>
  9025. <th>Description</th>
  9026. </tr>
  9027. </thead>
  9028. <tbody>
  9029. <tr>
  9030. <td>
  9031. <code>bearerToken</code></br>
  9032. <em>
  9033. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9034. External Secrets meta/v1.SecretKeySelector
  9035. </a>
  9036. </em>
  9037. </td>
  9038. <td>
  9039. </td>
  9040. </tr>
  9041. </tbody>
  9042. </table>
  9043. <h3 id="external-secrets.io/v1beta1.UniversalAuthCredentials">UniversalAuthCredentials
  9044. </h3>
  9045. <p>
  9046. (<em>Appears on:</em>
  9047. <a href="#external-secrets.io/v1beta1.InfisicalAuth">InfisicalAuth</a>)
  9048. </p>
  9049. <p>
  9050. </p>
  9051. <table>
  9052. <thead>
  9053. <tr>
  9054. <th>Field</th>
  9055. <th>Description</th>
  9056. </tr>
  9057. </thead>
  9058. <tbody>
  9059. <tr>
  9060. <td>
  9061. <code>clientId</code></br>
  9062. <em>
  9063. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9064. External Secrets meta/v1.SecretKeySelector
  9065. </a>
  9066. </em>
  9067. </td>
  9068. <td>
  9069. </td>
  9070. </tr>
  9071. <tr>
  9072. <td>
  9073. <code>clientSecret</code></br>
  9074. <em>
  9075. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9076. External Secrets meta/v1.SecretKeySelector
  9077. </a>
  9078. </em>
  9079. </td>
  9080. <td>
  9081. </td>
  9082. </tr>
  9083. </tbody>
  9084. </table>
  9085. <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
  9086. (<code>byte</code> alias)</p></h3>
  9087. <p>
  9088. </p>
  9089. <table>
  9090. <thead>
  9091. <tr>
  9092. <th>Value</th>
  9093. <th>Description</th>
  9094. </tr>
  9095. </thead>
  9096. <tbody><tr><td><p>2</p></td>
  9097. <td><p>Error indicates that there is a misconfiguration.</p>
  9098. </td>
  9099. </tr><tr><td><p>0</p></td>
  9100. <td><p>Ready indicates that the client is configured correctly
  9101. and can be used.</p>
  9102. </td>
  9103. </tr><tr><td><p>1</p></td>
  9104. <td><p>Unknown indicates that the client can be used
  9105. but information is missing and it can not be validated.</p>
  9106. </td>
  9107. </tr></tbody>
  9108. </table>
  9109. <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
  9110. </h3>
  9111. <p>
  9112. (<em>Appears on:</em>
  9113. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9114. </p>
  9115. <p>
  9116. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  9117. with the role and secret stored in a Kubernetes Secret resource.</p>
  9118. </p>
  9119. <table>
  9120. <thead>
  9121. <tr>
  9122. <th>Field</th>
  9123. <th>Description</th>
  9124. </tr>
  9125. </thead>
  9126. <tbody>
  9127. <tr>
  9128. <td>
  9129. <code>path</code></br>
  9130. <em>
  9131. string
  9132. </em>
  9133. </td>
  9134. <td>
  9135. <p>Path where the App Role authentication backend is mounted
  9136. in Vault, e.g: &ldquo;approle&rdquo;</p>
  9137. </td>
  9138. </tr>
  9139. <tr>
  9140. <td>
  9141. <code>roleId</code></br>
  9142. <em>
  9143. string
  9144. </em>
  9145. </td>
  9146. <td>
  9147. <em>(Optional)</em>
  9148. <p>RoleID configured in the App Role authentication backend when setting
  9149. up the authentication backend in Vault.</p>
  9150. </td>
  9151. </tr>
  9152. <tr>
  9153. <td>
  9154. <code>roleRef</code></br>
  9155. <em>
  9156. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9157. External Secrets meta/v1.SecretKeySelector
  9158. </a>
  9159. </em>
  9160. </td>
  9161. <td>
  9162. <em>(Optional)</em>
  9163. <p>Reference to a key in a Secret that contains the App Role ID used
  9164. to authenticate with Vault.
  9165. The <code>key</code> field must be specified and denotes which entry within the Secret
  9166. resource is used as the app role id.</p>
  9167. </td>
  9168. </tr>
  9169. <tr>
  9170. <td>
  9171. <code>secretRef</code></br>
  9172. <em>
  9173. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9174. External Secrets meta/v1.SecretKeySelector
  9175. </a>
  9176. </em>
  9177. </td>
  9178. <td>
  9179. <p>Reference to a key in a Secret that contains the App Role secret used
  9180. to authenticate with Vault.
  9181. The <code>key</code> field must be specified and denotes which entry within the Secret
  9182. resource is used as the app role secret.</p>
  9183. </td>
  9184. </tr>
  9185. </tbody>
  9186. </table>
  9187. <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
  9188. </h3>
  9189. <p>
  9190. (<em>Appears on:</em>
  9191. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  9192. </p>
  9193. <p>
  9194. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  9195. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>userPass</code>, <code>jwt</code> or <code>cert</code>
  9196. can be specified. A namespace to authenticate against can optionally be specified.</p>
  9197. </p>
  9198. <table>
  9199. <thead>
  9200. <tr>
  9201. <th>Field</th>
  9202. <th>Description</th>
  9203. </tr>
  9204. </thead>
  9205. <tbody>
  9206. <tr>
  9207. <td>
  9208. <code>namespace</code></br>
  9209. <em>
  9210. string
  9211. </em>
  9212. </td>
  9213. <td>
  9214. <em>(Optional)</em>
  9215. <p>Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in.
  9216. Namespaces is a set of features within Vault Enterprise that allows
  9217. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  9218. More about namespaces can be found here <a href="https://www.vaultproject.io/docs/enterprise/namespaces">https://www.vaultproject.io/docs/enterprise/namespaces</a>
  9219. This will default to Vault.Namespace field if set, or empty otherwise</p>
  9220. </td>
  9221. </tr>
  9222. <tr>
  9223. <td>
  9224. <code>tokenSecretRef</code></br>
  9225. <em>
  9226. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9227. External Secrets meta/v1.SecretKeySelector
  9228. </a>
  9229. </em>
  9230. </td>
  9231. <td>
  9232. <em>(Optional)</em>
  9233. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  9234. </td>
  9235. </tr>
  9236. <tr>
  9237. <td>
  9238. <code>appRole</code></br>
  9239. <em>
  9240. <a href="#external-secrets.io/v1beta1.VaultAppRole">
  9241. VaultAppRole
  9242. </a>
  9243. </em>
  9244. </td>
  9245. <td>
  9246. <em>(Optional)</em>
  9247. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  9248. with the role and secret stored in a Kubernetes Secret resource.</p>
  9249. </td>
  9250. </tr>
  9251. <tr>
  9252. <td>
  9253. <code>kubernetes</code></br>
  9254. <em>
  9255. <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
  9256. VaultKubernetesAuth
  9257. </a>
  9258. </em>
  9259. </td>
  9260. <td>
  9261. <em>(Optional)</em>
  9262. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  9263. token stored in the named Secret resource to the Vault server.</p>
  9264. </td>
  9265. </tr>
  9266. <tr>
  9267. <td>
  9268. <code>ldap</code></br>
  9269. <em>
  9270. <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
  9271. VaultLdapAuth
  9272. </a>
  9273. </em>
  9274. </td>
  9275. <td>
  9276. <em>(Optional)</em>
  9277. <p>Ldap authenticates with Vault by passing username/password pair using
  9278. the LDAP authentication method</p>
  9279. </td>
  9280. </tr>
  9281. <tr>
  9282. <td>
  9283. <code>jwt</code></br>
  9284. <em>
  9285. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
  9286. VaultJwtAuth
  9287. </a>
  9288. </em>
  9289. </td>
  9290. <td>
  9291. <em>(Optional)</em>
  9292. <p>Jwt authenticates with Vault by passing role and JWT token using the
  9293. JWT/OIDC authentication method</p>
  9294. </td>
  9295. </tr>
  9296. <tr>
  9297. <td>
  9298. <code>cert</code></br>
  9299. <em>
  9300. <a href="#external-secrets.io/v1beta1.VaultCertAuth">
  9301. VaultCertAuth
  9302. </a>
  9303. </em>
  9304. </td>
  9305. <td>
  9306. <em>(Optional)</em>
  9307. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  9308. Cert authentication method</p>
  9309. </td>
  9310. </tr>
  9311. <tr>
  9312. <td>
  9313. <code>iam</code></br>
  9314. <em>
  9315. <a href="#external-secrets.io/v1beta1.VaultIamAuth">
  9316. VaultIamAuth
  9317. </a>
  9318. </em>
  9319. </td>
  9320. <td>
  9321. <em>(Optional)</em>
  9322. <p>Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials
  9323. AWS IAM authentication method</p>
  9324. </td>
  9325. </tr>
  9326. <tr>
  9327. <td>
  9328. <code>userPass</code></br>
  9329. <em>
  9330. <a href="#external-secrets.io/v1beta1.VaultUserPassAuth">
  9331. VaultUserPassAuth
  9332. </a>
  9333. </em>
  9334. </td>
  9335. <td>
  9336. <em>(Optional)</em>
  9337. <p>UserPass authenticates with Vault by passing username/password pair</p>
  9338. </td>
  9339. </tr>
  9340. </tbody>
  9341. </table>
  9342. <h3 id="external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth
  9343. </h3>
  9344. <p>
  9345. <p>VaultAwsAuth tells the controller how to do authentication with aws.
  9346. Only one of secretRef or jwt can be specified.
  9347. if none is specified the controller will try to load credentials from its own service account assuming it is IRSA enabled.</p>
  9348. </p>
  9349. <table>
  9350. <thead>
  9351. <tr>
  9352. <th>Field</th>
  9353. <th>Description</th>
  9354. </tr>
  9355. </thead>
  9356. <tbody>
  9357. <tr>
  9358. <td>
  9359. <code>secretRef</code></br>
  9360. <em>
  9361. <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
  9362. VaultAwsAuthSecretRef
  9363. </a>
  9364. </em>
  9365. </td>
  9366. <td>
  9367. <em>(Optional)</em>
  9368. </td>
  9369. </tr>
  9370. <tr>
  9371. <td>
  9372. <code>jwt</code></br>
  9373. <em>
  9374. <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
  9375. VaultAwsJWTAuth
  9376. </a>
  9377. </em>
  9378. </td>
  9379. <td>
  9380. <em>(Optional)</em>
  9381. </td>
  9382. </tr>
  9383. </tbody>
  9384. </table>
  9385. <h3 id="external-secrets.io/v1beta1.VaultAwsAuthSecretRef">VaultAwsAuthSecretRef
  9386. </h3>
  9387. <p>
  9388. (<em>Appears on:</em>
  9389. <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
  9390. <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
  9391. </p>
  9392. <p>
  9393. <p>VaultAWSAuthSecretRef holds secret references for AWS credentials
  9394. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  9395. </p>
  9396. <table>
  9397. <thead>
  9398. <tr>
  9399. <th>Field</th>
  9400. <th>Description</th>
  9401. </tr>
  9402. </thead>
  9403. <tbody>
  9404. <tr>
  9405. <td>
  9406. <code>accessKeyIDSecretRef</code></br>
  9407. <em>
  9408. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9409. External Secrets meta/v1.SecretKeySelector
  9410. </a>
  9411. </em>
  9412. </td>
  9413. <td>
  9414. <p>The AccessKeyID is used for authentication</p>
  9415. </td>
  9416. </tr>
  9417. <tr>
  9418. <td>
  9419. <code>secretAccessKeySecretRef</code></br>
  9420. <em>
  9421. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9422. External Secrets meta/v1.SecretKeySelector
  9423. </a>
  9424. </em>
  9425. </td>
  9426. <td>
  9427. <p>The SecretAccessKey is used for authentication</p>
  9428. </td>
  9429. </tr>
  9430. <tr>
  9431. <td>
  9432. <code>sessionTokenSecretRef</code></br>
  9433. <em>
  9434. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9435. External Secrets meta/v1.SecretKeySelector
  9436. </a>
  9437. </em>
  9438. </td>
  9439. <td>
  9440. <p>The SessionToken used for authentication
  9441. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  9442. see: <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html">https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html</a></p>
  9443. </td>
  9444. </tr>
  9445. </tbody>
  9446. </table>
  9447. <h3 id="external-secrets.io/v1beta1.VaultAwsJWTAuth">VaultAwsJWTAuth
  9448. </h3>
  9449. <p>
  9450. (<em>Appears on:</em>
  9451. <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
  9452. <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
  9453. </p>
  9454. <p>
  9455. <p>Authenticate against AWS using service account tokens.</p>
  9456. </p>
  9457. <table>
  9458. <thead>
  9459. <tr>
  9460. <th>Field</th>
  9461. <th>Description</th>
  9462. </tr>
  9463. </thead>
  9464. <tbody>
  9465. <tr>
  9466. <td>
  9467. <code>serviceAccountRef</code></br>
  9468. <em>
  9469. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  9470. External Secrets meta/v1.ServiceAccountSelector
  9471. </a>
  9472. </em>
  9473. </td>
  9474. <td>
  9475. </td>
  9476. </tr>
  9477. </tbody>
  9478. </table>
  9479. <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
  9480. </h3>
  9481. <p>
  9482. (<em>Appears on:</em>
  9483. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9484. </p>
  9485. <p>
  9486. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  9487. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  9488. </p>
  9489. <table>
  9490. <thead>
  9491. <tr>
  9492. <th>Field</th>
  9493. <th>Description</th>
  9494. </tr>
  9495. </thead>
  9496. <tbody>
  9497. <tr>
  9498. <td>
  9499. <code>clientCert</code></br>
  9500. <em>
  9501. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9502. External Secrets meta/v1.SecretKeySelector
  9503. </a>
  9504. </em>
  9505. </td>
  9506. <td>
  9507. <em>(Optional)</em>
  9508. <p>ClientCert is a certificate to authenticate using the Cert Vault
  9509. authentication method</p>
  9510. </td>
  9511. </tr>
  9512. <tr>
  9513. <td>
  9514. <code>secretRef</code></br>
  9515. <em>
  9516. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9517. External Secrets meta/v1.SecretKeySelector
  9518. </a>
  9519. </em>
  9520. </td>
  9521. <td>
  9522. <p>SecretRef to a key in a Secret resource containing client private key to
  9523. authenticate with Vault using the Cert authentication method</p>
  9524. </td>
  9525. </tr>
  9526. </tbody>
  9527. </table>
  9528. <h3 id="external-secrets.io/v1beta1.VaultClientTLS">VaultClientTLS
  9529. </h3>
  9530. <p>
  9531. (<em>Appears on:</em>
  9532. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  9533. </p>
  9534. <p>
  9535. <p>VaultClientTLS is the configuration used for client side related TLS communication,
  9536. when the Vault server requires mutual authentication.</p>
  9537. </p>
  9538. <table>
  9539. <thead>
  9540. <tr>
  9541. <th>Field</th>
  9542. <th>Description</th>
  9543. </tr>
  9544. </thead>
  9545. <tbody>
  9546. <tr>
  9547. <td>
  9548. <code>certSecretRef</code></br>
  9549. <em>
  9550. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9551. External Secrets meta/v1.SecretKeySelector
  9552. </a>
  9553. </em>
  9554. </td>
  9555. <td>
  9556. <p>CertSecretRef is a certificate added to the transport layer
  9557. when communicating with the Vault server.
  9558. If no key for the Secret is specified, external-secret will default to &lsquo;tls.crt&rsquo;.</p>
  9559. </td>
  9560. </tr>
  9561. <tr>
  9562. <td>
  9563. <code>keySecretRef</code></br>
  9564. <em>
  9565. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9566. External Secrets meta/v1.SecretKeySelector
  9567. </a>
  9568. </em>
  9569. </td>
  9570. <td>
  9571. <p>KeySecretRef to a key in a Secret resource containing client private key
  9572. added to the transport layer when communicating with the Vault server.
  9573. If no key for the Secret is specified, external-secret will default to &lsquo;tls.key&rsquo;.</p>
  9574. </td>
  9575. </tr>
  9576. </tbody>
  9577. </table>
  9578. <h3 id="external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth
  9579. </h3>
  9580. <p>
  9581. (<em>Appears on:</em>
  9582. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9583. </p>
  9584. <p>
  9585. <p>VaultIamAuth authenticates with Vault using the Vault&rsquo;s AWS IAM authentication method. Refer: <a href="https://developer.hashicorp.com/vault/docs/auth/aws">https://developer.hashicorp.com/vault/docs/auth/aws</a></p>
  9586. </p>
  9587. <table>
  9588. <thead>
  9589. <tr>
  9590. <th>Field</th>
  9591. <th>Description</th>
  9592. </tr>
  9593. </thead>
  9594. <tbody>
  9595. <tr>
  9596. <td>
  9597. <code>path</code></br>
  9598. <em>
  9599. string
  9600. </em>
  9601. </td>
  9602. <td>
  9603. <p>Path where the AWS auth method is enabled in Vault, e.g: &ldquo;aws&rdquo;</p>
  9604. </td>
  9605. </tr>
  9606. <tr>
  9607. <td>
  9608. <code>region</code></br>
  9609. <em>
  9610. string
  9611. </em>
  9612. </td>
  9613. <td>
  9614. <p>AWS region</p>
  9615. </td>
  9616. </tr>
  9617. <tr>
  9618. <td>
  9619. <code>role</code></br>
  9620. <em>
  9621. string
  9622. </em>
  9623. </td>
  9624. <td>
  9625. <p>This is the AWS role to be assumed before talking to vault</p>
  9626. </td>
  9627. </tr>
  9628. <tr>
  9629. <td>
  9630. <code>vaultRole</code></br>
  9631. <em>
  9632. string
  9633. </em>
  9634. </td>
  9635. <td>
  9636. <p>Vault Role. In vault, a role describes an identity with a set of permissions, groups, or policies you want to attach a user of the secrets engine</p>
  9637. </td>
  9638. </tr>
  9639. <tr>
  9640. <td>
  9641. <code>externalID</code></br>
  9642. <em>
  9643. string
  9644. </em>
  9645. </td>
  9646. <td>
  9647. <p>AWS External ID set on assumed IAM roles</p>
  9648. </td>
  9649. </tr>
  9650. <tr>
  9651. <td>
  9652. <code>vaultAwsIamServerID</code></br>
  9653. <em>
  9654. string
  9655. </em>
  9656. </td>
  9657. <td>
  9658. <p>X-Vault-AWS-IAM-Server-ID is an additional header used by Vault IAM auth method to mitigate against different types of replay attacks. More details here: <a href="https://developer.hashicorp.com/vault/docs/auth/aws">https://developer.hashicorp.com/vault/docs/auth/aws</a></p>
  9659. </td>
  9660. </tr>
  9661. <tr>
  9662. <td>
  9663. <code>secretRef</code></br>
  9664. <em>
  9665. <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
  9666. VaultAwsAuthSecretRef
  9667. </a>
  9668. </em>
  9669. </td>
  9670. <td>
  9671. <em>(Optional)</em>
  9672. <p>Specify credentials in a Secret object</p>
  9673. </td>
  9674. </tr>
  9675. <tr>
  9676. <td>
  9677. <code>jwt</code></br>
  9678. <em>
  9679. <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
  9680. VaultAwsJWTAuth
  9681. </a>
  9682. </em>
  9683. </td>
  9684. <td>
  9685. <em>(Optional)</em>
  9686. <p>Specify a service account with IRSA enabled</p>
  9687. </td>
  9688. </tr>
  9689. </tbody>
  9690. </table>
  9691. <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
  9692. </h3>
  9693. <p>
  9694. (<em>Appears on:</em>
  9695. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9696. </p>
  9697. <p>
  9698. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  9699. method, with the role name and a token stored in a Kubernetes Secret resource or
  9700. a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
  9701. </p>
  9702. <table>
  9703. <thead>
  9704. <tr>
  9705. <th>Field</th>
  9706. <th>Description</th>
  9707. </tr>
  9708. </thead>
  9709. <tbody>
  9710. <tr>
  9711. <td>
  9712. <code>path</code></br>
  9713. <em>
  9714. string
  9715. </em>
  9716. </td>
  9717. <td>
  9718. <p>Path where the JWT authentication backend is mounted
  9719. in Vault, e.g: &ldquo;jwt&rdquo;</p>
  9720. </td>
  9721. </tr>
  9722. <tr>
  9723. <td>
  9724. <code>role</code></br>
  9725. <em>
  9726. string
  9727. </em>
  9728. </td>
  9729. <td>
  9730. <em>(Optional)</em>
  9731. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  9732. authentication method</p>
  9733. </td>
  9734. </tr>
  9735. <tr>
  9736. <td>
  9737. <code>secretRef</code></br>
  9738. <em>
  9739. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9740. External Secrets meta/v1.SecretKeySelector
  9741. </a>
  9742. </em>
  9743. </td>
  9744. <td>
  9745. <em>(Optional)</em>
  9746. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  9747. authenticate with Vault using the JWT/OIDC authentication method.</p>
  9748. </td>
  9749. </tr>
  9750. <tr>
  9751. <td>
  9752. <code>kubernetesServiceAccountToken</code></br>
  9753. <em>
  9754. <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
  9755. VaultKubernetesServiceAccountTokenAuth
  9756. </a>
  9757. </em>
  9758. </td>
  9759. <td>
  9760. <em>(Optional)</em>
  9761. <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  9762. a token for with the <code>TokenRequest</code> API.</p>
  9763. </td>
  9764. </tr>
  9765. </tbody>
  9766. </table>
  9767. <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
  9768. (<code>string</code> alias)</p></h3>
  9769. <p>
  9770. (<em>Appears on:</em>
  9771. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  9772. </p>
  9773. <p>
  9774. </p>
  9775. <table>
  9776. <thead>
  9777. <tr>
  9778. <th>Value</th>
  9779. <th>Description</th>
  9780. </tr>
  9781. </thead>
  9782. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  9783. <td></td>
  9784. </tr><tr><td><p>&#34;v2&#34;</p></td>
  9785. <td></td>
  9786. </tr></tbody>
  9787. </table>
  9788. <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
  9789. </h3>
  9790. <p>
  9791. (<em>Appears on:</em>
  9792. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9793. </p>
  9794. <p>
  9795. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  9796. a Secret.</p>
  9797. </p>
  9798. <table>
  9799. <thead>
  9800. <tr>
  9801. <th>Field</th>
  9802. <th>Description</th>
  9803. </tr>
  9804. </thead>
  9805. <tbody>
  9806. <tr>
  9807. <td>
  9808. <code>mountPath</code></br>
  9809. <em>
  9810. string
  9811. </em>
  9812. </td>
  9813. <td>
  9814. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  9815. &ldquo;kubernetes&rdquo;</p>
  9816. </td>
  9817. </tr>
  9818. <tr>
  9819. <td>
  9820. <code>serviceAccountRef</code></br>
  9821. <em>
  9822. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  9823. External Secrets meta/v1.ServiceAccountSelector
  9824. </a>
  9825. </em>
  9826. </td>
  9827. <td>
  9828. <em>(Optional)</em>
  9829. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  9830. If the service account is specified, the service account secret token JWT will be used
  9831. for authenticating with Vault. If the service account selector is not supplied,
  9832. the secretRef will be used instead.</p>
  9833. </td>
  9834. </tr>
  9835. <tr>
  9836. <td>
  9837. <code>secretRef</code></br>
  9838. <em>
  9839. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9840. External Secrets meta/v1.SecretKeySelector
  9841. </a>
  9842. </em>
  9843. </td>
  9844. <td>
  9845. <em>(Optional)</em>
  9846. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  9847. for authenticating with Vault. If a name is specified without a key,
  9848. <code>token</code> is the default. If one is not specified, the one bound to
  9849. the controller will be used.</p>
  9850. </td>
  9851. </tr>
  9852. <tr>
  9853. <td>
  9854. <code>role</code></br>
  9855. <em>
  9856. string
  9857. </em>
  9858. </td>
  9859. <td>
  9860. <p>A required field containing the Vault Role to assume. A Role binds a
  9861. Kubernetes ServiceAccount with a set of Vault policies.</p>
  9862. </td>
  9863. </tr>
  9864. </tbody>
  9865. </table>
  9866. <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
  9867. </h3>
  9868. <p>
  9869. (<em>Appears on:</em>
  9870. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
  9871. </p>
  9872. <p>
  9873. <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
  9874. Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
  9875. </p>
  9876. <table>
  9877. <thead>
  9878. <tr>
  9879. <th>Field</th>
  9880. <th>Description</th>
  9881. </tr>
  9882. </thead>
  9883. <tbody>
  9884. <tr>
  9885. <td>
  9886. <code>serviceAccountRef</code></br>
  9887. <em>
  9888. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  9889. External Secrets meta/v1.ServiceAccountSelector
  9890. </a>
  9891. </em>
  9892. </td>
  9893. <td>
  9894. <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
  9895. </td>
  9896. </tr>
  9897. <tr>
  9898. <td>
  9899. <code>audiences</code></br>
  9900. <em>
  9901. []string
  9902. </em>
  9903. </td>
  9904. <td>
  9905. <em>(Optional)</em>
  9906. <p>Optional audiences field that will be used to request a temporary Kubernetes service
  9907. account token for the service account referenced by <code>serviceAccountRef</code>.
  9908. Defaults to a single audience <code>vault</code> it not specified.
  9909. Deprecated: use serviceAccountRef.Audiences instead</p>
  9910. </td>
  9911. </tr>
  9912. <tr>
  9913. <td>
  9914. <code>expirationSeconds</code></br>
  9915. <em>
  9916. int64
  9917. </em>
  9918. </td>
  9919. <td>
  9920. <em>(Optional)</em>
  9921. <p>Optional expiration time in seconds that will be used to request a temporary
  9922. Kubernetes service account token for the service account referenced by
  9923. <code>serviceAccountRef</code>.
  9924. Deprecated: this will be removed in the future.
  9925. Defaults to 10 minutes.</p>
  9926. </td>
  9927. </tr>
  9928. </tbody>
  9929. </table>
  9930. <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
  9931. </h3>
  9932. <p>
  9933. (<em>Appears on:</em>
  9934. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9935. </p>
  9936. <p>
  9937. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  9938. with the username and password stored in a Kubernetes Secret resource.</p>
  9939. </p>
  9940. <table>
  9941. <thead>
  9942. <tr>
  9943. <th>Field</th>
  9944. <th>Description</th>
  9945. </tr>
  9946. </thead>
  9947. <tbody>
  9948. <tr>
  9949. <td>
  9950. <code>path</code></br>
  9951. <em>
  9952. string
  9953. </em>
  9954. </td>
  9955. <td>
  9956. <p>Path where the LDAP authentication backend is mounted
  9957. in Vault, e.g: &ldquo;ldap&rdquo;</p>
  9958. </td>
  9959. </tr>
  9960. <tr>
  9961. <td>
  9962. <code>username</code></br>
  9963. <em>
  9964. string
  9965. </em>
  9966. </td>
  9967. <td>
  9968. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  9969. authentication method</p>
  9970. </td>
  9971. </tr>
  9972. <tr>
  9973. <td>
  9974. <code>secretRef</code></br>
  9975. <em>
  9976. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9977. External Secrets meta/v1.SecretKeySelector
  9978. </a>
  9979. </em>
  9980. </td>
  9981. <td>
  9982. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  9983. user used to authenticate with Vault using the LDAP authentication
  9984. method</p>
  9985. </td>
  9986. </tr>
  9987. </tbody>
  9988. </table>
  9989. <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
  9990. </h3>
  9991. <p>
  9992. (<em>Appears on:</em>
  9993. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  9994. </p>
  9995. <p>
  9996. <p>Configures an store to sync secrets using a HashiCorp Vault
  9997. KV backend.</p>
  9998. </p>
  9999. <table>
  10000. <thead>
  10001. <tr>
  10002. <th>Field</th>
  10003. <th>Description</th>
  10004. </tr>
  10005. </thead>
  10006. <tbody>
  10007. <tr>
  10008. <td>
  10009. <code>auth</code></br>
  10010. <em>
  10011. <a href="#external-secrets.io/v1beta1.VaultAuth">
  10012. VaultAuth
  10013. </a>
  10014. </em>
  10015. </td>
  10016. <td>
  10017. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  10018. </td>
  10019. </tr>
  10020. <tr>
  10021. <td>
  10022. <code>server</code></br>
  10023. <em>
  10024. string
  10025. </em>
  10026. </td>
  10027. <td>
  10028. <p>Server is the connection address for the Vault server, e.g: &ldquo;<a href="https://vault.example.com:8200&quot;">https://vault.example.com:8200&rdquo;</a>.</p>
  10029. </td>
  10030. </tr>
  10031. <tr>
  10032. <td>
  10033. <code>path</code></br>
  10034. <em>
  10035. string
  10036. </em>
  10037. </td>
  10038. <td>
  10039. <em>(Optional)</em>
  10040. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  10041. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  10042. for fetching secrets from Vault is optional and will be appended
  10043. if not present in specified path.</p>
  10044. </td>
  10045. </tr>
  10046. <tr>
  10047. <td>
  10048. <code>version</code></br>
  10049. <em>
  10050. <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
  10051. VaultKVStoreVersion
  10052. </a>
  10053. </em>
  10054. </td>
  10055. <td>
  10056. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  10057. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  10058. </td>
  10059. </tr>
  10060. <tr>
  10061. <td>
  10062. <code>namespace</code></br>
  10063. <em>
  10064. string
  10065. </em>
  10066. </td>
  10067. <td>
  10068. <em>(Optional)</em>
  10069. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  10070. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  10071. More about namespaces can be found here <a href="https://www.vaultproject.io/docs/enterprise/namespaces">https://www.vaultproject.io/docs/enterprise/namespaces</a></p>
  10072. </td>
  10073. </tr>
  10074. <tr>
  10075. <td>
  10076. <code>caBundle</code></br>
  10077. <em>
  10078. []byte
  10079. </em>
  10080. </td>
  10081. <td>
  10082. <em>(Optional)</em>
  10083. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  10084. if the Server URL is using HTTPS protocol. This parameter is ignored for
  10085. plain HTTP protocol connection. If not set the system root certificates
  10086. are used to validate the TLS connection.</p>
  10087. </td>
  10088. </tr>
  10089. <tr>
  10090. <td>
  10091. <code>tls</code></br>
  10092. <em>
  10093. <a href="#external-secrets.io/v1beta1.VaultClientTLS">
  10094. VaultClientTLS
  10095. </a>
  10096. </em>
  10097. </td>
  10098. <td>
  10099. <em>(Optional)</em>
  10100. <p>The configuration used for client side related TLS communication, when the Vault server
  10101. requires mutual authentication. Only used if the Server URL is using HTTPS protocol.
  10102. This parameter is ignored for plain HTTP protocol connection.
  10103. It&rsquo;s worth noting this configuration is different from the &ldquo;TLS certificates auth method&rdquo;,
  10104. which is available under the <code>auth.cert</code> section.</p>
  10105. </td>
  10106. </tr>
  10107. <tr>
  10108. <td>
  10109. <code>caProvider</code></br>
  10110. <em>
  10111. <a href="#external-secrets.io/v1beta1.CAProvider">
  10112. CAProvider
  10113. </a>
  10114. </em>
  10115. </td>
  10116. <td>
  10117. <em>(Optional)</em>
  10118. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  10119. </td>
  10120. </tr>
  10121. <tr>
  10122. <td>
  10123. <code>readYourWrites</code></br>
  10124. <em>
  10125. bool
  10126. </em>
  10127. </td>
  10128. <td>
  10129. <em>(Optional)</em>
  10130. <p>ReadYourWrites ensures isolated read-after-write semantics by
  10131. providing discovered cluster replication states in each request.
  10132. More information about eventual consistency in Vault can be found here
  10133. <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
  10134. </td>
  10135. </tr>
  10136. <tr>
  10137. <td>
  10138. <code>forwardInconsistent</code></br>
  10139. <em>
  10140. bool
  10141. </em>
  10142. </td>
  10143. <td>
  10144. <em>(Optional)</em>
  10145. <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  10146. leader instead of simply retrying within a loop. This can increase performance if
  10147. the option is enabled serverside.
  10148. <a href="https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header">https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header</a></p>
  10149. </td>
  10150. </tr>
  10151. <tr>
  10152. <td>
  10153. <code>headers</code></br>
  10154. <em>
  10155. map[string]string
  10156. </em>
  10157. </td>
  10158. <td>
  10159. <em>(Optional)</em>
  10160. <p>Headers to be added in Vault request</p>
  10161. </td>
  10162. </tr>
  10163. </tbody>
  10164. </table>
  10165. <h3 id="external-secrets.io/v1beta1.VaultUserPassAuth">VaultUserPassAuth
  10166. </h3>
  10167. <p>
  10168. (<em>Appears on:</em>
  10169. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  10170. </p>
  10171. <p>
  10172. <p>VaultUserPassAuth authenticates with Vault using UserPass authentication method,
  10173. with the username and password stored in a Kubernetes Secret resource.</p>
  10174. </p>
  10175. <table>
  10176. <thead>
  10177. <tr>
  10178. <th>Field</th>
  10179. <th>Description</th>
  10180. </tr>
  10181. </thead>
  10182. <tbody>
  10183. <tr>
  10184. <td>
  10185. <code>path</code></br>
  10186. <em>
  10187. string
  10188. </em>
  10189. </td>
  10190. <td>
  10191. <p>Path where the UserPassword authentication backend is mounted
  10192. in Vault, e.g: &ldquo;user&rdquo;</p>
  10193. </td>
  10194. </tr>
  10195. <tr>
  10196. <td>
  10197. <code>username</code></br>
  10198. <em>
  10199. string
  10200. </em>
  10201. </td>
  10202. <td>
  10203. <p>Username is a user name used to authenticate using the UserPass Vault
  10204. authentication method</p>
  10205. </td>
  10206. </tr>
  10207. <tr>
  10208. <td>
  10209. <code>secretRef</code></br>
  10210. <em>
  10211. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10212. External Secrets meta/v1.SecretKeySelector
  10213. </a>
  10214. </em>
  10215. </td>
  10216. <td>
  10217. <p>SecretRef to a key in a Secret resource containing password for the
  10218. user used to authenticate with Vault using the UserPass authentication
  10219. method</p>
  10220. </td>
  10221. </tr>
  10222. </tbody>
  10223. </table>
  10224. <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
  10225. </h3>
  10226. <p>
  10227. (<em>Appears on:</em>
  10228. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  10229. </p>
  10230. <p>
  10231. <p>Defines a location to fetch the cert for the webhook provider from.</p>
  10232. </p>
  10233. <table>
  10234. <thead>
  10235. <tr>
  10236. <th>Field</th>
  10237. <th>Description</th>
  10238. </tr>
  10239. </thead>
  10240. <tbody>
  10241. <tr>
  10242. <td>
  10243. <code>type</code></br>
  10244. <em>
  10245. <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
  10246. WebhookCAProviderType
  10247. </a>
  10248. </em>
  10249. </td>
  10250. <td>
  10251. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  10252. </td>
  10253. </tr>
  10254. <tr>
  10255. <td>
  10256. <code>name</code></br>
  10257. <em>
  10258. string
  10259. </em>
  10260. </td>
  10261. <td>
  10262. <p>The name of the object located at the provider type.</p>
  10263. </td>
  10264. </tr>
  10265. <tr>
  10266. <td>
  10267. <code>key</code></br>
  10268. <em>
  10269. string
  10270. </em>
  10271. </td>
  10272. <td>
  10273. <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
  10274. </td>
  10275. </tr>
  10276. <tr>
  10277. <td>
  10278. <code>namespace</code></br>
  10279. <em>
  10280. string
  10281. </em>
  10282. </td>
  10283. <td>
  10284. <em>(Optional)</em>
  10285. <p>The namespace the Provider type is in.</p>
  10286. </td>
  10287. </tr>
  10288. </tbody>
  10289. </table>
  10290. <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
  10291. (<code>string</code> alias)</p></h3>
  10292. <p>
  10293. (<em>Appears on:</em>
  10294. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
  10295. </p>
  10296. <p>
  10297. </p>
  10298. <table>
  10299. <thead>
  10300. <tr>
  10301. <th>Value</th>
  10302. <th>Description</th>
  10303. </tr>
  10304. </thead>
  10305. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  10306. <td></td>
  10307. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  10308. <td></td>
  10309. </tr></tbody>
  10310. </table>
  10311. <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
  10312. </h3>
  10313. <p>
  10314. (<em>Appears on:</em>
  10315. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  10316. </p>
  10317. <p>
  10318. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  10319. </p>
  10320. <table>
  10321. <thead>
  10322. <tr>
  10323. <th>Field</th>
  10324. <th>Description</th>
  10325. </tr>
  10326. </thead>
  10327. <tbody>
  10328. <tr>
  10329. <td>
  10330. <code>method</code></br>
  10331. <em>
  10332. string
  10333. </em>
  10334. </td>
  10335. <td>
  10336. <p>Webhook Method</p>
  10337. </td>
  10338. </tr>
  10339. <tr>
  10340. <td>
  10341. <code>url</code></br>
  10342. <em>
  10343. string
  10344. </em>
  10345. </td>
  10346. <td>
  10347. <p>Webhook url to call</p>
  10348. </td>
  10349. </tr>
  10350. <tr>
  10351. <td>
  10352. <code>headers</code></br>
  10353. <em>
  10354. map[string]string
  10355. </em>
  10356. </td>
  10357. <td>
  10358. <em>(Optional)</em>
  10359. <p>Headers</p>
  10360. </td>
  10361. </tr>
  10362. <tr>
  10363. <td>
  10364. <code>body</code></br>
  10365. <em>
  10366. string
  10367. </em>
  10368. </td>
  10369. <td>
  10370. <em>(Optional)</em>
  10371. <p>Body</p>
  10372. </td>
  10373. </tr>
  10374. <tr>
  10375. <td>
  10376. <code>timeout</code></br>
  10377. <em>
  10378. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  10379. Kubernetes meta/v1.Duration
  10380. </a>
  10381. </em>
  10382. </td>
  10383. <td>
  10384. <em>(Optional)</em>
  10385. <p>Timeout</p>
  10386. </td>
  10387. </tr>
  10388. <tr>
  10389. <td>
  10390. <code>result</code></br>
  10391. <em>
  10392. <a href="#external-secrets.io/v1beta1.WebhookResult">
  10393. WebhookResult
  10394. </a>
  10395. </em>
  10396. </td>
  10397. <td>
  10398. <p>Result formatting</p>
  10399. </td>
  10400. </tr>
  10401. <tr>
  10402. <td>
  10403. <code>secrets</code></br>
  10404. <em>
  10405. <a href="#external-secrets.io/v1beta1.WebhookSecret">
  10406. []WebhookSecret
  10407. </a>
  10408. </em>
  10409. </td>
  10410. <td>
  10411. <em>(Optional)</em>
  10412. <p>Secrets to fill in templates
  10413. These secrets will be passed to the templating function as key value pairs under the given name</p>
  10414. </td>
  10415. </tr>
  10416. <tr>
  10417. <td>
  10418. <code>caBundle</code></br>
  10419. <em>
  10420. []byte
  10421. </em>
  10422. </td>
  10423. <td>
  10424. <em>(Optional)</em>
  10425. <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
  10426. if the Server URL is using HTTPS protocol. This parameter is ignored for
  10427. plain HTTP protocol connection. If not set the system root certificates
  10428. are used to validate the TLS connection.</p>
  10429. </td>
  10430. </tr>
  10431. <tr>
  10432. <td>
  10433. <code>caProvider</code></br>
  10434. <em>
  10435. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
  10436. WebhookCAProvider
  10437. </a>
  10438. </em>
  10439. </td>
  10440. <td>
  10441. <em>(Optional)</em>
  10442. <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
  10443. </td>
  10444. </tr>
  10445. </tbody>
  10446. </table>
  10447. <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
  10448. </h3>
  10449. <p>
  10450. (<em>Appears on:</em>
  10451. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  10452. </p>
  10453. <p>
  10454. </p>
  10455. <table>
  10456. <thead>
  10457. <tr>
  10458. <th>Field</th>
  10459. <th>Description</th>
  10460. </tr>
  10461. </thead>
  10462. <tbody>
  10463. <tr>
  10464. <td>
  10465. <code>jsonPath</code></br>
  10466. <em>
  10467. string
  10468. </em>
  10469. </td>
  10470. <td>
  10471. <em>(Optional)</em>
  10472. <p>Json path of return value</p>
  10473. </td>
  10474. </tr>
  10475. </tbody>
  10476. </table>
  10477. <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
  10478. </h3>
  10479. <p>
  10480. (<em>Appears on:</em>
  10481. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  10482. </p>
  10483. <p>
  10484. </p>
  10485. <table>
  10486. <thead>
  10487. <tr>
  10488. <th>Field</th>
  10489. <th>Description</th>
  10490. </tr>
  10491. </thead>
  10492. <tbody>
  10493. <tr>
  10494. <td>
  10495. <code>name</code></br>
  10496. <em>
  10497. string
  10498. </em>
  10499. </td>
  10500. <td>
  10501. <p>Name of this secret in templates</p>
  10502. </td>
  10503. </tr>
  10504. <tr>
  10505. <td>
  10506. <code>secretRef</code></br>
  10507. <em>
  10508. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10509. External Secrets meta/v1.SecretKeySelector
  10510. </a>
  10511. </em>
  10512. </td>
  10513. <td>
  10514. <p>Secret ref to fill in credentials</p>
  10515. </td>
  10516. </tr>
  10517. </tbody>
  10518. </table>
  10519. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerAuth">YandexCertificateManagerAuth
  10520. </h3>
  10521. <p>
  10522. (<em>Appears on:</em>
  10523. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  10524. </p>
  10525. <p>
  10526. </p>
  10527. <table>
  10528. <thead>
  10529. <tr>
  10530. <th>Field</th>
  10531. <th>Description</th>
  10532. </tr>
  10533. </thead>
  10534. <tbody>
  10535. <tr>
  10536. <td>
  10537. <code>authorizedKeySecretRef</code></br>
  10538. <em>
  10539. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10540. External Secrets meta/v1.SecretKeySelector
  10541. </a>
  10542. </em>
  10543. </td>
  10544. <td>
  10545. <em>(Optional)</em>
  10546. <p>The authorized key used for authentication</p>
  10547. </td>
  10548. </tr>
  10549. </tbody>
  10550. </table>
  10551. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">YandexCertificateManagerCAProvider
  10552. </h3>
  10553. <p>
  10554. (<em>Appears on:</em>
  10555. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  10556. </p>
  10557. <p>
  10558. </p>
  10559. <table>
  10560. <thead>
  10561. <tr>
  10562. <th>Field</th>
  10563. <th>Description</th>
  10564. </tr>
  10565. </thead>
  10566. <tbody>
  10567. <tr>
  10568. <td>
  10569. <code>certSecretRef</code></br>
  10570. <em>
  10571. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10572. External Secrets meta/v1.SecretKeySelector
  10573. </a>
  10574. </em>
  10575. </td>
  10576. <td>
  10577. </td>
  10578. </tr>
  10579. </tbody>
  10580. </table>
  10581. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
  10582. </h3>
  10583. <p>
  10584. (<em>Appears on:</em>
  10585. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  10586. </p>
  10587. <p>
  10588. <p>YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
  10589. </p>
  10590. <table>
  10591. <thead>
  10592. <tr>
  10593. <th>Field</th>
  10594. <th>Description</th>
  10595. </tr>
  10596. </thead>
  10597. <tbody>
  10598. <tr>
  10599. <td>
  10600. <code>apiEndpoint</code></br>
  10601. <em>
  10602. string
  10603. </em>
  10604. </td>
  10605. <td>
  10606. <em>(Optional)</em>
  10607. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  10608. </td>
  10609. </tr>
  10610. <tr>
  10611. <td>
  10612. <code>auth</code></br>
  10613. <em>
  10614. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerAuth">
  10615. YandexCertificateManagerAuth
  10616. </a>
  10617. </em>
  10618. </td>
  10619. <td>
  10620. <p>Auth defines the information necessary to authenticate against Yandex Certificate Manager</p>
  10621. </td>
  10622. </tr>
  10623. <tr>
  10624. <td>
  10625. <code>caProvider</code></br>
  10626. <em>
  10627. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">
  10628. YandexCertificateManagerCAProvider
  10629. </a>
  10630. </em>
  10631. </td>
  10632. <td>
  10633. <em>(Optional)</em>
  10634. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  10635. </td>
  10636. </tr>
  10637. </tbody>
  10638. </table>
  10639. <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
  10640. </h3>
  10641. <p>
  10642. (<em>Appears on:</em>
  10643. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  10644. </p>
  10645. <p>
  10646. </p>
  10647. <table>
  10648. <thead>
  10649. <tr>
  10650. <th>Field</th>
  10651. <th>Description</th>
  10652. </tr>
  10653. </thead>
  10654. <tbody>
  10655. <tr>
  10656. <td>
  10657. <code>authorizedKeySecretRef</code></br>
  10658. <em>
  10659. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10660. External Secrets meta/v1.SecretKeySelector
  10661. </a>
  10662. </em>
  10663. </td>
  10664. <td>
  10665. <em>(Optional)</em>
  10666. <p>The authorized key used for authentication</p>
  10667. </td>
  10668. </tr>
  10669. </tbody>
  10670. </table>
  10671. <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
  10672. </h3>
  10673. <p>
  10674. (<em>Appears on:</em>
  10675. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  10676. </p>
  10677. <p>
  10678. </p>
  10679. <table>
  10680. <thead>
  10681. <tr>
  10682. <th>Field</th>
  10683. <th>Description</th>
  10684. </tr>
  10685. </thead>
  10686. <tbody>
  10687. <tr>
  10688. <td>
  10689. <code>certSecretRef</code></br>
  10690. <em>
  10691. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10692. External Secrets meta/v1.SecretKeySelector
  10693. </a>
  10694. </em>
  10695. </td>
  10696. <td>
  10697. </td>
  10698. </tr>
  10699. </tbody>
  10700. </table>
  10701. <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
  10702. </h3>
  10703. <p>
  10704. (<em>Appears on:</em>
  10705. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  10706. </p>
  10707. <p>
  10708. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  10709. </p>
  10710. <table>
  10711. <thead>
  10712. <tr>
  10713. <th>Field</th>
  10714. <th>Description</th>
  10715. </tr>
  10716. </thead>
  10717. <tbody>
  10718. <tr>
  10719. <td>
  10720. <code>apiEndpoint</code></br>
  10721. <em>
  10722. string
  10723. </em>
  10724. </td>
  10725. <td>
  10726. <em>(Optional)</em>
  10727. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  10728. </td>
  10729. </tr>
  10730. <tr>
  10731. <td>
  10732. <code>auth</code></br>
  10733. <em>
  10734. <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
  10735. YandexLockboxAuth
  10736. </a>
  10737. </em>
  10738. </td>
  10739. <td>
  10740. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  10741. </td>
  10742. </tr>
  10743. <tr>
  10744. <td>
  10745. <code>caProvider</code></br>
  10746. <em>
  10747. <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
  10748. YandexLockboxCAProvider
  10749. </a>
  10750. </em>
  10751. </td>
  10752. <td>
  10753. <em>(Optional)</em>
  10754. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  10755. </td>
  10756. </tr>
  10757. </tbody>
  10758. </table>
  10759. <hr/>
  10760. <p><em>
  10761. Generated with <code>gen-crd-api-reference-docs</code>.
  10762. </em></p>
  10763. </article>
  10764. </div>
  10765. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  10766. </div>
  10767. </main>
  10768. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  10769. <footer class="md-footer">
  10770. <div class="md-footer-meta md-typeset">
  10771. <div class="md-footer-meta__inner md-grid">
  10772. <div class="md-copyright">
  10773. <div class="md-copyright__highlight">
  10774. &copy; 2024 The external-secrets Authors.<br/>
  10775. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  10776. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  10777. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  10778. </div>
  10779. Made with
  10780. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  10781. Material for MkDocs
  10782. </a>
  10783. </div>
  10784. </div>
  10785. </div>
  10786. </footer>
  10787. </div>
  10788. <div class="md-dialog" data-md-component="dialog">
  10789. <div class="md-dialog__inner md-typeset"></div>
  10790. </div>
  10791. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  10792. <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
  10793. </body>
  10794. </html>